Skip to main content
GET
List Orders

Authorizations

Authorization
string
header
required

Bearer API key for server-to-server access. Session auth is also supported in first-party UI flows.

Query Parameters

organizationId
string

Optional organization scope for session-authenticated calls. OAuth client credentials resolve the organization from the token.

Maximum string length: 120
q
string

Search order number, external order ID, buyer fields, and line-item product/SKU fields.

Maximum string length: 140
status
enum<string>

Filter by normalized order status group.

Available options:
to_ship,
shipped,
completed,
pending,
return,
canceled
marketplace
string

Comma-separated marketplace platforms (for example shopee,lazada,tiktok,zalora).

Maximum string length: 200
country
string

Comma-separated normalized country codes.

Maximum string length: 200
store
string

Comma-separated marketplace account IDs.

Maximum string length: 400
sortBy
string

Comma-separated sort tokens. Supports multi-sort up to six tokens. Aliases: latest -> updated_desc, oldest -> updated_asc.

Maximum string length: 240
dateFrom
string<date>

Inclusive lower bound on order created date (YYYY-MM-DD).

dateTo
string<date>

Inclusive upper bound on order created date (YYYY-MM-DD).

limit
integer
default:20

Result limit per page. Values above 50 are clamped silently. Defaults to 20.

Required range: 1 <= x <= 50
offset
integer
default:0

Zero-based pagination offset. Use pagination.nextOffset from the previous response to page forward.

Required range: x >= 0

Response

Orders page returned.

items
object[]
hasMore
boolean
nextOffset
integer
summary
object
pagination
object