younifyd
Menu

List All Promotion Stacks

List Promotion Stacks

GET/v1/promotions/stacks

Use it in a workflow

  1. Add a step and choose the Voucherify connector.
  2. Pick the List All Promotion Stacks action (under Promotions).
  3. Fill in the fields below, then reference the result from later steps as {{listAllPromotionStacks.response.data}}.

Request

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

orderstring

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

One ofcreated_at-created_atupdated_at-updated_atname-name

created_atobject

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`

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.

updated_atobject

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`

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.

Response

Returns 200 with an object. Read it in later steps with {{listAllPromotionStacks.response.data.<field>}}.

objectstring

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

One oflistDefault "list"

data_refstring

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

One ofdataDefault "data"

dataarray<any>

Contains array of promotion stack objects.

totalinteger

Total number of promotion stacks.

json
{
  "object": "list",
  "data_ref": "data",
  "data": [
    null
  ],
  "total": 0
}

Need more? See the Voucherify guide for connection setup and behaviour shared by every action.