List Promotion Tiers (client-side)

curl --request GET \
  --url https://{cluster}.voucherify.io/client/v1/promotions/tiers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Application-Id: <api-key>' \
  --header 'X-Client-Token: <api-key>' \
  --header 'origin: <origin>'

{
  "object": "list",
  "data_ref": "tiers",
  "tiers": [
    {
      "id": "promo_NzjTc3ZXTe7md5SziK3uYtei",
      "created_at": "2022-09-21T11:38:34.962Z",
      "name": "Order more than $100",
      "banner": "Order more than $100",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 3000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {},
      "hierarchy": 1,
      "promotion_id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
      "campaign": {
        "id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
        "start_date": "2022-09-21T00:00:00.000Z",
        "expiration_date": "2022-09-30T00:00:00.000Z",
        "validity_timeframe": {
          "interval": "P3D",
          "duration": "P2D"
        },
        "validity_day_of_week": [
          1,
          2,
          3,
          4,
          5
        ],
        "active": true,
        "category_id": "cat_0bb81a481615a37b5e",
        "object": "campaign"
      },
      "campaign_id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
      "active": true,
      "start_date": "2022-09-21T00:00:00.000Z",
      "expiration_date": "2022-09-30T00:00:00.000Z",
      "validity_timeframe": {
        "interval": "P3D",
        "duration": "P2D"
      },
      "validity_day_of_week": [
        1,
        2
      ],
      "summary": {
        "redemptions": {
          "total_redeemed": 0
        },
        "orders": {
          "total_amount": 0,
          "total_discount_amount": 0
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": null
    },
    {
      "id": "promo_RaYHtUBre5jU8frUXOvYBtlN",
      "created_at": "2021-12-15T11:34:01.358Z",
      "updated_at": "2022-02-09T09:20:08.619Z",
      "name": "Hot Promotion - Tier 2",
      "banner": "Get Tier 2 Discount $20 Off",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 2000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {},
      "hierarchy": 2,
      "promotion_id": "camp_5h0wc453_5",
      "campaign": {
        "id": "camp_5h0wc453_5",
        "start_date": null,
        "expiration_date": null,
        "active": true,
        "category_id": "cat_0b688929a2476386a6",
        "object": "campaign"
      },
      "campaign_id": "camp_5h0wc453_5",
      "active": true,
      "summary": {
        "redemptions": {
          "total_redeemed": 33
        },
        "orders": {
          "total_amount": 519200,
          "total_discount_amount": 66000
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": {
        "object": "list",
        "data_ref": "data",
        "data": [
          {
            "id": "asgm_pEe1inoYSfmO12p7",
            "rule_id": "val_5h0wc453_5",
            "related_object_id": "promo_RaYHtUBre5jU8frUXOvYBtlN",
            "related_object_type": "promotion_tier",
            "created_at": "2021-12-15T11:34:01.358Z",
            "object": "validation_rules_assignment"
          }
        ],
        "total": 1
      }
    },
    {
      "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
      "created_at": "2021-12-15T11:34:01.333Z",
      "updated_at": "2022-02-09T09:20:05.603Z",
      "name": "Hot Promotion - Tier 1",
      "banner": "Get Tier 1 Discount 10zl",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 1000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {
        "ProductionMetaData": "Hot Promotion - Tier 1"
      },
      "hierarchy": 1,
      "promotion_id": "camp_5h0wc453_5",
      "campaign": {
        "id": "camp_5h0wc453_5",
        "start_date": null,
        "expiration_date": null,
        "active": true,
        "category_id": "cat_0b688929a2476386a6",
        "object": "campaign"
      },
      "campaign_id": "camp_5h0wc453_5",
      "active": true,
      "summary": {
        "redemptions": {
          "total_redeemed": 11
        },
        "orders": {
          "total_amount": 1414979,
          "total_discount_amount": 11000
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": {
        "object": "list",
        "data_ref": "data",
        "data": [
          {
            "id": "asgm_QqYs7GGVy7cuh3L9",
            "rule_id": "val_5h0wc453_4",
            "related_object_id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
            "related_object_type": "promotion_tier",
            "created_at": "2021-12-15T11:34:01.333Z",
            "object": "validation_rules_assignment"
          }
        ],
        "total": 1
      }
    }
  ],
  "total": 3
}

GET

client

promotions

tiers

List Promotion Tiers (client-side)

curl --request GET \
  --url https://{cluster}.voucherify.io/client/v1/promotions/tiers \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Client-Application-Id: <api-key>' \
  --header 'X-Client-Token: <api-key>' \
  --header 'origin: <origin>'

{
  "object": "list",
  "data_ref": "tiers",
  "tiers": [
    {
      "id": "promo_NzjTc3ZXTe7md5SziK3uYtei",
      "created_at": "2022-09-21T11:38:34.962Z",
      "name": "Order more than $100",
      "banner": "Order more than $100",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 3000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {},
      "hierarchy": 1,
      "promotion_id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
      "campaign": {
        "id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
        "start_date": "2022-09-21T00:00:00.000Z",
        "expiration_date": "2022-09-30T00:00:00.000Z",
        "validity_timeframe": {
          "interval": "P3D",
          "duration": "P2D"
        },
        "validity_day_of_week": [
          1,
          2,
          3,
          4,
          5
        ],
        "active": true,
        "category_id": "cat_0bb81a481615a37b5e",
        "object": "campaign"
      },
      "campaign_id": "camp_VEL7UX0jZjrvLx3hfNZBVzpq",
      "active": true,
      "start_date": "2022-09-21T00:00:00.000Z",
      "expiration_date": "2022-09-30T00:00:00.000Z",
      "validity_timeframe": {
        "interval": "P3D",
        "duration": "P2D"
      },
      "validity_day_of_week": [
        1,
        2
      ],
      "summary": {
        "redemptions": {
          "total_redeemed": 0
        },
        "orders": {
          "total_amount": 0,
          "total_discount_amount": 0
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": null
    },
    {
      "id": "promo_RaYHtUBre5jU8frUXOvYBtlN",
      "created_at": "2021-12-15T11:34:01.358Z",
      "updated_at": "2022-02-09T09:20:08.619Z",
      "name": "Hot Promotion - Tier 2",
      "banner": "Get Tier 2 Discount $20 Off",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 2000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {},
      "hierarchy": 2,
      "promotion_id": "camp_5h0wc453_5",
      "campaign": {
        "id": "camp_5h0wc453_5",
        "start_date": null,
        "expiration_date": null,
        "active": true,
        "category_id": "cat_0b688929a2476386a6",
        "object": "campaign"
      },
      "campaign_id": "camp_5h0wc453_5",
      "active": true,
      "summary": {
        "redemptions": {
          "total_redeemed": 33
        },
        "orders": {
          "total_amount": 519200,
          "total_discount_amount": 66000
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": {
        "object": "list",
        "data_ref": "data",
        "data": [
          {
            "id": "asgm_pEe1inoYSfmO12p7",
            "rule_id": "val_5h0wc453_5",
            "related_object_id": "promo_RaYHtUBre5jU8frUXOvYBtlN",
            "related_object_type": "promotion_tier",
            "created_at": "2021-12-15T11:34:01.358Z",
            "object": "validation_rules_assignment"
          }
        ],
        "total": 1
      }
    },
    {
      "id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
      "created_at": "2021-12-15T11:34:01.333Z",
      "updated_at": "2022-02-09T09:20:05.603Z",
      "name": "Hot Promotion - Tier 1",
      "banner": "Get Tier 1 Discount 10zl",
      "action": {
        "discount": {
          "type": "AMOUNT",
          "amount_off": 1000,
          "effect": "APPLY_TO_ORDER"
        }
      },
      "metadata": {
        "ProductionMetaData": "Hot Promotion - Tier 1"
      },
      "hierarchy": 1,
      "promotion_id": "camp_5h0wc453_5",
      "campaign": {
        "id": "camp_5h0wc453_5",
        "start_date": null,
        "expiration_date": null,
        "active": true,
        "category_id": "cat_0b688929a2476386a6",
        "object": "campaign"
      },
      "campaign_id": "camp_5h0wc453_5",
      "active": true,
      "summary": {
        "redemptions": {
          "total_redeemed": 11
        },
        "orders": {
          "total_amount": 1414979,
          "total_discount_amount": 11000
        }
      },
      "object": "promotion_tier",
      "validation_rule_assignments": {
        "object": "list",
        "data_ref": "data",
        "data": [
          {
            "id": "asgm_QqYs7GGVy7cuh3L9",
            "rule_id": "val_5h0wc453_4",
            "related_object_id": "promo_63fYCt81Aw0h7lzyRkrGZh9p",
            "related_object_type": "promotion_tier",
            "created_at": "2021-12-15T11:34:01.333Z",
            "object": "validation_rules_assignment"
          }
        ],
        "total": 1
      }
    }
  ],
  "total": 3
}

Authorizations

X-Client-Application-Id

string

header

required

X-Client-Token

string

header

required

Authorization

string

header

required

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

Headers

origin

string<hostname>

required

Indicates the origin (scheme, hostname, and port).

Query Parameters

is_available

boolean

This parameter allows filtering promotions that are only available at the moment. When set to true, it selects only non-expired and active promotions.

limit

integer

Limits the number of objects to be returned. The limit can range between 1 and 100 items.

Required range: 1 <= x <= 100

page

integer

Which page of results to return. The lowest value is 1.

order

enum<string>

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

Available options:

created_at,

-created_at,

updated_at,

-updated_at

Response

200 - application/json

Returns a dictionary with a tiers property that contains an array of promotion tiers.

Response body schema for GET v1/client/v1/promotions/tiers. Promotion Tiers

object

string

default:list

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

data_ref

string

default:tiers

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

tiers

Promotion Tier · object[]

Contains array of promotion tier objects.

Show child attributes

tiers.id

string

Unique promotion tier ID.

Example:

"promo_63fYCt81Aw0h7lzyRkrGZh9p"

tiers.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"

tiers.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"

tiers.name

string

Name of the promotion tier.

tiers.banner

string

Text to be displayed to your customers on your website.

tiers.action

object

Contains details about the discount applied by the promotion tier.

Show child attributes

tiers.action.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

tiers.action.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

tiers.action.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

tiers.action.discount.amount_off_formula

string

Formula used to dynamically calculate the discount.

tiers.action.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

tiers.action.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

tiers.action.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

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

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

tiers.promotion_id

string

Promotion unique ID.

tiers.campaign

object

Contains details about promotion tier's parent campaign.

Show child attributes

tiers.campaign.id

string

Unique campaign ID.

tiers.campaign.start_date

string<date-time>

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

Example:

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

tiers.campaign.expiration_date

string<date-time>

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

Example:

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

tiers.campaign.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

tiers.campaign.validity_timeframe.duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

tiers.campaign.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example:

"P2D"

tiers.campaign.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

tiers.campaign.validity_hours

Validity Hours · object

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

Show child attributes

tiers.campaign.validity_hours.daily

object[]

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Show child attributes

tiers.campaign.validity_hours.daily.start_time

string<time>

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example:

"12:00"

tiers.campaign.validity_hours.daily.days_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the resource 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

tiers.campaign.validity_hours.daily.expiration_time

string<time>

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

Example:

"14:00"

tiers.campaign.active

boolean

A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint.

true indicates an active campaign
false indicates an inactive campaign

tiers.campaign.category_id

string

Unique category ID that this campaign belongs to.

Example:

"cat_0b688929a2476386a6"

tiers.campaign.object

string

default:campaign

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

tiers.campaign_id

string

Promotion tier's parent campaign's unique ID.

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

tiers.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"

tiers.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"

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

tiers.validity_timeframe.duration

string

Defines the amount of time an earning rule will be active in ISO 8601 format. For example, an earning rule with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

tiers.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, an earning rule with an interval of P2D will be valid every other day.

Example:

"P2D"

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

tiers.validity_hours

Validity Hours · object

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

Show child attributes

tiers.validity_hours.daily

object[]

Defines the recurring period(s) when the resource is active. The periods should not overlap.

Show child attributes

tiers.validity_hours.daily.start_time

string<time>

Defines the starting hour of validity in the HH:mm format. The resource is inactive before this time.

Example:

"12:00"

tiers.validity_hours.daily.days_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the resource 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

tiers.validity_hours.daily.expiration_time

string<time>

Defines the ending hour of validity in the HH:mm format. The resource is inactive after this time.

Example:

"14:00"

tiers.summary

object

Contains statistics about promotion tier redemptions and orders.

Show child attributes

tiers.summary.redemptions

object

Contains statistics about promotion tier redemptions.

Show child attributes

tiers.summary.redemptions.total_redeemed

integer

Number of times the promotion tier was redeemed.

tiers.summary.orders

object

Contains statistics about orders related to the promotion tier.

Show child attributes

tiers.summary.orders.total_amount

integer

Sum of order totals.

tiers.summary.orders.total_discount_amount

integer

Sum of total discount applied using the promotion tier.

tiers.object

string

default:promotion_tier

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

tiers.validation_rule_assignments

Validation Rule Assignments List · object

Validation Rule Assignments List

Show child attributes

tiers.validation_rule_assignments.object

string

default:list

required

The type of the object represented by JSON. This object stores information about validation rule assignments.

tiers.validation_rule_assignments.data_ref

string

default:data

required

Identifies the name of the JSON property that contains the array of validation rule assignments.

tiers.validation_rule_assignments.data

Validation Rule Assignment · object[]

required

A dictionary that contains an array of validation rule assignments.

Show child attributes

tiers.validation_rule_assignments.data.id

string

required

Validation rule assignment ID.

Example:

"asgm_74F7QZoYbUoljwQO"

tiers.validation_rule_assignments.data.rule_id

string

required

Validation rule ID.

Example:

"val_4j7DCRm2IS59"

The resource ID to which the validation rule was assigned.

Example:

"v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT"

The type of resource to which the validation rule was assigned.

Available options:

voucher,

campaign,

earning_rule,

reward_assignment,

promotion_tier,

distribution

tiers.validation_rule_assignments.data.created_at

string<date-time>

required

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

Example:

"2022-02-17T08:18:15.085Z"

tiers.validation_rule_assignments.data.object

enum<string>

default:validation_rules_assignment

required

The type of the object represented by the ID.

Available options:

validation_rules_assignment

tiers.validation_rule_assignments.total

integer

required

Total number of validation rule assignments.

tiers.category_id

string

Promotion tier category ID.

Example:

"cat_0c9da30e7116ba6bba"

tiers.categories

Category · object[]

Show child attributes

tiers.categories.id

string

required

Unique category ID assigned by Voucherify.

tiers.categories.name

string

required

Category name.

tiers.categories.hierarchy

integer

required

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

Required range: x >= 0

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

tiers.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"

tiers.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"

total

integer

Total number of promotion tiers.

has_more

boolean

As query results are always limited (by the limit parameter), the has_more flag indicates if there are more records for given filter parameters. This lets you know if you can run another request to get more records returned in the results.

Redeem Stackable Discounts (client-side)Track Custom Event (client-side)

⌘I

Introduction

Endpoints

Events

List Promotion Tiers (client-side)

Authorizations

Headers

Query Parameters

Response