Skip to content

Latest commit

 

History

History
67 lines (51 loc) · 4.91 KB

RedemptionVoucher.md

File metadata and controls

67 lines (51 loc) · 4.91 KB
Raw

RedemptionVoucher

Defines the details of the voucher being redeemed.

Properties

Name Type Description Notes
id String Assigned by the Voucherify API, identifies the voucher. [optional]
code String A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters. [optional]
campaign String A unique campaign name, identifies the voucher's parent campaign. [optional]
campaignId String Assigned by the Voucherify API, identifies the voucher's parent campaign. [optional]
category String Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint. [optional]
categoryId String Unique category ID assigned by Voucherify. [optional]
categories List<Category> Contains details about the category. [optional]
type TypeEnum Defines the type of the voucher. [optional]
discount Discount [optional]
gift CampaignsVouchersCreateCombinedResponseBodyGift [optional]
loyaltyCard CampaignsVouchersCreateCombinedResponseBodyLoyaltyCard [optional]
startDate OffsetDateTime Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. [optional]
expirationDate OffsetDateTime Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. [optional]
validityTimeframe CampaignsVouchersCreateCombinedResponseBodyValidityTimeframe [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]
active Boolean 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 [optional]
additionalInfo String An optional field to keep any extra textual information about the code such as a code description and details. [optional]
metadata Object 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. [optional]
assets VoucherAssets [optional]
isReferralCode Boolean Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. [optional]
createdAt OffsetDateTime Timestamp representing the date and time when the voucher was created. The value is shown in the ISO 8601 format. [optional]
updatedAt OffsetDateTime Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. [optional]
holderId String Unique identifier of the customer who owns the voucher. [optional]
referrerId String Unique identifier of the referring person. [optional]
_object String The type of the object represented by JSON. Default is `voucher`. [optional]
validationRulesAssignments ValidationRulesAssignmentsList [optional]
publish CampaignsVouchersCreateCombinedResponseBodyPublish [optional]
redemption CampaignsVouchersCreateCombinedResponseBodyRedemption [optional]
holder SimpleCustomer [optional]

Enum: TypeEnum

Name Value
GIFT_VOUCHER "GIFT_VOUCHER"
DISCOUNT_VOUCHER "DISCOUNT_VOUCHER"
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