Get Promotion Stack

This method returns the details of a promotion stack, including the promotion tiers grouped within the stack.

GET /v1/promotions/{campaignId}/stacks/{stackId}

Get Promotion Stack

cURL

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

200

Example

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

Authorizations

X-App-Id & X-App-TokenX-Voucherify-OAuth

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

campaignId · string · required

ID of the promotion campaign. You can either pass the campaign ID, which was assigned by Voucherify, or the name of the campaign as the path parameter value, e.g., Loyalty Campaign.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

stackId · string · required

Promotion stack ID.

Example:

"stack_KOIde7AUf08at12lZ1r3OfFL"

Response

200

application/json

Returns a stack object if valid identifiers were provided in the path.

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

name · string · required

Promotion stack name.

tiers · object · required

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

Show child attributes

id · string · required

Unique promotion stack ID.

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.

campaign_id · string · required

Promotion stack's parent campaign's unique ID.

object · enum<string> · default: promotion_stack · required

The type of the object represented by JSON.

Available options: promotion_stack

category_id · string | null · required

Promotion stack category ID.

categories · Category · object[] · required

Details about the category assigned to the promotion stack.

Show child attributes

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.