BookingFlow

Validates and applies a discount voucher/gift voucher code against an order

get/applyvoucher/{orderId}/{orderKey}/{voucherCode}

Path parameters

orderIdinteger required

Numeric search Id.

orderKeystring required

36-character search security key.

voucherCodestring required

Voucher code to apply to the order (leave blank to delete discount from order).

Query parameters

interactSessionstring

Optional but recommended customer interaction session. Keep the same session valid for the whole customer interaction journey.

giftAmountnumber double

Optional gift voucher amount to redeem against order - amount will be validated.

isSecondboolean

Optional setting to mark as a second gift voucher so not to replace the existing/first.

deleteboolean

Optional setting to delete a specific code from the order.

Response

Success - Returns the payment profile of the requested search session.

Changes

No recorded changes to this endpoint across all 1 revision of this API.