Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 1.63 KB

LoyaltyCampaignVoucher.md

File metadata and controls

45 lines (29 loc) · 1.63 KB

LoyaltyCampaignVoucher

Schema model for a campaign voucher.

Properties

Name Type Description
type TypeEnum Type of voucher.
loyaltyCard CampaignLoyaltyCard
redemption LoyaltyCampaignVoucherRedemption
codeConfig CodeConfig
isReferralCode Boolean Always `false` for a loyalty card voucher
startDate OffsetDateTime Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
expirationDate OffsetDateTime Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign 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

Enum: TypeEnum

Name Value
LOYALTY_CARD "LOYALTY_CARD"

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