sale/order/getHistory
POST/sale/order/getHistoryThis returns the list of order histories for an order 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_id
integer
required
The order ID to retrieve its histories.
page
integer
optional
Page number of the results.
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_id": 0,
"page": 0,
"limit": 0
}Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
error
array[string]
optional
Returns only if there is an error.
order_id
integer
optional
The order ID.
order_status_id
integer
optional
The order status ID.
total
integer
optional
The total number of results available.
histories
array [object {6}]
optional
The list of order histories.
order_status
string
required
The order status.
order_status_id
integer
required
The order status ID.
user_id
integer
required
The user ID that created the history.
user
string
required
The username that created the history.
comment
string
required
The history comment.
date_added
string
required
The date time history was created.
Example
{
"error": [
"string"
],
"order_id": 0,
"order_status_id": 0,
"total": 0,
"histories": [
{
"order_status": "string",
"order_status_id": 0,
"user_id": 0,
"user": "string",
"comment": "string",
"date_added": "string"
}
]
}Last modified: 4 months ago