/api/v1.0/vouchers/{appId}

appId

string

required

VoucherType

string

enum

Voucher Type

Allowed:

Promotion

object

Create Promotion

CreditNoteDetails

object

Credit note details

LumpDiscountDetails

object

Lump discount details

PercentDiscountDetails

object

Percent discount details

Code

string

Voucher Code

Description

string

Voucher Description (Visible on printout)

Stores

array of int32s

Stores that this voucher applies to

Stores

ValidOnOrdersOver

double

Valid on orders on or above

TakesPriority

boolean

Takes priority

IsEnabled

boolean

Is voucher enabled

IsAutomaticallyApplied

boolean

Is voucher automatically applied

IncludeDeliveryFee

boolean

Include delivery fees

IsValidForDeliveryOrders

boolean

Valid for delivery orders

IsValidForPickupOrders

boolean

Valid for pickup orders

IsValidForOrdersPayedOnline

boolean

Valid for orders payed online

IsValidForOrdersPayedByCash

boolean

Valid for orders payed in cash

IsValidForFirstOrderOnly

boolean

Valid only on the first order by the customer

IsValidOncePerCustomer

boolean

Valid once per customer

IsValidOnlyOnce

boolean

Valid only once, by any customer (once used cannot be used again by any other customer)

IsDiscoverable

boolean

Enables the voucher to be offered in the Voucher Discoverability feature

ForceDiscount

boolean

Force the discount to be applied which bypasses some menu restrictions

StartDate

date-time

Voucher Starts On (Time in UTC)

ExpiryDate

date-time

Voucher Expires On (Time in UTC)

ChannelRestrictions

array of strings

Limit the channels this voucher can be used on

ChannelRestrictions

ValidityPeriods

array of objects

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.

ValidityPeriods

VoucherSubType

string

enum

Voucher Subtype

Allowed:

CustomerId

int32 | null

Customer UserID

MaxRedemptions

int32 | null

Maximum number of times the voucher can be redeemed (used)

accept

string

enum

Defaults to application/json

Generated from available response content types

200OK

400BadRequest

401Unauthorized

403Successful authentication, but authorization has been denied for this request.

404NotFound