REST APILoyalty API
Get Rewards
Retrieves all active rewards available for redemption by the authenticated customer. Filters by tier eligibility, date range, and availability limits. Includes customer's remaining redemption allowance for each reward and their current point balance.
Response Body
application/json
application/json
application/json
curl -X GET "https://yourstore.myshopify.com/a/lantern/rewards/"{
"rewards": [
{
"id": "1",
"title": "$10 Off Your Order",
"cost": 1000,
"type": "Discount Code",
"value": 10,
"valueType": "Amount",
"thumbnailUrl": "https://storage.gadget.dev/discount-icon.png",
"minOrderValue": 50,
"customerRedemptionLimit": 5,
"remainingRedemptions": 4,
"globalRedemptionLimit": 100,
"globalRemaining": 67,
"eligible": true,
"canAfford": true,
"tierRestricted": false,
"requiredTiers": [
{
"id": "3",
"name": "Gold Member"
}
],
"variants": [
{
"id": "101",
"cost": 300,
"value": 5,
"productVariantId": "44123456789",
"productTitle": "Sample Kit",
"productVariantTitle": "Small"
}
]
}
],
"customerPoints": 1500
}{
"error": "Invalid app proxy request"
}{
"error": "Shop not found",
"shop": "nonexistent-store.myshopify.com"
}