setting/order_status/get
POST/setting/order_status/getThis returns the list of order statuses available in the Equotix One account.
Request
The domain you are assigned to authenticate your Equotix One account.
The email address assigned to the user account in your Equotix One.
The unix timestamp used to sign this API request.
The calculated signature for this API request.
The order status ID to search for specifically.
Filter the list of order statuses modified after the spcified date.
Filter the list of order statuses to include deleted records.
Filter the list of order statuses by channel group ID, comma separated values.
Page number of the results.
The key for the ordering of the results. Accepts "name", "date_modified"
The direction for the ordering of the results. Accepts "ASC", "DESC"
The number of results per page. Accepts 1 to 100.
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"order_status_id": 0,
"filter_date_modified": "string",
"filter_deleted": true,
"filter_channel_group_id": "string",
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
The total number of results available.
The list of order statuses.
The order status ID.
The channel group ID assigned to the order status.
The order status name.
Indicates if the order status will deduct items.
The date time this order status was last modified.
Indicates if the order status has been deleted. Only returned if filter_deleted is "1".
{
"total": 0,
"order_statuses": [
{
"order_status_id": 0,
"channel_group_id": 0,
"name": "string",
"deduct": true,
"date_modified": "string",
"deleted": true
}
]
}