Coupon actions
Apply coupon
Validates and applies a coupon to an order, calculating the resulting discount
POST
Apply coupon
Authorizations
Restaurant API Key. Can be obtained from Tools > API Access in the xMenu dashboard.
Query Parameters
Unique restaurant identifier
Coupon code to redeem
Order total amount on which to apply the coupon
Response
Coupon application response
Operation result: true if successful, false if failed
Error code if the operation failed. Possible values:
NOT_FOUND= Coupon not foundCANNOT_APPLY= Cannot redeem coupon (invalid or not valid - see message field for details)
See Error codes for general error codes that may also occur.
Human-readable error description if the operation failed
Coupon object with details about discount code
Result of applying a coupon to an order
Apply coupon