Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

OAuth 2.0 with opaque bearer tokens. Authorization-code requests require PKCE S256.

Scopes

orders.read

Read orders, order items, reconciliation issues, and sales activity.

Headers

X-API-Version
string

Pin a dated API release (YYYY-MM-DD). Omit for the latest (2026-06-09). Unknown values return 400 unsupported_api_version; the resolved version is echoed back in the X-API-Version response header.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-06-09"

Query Parameters

state
enum<string>
Available options:
DRAFT,
OPEN,
COMPLETED,
CANCELED
location_id
string<uuid>
external_order_id
string
limit
integer
default:50
Required range: x <= 100
offset
integer
default:0
cursor
string

Opaque keyset cursor from a previous response's pagination.next_cursor. Preferred over offset for walking every page: it does not re-scan earlier rows, and it cannot skip or repeat a row when the data changes mid-sync. Ignores offset when supplied.

Response

200 - application/json

Order list with pagination.