Get Vendor Redemptions details

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 MethodGET
PaginationYes
Batch supportNo
Rate limit informationNone

API endpoint example

https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/redemptions?page=0&size=3&vendorId=3&rewardType=MILES&order=ASC&sortOn=LAST_UPDATED_ON

Request query parameters

Parameter NameData TypeDescription
sizeIntegerSize of the page
pageIntegerThe maximum number of results that should be displayed.
vendorIdIntegerUnique ID of Vendor. You can get the vendorId from Marvel Rewards UI.
rewardTypeEnumSpecifies 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.
orderBooleanOrder of the results in ascending or descending order. Supported values: ASC, DESC. It can be null. Default is set to ASC.
sortOnEnumSorting 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&vendorId=3&rewardType=MILES&order=ASC&sortOn=LAST_UPDATED_ON

Response parameters

Parameter NameDescription
statusContains the status details of the vendor redemption fetch.
successIndicates if the request was successful.
codeStatus code of the response.
messageMessage describing the status of the response.
redemptionListList of vendor redemptions fetched in the response.
idUnique ID of the vendor redemption.
nameName of the vendor redemption.
enabledIndicates if the vendor redemption is enabled.
responseKeysresponseKeys 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.
lastUpdatedOnLast updated timestamp in epoch.
redemptionTypeSpecifies the category of reward redemption available, using predefined types that indicate how users can redeem the reward.
redemptionActionListList of redemption actions. You can specify redemptionAction using Create Vendor Redemption.
pagingDetailsPaging 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 CodeDescription
8000Unable to fetch as Page number and size is invalid
2110Invalid redemption type
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!