Examine rewards
curl --request POST \
--url {protocol}://{host}/v2/loyalties/examine/rewards \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"customer_identification": {
"customer_id": "<string>",
"customer_source_id": "<string>",
"member_id": "<string>"
},
"customer": {
"metadata": {}
},
"member": {
"metadata": {}
}
}
'{
"customer": {
"id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
"source_id": "lx-rdmptr",
"metadata": {
"VIP": true
},
"object": "customer"
},
"rewards": [
{
"id": "lrew_128f4cab04147c8608",
"name": "Free item coupon",
"type": "DIGITAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "FIXED_COOLDOWN",
"fixed_cooldown": {
"period": {
"value": 1,
"unit": "DAY"
}
}
},
"frequency": {
"type": "LIMITED",
"limits": [
{
"type": "TIME_BASED",
"period": {
"type": "CURRENT_PERIOD",
"current_period": {
"unit": "DAY"
}
},
"triggers": {
"max": 1
}
}
]
}
}
},
{
"id": "lrew_128f4c6710947c85d1",
"name": "Minas Gerais 500",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_1294cebb458e4904a0",
"name": "Carioca shirt",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_12b22d6ef31184e002",
"name": "Carioca shorts",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_12bb65405edf8d3dec",
"name": "Carioca longsleeve",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
}
],
"memberships": [
{
"member": {
"id": "lmbr_128f962dbc8c4ba5dc",
"customer_id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
"program_id": "lprg_128f58429f4c4bf7b2",
"metadata": {},
"object": "member"
},
"program": {
"id": "lprg_128f58429f4c4bf7b2",
"name": "AnnualProgram",
"metadata": {},
"object": "program"
},
"cards": [
{
"card": {
"id": "lcrd_128f962dbd8c4ba5e1",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"card_type": "INDIVIDUAL",
"code": "AnnualTime-7M7ShPGfme",
"object": "card"
},
"rewards": [
{
"reward": {
"id": "lrew_128f4cab04147c8608",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 300,
"object": "reward_cost"
},
"object": "reward_estimation"
},
{
"reward": {
"id": "lrew_128f4c6710947c85d1",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 150,
"object": "reward_cost"
},
"object": "reward_estimation"
},
{
"reward": {
"id": "lrew_1294cebb458e4904a0",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 500,
"object": "reward_cost"
},
"object": "reward_estimation"
}
],
"object": "card_estimation"
},
{
"card": {
"id": "lcrd_128f962dbd8c4ba5df",
"card_definition_id": "lcdef_128f495f720c4bec8c",
"card_type": "INDIVIDUAL",
"code": "SummerTime-7z8dWawICd",
"object": "card"
},
"rewards": [
{
"reward": {
"id": "lrew_12b22d6ef31184e002",
"object": "reward"
},
"status": "UNAVAILABLE",
"cost": {
"points": 321,
"object": "reward_cost"
},
"unavailability_reasons": [
{
"reason": "insufficient_balance",
"details": {
"required": 321,
"available": 10,
"missing": 311
},
"object": "reward_unavailability_reason"
}
],
"object": "reward_estimation"
}
],
"object": "card_estimation"
}
],
"object": "member_rewards_opportunity"
}
],
"object": "rewards_examine_result"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 404,
"key": "not_found",
"message": "Resource not found",
"details": "Cannot find customer with id cust_6onRrs4kCnvSVrTs5YtDPFB",
"request_id": "v-12c2e64d5d4a67cddc",
"resource_id": "cust_6onRrs4kCnvSVrTs5YtDPFB",
"resource_type": "customer"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}Examine rewards
Evaluates rewards assigned to a customer’s active Loyalty v2 program memberships. Applies temporary customer and member metadata overrides without updating stored data. Returns reward availability by card, including points costs and applicable unavailability reasons.
This endpoint can examine rewards for all loyalty programs the customer belongs to by using customer_identification with customer_id or source_id. To examine rewards only for one program, use member_id in customer_identification, as member_id is loyalty program-specific.
POST
/
v2
/
loyalties
/
examine
/
rewards
Examine rewards
curl --request POST \
--url {protocol}://{host}/v2/loyalties/examine/rewards \
--header 'Content-Type: application/json' \
--header 'X-App-Id: <api-key>' \
--header 'X-App-Token: <api-key>' \
--data '
{
"customer_identification": {
"customer_id": "<string>",
"customer_source_id": "<string>",
"member_id": "<string>"
},
"customer": {
"metadata": {}
},
"member": {
"metadata": {}
}
}
'{
"customer": {
"id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
"source_id": "lx-rdmptr",
"metadata": {
"VIP": true
},
"object": "customer"
},
"rewards": [
{
"id": "lrew_128f4cab04147c8608",
"name": "Free item coupon",
"type": "DIGITAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "FIXED_COOLDOWN",
"fixed_cooldown": {
"period": {
"value": 1,
"unit": "DAY"
}
}
},
"frequency": {
"type": "LIMITED",
"limits": [
{
"type": "TIME_BASED",
"period": {
"type": "CURRENT_PERIOD",
"current_period": {
"unit": "DAY"
}
},
"triggers": {
"max": 1
}
}
]
}
}
},
{
"id": "lrew_128f4c6710947c85d1",
"name": "Minas Gerais 500",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_1294cebb458e4904a0",
"name": "Carioca shirt",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_12b22d6ef31184e002",
"name": "Carioca shorts",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
},
{
"id": "lrew_12bb65405edf8d3dec",
"name": "Carioca longsleeve",
"type": "MATERIAL",
"metadata": {},
"object": "reward",
"purchase_limits": {
"cooldown": {
"type": "NO_COOLDOWN"
},
"frequency": {
"type": "NO_LIMIT",
"limits": []
}
}
}
],
"memberships": [
{
"member": {
"id": "lmbr_128f962dbc8c4ba5dc",
"customer_id": "cust_6onRrs4kCnvSVrTs5YtDPFBG",
"program_id": "lprg_128f58429f4c4bf7b2",
"metadata": {},
"object": "member"
},
"program": {
"id": "lprg_128f58429f4c4bf7b2",
"name": "AnnualProgram",
"metadata": {},
"object": "program"
},
"cards": [
{
"card": {
"id": "lcrd_128f962dbd8c4ba5e1",
"card_definition_id": "lcdef_128f4a88414c4bed69",
"card_type": "INDIVIDUAL",
"code": "AnnualTime-7M7ShPGfme",
"object": "card"
},
"rewards": [
{
"reward": {
"id": "lrew_128f4cab04147c8608",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 300,
"object": "reward_cost"
},
"object": "reward_estimation"
},
{
"reward": {
"id": "lrew_128f4c6710947c85d1",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 150,
"object": "reward_cost"
},
"object": "reward_estimation"
},
{
"reward": {
"id": "lrew_1294cebb458e4904a0",
"object": "reward"
},
"status": "AVAILABLE",
"cost": {
"points": 500,
"object": "reward_cost"
},
"object": "reward_estimation"
}
],
"object": "card_estimation"
},
{
"card": {
"id": "lcrd_128f962dbd8c4ba5df",
"card_definition_id": "lcdef_128f495f720c4bec8c",
"card_type": "INDIVIDUAL",
"code": "SummerTime-7z8dWawICd",
"object": "card"
},
"rewards": [
{
"reward": {
"id": "lrew_12b22d6ef31184e002",
"object": "reward"
},
"status": "UNAVAILABLE",
"cost": {
"points": 321,
"object": "reward_cost"
},
"unavailability_reasons": [
{
"reason": "insufficient_balance",
"details": {
"required": 321,
"available": 10,
"missing": 311
},
"object": "reward_unavailability_reason"
}
],
"object": "reward_estimation"
}
],
"object": "card_estimation"
}
],
"object": "member_rewards_opportunity"
}
],
"object": "rewards_examine_result"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}{
"code": 404,
"key": "not_found",
"message": "Resource not found",
"details": "Cannot find customer with id cust_6onRrs4kCnvSVrTs5YtDPFB",
"request_id": "v-12c2e64d5d4a67cddc",
"resource_id": "cust_6onRrs4kCnvSVrTs5YtDPFB",
"resource_type": "customer"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>",
"resource_id": "<string>",
"resource_type": "<string>"
}Authorizations
X-App-Id & X-App-TokenbearerAuth
Body
application/json
Request body for examining rewards.
Identifies the customer or loyalty member to examine.
Show child attributes
Show child attributes
Provides temporary customer metadata overrides for the examination. Merges them with stored metadata without updating the customer.
Show child attributes
Show child attributes
Provides temporary member metadata overrides for the examination. Requires customer_identification.type to be member_id. Merges them with stored metadata without updating the member.
Show child attributes
Show child attributes
Response
Rewards examination result
Identifies the customer used for the examination.
Show child attributes
Show child attributes
Lists rewards included in the returned card estimations.
Show child attributes
Show child attributes
Reward opportunities per program membership.
Show child attributes
Show child attributes
Object type marker. Always rewards_examine_result.
Allowed value:
"rewards_examine_result"Last modified on August 10, 2026
Was this page helpful?
⌘I