The merchant's order book, newest first
The merchant's order book, newest first by created_at and optionally narrowed by status.
/v1/clients/{clientId}/ordersThe merchant's order book, newest first by created_at and optionally narrowed by status. Ties are broken by id so a page boundary never skips or repeats an order. Needs authority over the client — membership of its organization, an API key bound to this client, or tenant staff holding clients:manage; anything else is refused not_client_member or insufficient_scope (403), and an unknown client client_not_found (404). Cursor paged: pass the last id you saw as cursor; limit is clamped to 1-100 and defaults to 50.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Path Parameters
uuidQuery Parameters
Value in
- "open"
- "paying"
- "paid"
- "canceled"
- "expired"
Last seen id from the previous page. The listing resumes after that row, so an id that belongs to no row in the listing is refused invalid_request (400) rather than answered with an empty page.
uuid1 <= value <= 10050Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/clients/497f6eca-6276-4993-bfeb-53cbbbba6f08/orders"[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "status": "open", "subtotal": 0, "commission": 0, "total": 0, "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71", "expires_at": "2019-08-24T14:15:22Z", "restocked_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "lines": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "offering_id": "a7d124b6-6a8c-44d1-9d46-4636e3f8c04e", "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6", "title": "string", "variant_title": "string", "sku": "string", "unit_amount": 0, "quantity": 0, "line_amount": 0, "commission": 0 } ] }]