Get Promotion Tier

This method enables you to retrieve a specific promotion tier.

GET /v1/promotions/tiers/{promotionTierId}

Get Promotion Tier

cURL

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

200

{
  "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
  "created_at": "2021-12-15T11:34:01.333Z",
  "updated_at": "2022-02-09T09:20:05.603Z",
  "name": "<string>",
  "banner": "<string>",
  "action": {
    "discount": {
      "type": "AMOUNT",
      "amount_off": 123,
      "amount_off_formula": "<string>",
      "aggregated_amount_limit": 123,
      "effect": "APPLY_TO_ORDER",
      "is_dynamic": true
    }
  },
  "metadata": {},
  "hierarchy": 123,
  "promotion_id": "<string>",
  "campaign": {
    "id": "<string>",
    "start_date": "2022-09-22T00:00:00.000Z",
    "expiration_date": "2022-09-30T00:00:00.000Z",
    "validity_timeframe": {
      "duration": "PT1H",
      "interval": "P2D"
    },
    "validity_day_of_week": [
      0
    ],
    "validity_hours": {
      "daily": [
        {
          "start_time": "12:00",
          "days_of_week": [
            0
          ],
          "expiration_time": "14:00"
        }
      ]
    },
    "active": true,
    "category_id": "cat_0b688929a2476386a6",
    "object": "campaign"
  },
  "campaign_id": "<string>",
  "active": true,
  "start_date": "2022-09-23T00:00:00.000Z",
  "expiration_date": "2022-09-26T00:00:00.000Z",
  "validity_timeframe": {
    "duration": "PT1H",
    "interval": "P2D"
  },
  "validity_day_of_week": [
    0
  ],
  "validity_hours": {
    "daily": [
      {
        "start_time": "12:00",
        "days_of_week": [
          0
        ],
        "expiration_time": "14:00"
      }
    ]
  },
  "summary": {
    "redemptions": {
      "total_redeemed": 123
    },
    "orders": {
      "total_amount": 123,
      "total_discount_amount": 123
    }
  },
  "object": "promotion_tier",
  "validation_rule_assignments": {
    "object": "list",
    "data_ref": "data",
    "data": [
      {
        "id": "asgm_74F7QZoYbUoljwQO",
        "rule_id": "val_4j7DCRm2IS59",
        "related_object_id": "v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT",
        "related_object_type": "voucher",
        "created_at": "2022-02-17T08:18:15.085Z",
        "object": "validation_rules_assignment"
      }
    ],
    "total": 123
  },
  "category_id": "cat_0c9da30e7116ba6bba",
  "categories": [
    {
      "id": "<string>",
      "name": "<string>",
      "hierarchy": 1,
      "object": "category",
      "created_at": "2022-07-14T10:45:13.156Z",
      "updated_at": "2022-08-16T10:52:08.094Z"
    }
  ]
}

Authorizations

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

X-App-Id · string · header · required

X-App-Token · string · header · required

Path Parameters

promotionTierId · string · required

Unique promotion tier ID.

Example:

"promo_2EnAik6Jt7dKTOMkRTIgEjZH"

Response

200 - application/json

Returns a promotion tier object.

Response body schema for GET v1/promotions/tiers/{promotionTierId}.

id · string

Unique promotion tier ID.

Example:

"promo_63fYCt81Aw0h7lzyRkrGZh9p"

created_at · string<date-time>

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

Example:

"2021-12-15T11:34:01.333Z"

updated_at · string<date-time>

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

Example:

"2022-02-09T09:20:05.603Z"

name · string

Name of the promotion tier.

banner · string

Text to be displayed to your customers on your website.

action · object

Contains details about the discount applied by the promotion tier.

Show child attributes

metadata · object

The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.

hierarchy · integer

The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.

promotion_id · string

Promotion unique ID.

campaign · object

Contains details about promotion tier's parent campaign.

Show child attributes

campaign_id · string

Promotion tier's parent campaign's unique ID.

active · boolean

A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date and expiration_date.

• true indicates an active promotion tier
• false indicates an inactive promotion tier

start_date · string<date-time>

Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date.

Example:

"2022-09-23T00:00:00.000Z"

expiration_date · string<date-time>

Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date.

Example:

"2022-09-26T00:00:00.000Z"

validity_timeframe · Validity Timeframe · object

Set recurrent time periods when the earning rule is valid. For example, valid for 1 hour every other day.start_date required when including the validity_timeframe.

Show child attributes

validity_day_of_week · enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

• 0 Sunday
• 1 Monday
• 2 Tuesday
• 3 Wednesday
• 4 Thursday
• 5 Friday
• 6 Saturday

Available options: 0, 1, 2, 3, 4, 5, 6

validity_hours · Validity Hours · object

Determines the hours of validity, e.g. to create a happy hours scenario.

Show child attributes

summary · object

Contains statistics about promotion tier redemptions and orders.

Show child attributes

object · string · default: promotion_tier

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

validation_rule_assignments · Validation Rule Assignments List · object

Validation Rule Assignments List

Show child attributes

category_id · string

Promotion tier category ID.

Example:

"cat_0c9da30e7116ba6bba"

categories · Category · object[]

Show child attributes