Sign in

v1

latestSwagger 2.02026-08-045928532.7 MB
Vouchers

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

Path parameters

appIdstring required

Request body

VoucherType'PercentageDiscount' | 'LumpDiscount' | 'AddItem' | 'CreditNote' | 'FreeDelivery'

Voucher Type

Codestring

Voucher Code

Descriptionstring

Voucher Description (Visible on printout)

Storesinteger[]

Stores that this voucher applies to

ValidOnOrdersOvernumber double

Valid on orders on or above

TakesPriorityboolean

Takes priority

IsEnabledboolean

Is voucher enabled

IsAutomaticallyAppliedboolean

Is voucher automatically applied

IncludeDeliveryFeeboolean

Include delivery fees

IsValidForDeliveryOrdersboolean

Valid for delivery orders

IsValidForPickupOrdersboolean

Valid for pickup orders

IsValidForOrdersPayedOnlineboolean

Valid for orders payed online

IsValidForOrdersPayedByCashboolean

Valid for orders payed in cash

IsValidForFirstOrderOnlyboolean

Valid only on the first order by the customer

IsValidOncePerCustomerboolean

Valid once per customer

IsValidOnlyOnceboolean

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

IsDiscoverableboolean

Enables the voucher to be offered in the Voucher Discoverability feature

ForceDiscountboolean

Force the discount to be applied which bypasses some menu restrictions

StartDatestring date-time

Voucher Starts On (Time in UTC)

ExpiryDatestring date-time

Voucher Expires On (Time in UTC)

ChannelRestrictionsstring[]

Limit the channels this voucher can be used on

VoucherSubType'None' | 'SignUp' | 'Loyalty' | 'Loyalty25' | 'Retention' | 'SecondaryRetention' | 'Custom'

Voucher Subtype

CustomerIdinteger nullable

Customer UserID

MaxRedemptionsinteger nullable

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

Example request

{
  "Promotion": {
    "MenuItemPublicIds": [
      "00000000-0000-0000-0000-000000000000"
    ]
  }
}

Response

OK

Example response

{
  "Data": {
    "PromotionDetails": {
      "PromotionAwards": [
        {
          "MenuItemPublicId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  }
}