get https://{host}/api_gateway/rewards/core/v1/user/vouchers/brand/?mobile=&username=
This API is used to get the user reward details based on mobile number/email ID/external ID.
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
- Basic Authentication
- Default access group
Resource information
| URI | /api_gateway/rewards/core/v1/user/vouchers/brand/{brand name}?mobile={mobile}&username={store} |
| HTTP Method | GET |
| Pagination | Yes. Limit=10, Page= 0 |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/user/vouchers/brand/BUKL?mobile=919456430850&username=swati
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| BrandName* | String | Name of the brand. |
Request query parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| Mobile | String | The mobile number of the customer. Ex: 919456430850 |
| Username* | String | Username of the customer. Ex: swati |
| sortBy | String | Supported values: REWARD_ID, INTOUCH_VOUCHER,INTOUCH_VOUCHER_EXPIRY,PURCHASE_DATE. Default values: IntouchPoints |
| orderBy | String | Supported values: ASC,DESC. Default values: ASC. |
| status | String | The status of the reward. Ex: active |
| intouch | Boolean | Allows you to fetch rewards from InTouch if enabled. Ex: true |
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/user/vouchers/brand/BUKL?mobile=919456430850&username=swati
Response parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| success | Boolean | Indicates the success of the fetch operation. |
| code | Integer | HTTP status code indicating the result of the operation. |
| message | String | Descriptive message about the operation outcome. |
| id | Integer | Unique identifier of the reward. |
| name | String | Name of the reward. |
| description | String | Description of the reward. |
| imageId | String | Identifier for the main image of the reward. |
| imageUrl | String | URL for the main image of the reward. |
| thumbnailId | String | Identifier for the thumbnail image of the reward. |
| thumbnailUrl | String | URL for the thumbnail image of the reward. |
| termAndConditionsId | String | Identifier for the terms and conditions document of the reward. |
| termAndConditionsUrl | String | URL for the terms and conditions document of the reward. |
| tier | String | Tier level associated with the reward. |
| label | String | Label associated with the reward. |
| priority | Integer | Priority level of the reward. |
| intouchPoints | Integer | Number of points needed to redeem the reward. |
| group | String | Group associated with the reward. |
| startTime | DateTime | Start time for the reward's availability. |
| endTime | DateTime | End time for the reward's availability. |
| expired | Boolean | Indicates whether the reward is expired. |
| started | Boolean | Indicates whether the reward has started. |
| programId | Integer | Identifier for the program associated with the reward. |
| categoryList | Object | List of categories associated with the reward. |
| customFields | Object | Key-value pairs for custom fields associated with the reward. |
| loyaltyProgramCriteria | Array | Criteria for loyalty programs associated with the reward. |
| restrictions | Object | Restrictions associated with the reward. |
| appliedPromotions | Array | List of applied promotions associated with the reward. |
| groupName | String | Name of the group associated with the reward. |
| groupRank | Integer | Rank of the group associated with the reward. |
| rewardRank | Integer | Rank of the reward within its category or program. |
| images | Array | List of additional images associated with the reward. |
| videos | Array | List of videos associated with the reward. |
{
"status": {
"success": true,
"code": 200,
"message": "User Reward fetched successfully"
},
"reward": {
"id": 121879,
"name": "Flat 100 off on protein powder",
"description": "Burn 100 points and get a Flat 100 off on protein powder coupon",
"imageId": "0f1aee40-3e4d-474d-8070-546eb2ac777e",
"imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/5bea603b-6ff2-4e00-88fb-8610012b.jpg",
"thumbnailId": "2f6fc242-58c1-4a41-9e2f-66bc9acac52e",
"thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/ae890c7e-9c8f-47d9-b5e2-1c62265e.jpg",
"termAndConditionsId": "9303b31a-6042-475e-bb46-3129bc22baa1",
"termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/b7bb1e12-8b1e-4089-888d-3f13723.html",
"tier": "4",
"label": "4",
"priority": 1,
"intouchPoints": 100,
"group": "Protein",
"startTime": "2024-01-24 08:28:16",
"endTime": "2028-07-31 02:58:16",
"expired": false,
"started": true,
"programId": null,
"categoryList": [
{
"id": 2,
"name": "accessories",
"enabled": true
}
],
"customFields": {
"CF2": "value"
},
"loyaltyProgramCriteria": [],
"restrictions": {
"isValid": true
},
"appliedPromotions": [],
"groupName": TOP,
"groupRank": 1,
"rewardRank": 5,
"images": [],
"videos": []
}
}
API-specific error codes
| Code | Description |
|---|---|
| 1014 | Cannot find customer for provided mobile/external-id/e-mail/id |