v9

latestOpenAPI 3.0.0raw.githubusercontent.com2026-07-071292691.1 MB
orders

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
  }
}