Home > Developers > API Reference >Order Statuses

Order Statuses

Provides you with all of the functionality that you need to create and maintain the “statuses” which can be assigned to your orders within the Divendo environment.

Getting Order Statuses

To retrieve a list of current “order statuses”, you would make an HTTP request:

GET

https://www.mystore.com/restapi/orderstatuses.json

[
    {
        "ID":7,
        "Name":"Cancelled"
    },
    {
        "ID":5,
        "Name":"Complete"
    },
    {
        "ID":10,
        "Name":"Dispatched"
    }
]

Retrieving an Order Status

To retrieve an existing “order status”, you would make an HTTP request:

GET

https://www.mystore.com/restapi/orderstatuses/{id}.json

{
    "ID":7,
    "Name":"Cancelled"
}

Creating an Order Status

To create a new “order status”, you would make an HTTP request:

POST

https://www.mystore.com/restapi/orderstatuses.json

{
    "Name": "New Status"
}

Updating an Order Status

To update an existing “order status”, you would make an HTTP request:

PUT

https://www.mystore.com/restapi/orderstatuses/{id}.json

{
    "ID":99,
    "Name":"Updated Name"
}

Deleting an Order Status

To delete an existing “order status”, you would make an HTTP request:

DELETE

https://www.mystore.com/restapi/orderstatuses.json

HTTP/1.1 200 OK
Back to top

Say Hello

Request a Quote