Skip to main content

Complete Markdown references

Each DYLI API has a standalone raw Markdown reference containing its full integration contract. Open a file directly, download it, or provide its URL to a coding model.

APIRaw MarkdownOther machine-readable contract
Read APIread-api.mdRuntime endpoint index: GET /api/public/v1/overview
Commerce APIcommerce-api.mdOpenAPI 3.1 JSON
3PL API3pl-api.mdCompany-scoped runtime responses

The llms.txt index links all three files and the human-readable documentation.

What each file contains

  • Read API: authentication, endpoint map, filtering, pagination, identifiers, response semantics, errors, and retries.
  • Commerce API: key-only setup, application discovery, catalog and customer identity, quotes, Stripe, customer or treasury USDC, orders, Boxes, redemptions, signed events, and testing. For a shorter human introduction, use the Commerce quickstart.
  • 3PL API: company-scoped inventory reads, account access, inventory identifiers, address and username validation, rates, USDC payment, shipments, tracking, vaulting, testing, and retries.

The Markdown references are versioned with the application and published by the same release process as these docs. For Commerce request/response schemas, use the OpenAPI document together with commerce-api.md.