Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 3.78 KB

File metadata and controls

65 lines (49 loc) · 3.78 KB

MemberActivityDataRedemptionRewardVoucher

Properties

Name Type Description
id String
code String
gift MemberActivityDataRedemptionRewardVoucherGift
discount Discount
loyaltyCard MemberActivityDataRedemptionRewardVoucherLoyaltyCard
type TypeEnum
campaign String
campaignId String
isReferralCode Boolean Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`.
holderId String Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.
referrerId String
categoryId String
categories List<Category> Contains details about the category.
active Boolean Shows whether the voucher is on or off. `true` indicates an active voucher and `false` indicates an inactive voucher. and A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the `start_date` and `expiration_date`. - `true` indicates an active voucher - `false` indicates an inactive voucher
createdAt String
updatedAt String
redemption MemberActivityDataRedemptionRewardVoucherRedemption
startDate String
expirationDate OffsetDateTime Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.
metadata Object A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher. and The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.
_object String
category String Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
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
additionalInfo String An optional field to keep any extra textual information about the code such as a code description and details.
assets VoucherAssets
publish MemberActivityDataRedemptionRewardVoucherPublish
validationRulesAssignments ValidationRulesAssignmentsList

Enum: TypeEnum

Name Value
DISCOUNT_VOUCHER "DISCOUNT_VOUCHER"
LOYALTY_CARD "LOYALTY_CARD"
GIFT_VOUCHER "GIFT_VOUCHER"

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