Skip to main content
GET
List your orders across all your brands

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Query Parameters

brand_id
string

narrow to ONE of the client's own brands (brd_…); omitted ⇒ all the client's brands. A brand the client does not own is a foreign brand → 404 (never 403).

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$
status
enum<string>

filter to one order state

Available options:
created,
payment_authorized,
paid,
payment_failed,
partially_refunded,
refunded,
disputed,
cancelled
updated_since
string<date-time>

RECONCILIATION filter (ISO 8601 date-time, inclusive): return only orders whose updated_at ≥ this. Record the greatest updated_at you have processed and re-query with it to catch up on everything that changed after a missed/dropped webhook window.

limit
integer
default:50

page size (default 50, max 200)

Required range: 1 <= x <= 200
cursor
string

opaque, scope+filter-bound keyset cursor (api-style-guide §2). Bound to BOTH the tenant scope and the active filters — a cursor from another scope or a changed filter set is rejected (400), never silently re-scoped.

Response

a page of the client's orders (non-PHI projection) + an optional next_cursor

A page of your orders: a list of non-PHI order rows plus an optional next_cursor for keyset pagination. The cursor is opaque and bound to both your scope and the active filters. When next_cursor is absent, you have reached the last page. Walk the cursor to the end, together with updated_since, to reconcile completely.

data
object[]
required
next_cursor
string

opaque keyset cursor for the next page; bound to BOTH the tenant scope and the active filters (changing either invalidates it — a stale/foreign cursor 400s, never re-scopes).