get https://{host}/api_gateway/rewards/core/v1/user/reward/brand/?userId=
This API gives all the details for the reward purchased such as Reward ID, Metadata, Intouch points, Programs/tiers, Reward restrictions/limits, and Catalog promotions applied.
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Authentication: Basic or OAuth authentication
- Default access group
Resource information
| URI | /api_gateway/rewards/core/v1/user/reward/brand/{BrandName}?userId={userID} |
| HTTP Method | GET |
| Pagination | No |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/BUKL?userId=177071561
Request query parameters
| Parameters | Data Type | Description |
|---|---|---|
| UserId* | Long | User ID of the customer. Ex: 177071561 |
| includeExpired | Boolean | Pass includeExpired as true to retrieve expired reward details. |
| groupName | String | Enter the group name to fetch all the rewards associated with the group. |
Request path parameters
| Parameters | Data Type | Description |
|---|---|---|
| Brand Name* | String | Name of the brand. Ex: Bukl |
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/SUPERMARKETDEMO?userId=62090013
Response parameters
| Parameter | Description |
|---|---|
| success | Indicates if the request was successful. A value of true means the operation completed successfully, while false signifies failure. |
| code | The HTTP status code returned by the server. A value of 200 typically indicates success, while other values indicate different types of errors. |
| message | A descriptive message providing additional details about the status of the request, usually helping diagnose any issues. |
| rewardList | A list containing details about the rewards available for the user, including information. |
| id | The unique identifier assigned to each reward for reference in the system. |
| name | The name of the reward, which can be displayed to the user. |
| description | A short description of the reward, providing more context about its benefits. If not applicable, it may be null. |
| imageId | A unique identifier for the image associated with the reward, useful for retrieving image data from a storage system. |
| imageUrl | The URL link to the full-size image representing the reward, providing visual context for the user. |
| thumbnailId | A unique identifier for a smaller version of the reward's image, often used as a thumbnail. |
| thumbnailUrl | The URL to access the thumbnail image of the reward, typically used in lists or previews. |
| termAndConditionsId | The identifier for the terms and conditions associated with the reward, pointing to a specific document. |
| termAndConditionsUrl | The URL where users can view the terms and conditions that apply to the reward, ensuring transparency. |
| tier | The reward tier that indicates the level or category of the reward. |
| label | A tag or category that helps classify the rewards. |
| priority | Indicates the priority of the reward. Higher values indicate higher priority for the reward's visibility or redemption. |
| intouchPoints | The number of points required to redeem the reward. |
| group | A grouping label or category that this reward may belong to. |
| startTime | The start date and time when the reward becomes available for redemption by users. |
| endTime | The end date and time when the reward will no longer be available for redemption. |
| expired | A flag indicating whether the reward has expired. true means expired, and false means the reward is still available. |
| started | Indicates whether the reward has begun and is currently available for redemption. |
| programId | An identifier for the loyalty program tied to the reward. |
| categoryList | A list of categories associated with the reward. If no categories are applied, it will be empty. |
| customFields | A set of custom fields used to store additional metadata about the reward, allowing flexibility in reward configuration. |
| loyaltyProgramCriteria | A list of criteria or conditions that must be met for the reward to be eligible under a loyalty program. |
| groups | A list of groups associated with the reward. This can be used to target specific user groups or demographics. |
| rewardRestrictions | Defines the limitations or conditions that apply to the reward’s use, including validity and redemption conditions. |
| isValid | Indicates whether the reward restrictions are currently valid. |
| rewardRank | The rank of the reward, which could represent its priority or level within a program. |
| images | A list of URLs pointing to additional images associated with the reward |
| videos | A list of URLs for any video content related to the reward. |
| paymentConfigs | Configuration details for how users can redeem the reward, including the payment mode and associated ratios or values. |
| pagingDto | Contains information about the pagination of the results, allowing the user to navigate between multiple pages of rewards. |
| last | Indicates if the current page is the last page of available results. |
| totalElements | The total number of rewards available across all pages, helping to gauge the size of the dataset. |
| totalPages | The total number of pages required to display all available rewards. |
| numberOfElements | The number of rewards present on the current page, which is a subset of the total rewards. |
| first | Indicates if the current page is the first page in the paginated result set. |
| size | The number of rewards shown per page, used to manage the size of each page in pagination. |
| number | The index of the current page, starting from 0 for the first page. |
| orgLevelRestrictions | Restrictions applied at the organizational level, specifically regarding the redemption type and limits. |
| isValid | Indicates if the organizational restrictions are currently valid and enforceable. |
| customerRedemptionTypeLevel | Defines the restrictions for different customer redemption types |
| rewardConstraintId | The unique identifier for the specific reward constraint being applied. |
| orgId | The organization ID associated with the redemption constraints. |
| kpi | The key performance indicator associated with the redemption type. |
| constraintLevel | Specifies the level at which the constraint is applied. |
| frequencyType | Defines how often the constraint applies, such as monthly, yearly, etc. |
| constraintLimitValue | The maximum value or limit that can be redeemed within the specified frequency. |
| isActive | Indicates whether the constraint is currently active and can be enforced. |
| isValid | Confirms whether the constraint is valid and enforceable at the time. |
| consumed | Tracks how much of the constraint limit has already been consumed. |
| redemptionType | Specifies the type of redemption. |
{
"status": {
"success": true,
"code": 200,
"message": "User Reward fetched successfully"
},
"rewardList": [
{
"id": 262700,
"name": "Redeem 500 and donate 50 SAR for charity A",
"description": "Redeem 500 and donate 50 SAR for charity A",
"imageId": "f48391c1-f5d9-42ea-9f96-a25222924c9d",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/84625c17-5e5e-41de-b144-afe4d24.jfif",
"thumbnailId": "de8df295-ef47-4e96-aade-210ec79acd60",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/eee264b1-7e3d-4146-92e9-f7fd359.jfif",
"termAndConditionsId": "f9e17237-fc17-4dce-853d-3b90b9e33689",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/b1d05657-6a23-4095-bffc-3ecf1fa.html",
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 500,
"group": "",
"startTime": "2024-11-08 06:39:22",
"endTime": "2024-11-30 06:39:22",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 17,
"name": "children's special",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 262308,
"name": "Redeem 700 points and get 10% discount voucher, valid on \"Frozen\" category only",
"description": "Redeem 700 points and get 10% discount voucher, valid on \"Frozen\" category only",
"imageId": "da6642d7-f1ae-4b8e-a99e-f17982af8e76",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/0bc9266f-7b27-4427-aafd-bbfc6f9a.jpg",
"thumbnailId": "cc64642a-9f5c-4603-ba15-7b711778a871",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/2b98515b-8080-43df-acbf-581a876d.jpg",
"termAndConditionsId": "a530cc6a-19ce-4977-9b02-37631e2456b5",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/20368774-0185-4da5-b306-8c3e286.html",
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 10,
"group": "",
"startTime": "2024-11-07 12:40:42",
"endTime": "2024-11-30 07:10:42",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 118,
"name": "frozen",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 262301,
"name": "Redeem 800 points and get 10% discount voucher, valid on \"Bakery\" category only",
"description": "Redeem 800 points and get 10% discount voucher, valid on \"Bakery\" category only",
"imageId": "4dcf28a0-b0fb-45f7-abf0-51c20f132bc7",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/2232163c-4d6a-4648-81e5-47f5328b.jpg",
"thumbnailId": "7858c530-9400-46cc-b125-1afe5b9b8749",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/4352ec4c-8d2b-4347-a48f-8f6d25fb.jpg",
"termAndConditionsId": "a3a3cba0-6232-4d5a-96d3-d9844871012a",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/b08df585-75dc-4273-bf9c-8879b77.html",
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 800,
"group": "",
"startTime": "2024-11-07 12:39:18",
"endTime": "2024-11-30 12:39:18",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 117,
"name": "bakery",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 262292,
"name": "Redeem 7000 points and get 100SAR voucher, valid on \"Fresh Products\" category only",
"description": "Redeem 7000 points and get 100SAR voucher, valid on \"Fresh Products\" category only",
"imageId": "b44fe4cd-2bce-40d7-bfee-b47ae32b1d57",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/00290707-3a3a-4299-bc03-9e79b67.jfif",
"thumbnailId": "e990db00-cbbc-4b8f-8d7e-a940b891b0f4",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/d7fb1d2a-31cc-4f16-9bc6-984652f.jfif",
"termAndConditionsId": null,
"termAndConditionsUrl": null,
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 7000,
"group": "",
"startTime": "2024-11-07 12:37:21",
"endTime": "2024-11-30 12:37:21",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 116,
"name": "fresh products ",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 262283,
"name": "Redeem 1000 points and get 100SAR voucher, valid on \"Dairy\" category only",
"description": "Redeem 1000 points and get 100SAR voucher, valid on \"Dairy\" category only",
"imageId": "4240e562-097c-40d5-bbef-661e25f9efcf",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/cc2716e5-a317-4db5-8e8c-678683ba.jpg",
"thumbnailId": "bddcaad1-ec68-4e09-bf55-d78500f3f6e2",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/84f56989-1018-4fe7-8cf2-e11aeaff.jpg",
"termAndConditionsId": "513f804f-0100-491f-b23a-3c649fcb722d",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/457cbfc2-38ab-47e2-a4b4-28b4950.html",
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 1000,
"group": "",
"startTime": "2024-11-07 12:36:01",
"endTime": "2024-11-30 12:36:01",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 114,
"name": "dairy",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 245533,
"name": "150 off on handbags and wallets",
"description": "150 off on handbags and wallets",
"imageId": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg",
"thumbnailId": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg",
"termAndConditionsId": "36797a3b-7726-4d75-ad8b-aa1dc0bd7874",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5f259983-5671-453e-af25-c9d1293.html",
"tier": null,
"label": null,
"priority": 1,
"intouchPoints": 0,
"group": "AFG",
"startTime": "2024-11-01 06:00:00",
"endTime": "2030-10-31 11:59:30",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 20,
"name": "groceries",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [
{
"name": "Hero image",
"id": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
"url": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg"
},
{
"name": "1st image",
"id": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
"url": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg"
},
{
"name": "Mobile image",
"id": "04bbabf2-ce9d-48b3-9a58-347479b8ea88",
"url": "https://eucrm-solutions.s3.amazonaws.com/rewards/969c2707-e082-4cc5-bbad-48f6ae1.jpeg"
}
],
"videos": [
{
"name": "videoname1",
"id": null,
"url": "https://www.youtube.com/watch?v=JlxgrLH6hu4",
"isExternal": true
}
],
"paymentConfigs": [
{
"paymentMode": "CASH",
"id": 1017,
"cash": 150.0000
},
{
"paymentMode": "POINTS",
"id": 1018,
"points": 100.0000
},
{
"paymentMode": "POINTS_CASH",
"id": 1019,
"cash": 150.0000,
"points": 100.0000
}
]
},
{
"id": 238940,
"name": "Davi - 5% coupon valid at Cebu pacific",
"description": "Davi - 5% coupon valid at Cebu pacific",
"imageId": "eac654a5-7476-44be-a861-ce9188045170",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/de153527-18bb-4374-9d3a-ed69f5c.jpeg",
"thumbnailId": "b7ec8a0f-a8b0-4a4b-818f-f7e20ef13eb7",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/da2a2c2e-b717-4501-82e5-a052035.jpeg",
"termAndConditionsId": "76bb87ea-75f5-4a80-99c6-b2bf3038daf2",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/cc3ce32d-f5a9-4155-a154-f0a5e62.html",
"tier": null,
"label": "shops",
"priority": 4,
"intouchPoints": 10,
"group": null,
"startTime": "2024-09-25 06:32:28",
"endTime": "2025-11-26 03:02:28",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 110,
"name": "shops",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 238939,
"name": "Davi - 10% coupon valid at Southstar drug",
"description": "Davi - 10% coupon valid at Southstar drug",
"imageId": "97e9522e-211a-43e6-8e6f-520b3c0f5de2",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/41b57d28-01d3-4d71-9d4a-d4c57cb.jpeg",
"thumbnailId": "4e961873-1005-40fe-a53e-c1791cb3282b",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/34e44cec-76f6-45b0-9f12-6260765.jpeg",
"termAndConditionsId": "5dcac1f2-0af8-449d-a94c-884465090f7a",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/21734fdb-c2b5-4963-b7ea-c7d040a.html",
"tier": null,
"label": "shops",
"priority": 3,
"intouchPoints": 20,
"group": null,
"startTime": "2024-09-25 06:29:14",
"endTime": "2025-09-22 08:29:14",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 110,
"name": "shops",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 238938,
"name": " Davi - 10% coupon valid at Robinson's",
"description": " Davi - 10% coupon valid at Robinson's",
"imageId": "342f90d5-a0fa-42da-b242-2dcb35c65f09",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/c32ed143-e208-46dc-80e3-fb4f9a1.jpeg",
"thumbnailId": "1814965a-b775-4288-bb0b-bc4ef583b35a",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/000425f9-b387-4aa9-91dc-b2e055c.jpeg",
"termAndConditionsId": "622228ec-0cf8-470c-b590-784a27421680",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/7a32cde5-e632-439b-a7c1-1da870c.html",
"tier": "",
"label": "",
"priority": 1,
"intouchPoints": 20,
"group": "",
"startTime": "2024-09-25 06:25:52",
"endTime": "2025-09-24 08:29:52",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 110,
"name": "shops",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
},
{
"id": 238912,
"name": "Davi 5% off coupon",
"description": "Davi 5% off coupon",
"imageId": "0858da16-193b-46f9-804b-728115b967b4",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/f06e6b8d-c968-41d6-ab13-35ca97a.jpeg",
"thumbnailId": "8aafcf71-af2c-41c0-a76e-e945d094d43e",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/f8281102-d94e-4ca8-981f-3390f3a.jpeg",
"termAndConditionsId": "3358f1cb-a7d5-4259-8961-ee60984a4317",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/d2a875a3-48cf-4cb7-8de7-c642fcc.html",
"tier": null,
"label": "shops",
"priority": 1,
"intouchPoints": 20,
"group": null,
"startTime": "2024-09-25 06:06:08",
"endTime": "2025-10-29 08:06:08",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 110,
"name": "shops",
"enabled": true
}
],
"customFields": {
"CF210": "value"
},
"loyaltyProgramCriteria": [],
"groups": [],
"rewardRestrictions": {
"isValid": true
},
"rewardRank": null,
"images": [],
"videos": []
}
],
"pagingDto": {
"last": true,
"totalElements": 14,
"totalPages": 1,
"numberOfElements": 14,
"first": true,
"size": 14,
"number": 0
},
"orgLevelRestrictions": {
"isValid": true,
"customerRedemptionTypeLevel": [
{
"rewardConstraintId": 13055,
"orgId": 100606,
"kpi": "POINTS",
"constraintLevel": "CUSTOMER_REDEMPTION_TYPE",
"frequencyType": "MONTHLY",
"constraintLimitValue": 4000,
"isActive": true,
"isValid": true,
"consumed": 0,
"redemptionType": "CHARITY"
},
{
"rewardConstraintId": 13154,
"orgId": 100606,
"kpi": "POINTS",
"constraintLevel": "CUSTOMER_REDEMPTION_TYPE",
"frequencyType": "MONTHLY",
"constraintLimitValue": 500000,
"isActive": true,
"isValid": true,
"consumed": 0,
"redemptionType": "NULL"
}
]
}
}