Order Statuses

Add an Order Status

Add a status to your organisation's catalogue. The status becomes available to every depot in your organisation and appears in the SmartRoutes web app.

The name is stored as you send it — surrounding whitespace is not trimmed. The response carries the name exactly as it will appear on orders; use that value when removing it later.

Adding a name your organisation already has, or one of the SmartRoutes defaults, returns 400.

post/order-statuses

Request

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

Request body

statusstring required

The status name. Cannot be empty or whitespace only.

Example request

{
  "status": "Packed"
}

Response

The status is now available to your organisation.

Example response

{
  "order_status": {
    "status": "RETURNED",
    "is_custom": true
  }
}

Changes

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