extension/total/promotion/getHistory

This returns the list of promotion histories available for 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.

filter_promotion_id

integer

optional

Filters the list by the promotion ID.

filter_date_added

string

optional

Filter the list of promotion histories created after the spcified date.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "date_added".

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",
    "filter_promotion_id": 0,
    "filter_date_added": "string",
    "page": 0,
    "sort": "string",
    "order": "string",
    "limit": 0
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

total

integer

optional

The total number of results available if there is no error.

histories

array [object {6}]

optional

The list of promotions histories available if there is no error.

promotion_history_id

integer

required

The promotion history ID.

promotion_id

integer

required

The promotion ID.

customer_id

integer

required

The customer ID.

order_id

integer

required

The order ID.

total

number

required

The promotion total.

date_added

string

required

The date time promotion history was created.

Example

{
    "error": [
        "string"
    ],
    "total": 0,
    "histories": [
        {
            "promotion_history_id": 0,
            "promotion_id": 0,
            "customer_id": 0,
            "order_id": 0,
            "total": 0,
            "date_added": "string"
        }
    ]
}