Contributors:
CRM Order Statuses API
Create, Retrieve, Update and Delete CRM Order Statuses via the public API endpoint using "where" filtering.
GET CRM Order Statuses List
Retrieves a list of Order Statuses as a JSON response based on your provided query parameters.
/api/v2/admin/orders/order-statusesParameters
Parameter
Values
Required
Where
{<where query>}Order_By
<propertyAlias>Offset
<integer>Limit
<integer>Data / Response:
N/A
{
"Items": [
{
"Id": 0,
"EmailId": 0,
"NotifyCustomer": true,
"IsSystem": true,
"Name": "string",
"Type": "string",
"TypeDisplayName": "string",
"Workflows": [
0
]
}
],
"TotalItemsCount": 0
}
POST CRM Order Status Create
Creates a new Order Status based on the provided data.
/api/v2/admin/orders/order-statusesData / Response:
{
"Name": "string",
"NotifyCustomer": true,
"Workflows": [
"string"
]
}
{
"Id": 0,
"EmailId": 0,
"NotifyCustomer": true,
"IsSystem": true,
"Name": "string",
"Type": "string",
"TypeDisplayName": "string",
"Workflows": [
0
]
}
GET CRM Order Status Item
Retrieves a single Order Status based on the ID passed in the endpoint URL.
/api/v2/admin/orders/order-statuses/{id}Data / Response:
N/A
{
"Id": 0,
"EmailId": 0,
"NotifyCustomer": true,
"IsSystem": true,
"Name": "string",
"Type": "string",
"TypeDisplayName": "string",
"Workflows": [
0
]
}
PUT CRM Order Status Update
Updates a single Order Status based on the ID passed in the endpoint URL and data provided.
/api/v2/admin/orders/order-statuses/{id}Data / Response:
{
"Name": "string",
"NotifyCustomer": true,
"Workflows": [
"string"
]
}
{
"Id": 0,
"EmailId": 0,
"NotifyCustomer": true,
"IsSystem": true,
"Name": "string",
"Type": "string",
"TypeDisplayName": "string",
"Workflows": [
0
]
}
DELETE CRM Order Status Delete
Deletes a single Order Status based on the ID passed in the endpoint URL.
/api/v2/admin/orders/order-statuses/{id}Data / Response:
N/A
Status 204