Explore

Retrieve all order statuses

GET/store/orderstatuses

Gets information about all order status within your store configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 37,
  "count": 3,
  "offset": 0,
  "results": [
    {
      "id": "56444d1946fc510a905dec2f",
      "name": "High Fraud"
    },
    {
      "id": "56444d0546fc510a905dec00",
      "name": "In Progress"
    },
    {
      "id": "56406f9846fc5208c4d3f4d3",
      "name": "New Order"
    }
  ]
}

Lookup a specific order status

GET/store/orderstatuses/{id}

Gets information about a specific order status within your store configuration.

Parameters

The unique id for the order status

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "56444d0546fc510a905dec00",
  "name": "In Progress"
}

Create a new order status

POST/store/orderstatuses

Creates a new order status within your store configuration.

Request body

Order Status

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Delayed"
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5aba870a9b04b4226c2e9542",
  "name": "Delayed"
}

Update a order status

PUT/store/orderstatuses/{id}

Updates the settings for a specific order status.

Parameters	id	The unique id for the order status
Request body	Order Status

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Deferred"
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5aba870a9b04b4226c2e9542",
  "name": "Deferred"
}

Delete a order status

DELETE/store/orderstatuses/{id}

Deletes an order status from your store configuration.

Parameters

The unique id for the order status

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8