extension/total/promotion/get
POST/extension/total/promotion/getThis returns the list of promotions available for 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.
Filters the list by the name.
Filters the list by the title.
Filters the list by the promotion type.
Filters the list by the status.
Filter the list of promotions modified after the spcified date.
Page number of the results.
The key for the ordering of the results. Accepts "name", "type", "status", "total_used", "date_start", "date_end", "date_added", "date_modified", "sort_order".
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",
"filter_name": "string",
"filter_title": "string",
"filter_type": "string",
"filter_status": 0,
"filter_date_modified": "string",
"page": 0,
"sort": "string",
"order": "string",
"limit": 0
}Responses
Returns only if there is an error.
The total number of results available if there is no error.
The list of promotions available if there is no error.
The promotion ID.
The name.
The title.
Indicates if it is a order total promotion.
The promotion type.
The status.
The sort order.
The promotion settings key-value.
The promotion minimum total amount.
The promotion use limit count.
The promotion total used count.
The date time promotion starts.
The date time promotion ends.
The date time promotion was created.
The date time the promotion was last modified.
The promotion linked categories.
{
"error": [
"string"
],
"total": 0,
"promotions": [
{
"promotion_id": 0,
"name": "string",
"title": "string",
"total_promotion": true,
"type": "string",
"status": true,
"sort_order": 0,
"configuration": {},
"total": 0,
"total_use_limit": 0,
"total_used": 0,
"date_start": "string",
"date_end": "string",
"date_added": "string",
"date_modified": "string",
"categories": {}
}
]
}