REST APILoyalty API
Redeem Reward
Redeems a reward for the authenticated customer, deducting points and returning the discount code, gift card code, or free product information. The endpoint validates tier eligibility, point balance, and redemption limits before processing.
Request Body
application/json
rewardVariantId*string
The ID of the reward variant to redeem.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://yourstore.myshopify.com/a/lantern/rewards/redeem" \ -H "Content-Type: application/json" \ -d '{ "rewardVariantId": "123" }'{
"success": true,
"redemption": {
"id": "456",
"code": "SAVE10-ABC123",
"type": "Discount Code",
"value": 10,
"valueType": "Amount",
"expiresAt": "2026-03-02T00:00:00.000Z",
"minOrderValue": 50,
"productVariantId": "44123456789"
},
"pointsRemaining": 500
}{
"error": "Missing required field",
"message": "handle is required"
}{
"error": "Invalid app proxy request"
}{
"error": "Tier requirement not met",
"message": "You must be in a higher tier to redeem this reward"
}{
"error": "Reward not found",
"rewardVariantId": "invalid-id"
}