Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.

Query parameters

integer (int32)
Maximum number of results to return (default: 50).
integer (int32)
Number of results to skip (default: 0). Ignored when after cursor is set.
string
Cursor for keyset pagination (opaque token from next_cursor).
string
Filter by customer ID (UUID).
string
Filter by order status (pending, confirmed, shipped, delivered, cancelled).
string
Filter by payment status (pending, paid, partially_refunded, refunded).
string
Filter by fulfillment status (unfulfilled, partial, fulfilled).
string
Orders created on or after this date (RFC 3339, e.g. 2024-01-15T00:00:00Z).
string
Orders created on or before this date (RFC 3339, e.g. 2024-12-31T23:59:59Z).

Response

OrderListResponse
boolean
required
Whether more results are available after this page.
integer (int32)
required
Minimum: 0.
string,null
Opaque cursor for fetching the next page (keyset pagination).
integer (int32)
required
Minimum: 0.
OrderResponse[]
required
integer
required
Minimum: 0.

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026