setting/order_status/get - Equotix One API

This returns the list of order statuses available in the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

order_status_id

integer

optional

The order status ID to search for specifically.

filter_date_modified

string

optional

Filter the list of order statuses modified after the spcified date.

filter_deleted

boolean

optional

Filter the list of order statuses to include deleted records.

filter_channel_group_id

string

optional

Filter the list of order statuses by channel group ID, comma separated values.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "date_modified"

order

string

optional

The direction for the ordering of the results. Accepts "ASC", "DESC"

limit

integer

optional

The number of results per page. Accepts 1 to 100.

Example

{
  "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

🟢200Success

application/json

Body

total

integer

required

The total number of results available.

order_statuses

array [object {6}]

required

The list of order statuses.

order_status_id

integer

required

The order status ID.

channel_group_id

integer

required

The channel group ID assigned to the order status.

name

string

required

The order status name.

deduct

boolean

required

Indicates if the order status will deduct items.

date_modified

string

required

The date time this order status was last modified.

deleted

boolean

optional

Indicates if the order status has been deleted. Only returned if filter_deleted is "1".

Example

{
  "total": 0,
  "order_statuses": [
    {
      "order_status_id": 0,
      "channel_group_id": 0,
      "name": "string",
      "deduct": true,
      "date_modified": "string",
      "deleted": true
    }
  ]
}