Order Statuses [API]

Order statuses allow you to categorize your orders. For example, setting an order to 'Canceled' might remind all users that the order should not be delivered. It could also automatically notify the customer that their order was canceled.

Description List Order Statuses
Action GET
URL <your URL here>/api/status_orders/
Sample request parameters (empty – no data required)
Sample Successful Response [ { "id": 1, "name": "Submitted", "is_temp": true, "cannot_delete": true, "sort": 0, "colors": null, "notify_customer": false }, { "id": 2, "name": "Sent", "is_temp": false, "cannot_delete": true, "sort": 0, "colors": "#337AB7#FFFFFF", "notify_customer": false }, { "id": 3, "name": "Complete", "is_temp": false, "cannot_delete": false, "sort": 8, "colors": "#F0AD4E#FFFFFF", "notify_customer": true }, { "id": 4, "name": "Canceled", "is_temp": false, "cannot_delete": false, "sort": 10, "colors": "", "notify_customer": true } ]

Description  Create New Order Status
Action POST
URL <your URL here>/api/status_orders
Sample request parameters  {"status_order": {"name": "Refunded"}}
Sample Successful Response { "id": 5, "name": "Refunded", "is_temp": false, "cannot_delete": false, "sort": 0, "colors": null, "notify_customer": false}
Required fields name. This is the only modifiable parameter.

Description  Update Order Status Name
URL <your URL here>/api/status_orders/<id of order status>
Sample request parameters  {"status_order": {"name": "Confirmed"}}
Sample Successful Response { "id": 3, "name": "Confirmed", "is_temp": false, "cannot_delete": false, "sort": 9, "colors": "", "notify_customer": true }
Sample Failed Response You will receive a '404' error if the order status you are trying to update does not exist or the syntax is incorrect.
Required fields name

Field descriptions for Price lists

Name Type Description Required
id integer Order Status ID auto calculated
name string Name of order status yes
is_temp boolean - no
cannot_delete boolean Order Status is in system's default and cannot be deleted auto calculated
sort integer Show order no
colors string - no
notify_customer boolean Email the customer when this order status is applied no

Still need help? Contact Us Contact Us