Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.88 KB

CampaignVoucher.md

File metadata and controls

39 lines (27 loc) · 1.88 KB

CampaignVoucher

Schema model for a campaign voucher.

Properties

Name Type Description Notes
type String Type of voucher.
discount Discount [optional]
gift Gift [optional]
loyaltyCard CampaignLoyaltyCard [optional]
redemption CampaignVoucherRedemption
codeConfig CodeConfigRequiredLengthCharsetPattern
isReferralCode Boolean Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
startDate OffsetDateTime Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date. [optional]
expirationDate OffsetDateTime Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date. [optional]
validityTimeframe CampaignBaseValidityTimeframe [optional]
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 [optional]
validityHours ValidityHours [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