Order Statuses

Get All Order Statuses

Every order status your organisation can use: the SmartRoutes defaults that every organisation has, plus any custom statuses your organisation has added.

Order statuses are organisation-wide — the same list is returned for every depot in your organisation, and it is the same list your users see in the SmartRoutes web app.

Aggregate PARTIALLY_* statuses are excluded: SmartRoutes derives those from line-item states and they are never chosen directly.

get/order-statuses

Request

  • Base URL: https://api.smartroutes.io/v2
  • URL: https://api.smartroutes.io/v2/order-statuses
  • Auth: none declared

Response

Successful response

Example response

{
  "order_statuses": [
    {
      "status": "RETURNED",
      "is_custom": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.