Redeem Rewards

Redeem loyalty promotions for a customer’s order.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Business Location ID of the merchant location.

string
required

Loyalty customer ID, as issued by the location's loyalty provider.

Body Params
string
required

POS order ID. Use the same ID for every loyalty request on this order (accrue, redeem, reverse).

promotion_ids
array of strings
required

ID of the promotion that was redeemed on the order. Only one promotion may be redeemed on an order.

promotion_ids*
string

Order subtotal in cents at redemption (optional | value must be positive). Lets a provider compute the discount against the cart being paid for.

line_items
array of objects

Final cart at redemption, so a loyalty provider can evaluate item-level promotions and compute the authoritative discount_amount against the exact cart being paid for.

line_items
string

Client-issued idempotency key for this redemption (max 50 chars). Replaying the same key with the same body returns the original result; a different body is rejected with 409.

string

Order total in cents at redemption (optional | must be zero or greater).

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json