Skip to main content
GET
List orders by status, by payment method, or every order in a date range

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

Query Parameters

status
enum<string>

List only orders in this status. Mutually exclusive with paymentMethod; with neither, every order in the created-date window is listed.

Available options:
DRAFT,
PENDING,
PAID,
CANCELLED
Example:

"PAID"

paymentMethod
enum<string>

List by how the order was settled. This mode reads a settled-date index, so pair it with startSettledAt/endSettledAt and never with the created-date parameters. Only settled orders carry a payment method, so DRAFT and PENDING orders never appear in this mode; a settled order later CANCELLED (refunded or not) still does, with its status. Mutually exclusive with status.

Available options:
STRIPE,
CASH,
EXTERNAL,
COMP,
MIXED,
LEGACY
Example:

"CASH"

startCreatedAt
string<date-time>

Inclusive lower bound on createdAt, as an ISO 8601 instant. Valid in the status and no-filter modes only.

Example:

"2026-09-01T00:00:00.000Z"

endCreatedAt
string<date-time>

Upper bound on createdAt, as an ISO 8601 instant, EXCLUSIVE of the instant itself — pass the next period's start to cover a whole day or month. Valid in the status and no-filter modes only.

Example:

"2026-10-01T00:00:00.000Z"

startSettledAt
string<date-time>

Inclusive lower bound on settledAt, as an ISO 8601 instant. Requires paymentMethod.

Example:

"2026-09-01T00:00:00.000Z"

endSettledAt
string<date-time>

Upper bound on settledAt, as an ISO 8601 instant, EXCLUSIVE of the instant itself — pass the next period's start to cover a whole day or month. Requires paymentMethod.

Example:

"2026-10-01T00:00:00.000Z"

limit
integer
default:50

Maximum rows to return in data, 1–200. Defaults to 50. Values outside the range return 400. A page can still hold fewer rows than requested, so treat nextCursor: null as the only end-of-results signal and never stop on a page that merely looks short.

Required range: 1 <= x <= 200
Example:

50

cursor
string

Opaque pagination token from a previous response's nextCursor. Treat it as a magic string — never parse or construct one. A cursor is only valid for the same filters that produced it, and nextCursor: null means the last page.

Response

Orders list

data
object[]
required
nextCursor
string | null
required