Reference

List order statuses

Every status and sub-status your orders can carry.

GET/v1/order-statuses

Bearer tokenReturns JSONSuccess 200

Statuses come in journey order (sequence). isTerminal marks a status that ends the journey. Use the code values to filter orders and to read tracking events and webhooks.

Request

Headers

Field	Type	Description
`Authorization`required	`string`	The access token from Get token, as "Bearer <token>".

This endpoint takes no parameters.

Example request

curl -X GET "https://api.swiftazu.com/v1/order-statuses" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response

Example response · 200

[
  {
    "code": "pending",
    "name": "Pending",
    "nameAr": "قيد الانتظار",
    "sequence": 10,
    "isTerminal": false,
    "isCustomerVisible": true,
    "subStatuses": []
  },
  {
    "code": "ready_for_pickup",
    "name": "Ready for Pickup",
    "nameAr": "جاهز للاستلام",
    "sequence": 20,
    "isTerminal": false,
    "isCustomerVisible": true,
    "subStatuses": []
  }
]

Errors

Every call can also return the shared errors listed on the Overview page. Overview