Request body schema for POST v1/v1/promotions/{campaignId}/tiers
.
Name | Type | Description |
---|---|---|
name | String | Name of the promotion tier. |
banner | String | Text to be displayed to your customers on your website. |
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. |
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 |
startDate | OffsetDateTime | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date. |
expirationDate | OffsetDateTime | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date. |
validityTimeframe | ValidityTimeframe | |
validityDayOfWeek | List<ValidityDayOfWeekEnum> | 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 |
validityHours | ValidityHours | |
category | String | Assign a new or update the promotion tier's category using name. |
categoryId | String | Assign a new or update the promotion tier's category using id |
action | PromotionsTiersCreateRequestBodyAction | |
validationRuleAssignments | ValidationRuleAssignmentsList |
Name | Value |
---|---|
NUMBER_0 | 0 |
NUMBER_1 | 1 |
NUMBER_2 | 2 |
NUMBER_3 | 3 |
NUMBER_4 | 4 |
NUMBER_5 | 5 |
NUMBER_6 | 6 |