setting/order_status/add
POST
/setting/order_status/addThis adds an order status to 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.
name
string
required
The name of the order status.
channel_group_id
integer
required
The channel group ID for restriction control. Accepts "0" if none.
deduct
integer
required
Indicates if a deduct should happen at this order status. Accepts "1" or "0".
Example
{
"domain": "string",
"api_key": "string",
"auth_timestamp": 0,
"auth_signature": "string",
"name": "string",
"channel_group_id": 0,
"deduct": 0
}
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
error
array[string]
optional
Returns only if there is an error.
success
boolean
optional
Returns only if there is no error.
order_status_id
integer
optional
The newly added order status ID.
Example
{
"error": [
"string"
],
"success": true,
"order_status_id": 0
}
Last modified: 3 months ago