get https://{host}/api_gateway/rewards/core/v1/reward/list/brand/
This API is used to retrieve list of rewards owned by brands based on filters.
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/reward/list/brand/{BrandID} |
| HTTP Method | GET |
| Pagination | Yes Default - 100 |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/reward/list/brand/1?page=0&size=20
Request path parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| brandId* | String | Unique identifier of the brand. |
Request query parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| Page | Integer | Allows to retrieve details of a specific page. |
| Size | Long | Results to show per page. Default - 100 |
| ownerType | Enum | Module for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill. |
| ownerId | String | Unique identifier of the owner to claim the reward. |
| startDate | Long | Start date of the reward. Any rewards between the specified start and end date will be displayed. If either the start or end date falls within the timeline, the reward will still be included in the response. If the start date is used as a filter, the end date must also be specified, and vice versa. Format for startDate is in epoch. |
| endDate | Long | End date of the reward. Any rewards between the specified start and end date will be displayed. If either the start or end date falls within the timeline, the reward will still be included in the response. Format for startDate is in epoch. |
| rewardStatus | Enum | Indicates the current state of the reward. Supported values: LIVE: The reward is currently available for redemption. UPCOMING: The reward will be available in the future. ENDED: The reward is no longer available. |
| vendorIds | Integer | A collection of identifiers for vendors associated with the reward. Multiple vendorIds are supported. There's no limit specifically for vendorIds. |
| rewardType | Enum | Specifies the category of reward redemption available, using predefined types that indicate how users can redeem the reward. Also known as redemptionType. Supported values: GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC. |
| rewardName | String | The name of the reward which was created. rewardName supports Partial Search. Users can search for a reward using part of its name, and results that match the partial input will be returned (e.g., searching for "Gold" could return "Gold Star Reward" or "Golden Points"). |
| enabled | Boolean | A boolean indicating whether the reward is currently active or inactive for users. |
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/reward/list/brand/1?page=0&size=20&startDate=1727254620000&endDate=1752244980000&rewardType=CHARITY&rewardStatus=LIVE
Response parameters
| Parameter | Data Type | Description |
|---|---|---|
| status | Object | Object containing the status of the reward details |
| success | Boolean | Indicates if the operation was successful |
| code | Integer | Status code of the operation |
| message | String | Status message |
| rewardList | Array | List of rewards |
| id | Integer | Unique identifier of the reward. This is the reward ID which was generated during reward creation. |
| name | String | Name of the reward |
| startTime | String | Start time of the reward availability |
| endTime | String | End time of the reward availability |
| type | String | Type of the reward. |
| priority | Integer | Priority of the reward |
| enabled | Boolean | Indicates if the reward is enabled |
| intouchPoints | Integer | Points required for the reward |
| redemptionType | String | Type of redemption for the reward |
| customFields | Object | Custom fields for additional information |
| status | Enum | Indicates the current state of the reward. Example: LIVE, UPCOMING, ENDED |
| intouchSeriesId | Integer | Coupon series ID or cart promotion ID when intouch reward is selected. |
| vendorId | Integer | Unique ID of the vendor. |
| vendorName | String | Name of the vendor. |
| vendorRedemptionId | Integer | Unique vendor redemption ID which was generated from this API. |
| vendorRedemptionName | String | Name of the vendor redemption. |
| lastUpdatedOn | Date | Date on which the Reward was last updated. |
| lastUpdatedBy | String | Name of the user by which the Reward was last updated. |
| owners | Array | List of owners of the reward |
| ownerType | Enum | Module for which the reward was created. |
| ownerId | String | Unique identifier of the owner to claim the reward. |
| pagingDto | Object | The object containing paging details |
| paymentConfigs | Array | The list of payment mode supported by the reward. |
| groups | Array | An array containing information about groups and rewards associated with reward. |
| last | Boolean | Indicates if it is the last page |
| totalElements | Integer | Total number of elements |
| totalPages | Integer | Total number of pages |
| numberOfElements | Integer | Number of elements in the current page |
| first | Boolean | Indicates if it is the first page |
| size | Integer | The number of items or records returned in a single API response. |
| number | Integer | Current page number |
{
"status": {
"success": true,
"code": 6101,
"message": "Reward details fetched successfully"
},
"rewardList": [
{
"id": 20867,
"name": "name_first",
"startTime": "2024-11-01 03:53:01",
"endTime": "2027-01-15 07:26:45",
"type": "VOUCHER",
"priority": 1,
"enabled": true,
"intouchPoints": 1,
"redemptionType": "SWEEPSTAKES",
"customFields": {},
"owners": null,
"paymentConfigs": [
{
"paymentMode": "CASH",
"id": 813,
"cash": 25.0000
}
],
"groups": [
{
"groupName": "groupName014",
"groupRank": 8
}
],
"rewardRank": 10,
"status": "UPCOMING",
"intouchSeriesId": null,
"vendorRedemptionId": 1627,
"vendorRedemptionName": "demo vendor for physicalReward",
"vendorId": 17,
"vendorName": "testVendor002",
"lastUpdatedOn": 1725359777000,
"lastUpdatedBy": null
}
],
"pagingDto": {
"last": true,
"totalElements": 1,
"totalPages": 1,
"numberOfElements": 1,
"first": true,
"size": 10,
"number": 0
}
}
{
"status": {
"success": true,
"code": 6101,
"message": "Reward details fetched successfully"
},
"rewardList": [
{
"id": 28548,
"name": "English",
"startTime": "2024-12-01 18:04:00",
"endTime": "2024-12-01 18:04:10",
"type": "VOUCHER",
"priority": 1,
"enabled": true,
"intouchPoints": 1,
"redemptionType": "CART_PROMOTION",
"customFields": {},
"owners": [
{
"ownerType": "LOYALTY_PROGRAM",
"ownerId": "123456789"
}
]
}
],
"pagingDto": {
"last": true,
"totalElements": 1,
"totalPages": 1,
"numberOfElements": 1,
"first": true,
"size": 10,
"number": 0
}
}
{
"status": {
"success": false,
"code": 3004,
"message": "Brand not found"
}
}
API-specific error codes
| Error code | Description |
|---|---|
| 3004 | Brand not found |