Skip to main content
GET
List Orders

Authorizations

X-API-KEY
string
header
required

Query Parameters

cursor
string

Opaque cursor from a previous response's nextCursor or previousCursor. Omit on the first request.

limit
integer
default:30

Maximum number of orders to return. Minimum 1, maximum 100.

Required range: 1 <= x <= 100
sort
enum<string>
default:desc

Sort direction applied to createdAt.

Available options:
asc,
desc
paymentStatus
enum<string>[]

Comma-separated list of payment statuses. Orders matching any value are returned. Maximum 20 terms per parameter. Keep filter params stable when paginating with cursors.

Maximum array length: 20
Available options:
quote-phase,
in-progress,
succeeded,
declined,
expired,
refunded
deliveryStatus
enum<string>[]

Comma-separated list of delivery statuses. Orders matching any value are returned. Maximum 20 terms per parameter. Keep filter params stable when paginating with cursors.

Maximum array length: 20
Available options:
not-started,
in-progress,
partial-delivery,
delivered,
failed
paymentMethod
string[]

Comma-separated list of currencies matched against payment.totalPaid.currency. The fiat value matches all fiat payment methods. Maximum 20 terms per parameter.

Maximum array length: 20
recipientAddress
string[]

Exact match on buyer wallet address (buyer.mintTo). Supports EVM and Solana addresses. Maximum 20 terms per parameter.

Maximum array length: 20
orderId
string<uuid>[]

Exact match on order ID (orderIdentifier). Maximum 20 terms per parameter.

Maximum array length: 20

Response

Orders retrieved successfully.

data
object[]
required

Page of orders in the requested sort order.

nextCursor
string | null

Cursor to fetch the next page. Absent when there are no more results.

previousCursor
string | null

Cursor to fetch the previous page. Absent on the first page.