Skip to main content
GET
List orders

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter[status]
enum<string>
Available options:
pending,
confirmed,
in_progress,
out_for_delivery,
fulfilled,
cancelled
filter[payment_status]
enum<string>
Available options:
unpaid,
partially_paid,
paid,
refunded,
partially_refunded,
voided
filter[fulfilment_method]
enum<string>
Available options:
delivery,
collection,
relay
filter[fulfilment_date]
string

Filter by fulfilment month (YYYY-MM) or fulfilment date (YYYY-MM-DD).

Pattern: ^\d{4}-\d{2}(-\d{2})?$
filter[updated_since]
string<date-time>
per_page
integer

Page size. Values above the maximum are clamped.

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

Response

A page of orders.

data
Order · object[]
required
meta
object
required
Last modified on July 2, 2026