Skip to main content
GET
List the signed-in member’s orders

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Query Parameters

filter[relationship]
enum<string>

Select own purchases or volume-credited orders. Omit for their deduplicated union.

Available options:
placed,
credited
filter[status]
enum<string>

Match a lifecycle state or a screen bucket. Fulfilled and preparing exclude cancelled orders and full refunds; fulfilled requires fulfilled fulfillment and preparing requires another fulfillment state. Subscription selects orders linked to a subscription and can overlap either fulfillment bucket.

Available options:
draft,
pending,
pending_review,
processing,
completed,
cancelled,
archived,
fulfilled,
preparing,
subscription
filter[q]
string

Case-insensitive literal substring of the order number, buyer first/last name, email or stored line-item title. Requires filter[relationship]=placed; omitted or credited relationship returns 422. Percent and underscore match literal characters. Empty or whitespace-only searches return 422; omit this parameter for an unfiltered list.

Required string length: 1 - 100
Pattern: ^(?=[\s\S]*\S)[^\u0000]*$
filter[placed_since]
string<date-time>

Include orders placed at or after this timestamp.

filter[placed_until]
string<date-time>

Include orders placed at or before this timestamp; must not precede placed_since.

filter[contact_id]
string<uuid>

Match a contact UUID within the current company; never widens the member scope.

page[cursor]
string

Encrypted next-page cursor, valid for three days. Changing filters or member ownership restarts at the first page.

page[limit]
integer
default:25

Maximum number of orders returned.

Required range: 1 <= x <= 100

Response

A deduplicated page of accessible orders.

A page of orders.

status
integer
required

HTTP response status.

data
object[]
required

Matching orders on this page.

meta
object
required

Envelope metadata present on every response.