Skip to content

LoyaltiesMembersTransfersCreateResponseBody.md

Latest commit

 

History

History
62 lines (38 loc) · 3.82 KB

LoyaltiesMembersTransfersCreateResponseBody.md

File metadata and controls

62 lines (38 loc) · 3.82 KB
Raw

Voucherify.LoyaltiesMembersTransfersCreateResponseBody

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 [Category] [optional]
type String Defines the type of the voucher. [optional] [default to 'LOYALTY_CARD']
loyaltyCard LoyaltiesMembersTransfersCreateResponseBodyLoyaltyCard [optional]
startDate Date Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date. [optional]
expirationDate Date Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date. [optional]
validityTimeframe ValidityTimeframe
validityDayOfWeek [Number] 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 [optional]
publish LoyaltiesMembersTransfersCreateResponseBodyPublish [optional]
redemption LoyaltiesMembersTransfersCreateResponseBodyRedemption [optional]
active String 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 LoyaltiesMembersTransfersCreateResponseBodyAssets [optional]
isReferralCode Boolean Flag indicating whether this voucher is a referral code; `true` for campaign type `REFERRAL_PROGRAM`. [optional]
holderId String Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify. [optional]
updatedAt Date Timestamp representing the date and time when the voucher was last updated in ISO 8601 format. [optional]
createdAt Date [optional]

Enum: TypeEnum

  • LOYALTY_CARD (value: "LOYALTY_CARD")

Enum: [ValidityDayOfWeekEnum]

  • 0 (value: 0)

  • 1 (value: 1)

  • 2 (value: 2)

  • 3 (value: 3)

  • 4 (value: 4)

  • 5 (value: 5)

  • 6 (value: 6)