get https://{host}/api_gateway/rewards/core/v1/vendor/redemptions
This API is used to retrieve Vendor Redemption details. You can specify either a particular vendor or a reward type to filter the redemption details
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
API Specification
| URI | /api_gateway/rewards/core/v1/vendor/redemptions |
| HTTP Method | GET |
| Pagination | Yes |
| Batch support | No |
| Rate limit information | None |
API endpoint example
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemptions?page=0&size=3&vendorIds=36,32&order=ASC&sortOn=LAST_UPDATED_ON&redemptionType=SWEEPSTAKES
Request query parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| size | Integer | Size of the page |
| page | Integer | The maximum number of results that should be displayed. |
| vendorIds | Integer | A collection of identifiers for vendors associated with the reward. Multiple vendorIds are supported by a comma (","). For example: VendorIds=36,32. There is no specific limit on the number of vendorIds. |
| redemptionType | Enum | Specifies the category of reward redemption available, it indicates how users can redeem the reward. 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. |
| order | Boolean | Order of the results in ascending or descending order. Supported values: ASC, DESC. It can be null. Default is set to ASC. |
| sortOn | Enum | Sorting based on LAST_UPDATED_ON. Supported value: LAST_UPDATED_ON. It can be null. |
https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemptions?page=0&size=3&vendorIds=36,32&order=ASC&sortOn=LAST_UPDATED_ON&redemptionType=SWEEPSTAKES
Response parameters
| Parameter Name | Description |
|---|---|
| status | Contains the status details of the vendor redemption fetch. |
| success | Indicates if the request was successful. |
| code | Status code of the response. |
| message | Message describing the status of the response. |
| redemptionList | List of vendor redemptions fetched in the response. |
| id | Unique ID of the vendor redemption. |
| name | Name of the vendor redemption. |
| enabled | Indicates if the vendor redemption is enabled. |
| responseKeys | responseKeys are the specific details we need from a vendor's response after an API call. For example, if the vendor returns multiple fields like id, status, and code, we only pick the important ones, like code and id, for our use. |
| lastUpdatedOn | Last updated timestamp in epoch. |
| redemptionType | Specifies the category of reward redemption available, using predefined types that indicate how users can redeem the reward. |
| redemptionActionList | List of redemption actions. You can specify redemptionAction using Create Vendor Redemption. |
| pagingDetails | Paging details of the vendor redemption list response. |
{
"status": {
"success": true,
"code": 5011,
"message": "Vendor redemption fetched successfully"
},
"redemptionList": [
{
"id": 1727,
"name": "Vendor Redmeption_1",
"enabled": false,
"responseKeys": [],
"lastUpdatedOn": 1725565005000,
"redemptionType": "MILES",
"redemptionActionList": null
},
{
"id": 1728,
"name": "Vendor Redmeption_2",
"enabled": false,
"responseKeys": [],
"lastUpdatedOn": 1725565005000,
"redemptionType": "MILES",
"redemptionActionList": null
},
{
"id": 1726,
"name": "Vendor Redmeption_3",
"enabled": false,
"responseKeys": [],
"lastUpdatedOn": 1725565218000,
"redemptionType": "MILES",
"redemptionActionList": null
}
],
"pagingDetails": {
"last": false,
"totalElements": 6,
"totalPages": 2,
"numberOfElements": 3,
"first": true,
"size": 3,
"number": 0
}
}
{
"status": {
"success": false,
"code": 8000,
"message": "Unable to fetch as Page number and size is invalid"
},
"redemptionList": null,
"pagingDetails": null
}
{
"status": {
"success": false,
"code": 2110,
"message": "Invalid redemption(reward) type"
},
"redemptionList": null,
"pagingDetails": null
}
API-specific error codes
| Error Code | Description |
|---|---|
| 8000 | Unable to fetch as Page number and size is invalid |
| 2110 | Invalid redemption type |