curl --request POST \
--url {protocol}://{host}/v2/loyalties/examine/rewards \
--header 'Authorization: Bearer <token>' \
--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": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "<string>"
},
"rewards": [
{
"id": "<string>",
"name": "<string>",
"metadata": {},
"object": "<string>"
}
],
"memberships": [
{
"member": {
"id": "<string>",
"customer_id": "<string>",
"program_id": "<string>",
"metadata": {},
"object": "<string>"
},
"program": {
"id": "<string>",
"name": "<string>",
"metadata": {},
"object": "<string>"
},
"cards": [
{
"card": {
"id": "<string>",
"card_definition_id": "<string>",
"card_type": "INDIVIDUAL",
"code": "<string>",
"object": "<string>"
},
"rewards": [
{
"reward": {
"id": "<string>",
"object": "<string>"
},
"cost": {
"points": 123,
"object": "<string>"
},
"unavailability_reasons": [
{
"details": "<string>",
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Examine rewards
⚠️ BETA endpoint
This is a work-in-progress documentation of a BETA endpoint. The parameters, fields, request and response bodies, and other data may subject to change. If you want to share feedback or improvements, contact Voucherify support or your Technical Account Manager.
Estimates which rewards a customer can obtain across their loyalty program memberships, including availability status, points cost and unavailability reasons.
curl --request POST \
--url {protocol}://{host}/v2/loyalties/examine/rewards \
--header 'Authorization: Bearer <token>' \
--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": "<string>",
"source_id": "<string>",
"metadata": {},
"object": "<string>"
},
"rewards": [
{
"id": "<string>",
"name": "<string>",
"metadata": {},
"object": "<string>"
}
],
"memberships": [
{
"member": {
"id": "<string>",
"customer_id": "<string>",
"program_id": "<string>",
"metadata": {},
"object": "<string>"
},
"program": {
"id": "<string>",
"name": "<string>",
"metadata": {},
"object": "<string>"
},
"cards": [
{
"card": {
"id": "<string>",
"card_definition_id": "<string>",
"card_type": "INDIVIDUAL",
"code": "<string>",
"object": "<string>"
},
"rewards": [
{
"reward": {
"id": "<string>",
"object": "<string>"
},
"cost": {
"points": 123,
"object": "<string>"
},
"unavailability_reasons": [
{
"details": "<string>",
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}
],
"object": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}{
"code": 123,
"key": "<string>",
"message": "<string>",
"details": "<string>",
"request_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Request body for examining rewards.
How the examined customer is identified. Depending on type, exactly one of customer_id, customer_source_id or member_id is required; the other two must not be present.
Show child attributes
Show child attributes
Customer metadata overrides used during examination.
Show child attributes
Show child attributes
Member metadata overrides used during examination.
Show child attributes
Show child attributes
Response
Rewards examination result
Rewards examination result.
Customer reference in examine results.
Show child attributes
Show child attributes
All rewards considered during examination (deduplicated).
Show child attributes
Show child attributes
Reward opportunities per program membership.
Show child attributes
Show child attributes
Object type marker. Always rewards_examine_result.
"rewards_examine_result"Was this page helpful?

