Commerce
List orders
AuthorizationBearer <token>
Present an API key (sb_live_… / sb_test_…), an OAuth2 access token, or a static token as a Bearer credential. The operator is implied by the credential; it is never in the path. Only a SHA-256 hash of an API key is stored server-side.
In: header
Query Parameters
cursor?string
Opaque pagination cursor from meta.cursor.next of the previous page. Do not construct or parse it.
limit?integer
Page size. Values above the maximum are clamped.
Range
1 <= value <= 100Default
25status?string
Filter by order status.
Value in
- "draft"
- "awaiting_payment"
- "paid"
- "provisioned"
- "completed"
- "cancelled"
- "expired"
- "abandoned"
- "failed"
contact_id?string
Filter by contact.
Format
uuidsite_id?string
Filter to a single site.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/orders"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "order", "site_id": "72771e6a-6f5e-4de4-a5b9-1266c4197811", "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "reservation_id": "b947feb5-3593-40ee-8244-4428da3fe32d", "number": "string", "status": "draft", "channel": "storefront", "subtotal_minor": 0, "tax_minor": 0, "total_minor": 0, "currency": "str", "coupon_id": "97ffaabb-eb3d-43ed-8769-a889d53b9a3d", "placed_at": "2019-08-24T14:15:22Z", "lines": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "object": "order_line", "order_id": "93101167-9065-4b9c-b98b-5d789a3ed9fe", "line_type": "unit", "description": "string", "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1", "coverage_product_id": "0e95c9ac-638a-4481-a2a0-6c1a0f8ac15e", "unit_id": "5becc822-b69e-4e66-a762-ad8e868dcab6", "quantity": 0, "unit_price_minor": 0, "amount_minor": 0, "tax_minor": 0, "ipt_minor": 0, "vat_treatment": "standard_20", "tax_kind": "vat", "currency": "str", "recurring": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "meta": { "limit": 0, "cursor": { "next": "string", "has_more": true } }}{ "error": { "code": "unauthorized", "message": "Missing or invalid credential." }}{ "error": { "code": "insufficient_scope", "message": "The credential lacks a scope required by this endpoint." }}{ "error": { "code": "rate_limited", "message": "Rate limit exceeded. Retry after 7s." }}{ "error": { "code": "validation_error", "message": "string", "details": [ { "field": "string", "issue": "string" } ] }}