Skip to content

Latest commit

 

History

History
41 lines (29 loc) · 3.04 KB

PromotionTierCreateParams.md

File metadata and controls

41 lines (29 loc) · 3.04 KB

PromotionTierCreateParams

This is an object representing a promotion tier create params. Promotion tiers are always assigned to a campaign and cannot be used standalone.

Properties

Name Type Description Notes
name String Name of the promotion tier.
banner String Text to be displayed to your customers on your website. [optional]
action PromotionTierAction [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]
validationRules List<String> Array containing the ID of the validation rule associated with the promotion tier. [optional]
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 [optional]
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. [optional]
startDate OffsetDateTime Activation timestamp defines when the promotion tier starts to be active in ISO 8601 format. Promotion tier is inactive before this date. [optional]
expirationDate OffsetDateTime Activation timestamp defines when the promotion tier expires in ISO 8601 format. Promotion tier is inactive after this date. [optional]
validityTimeframe PromotionTierValidityTimeframe [optional]
validityDayOfWeek List<ValidityDayOfWeekEnum> Integer array corresponding to the particular days of the week in which the promotion tier is valid. - `0` Sunday - `1` Monday - `2` Tuesday - `3` Wednesday - `4` Thursday - `5` Friday - `6` Saturday [optional]
validityHours ValidityHours [optional]
category String Assign category to the promotion tier. [optional]
categoryId String Instead of using the category name, you can alternatively assign a new category to a promotion tier using a unique category ID, i.e. `cat_0c9da30e7116ba6bba`. [optional]

Enum: List<ValidityDayOfWeekEnum>

Name Value
NUMBER_0 0
NUMBER_1 1
NUMBER_2 2
NUMBER_3 3
NUMBER_4 4
NUMBER_5 5
NUMBER_6 6