List Promotion Stacks in Campaign

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/promotions/{campaignId}/stacks \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "stack_p0WhtyyDU95crobleMpRabhH",
      "name": "First stack",
      "created_at": "2022-09-22T13:03:25.740Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC",
          "promo_aaAF8mVAzA0PF1igia2OC63d"
        ],
        "hierarchy_mode": "MANUAL"
      }
    },
    {
      "id": "stack_XAzn8AFR3Ks3DBPLAQxV7zHe",
      "name": "Second stack",
      "created_at": "2022-09-22T13:03:25.903Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_aaAF8mVAzA0PF1igia2OC63d",
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC"
        ],
        "hierarchy_mode": "MANUAL"
      }
    }
  ],
  "total": 2
}

GET

promotions

{campaignId}

stacks

List Promotion Stacks in Campaign

curl --request GET \
  --url https://{cluster}.voucherify.io/v1/promotions/{campaignId}/stacks \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'

{
  "object": "list",
  "data_ref": "data",
  "data": [
    {
      "id": "stack_p0WhtyyDU95crobleMpRabhH",
      "name": "First stack",
      "created_at": "2022-09-22T13:03:25.740Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC",
          "promo_aaAF8mVAzA0PF1igia2OC63d"
        ],
        "hierarchy_mode": "MANUAL"
      }
    },
    {
      "id": "stack_XAzn8AFR3Ks3DBPLAQxV7zHe",
      "name": "Second stack",
      "created_at": "2022-09-22T13:03:25.903Z",
      "campaign_id": "camp_99HUWI53bVyLzPN1Fg5TBLWX",
      "object": "promotion_stack",
      "tiers": {
        "ids": [
          "promo_aaAF8mVAzA0PF1igia2OC63d",
          "promo_dJNhAEeV5sR5oPQq1UrUdnMC"
        ],
        "hierarchy_mode": "MANUAL"
      }
    }
  ],
  "total": 2
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

campaignId

string

required

Unique campaign ID.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

Response

200 - application/json

Returns a list of promotion stack objects.

Response body schema for GET v1/promotions/stacks and for GET v1/promotions/{campaignId}/stacks.

object

enum<string>

default:list

required

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

Available options:

list

data_ref

enum<string>

default:data

required

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

Available options:

data

data

Promotion Stack Base · object[]

required

Contains array of promotion stack objects.

Show child attributes

data.name

string

required

Promotion stack name.

data.tiers

object

required

Contains the tier configuration. A promotion stack can include up to 30 tiers.

Show child attributes

data.tiers.ids

string[]

required

Contains the list of tiers in a pre-defined sequence.

Minimum array length: 1

data.tiers.hierarchy_mode

enum<string>

default:MANUAL

Available options:

MANUAL

data.id

string

required

Unique promotion stack ID.

data.created_at

string<date-time>

required

Timestamp representing the date and time when the promotion stack was created. The value is shown in the ISO 8601 format.

data.campaign_id

string

required

Promotion stack's parent campaign's unique ID.

data.object

enum<string>

default:promotion_stack

required

The type of the object represented by JSON.

Available options:

promotion_stack

data.category_id

string | null

required

Promotion stack category ID.

data.categories

Category · object[]

required

Details about the category assigned to the promotion stack.

Show child attributes

data.categories.id

string

required

Unique category ID assigned by Voucherify.

data.categories.name

string

required

Category name.

data.categories.hierarchy

integer

required

Category hierarchy. Categories with lower hierarchy are processed before categories with higher hierarchy value.

Required range: x >= 0

data.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

data.categories.created_at

string<date-time>

required

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

Example:

"2022-07-14T10:45:13.156Z"

data.categories.updated_at

string<date-time>

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

Example:

"2022-08-16T10:52:08.094Z"

data.updated_at

string<date-time>

Timestamp representing the date and time when the promotion stack was updated. The value is shown in the ISO 8601 format.

total

integer

required

Total number of promotion stacks.

Required range: x >= 0

List Promotion Stacks Get Promotion Stack

⌘I

Introduction

Endpoints

Events

List Promotion Stacks in Campaign

Authorizations

Path Parameters

Response