<- Loyalty API

Loyalty API

Redeem loyalty reward

POST

 /v2/loyalty/rewards/{reward_id}/redeem

Redeems a loyalty reward.

The endpoint sets the reward to the REDEEMED terminal state.

If you are using your own order processing system (not using the Orders API), you call this endpoint after the buyer paid for the purchase.

After the reward reaches the terminal state, it cannot be deleted. In other words, points used for the reward cannot be returned to the account.

Permissions:LOYALTY_WRITE

Guide

Redeem loyalty reward

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

reward_id

string

Required

The ID of the loyalty reward to redeem.

Link to section

Request body

Link to section

idempotency_key

string

Required

A unique string that identifies this RedeemLoyaltyReward request. Keys can be any valid string, but must be unique for every request.

Min Length
1
Max Length
128
Link to section

location_id

string

Required

The ID of the location where the reward is redeemed.

Min Length
1
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

event

The LoyaltyEvent for redeeming the reward.

Show attributes