curl https://api.thanxsandbox.com/rewards/:id \
-X GET \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${token}" \
-H "X-ClientId: ${client_id}"
{
"reward": {
"id": "222441e34626",
"olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"user_id": "werofsdf",
"merchant_id": "weroif",
"campaign_id": "85133c3c1258",
"state": "available",
"earn": {
"type": "intro"
},
"redeem": {
"type": "manual",
"text": "$10 off",
"detail": "Long description",
"window": 60,
"venue": "all"
},
"coupon_code": {
"code": null,
"type": null,
"display": null
},
"fine_print": "Can't be used for alcohol purchases",
"instructions": "Example staff instructions",
"available_at": "2019-12-25T19:00:00Z",
"activated_at": "2020-01-01T20:00:00Z",
"retire_at": null,
"used_at": null,
"images": {
"index": {
"small": "https://...png", // width: 563px
"large": "https://...png" // width: 1125px
},
"detail": {
"small": "https://...png", // width: 642px
"large": "https://...png" // width: 1284px
},
"advertising": {
"small": "https://...png", // width: 430px
"large": "https://...png" // width: 860px
}
},
"redemption_location_id": "92b7b0dac4",
"uses_dynamic_coupon_codes": false
}
}
Rewards
Get Reward
This endpoint returns the reward corresponding to the ID in the path.
GET
/
rewards
/
:id
curl https://api.thanxsandbox.com/rewards/:id \
-X GET \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${token}" \
-H "X-ClientId: ${client_id}"
{
"reward": {
"id": "222441e34626",
"olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"user_id": "werofsdf",
"merchant_id": "weroif",
"campaign_id": "85133c3c1258",
"state": "available",
"earn": {
"type": "intro"
},
"redeem": {
"type": "manual",
"text": "$10 off",
"detail": "Long description",
"window": 60,
"venue": "all"
},
"coupon_code": {
"code": null,
"type": null,
"display": null
},
"fine_print": "Can't be used for alcohol purchases",
"instructions": "Example staff instructions",
"available_at": "2019-12-25T19:00:00Z",
"activated_at": "2020-01-01T20:00:00Z",
"retire_at": null,
"used_at": null,
"images": {
"index": {
"small": "https://...png", // width: 563px
"large": "https://...png" // width: 1125px
},
"detail": {
"small": "https://...png", // width: 642px
"large": "https://...png" // width: 1284px
},
"advertising": {
"small": "https://...png", // width: 430px
"large": "https://...png" // width: 860px
}
},
"redemption_location_id": "92b7b0dac4",
"uses_dynamic_coupon_codes": false
}
}
Please review proper request headers here.
Parameters
Response
Developers that do not communicate directly with the Olo APIs can ignore this
field.The field is only present for merchants that have integrated with Olo. This
UID should be used instead of the Reward ID when attempting to apply a reward
to the basket when communicating directly with the Olo API.This UID can also be used to match records (via the
externalreference Olo
rewards API attribute) being returned by the Olo API to relevant reward or
points product records in the Thanx API.This hash will be populated if the reward is 'active' or 'used' and the
merchant uses coupon codes.
Show coupon_code
Show coupon_code
The type of coupon code that should be used to render the
coupon_code
value (raw, qrcode, barcode39, barcode39extended, barcode93,
barcode128, barcode_upc_a, barcode_ean_8, barcode_ean_13,
barcode25interleaved)Details of how the reward can be redeemed
Show redeem
Show redeem
Each of these values is a URL of the reward image with the aspect ratio preserved. Each property (EG:
index.small) has a set width for all rewards, and the height varies based on the aspect ratio.For example, if you import an image with the dimensions 1000x1000 (aspect ratio of 1:1), then the image for index.small has the dimensions 563x563 because it matches the original aspect ratio.Show images
Show images
Indicates whether this reward uses dynamically generated coupon codes. When
true, a unique coupon code will be generated from a coupon pool when the reward is activated. This field is relevant for rewards created from points products or campaigns with dynamic coupon pools.curl https://api.thanxsandbox.com/rewards/:id \
-X GET \
-H "Content-Type: application/json" \
-H "Accept-Version: v4.0" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${token}" \
-H "X-ClientId: ${client_id}"
{
"reward": {
"id": "222441e34626",
"olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"user_id": "werofsdf",
"merchant_id": "weroif",
"campaign_id": "85133c3c1258",
"state": "available",
"earn": {
"type": "intro"
},
"redeem": {
"type": "manual",
"text": "$10 off",
"detail": "Long description",
"window": 60,
"venue": "all"
},
"coupon_code": {
"code": null,
"type": null,
"display": null
},
"fine_print": "Can't be used for alcohol purchases",
"instructions": "Example staff instructions",
"available_at": "2019-12-25T19:00:00Z",
"activated_at": "2020-01-01T20:00:00Z",
"retire_at": null,
"used_at": null,
"images": {
"index": {
"small": "https://...png", // width: 563px
"large": "https://...png" // width: 1125px
},
"detail": {
"small": "https://...png", // width: 642px
"large": "https://...png" // width: 1284px
},
"advertising": {
"small": "https://...png", // width: 430px
"large": "https://...png" // width: 860px
}
},
"redemption_location_id": "92b7b0dac4",
"uses_dynamic_coupon_codes": false
}
}