Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.75 KB

VouchersImportCreateItemRequestBody.md

File metadata and controls

48 lines (32 loc) · 2.75 KB

VouchersImportCreateItemRequestBody

Properties

Name Type Description
code String Value representing the imported code.
redemption VouchersImportCreateItemRequestBodyRedemption
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 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.
category String Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.
startDate OffsetDateTime Activation timestamp presented in the ISO 8601 format. Voucher is inactive before this date. Start date defines when the code starts to be active. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ
expirationDate OffsetDateTime Expiration date defines when the code expires. Expiration timestamp is presented in the ISO 8601 format. Voucher is inactive after this date. Allowed date formats are: - YYYY-MM-DD - YYYY-MM-DDTHH - YYYY-MM-DDTHH:mm - YYYY-MM-DDTHH:mm:ss - YYYY-MM-DDTHH:mm:ssZ - YYYY-MM-DDTHH:mm:ss.SSSZ
validityTimeframe ValidityTimeframe
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
additionalInfo String An optional field to keep any extra textual information about the code such as a code description and details.
type TypeEnum
gift Gift
discount Discount

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

Enum: TypeEnum

Name Value
GIFT_VOUCHER "GIFT_VOUCHER"
DISCOUNT_VOUCHER "DISCOUNT_VOUCHER"