Order Statuses
Remove an Order Status
Remove a custom status from your organisation's catalogue.
This only removes the status from your organisation's list. Orders already carrying the status keep it — their status is not rewritten, and GET /orders will still return it.
Removing a SmartRoutes default returns 400. A name your organisation has not added returns 404.
delete/order-statuses/{status}
Request
- Base URL: https://api.smartroutes.io/v2
- URL: https://api.smartroutes.io/v2/order-statuses/{status}
- Auth: none declared
Path parameters
statusstring required
Name of the status to remove, exactly as returned by GET /order-statuses, URL-encoded — for example Awaiting%20Parts for Awaiting Parts. Surrounding whitespace is part of the name and must be encoded too.
Response
The status is no longer available to your organisation.
Changes
No recorded changes to this operation across all 1 revision of this API.