List Orders
List orders, filtered by state, payment or shipping status, customer, or date.
GET
Overview
Returns a page of orders.status, payment_status, and fulfillment_status are three
independent axes — an order can be paid and unfulfilled, or fulfilled and unpaid. Filter on the
axis you actually care about rather than inferring one from another.
Query
integer
Maximum results to return. Defaults to 50.
integer
Number of results to skip. Defaults to 0. Ignored when
after is set.string
Opaque cursor for keyset pagination — pass the previous response’s
next_cursor.string
Filter by customer ID (UUID).
string
Order status:
pending, confirmed, shipped, delivered, or cancelled.string
Payment status:
pending, paid, partially_refunded, or refunded.string
Fulfillment status:
unfulfilled, partial, or 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).
Response
array
required
The orders, each shaped as in Get Order —
id, name, number, source, state, customerID, items, totalAmount, paymentStatus,
shippingStatus, createdAt, updatedAt, and metadata.boolean
required
Whether further pages exist.
string
Cursor for the next page. Absent on the last page.
Related
- Get Order
- Create Order
- Orders — the full order lifecycle