Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 1.58 KB

CampaignsImportVoucherItem.md

File metadata and controls

33 lines (21 loc) · 1.58 KB

CampaignsImportVoucherItem

Import Vouchers to Campaign

Properties

Name Type Description
code String Unique custom voucher code.
type TypeEnum Type of voucher.
redemption CampaignsImportVoucherItemRedemption
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
metadata Object The metadata object stores all custom attributes assigned to the voucher. 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.
category String The category assigned to the campaign. Either pass this parameter OR the `category_id`.
additionalInfo String An optional field to keep any extra textual information about the code such as a code description and details.
gift Gift
loyaltyCard CampaignsImportVoucherLoyaltyCard

Enum: TypeEnum

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