get https://{host}/api_gateway/rewards/core/v1/reward/brand//list
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
- Basic Authentication
- Default access group
Resource information
| URI | api_gateway/rewards/core/v1/reward/brand/{brandId}/list |
| HTTP Method | GET |
| Pagination | Yes Default - 100 |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/{brandId}/list?page=0 &size=10 & ownerType=LOYALTY_PROGRAM & ownerId=abc4
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. |
https://eucrm.cc.capillarytech.com/api_gateway/rewards/core/v1/user/reward/brand/29/list?page=0
&size=10 & ownerType=LOYALTY_PROGRAM & ownerId=abc4
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 |
| 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 |
| 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 |
| 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 | Size of the page |
| number | Integer | Current page number |
{
"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
}
}