...

Response Format

Success response body

• balances: object that indicates loyalty balance of the user's account

  amount

  points <number>: this represents the number of loyalty points the user has after the change of status is complete. If

  this QR code was pre-selected with rewards, then this number already has those loyalty points temporarily deducted from total user’s loyalty points balance.

• currency <string>: this represents the currency the above amount. Normally set to "points".

order: an array that includes objects with the below fields for each product that is in the order basket.

• productId <string>: PLU of the product that was pre-selected in the app. This can be an offer or a reward.

• quantity <number>: the amount of the above product that is in the loyalty order.

• price <number>: the price of the product

• productType <string>: the type of product. In this case it would either be REWARD or OFFER

referenceId <string>: unique line ID of the product

the order changes to a status of "CLAIMED" this is the final point balance of the guest after the order is completed. If the order changes to a status of "VOID" this is the final point balance after the order has been cancelled and guest loyalty points reversed.

• pointsEarned <number>: this represents the number of loyalty points the user has earned with this change of status. If the order changes to a status of "CLAIMED" this is the total number of points that were earned in this order. If the order changes to a status of "VOID" this is the total number of points that were earned when the guest’s loyalty points were reversed.

• pointsRedeemed <number>: this represents the number of loyalty points the user has redeemed with this change of status. If the order changes to a status of "CLAIMED" this is the final number of points that were deducted / burned in this order. If the order changes to a status of "VOID" this is the final number of points that were deducted from the user balance after the cancellation of the order is complete.

Success response example

{
    "points": 14464,
    "pointsEarned": 50,
    "pointsRedeemed": 750,
}

...