Get Points Products
/points_products
curl --request GET \
--url https://api.thanx.com/points_products \
--header 'Authorization: Bearer <token>'
Parameters
Only return points products configured for this merchant
Only return points products configured for this points experience
Response
The identifier of the points product
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. For developers that do not communicate directly with the Olo APIs, this field can be ignored.
The identifer of the points experience
Points needed to buy this product
The timestamp denoting when the product goes live
The timestamp denoting when the product expires
Fine print for the points product
IDs of locations at which reward can be redeemed based on restrictions.
Image of the points product
{
"points_products": [
{
"id": "9xw6543wh8jmde0",
"olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"points_experience_id": "590485d6f0",
"cost": 10,
"exchange_start_at": "2022-01-02T00:00:01.000Z",
"exchange_end_at": "2022-02-02T00:00:01.000Z",
"fine_print": "...",
"redeem": {
"type": "manual",
"venue": "instore",
"window": 60,
"text": "Onion rings",
"detail": "Crispy, golden brown and bursting with flavor, our onion rings are the perfect addition to any meal.",
"restrictions": "Redemption restriction description"
},
"valid_location_ids": [
"80925z17h8j7vmk"
]
"image": {
"small": "https://...png",
"default": "https://...png",
"large": "https://...png"
}
}
]
}
curl --request GET \
--url https://api.thanx.com/points_products \
--header 'Authorization: Bearer <token>'
{
"points_products": [
{
"id": "9xw6543wh8jmde0",
"olo_uid": "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmn",
"points_experience_id": "590485d6f0",
"cost": 10,
"exchange_start_at": "2022-01-02T00:00:01.000Z",
"exchange_end_at": "2022-02-02T00:00:01.000Z",
"fine_print": "...",
"redeem": {
"type": "manual",
"venue": "instore",
"window": 60,
"text": "Onion rings",
"detail": "Crispy, golden brown and bursting with flavor, our onion rings are the perfect addition to any meal.",
"restrictions": "Redemption restriction description"
},
"valid_location_ids": [
"80925z17h8j7vmk"
]
"image": {
"small": "https://...png",
"default": "https://...png",
"large": "https://...png"
}
}
]
}