setting/credit_note_status/get
POST
/setting/credit_note_status/getThis returns the list of credit note 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 credit note status ID to search for specifically.
Filter the list of credit note statuses modified after the spcified date.
Filter the list of credit note statuses to include deleted records.
Filter the list of credit note 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",
"credit_note_status_id": 0,
"filter_date_modified": "string",
"filter_deleted": true,
"filter_channel_group_id": "string",
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}
Responses
Returns only if there is an error.
The total number of results available.
The list of credit note statuses.
The channel group ID.
The channel group ID assigned to the credit note status.
The credit note status name.
Indicates if the credit note status will restock items.
The date time this credit note status was last modified.
Indicates if the credit note status has been deleted. Only returned if filter_deleted is "1".
{
"error": [
"string"
],
"total": 0,
"credit_note_statuses": [
{
"credit_note_status_id": 0,
"channel_group_id": 0,
"name": "string",
"restock": true,
"date_modified": "string",
"deleted": true
}
]
}