Skip to content

Latest commit

 

History

History
61 lines (52 loc) · 3.36 KB

File metadata and controls

61 lines (52 loc) · 3.36 KB

UpdateVoucher

Properties

Name Type Description Notes
promotionId Integer Promotion ID to update [optional]
promotionName String The updated name of the promotion [optional]
promotionAwardMenuItemPublicIds List<UUID> The updated menu items that the promotion awards [optional]
code String Voucher Code [optional]
description String Voucher Description (Visible on printout) [optional]
stores List<Integer> Stores that this voucher applies to [optional]
validOnOrdersOver Double Valid on orders on or above [optional]
takesPriority Boolean Takes priority [optional]
isEnabled Boolean Is voucher enabled [optional]
isAutomaticallyApplied Boolean Is voucher automatically applied [optional]
includeDeliveryFee Boolean Include delivery fees [optional]
isValidForDeliveryOrders Boolean Valid for delivery orders [optional]
isValidForPickupOrders Boolean Valid for pickup orders [optional]
isValidForOrdersPayedOnline Boolean Valid for orders payed online [optional]
isValidForOrdersPayedByCash Boolean Valid for orders payed in cash [optional]
isValidForFirstOrderOnly Boolean Valid only on the first order by the customer [optional]
isValidOncePerCustomer Boolean Valid once per customer [optional]
isValidOnlyOnce Boolean Valid only once, by any customer (once used cannot be used again by any other customer) [optional]
isDiscoverable Boolean Enables the voucher to be offered in the Voucher Discoverability feature [optional]
forceDiscount Boolean Force the discount to be applied which bypasses some menu restrictions [optional]
startDate OffsetDateTime Voucher Starts On (Time in UTC) [optional]
expiryDate OffsetDateTime Voucher Expires On (Time in UTC) [optional]
channelRestrictions List<ChannelRestrictionsEnum> Limit the channels this voucher can be used on [optional]
validityPeriods List<ValidityPeriod> Periods in which the voucher is valid. An empty list means the voucher is valid at all times. When updating the voucher, if this is set to null, the validity periods won't be updated. [optional]
voucherSubType VoucherSubTypeEnum Voucher Subtype [optional]
customerId Integer Customer UserID [optional]
maxRedemptions Integer Maximum number of times the voucher can be redeemed (used) [optional]

Enum: List<ChannelRestrictionsEnum>

Name Value
IOS "Ios"
ANDROID "Android"
WEB "Web"
KIOSK "Kiosk"
POS "Pos"
GOOGLE "Google"

Enum: VoucherSubTypeEnum

Name Value
NONE "None"
SIGNUP "SignUp"
LOYALTY "Loyalty"
LOYALTY25 "Loyalty25"
RETENTION "Retention"
SECONDARYRETENTION "SecondaryRetention"
CUSTOM "Custom"