Orders
List orders
GET
Lists the store's orders, newest first, with line items, customer and addresses. Filter by status, fulfillment status, channel or date; to sync, poll with updated_after set to your last sync time.
apiKeyheader
AuthorizationBearer <token>A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….
limit?integerPage size, 1–100
Range
1 <= value <= 100Default
25cursor?stringnext_cursor from the previous page
Length
length <= 500order?stringSort by created_at; newest first by default
Default
"desc"Value in
"desc""asc"created_after?stringOnly records created after this time
Format
date-timecreated_before?stringOnly records created before this time
Format
date-timeupdated_after?stringOnly records changed after this time — poll with your last sync time
Format
date-timeupdated_before?stringOnly records changed before this time
Format
date-timestatus?stringPayment / order status
Value in
"pending""pending_payment""captured""completed""canceled""failed""confirmed""refunded""draft"fulfillment_status?stringValue in
"pending""confirmed""processing""ready""shipped""delivered""canceled""returned""fulfilled"channel?stringWhere the order was placed
Value in
"storefront""marketplace""zaher""dashboard"Success
application/json- response
object*"list"Value in
"list"data*array<>has_more*booleanWhether another page exists
next_cursor*stringPass as cursor to get the next page; null on the last
curl -X GET "https://example.com/orders"{ "object": "list", "data": [ { "id": "00000000-0000-4000-8000-000000000001", "order_number": 1042, "status": "pending", "fulfillment_status": "pending", "channel": "storefront", "currency": "SAR", "subtotal": "230.00", "shipping_total": "25.00", "tax_total": "0.00", "total": "255.00", "payment_method": "card", "payment_gateway": "stripe", "paid_at": null, "tracking_number": null, "tracking_carrier": null, "customer": { "id": "00000000-0000-4000-8000-000000000010", "name": "Sara Ahmed", "email": "sara@example.com", "phone": "+966500000000" }, "billing_address": { "first_name": "Sara", "last_name": "Ahmed", "phone": "+966500000000", "line1": "King Fahd Road 123", "line2": null, "city": "Riyadh", "state": "Riyadh", "postal_code": "12271", "country": "Saudi Arabia", "country_code": "SA" }, "shipping_address": { "first_name": "Sara", "last_name": "Ahmed", "phone": "+966500000000", "line1": "King Fahd Road 123", "line2": null, "city": "Riyadh", "state": "Riyadh", "postal_code": "12271", "country": "Saudi Arabia", "country_code": "SA" }, "line_items": [ { "id": "00000000-0000-4000-8000-000000000101", "product_id": "00000000-0000-4000-8000-000000000201", "product_name": "Arabic Calligraphy Course", "variant_id": "00000000-0000-4000-8000-000000000301", "variant_title": "Lifetime access", "quantity": 1, "unit_price": "150.00", "unit_discount": "0.00", "total": "150.00" }, { "id": "00000000-0000-4000-8000-000000000102", "product_id": "00000000-0000-4000-8000-000000000202", "product_name": "Notebook", "variant_id": "00000000-0000-4000-8000-000000000302", "variant_title": "A5 / Black", "quantity": 2, "unit_price": "45.00", "unit_discount": "5.00", "total": "80.00" } ], "created_at": "2026-10-01T09:28:00.000Z", "updated_at": "2026-10-01T09:30:00.000Z", "object": "order" } ], "has_more": false, "next_cursor": null}