Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.64 KB

CustomerRedeemable.md

File metadata and controls

55 lines (35 loc) · 1.64 KB

CustomerRedeemable

Single customer's redeemable

Properties

Name Type Description
id String Unique redeemable holder identifier.
createdAt OffsetDateTime Timestamp representing the date and time when the redeemable was assigned. The value is shown in the ISO 8601 format.
redeemableId String Identifier of the redeemable item.
redeemableObject String Type of the redeemable.
customerId String Identifier of the customer.
holderRole HolderRoleEnum Role of the holder.
campaignId String Unique campaign identifier, assigned by Voucherify.
campaignType CampaignTypeEnum Defines the type of the campaign.
voucherType VoucherTypeEnum Defines the type of the voucher.
redeemable CustomerRedeemableRedeemable

Enum: HolderRoleEnum

Name Value
OWNER "OWNER"
REFERRER "REFERRER"
REFEREE "REFEREE"

Enum: CampaignTypeEnum

Name Value
LOYALTY_PROGRAM "LOYALTY_PROGRAM"
GIFT_VOUCHERS "GIFT_VOUCHERS"
DISCOUNT_COUPONS "DISCOUNT_COUPONS"
PROMOTION "PROMOTION"
REFERRAL_PROGRAM "REFERRAL_PROGRAM"

Enum: VoucherTypeEnum

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