List orders
Returns a paginated list of orders matching the supplied filters. Use
page[number] and page[size] to paginate; follow links.next to
advance. Orders are ordered per sort (-createdAt by default).
Authorizations
Partner API key. Finalized per partner integration agreement.
Headers
Optional account identifier for scoping/validation/filtering.
Optional company identifier for scoping/validation/filtering.
Query Parameters
1-indexed page number. Defaults to 1.
x >= 1Number of orders to return per page (max 300, default 100).
1 <= x <= 300Sort order. -createdAt (default) returns newest first; createdAt
returns oldest first.
createdAt, -createdAt Filter by order status. active: orders that are in progress or have
been delivered. cancelled: orders that were cancelled.
active, cancelled Comma-separated list of idempotency keys. Returns orders matching any of the supplied keys.
1Return orders created at or after this ISO 8601 timestamp.
Return orders created at or before this ISO 8601 timestamp.
Response
Page of orders plus pagination links.
JSON:API list envelope. Returns the page of orders plus pagination links.