Developers
Orders

Get an order

GET
/orders/{id}

Returns one order with its line items, customer and addresses.

Authorization

apiKey
headerAuthorizationBearer <token>

A store API key from Settings → Developers → API keys, sent as Authorization: Bearer zk_live_….

Path Parameters

id*string

The resource id

Formatuuid

Response Body

Success

application/json
  1. response
id*string
order_number*integer
status*string
Value in"pending""pending_payment""captured""completed""canceled""failed""confirmed""refunded""draft"
fulfillment_status*string
Value in"pending""confirmed""processing""ready""shipped""delivered""canceled""returned""fulfilled"
channel*string
Value in"storefront""marketplace""zaher""dashboard"
currency*string
Length3 <= length <= 3
subtotal*string

Decimal amount as a string, e.g. "149.00"

shipping_total*string

Decimal amount as a string, e.g. "149.00"

tax_total*string

Decimal amount as a string, e.g. "149.00"

total*string

Decimal amount as a string, e.g. "149.00"

payment_method*string
payment_gateway*string
paid_at*string

ISO 8601 timestamp

tracking_number*string
tracking_carrier*string
customer*
billing_address*
shipping_address*
line_items*array<>
created_at*string

ISO 8601 timestamp

updated_at*string

ISO 8601 timestamp

object*"order"
Value in"order"
curl -X GET "https://example.com/orders/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "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"}

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.

Update fulfillment POST

Moves an order to a new fulfillment status (for example `shipped`), optionally with a tracking number and carrier. Only valid next steps are allowed. The customer is notified and `order.*` webhooks fire as when the change is made in the dashboard.