Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Promotions

List Promotion Stacks

This method enables you to list promotion stacks irrespective of the campaign they are associated with.

You can use filters in the query parameters to specify the stacks to be returned in the response.

Advanced filters for fetching promotion stacks

FiltersExamples
Created Before- [created_at][before]=2021-12-30T13:52:18.227Z<br />- [filters][created_at][conditions][$before][0]=2021-12-30T13:52:18.227Z
Created After- [created_at][after]=2021-12-30T13:52:18.227Z<br />- [filters][created_at][conditions][$after][0]=2021-12-30T13:52:18.227Z
Updated Before- [updated_at][before]=2021-12-30T13:52:18.227Z<br />- [filters][updated_at][conditions][$before][0]=2021-12-30T13:52:18.227Z
Updated After- [updated_at][after]=2021-12-30T13:52:18.227Z<br />- [filters][updated_at][conditions][$after][0]=2021-12-30T13:52:18.227Z
get/v1/promotions/stacks

Query parameters

limitinteger

Limits the number of objects to be returned. The limit can range between 1 and 100 items.

pageinteger

Which page of results to return. The lowest value is 1.

order'created_at' | '-created_at' | 'updated_at' | '-updated_at' | 'name' | '-name'

Sorts the results using one of the filtering options, where the dash - preceding a sorting option means sorting in a descending order.

beforestring date-time

Timestamp representing the date and time before the voucher was created. The value is shown in the ISO 8601 format.

afterstring date-time

Timestamp representing the date and time after the voucher was created. The value is shown in the ISO 8601 format.

A filter on the list based on the object created_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [created_at][before]=2017-09-08T13:52:18.227Z

{
  "before": "2021-12-22T10:13:06.487Z",
  "after": "2021-12-22T10:13:06.487Z"
}
beforestring date-time

Timestamp representing the date and time before the voucher was updated. The value is shown in the ISO 8601 format.

afterstring date-time

Timestamp representing the date and time after the voucher was updated. The value is shown in the ISO 8601 format.

A filter on the list based on the object updated_at field. The value is a dictionary with the following options: before, after. A date value must be presented in ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16). An example: [updated_at][before]=2017-09-08T13:52:18.227Z

{
  "before": "2021-12-22T10:13:06.487Z",
  "after": "2021-12-22T10:13:06.487Z"
}

Response

Returns a dictionary with a data property that contains an array of promotion stacks across all your campaigns.

object'list' required

The type of the object represented by JSON. This object stores information about promotion stacks in a dictionary.

data_ref'data' required

Identifies the name of the attribute that contains the array of promotion stack objects.

totalinteger required

Total number of promotion stacks.

Example response

{
  "data": [
    {
      "categories": [
        {
          "created_at": "2022-07-14T10:45:13.156Z",
          "updated_at": "2022-08-16T10:52:08.094Z"
        }
      ]
    }
  ]
}