extension/total/promotion/get

This returns the list of promotions 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_name

string

optional

Filters the list by the name.

filter_title

string

optional

Filters the list by the title.

filter_type

string

optional

Filters the list by the promotion type.

filter_status

integer

optional

Filters the list by the status.

filter_date_modified

string

optional

Filter the list of promotions modified after the spcified date.

page

integer

optional

Page number of the results.

sort

string

optional

The key for the ordering of the results. Accepts "name", "type", "status", "total_used", "date_start", "date_end", "date_added", "date_modified", "sort_order".

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_name": "string",
    "filter_title": "string",
    "filter_type": "string",
    "filter_status": 0,
    "filter_date_modified": "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.

promotions

array [object {16}]

optional

The list of promotions available if there is no error.

promotion_id

integer

required

The promotion ID.

name

string

required

The name.

title

string

required

The title.

total_promotion

boolean

required

Indicates if it is a order total promotion.

type

string

required

The promotion type.

status

boolean

required

The status.

sort_order

integer

required

The sort order.

configuration

object

required

The promotion settings key-value.

total

number

required

The promotion minimum total amount.

total_use_limit

integer

required

The promotion use limit count.

total_used

integer

required

The promotion total used count.

date_start

string

required

The date time promotion starts.

date_end

string

required

The date time promotion ends.

date_added

string

required

The date time promotion was created.

date_modified

string

required

The date time the promotion was last modified.

categories

object

required

The promotion linked categories.

Example

{
    "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": {}
        }
    ]
}