Response body schema for POST v1/promotions/{campaignId}/tiers
.
Name | Type | Description | Notes |
---|---|---|---|
id | str | Unique promotion tier ID. | [optional] |
created_at | datetime | Timestamp representing the date and time when the promotion tier was created. The value is shown in the ISO 8601 format. | [optional] |
updated_at | datetime | Timestamp representing the date and time when the promotion tier was updated. The value is shown in the ISO 8601 format. | [optional] |
name | str | Name of the promotion tier. | [optional] |
banner | str | Text to be displayed to your customers on your website. | [optional] |
action | PromotionsTiersCreateResponseBodyAction | [optional] | |
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. | [optional] |
hierarchy | int | 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. | [optional] |
promotion_id | str | Promotion unique ID. | [optional] |
campaign | PromotionsTiersCreateResponseBodyCampaign | [optional] | |
campaign_id | str | Promotion tier's parent campaign's unique ID. | [optional] |
active | bool | 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 | [optional] |
start_date | datetime | Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date. | [optional] |
expiration_date | datetime | Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date. | [optional] |
validity_timeframe | ValidityTimeframe | [optional] | |
validity_day_of_week | List[int] | 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 | [optional] |
validity_hours | ValidityHours | [optional] | |
summary | PromotionsTiersCreateResponseBodySummary | [optional] | |
object | str | The type of the object represented by JSON. This object stores information about the promotion tier. | [optional] [default to 'promotion_tier'] |
validation_rule_assignments | ValidationRuleAssignmentsList | [optional] | |
category_id | str | Promotion tier category ID. | [optional] |
categories | List[Category] | [optional] |