Skip to main content
GET
/
v1
/
promotions
/
tiers
/
{promotionTierId}
Get Promotion Tier
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/promotions/tiers/{promotionTierId} \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "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
string
header
required
X-App-Token
string
header
required
Authorization
string
header
required

Path Parameters

promotionTierId
string
required
Example:

Response

200 - application/json
id
string
Example:
created_at
string<date-time>
Example:
updated_at
string<date-time>
Example:
name
string
banner
string
action
object
metadata
object
hierarchy
integer
promotion_id
string
campaign
object
campaign_id
string
active
boolean
start_date
string<date-time>
Example:
expiration_date
string<date-time>
Example:
validity_timeframe
object
validity_day_of_week
enum<integer>[]
validity_hours
object
summary
object
object
string
default:promotion_tier
validation_rule_assignments
object
category_id
string
Example:
categories
Category · object[]