Retrieve a Customer's Loyalty Benefits
Retrieves all loyalty-related benefits for a customer, identified by their unique ID.
This endpoint is designed to provide a complete overview of a customer's loyalty status, perfect for display on POS (Point of Sale) or Kiosk interfaces.
The returned object includes:
- credit: The customer's available monetary balance (e.g., cashback).
- points: The total number of loyalty points the customer has earned.
- rewards: A list of all rewards available to the customer, including their current usability status.
GET
/v1/benefits/{customerId}authorization<token>
To get an API key, please contact us. We'll be happy to help you.
In: header
Path Parameters
customerIdstring
Customer id
Format
uuidResponse Body
application/json
application/json
application/json
curl -X GET "http://localhost:4010/v1/benefits/497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"points": 1000,
"credit": 0,
"rewards": [
{
"id": "7U66KpLzLW7hVLktjML4MWOTyPoqX5XOAjpxpNo8",
"type": "AMOUNT",
"name": "5% off entire purchase",
"image": "https://services.prod.bcomo.com/GetResource?namespace=location_8270&resourceId=image_medium_747001&version=0",
"description": "5 OFF",
"couponCode": null,
"isUsed": false,
"useable": true,
"requirement": {
"expirationDate": "2030-08-25T11:00:52.000Z",
"redeemPoints": null
},
"value": null,
"hash": null,
"receivedAt": null,
"usedAt": null
},
{
"id": "4kOvH4foImPWSa4igbXtIFWJuvAoW469C7yRcjMQ8",
"type": "AMOUNT",
"name": "Test free coffee",
"image": "https://services.prod.bcomo.com/GetResource?namespace=location_8270&resourceId=image_medium_747001&version=0",
"description": "free coffee",
"couponCode": null,
"isUsed": false,
"useable": true,
"requirement": {
"expirationDate": "2030-04-24T09:06:26.000Z",
"redeemPoints": null
},
"value": null,
"hash": null,
"receivedAt": null,
"usedAt": null
},
{
"id": "rew_0ece003f2e",
"type": "FREE_PRODUCT",
"name": "Coffree - get your free coffee",
"image": "https://sandbox-static.heypongo.com/rewards/515_1745393587.png",
"description": "BOOM ! Montre ce SMS au vendeur pour récupérer {{reward}}",
"couponCode": null,
"isUsed": false,
"useable": true,
"requirement": {
"redeemPoints": 10,
"productSku": "FOX123154654654654,COFFREE"
},
"value": null,
"hash": "231c8dcf374f0a473ed11182e7811b60c916abfe",
"receivedAt": "2025-09-15T08:37:07.000000Z",
"usedAt": null
},
{
"id": "rew_9f34330493",
"type": "FREE_DELIVERY",
"name": "Free delivery",
"image": "https://sandbox-static.heypongo.com/rewards/default_reward.jpg",
"description": "Bravo, tu as gagné {{reward}} ! Utilise ce code promo sur notre site pour en profiter lors de ta prochaine commande : {{voucher}}",
"couponCode": null,
"isUsed": false,
"useable": true,
"requirement": {
"minOrderAmount": 5000,
"redeemPoints": 20,
"productSku": null
},
"value": null,
"hash": null,
"receivedAt": "2025-06-10T18:36:44.000000Z",
"usedAt": null
}
]
}{
"code": "CUSTOMER_NOT_FOUND",
"message": "No customers found."
}{
"code": "UNEXPECTED_ERROR",
"message": "Internal server error."
}