List orders

Returns a paginated list of orders scoped to the caller account. A creation-date window (createdFrom/createdTo, ISO 8601, max 6 months apart) is required; status, channel filters, free-text search and sorting are optional.

get/api/v1/orders

Query parameters

statusstring[]

channelIdstring[]

customerIdstring

createdFromstring required

createdTostring required

qstring

pagenumber

limitnumber

sortBystring

sortOrderstring

Response

Paginated list of orders.

Example response

{
  "meta": {
    "total": 42,
    "pages": 3,
    "current_page": 1,
    "next_page": 2,
    "limit": 20
  }
}

Changes

Changed in 2 of the 9 revisions of this API.215

Jul 7, 2026a3b4750a505f214See the full diff
- ▲
  added the new required query request parameter createdFrom
  new-required-request-parameter
- ▲
  added the new required query request parameter createdTo
  new-required-request-parameter
- ○
  added the new optional query request parameter channelId
  new-optional-request-parameter
- ○
  added the new optional query request parameter customerId
  new-optional-request-parameter
- ○
  added the new optional query request parameter limit
  new-optional-request-parameter
- ○
  added the new optional query request parameter page
  new-optional-request-parameter
- ○
  added the new optional query request parameter q
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortBy
  new-optional-request-parameter
- ○
  added the new optional query request parameter sortOrder
  new-optional-request-parameter
- ○
  added the new optional query request parameter status
  new-optional-request-parameter
- ○
  added the required property data/items/created_at to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/external_order_id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/id to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/item_count to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/total to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/items/updated_at to the response with the 200 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 7, 202684194c31ab851See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 36 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history