Skip to content

Latest commit

 

History

History
26 lines (23 loc) · 3.13 KB

VouchersCreateWithSpecificCodeRequestBody.md

File metadata and controls

26 lines (23 loc) · 3.13 KB
Raw

# VouchersCreateWithSpecificCodeRequestBody

Properties

Name Type Description Notes
campaign string Identifies the voucher's parent campaign using a unique campaign name. [optional]
campaignId string Identifies the voucher's parent campaign using a unique campaign ID assigned by the Voucherify API. [optional]
category string The name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. [optional]
categoryId string Unique identifier assigned by Voucherify to the name of the category that this voucher belongs to. Useful when listing vouchers with the List Vouchers endpoint. [optional]
startDate \DateTime Start date defines when the code starts to be active. Activation timestamp is presented in the ISO 8601 format. Voucher is inactive before this date. [optional]
expirationDate \DateTime Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is inactive after this date. [optional]
validityTimeframe \OpenAPI\Client\Model\ValidityTimeframe [optional]
validityDayOfWeek int[] 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 \OpenAPI\Client\Model\ValidityHours [optional]
active bool 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]
validationRules string[] Array containing the ID of the validation rule associated with the voucher. [optional]
redemption \OpenAPI\Client\Model\VouchersCreateWithSpecificCodeRequestBodyRedemption [optional]
type string [optional]
loyaltyCard \OpenAPI\Client\Model\SimpleLoyaltyCard [optional]
gift \OpenAPI\Client\Model\Gift [optional]
discount \OpenAPI\Client\Model\Discount [optional]

[Back to Model list] [Back to API list] [Back to README]