Developers
API referenceBusiness sign in

Orders

List orders

GET/orders

Scope orders.read

Orders in stores bound to this key's API client, newest first, with per-status counts.

Request

Query parameters

Query parameters
NameInTypeDescription
statusOptionalquerystringStatus.One of AWAITING_SHIPMENT, SHIPMENT_CREATED, FAILED, CANCELLED
storeIdOptionalquerystringOne store.Pattern ^(?:QD-STR-[A-F0-9]{24}|QDSTR[A-Z0-9]{3,31})$
searchOptionalquerystringOrder number, reference, receiver, buyer or tracking number.At most 100 characters
limitOptionalqueryintegerPage size.1 to 100Default 25
cursorOptionalquerystringOpaque cursor from nextCursor.

Response

Success responses
StatusMeaning
200A page of orders

The body is { "status": "success", "data": … }. Fields of data (OrderList):

Response data
FieldTypeDescription
ordersRequiredarray of Order
countsRequiredobject
AWAITING_SHIPMENTOptionalinteger
SHIPMENT_CREATEDOptionalinteger
FAILEDOptionalinteger
CANCELLEDOptionalinteger
nextCursorRequiredstring or null

Errors

Errors use the error envelope { "status": "error", "message", "code"?, "details"? }.

Error responses
StatusWhen
400The request is not valid. A field is missing or invalid, or the Idempotency-Key header is missing or malformed.
401Missing, invalid, expired or revoked API key. The API key is missing, invalid, expired or revoked.
403The key lacks the scope, or the operation needs a LIVE key. The key lacks the scope, or this call needs a LIVE key (LIVE_KEY_REQUIRED), or the Business owner is not verified (SENDER_VERIFICATION_REQUIRED).
404Not found for this Business and environment. IDs from another Business or environment are always 404. Not found for this Business and environment. IDs from another Business or the other environment are always 404.
429Too many requests. See the RateLimit headers. Too many requests. Wait for Retry-After, then retry with the same idempotency key.