extension/total/promotion/getCategory

This returns the list of promotion categories 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_date_modified

string

optional

Filter the list of promotion categories 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", "date_added", "date_modified".

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_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.

categories

array [object {5}]

optional

The list of promotions available if there is no error.

promotion_category_id

integer

required

The promotion category ID.

name

string

required

The name.

date_added

string

required

The date time category was created.

date_modified

string

required

The date time the category was last modified.

items

object

required

The items in the category.

Example

{
  "error": [
    "string"
  ],
  "total": 0,
  "categories": [
    {
      "promotion_category_id": 0,
      "name": "string",
      "date_added": "string",
      "date_modified": "string",
      "items": {}
    }
  ]
}