API Documentation
Start typing to search…

Vendor Redemption Details by Brand ID and Vendor ID

get
https://{host}/api_gateway/rewards/core/v1/vendor//redemption/brand/

This API endpoint retrieves the details of a specific vendor redemption associated with a specific vendor and brand ID.

Example request

curl --location 'https://eu.api.capillarytech.com/api_gateway/rewards/core/v1/vendor/430/redemption/brand/61?orderBy=DESC&sortBy=lastUpdatedOn' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--header 'Authorization: Basic bWFkaHVfcU2YQ==' \
--header 'Cookie: _cfuvid=RDRytk3yV2h_eZZyhcNDJzrxSX7MWQFapynbiotOD28-1764241859312-0.0.1.1-604800000'

Path Parameters

Parameter NameData TypeDescription
vendorIdLongUnique identifier for the vendor whose redemption details are being requested.
brandIdLongUnique identifier for the brand associated with the vendor redemption.

Request Query Parameters

Parameter NameData TypeDescription
sizeIntegerSpecifies the number of results to return per page. Used for pagination.
pageIntegerIndicates the page number to retrieve. Used with size to paginate results.
orderByStringSort order of the results. Supported values: ASC, DESC. Default value is DESC.
sortByEnumField to sort results by. Supported value: LAST_UPDATED_ON.

Example response

{
    "status": {
        "success": true,
        "code": 5011,
        "message": "Vendor redemption fetched successfully"
    },
    "redemptionList": [
        {
            "id": 34443,
            "name": "UAT Vendor Redemption 6 update 1",
            "redemptionType": "MILES",
            "enabled": true,
            "lastUpdatedOn": 1764157003000,
            "lastUpdatedOnDateTime": "2025-11-26T11:36:43Z",
            "actionCount": 77,
            "createdBy": 75155297,
            "lastUpdatedBy": 75197372,
            "createdOn": 1759749421000,
            "createdOnDateTime": "2025-10-06T11:17:01Z"
        },
        {
            "id": 36988,
            "name": "UAT Vendor Redemption 6",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1764153802000,
            "lastUpdatedOnDateTime": "2025-11-26T10:43:22Z",
            "actionCount": 1,
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764153802000,
            "createdOnDateTime": "2025-11-26T10:43:22Z"
        },
        {
            "id": 36987,
            "name": "UAT Vendor Redemption 6",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1764153001000,
            "lastUpdatedOnDateTime": "2025-11-26T10:30:01Z",
            "actionCount": 1,
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764153001000,
            "createdOnDateTime": "2025-11-26T10:30:01Z"
        },
        {
            "id": 36986,
            "name": "UAT Vendor Redemption 6",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1764152638000,
            "lastUpdatedOnDateTime": "2025-11-26T10:23:58Z",
            "actionCount": 1,
            "createdBy": 75197372,
            "lastUpdatedBy": 75197372,
            "createdOn": 1764152638000,
            "createdOnDateTime": "2025-11-26T10:23:58Z"
        },
        {
            "id": 34444,
            "name": "UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Redemption 6 UAT Vendor Rede",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759750121000,
            "lastUpdatedOnDateTime": "2025-10-06T11:28:41Z",
            "actionCount": 0,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759750121000,
            "createdOnDateTime": "2025-10-06T11:28:41Z"
        },
        {
            "id": 34442,
            "name": "UAT Vendor Redemption 6",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759749265000,
            "lastUpdatedOnDateTime": "2025-10-06T11:14:25Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759749265000,
            "createdOnDateTime": "2025-10-06T11:14:25Z"
        },
        {
            "id": 34437,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759741624000,
            "lastUpdatedOnDateTime": "2025-10-06T09:07:04Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741624000,
            "createdOnDateTime": "2025-10-06T09:07:04Z"
        },
        {
            "id": 34436,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759741612000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:52Z",
            "actionCount": 0,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741612000,
            "createdOnDateTime": "2025-10-06T09:06:52Z"
        },
        {
            "id": 34435,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759741603000,
            "lastUpdatedOnDateTime": "2025-10-06T09:06:43Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741603000,
            "createdOnDateTime": "2025-10-06T09:06:43Z"
        },
        {
            "id": 34432,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759741307000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:47Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741307000,
            "createdOnDateTime": "2025-10-06T09:01:47Z"
        },
        {
            "id": 34431,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759741297000,
            "lastUpdatedOnDateTime": "2025-10-06T09:01:37Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759741297000,
            "createdOnDateTime": "2025-10-06T09:01:37Z"
        },
        {
            "id": 34430,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759740876000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:36Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740876000,
            "createdOnDateTime": "2025-10-06T08:54:36Z"
        },
        {
            "id": 34429,
            "name": "UAT Vendor Redemption 5",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759740863000,
            "lastUpdatedOnDateTime": "2025-10-06T08:54:23Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740863000,
            "createdOnDateTime": "2025-10-06T08:54:23Z"
        },
        {
            "id": 34428,
            "name": "UAT Vendor Redemption 4",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759740733000,
            "lastUpdatedOnDateTime": "2025-10-06T08:52:13Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740733000,
            "createdOnDateTime": "2025-10-06T08:52:13Z"
        },
        {
            "id": 34427,
            "name": "UAT Vendor Redemption 3",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759740368000,
            "lastUpdatedOnDateTime": "2025-10-06T08:46:08Z",
            "actionCount": 3,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740368000,
            "createdOnDateTime": "2025-10-06T08:46:08Z"
        },
        {
            "id": 34426,
            "name": "UAT Vendor Redemption 2",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759740082000,
            "lastUpdatedOnDateTime": "2025-10-06T08:41:22Z",
            "actionCount": 0,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759740082000,
            "createdOnDateTime": "2025-10-06T08:41:22Z"
        },
        {
            "id": 34421,
            "name": "UAT Vendor Redemption 1",
            "redemptionType": "INTOUCH_REWARD",
            "enabled": true,
            "lastUpdatedOn": 1759733970000,
            "lastUpdatedOnDateTime": "2025-10-06T06:59:30Z",
            "actionCount": 1,
            "createdBy": 75155297,
            "lastUpdatedBy": 75155297,
            "createdOn": 1759733970000,
            "createdOnDateTime": "2025-10-06T06:59:30Z"
        }
    ]
}

Response Parameters

Parameter NameData TypeDescription
statusObjectContains the status details of the vendor redemption.
successBooleanIndicates if the request was successful.
codeIntegerStatus code of the response.
messageStringMessage describing the status of the response.
redemptionListArrayList of vendor redemptions.
idLongUnique ID of the vendor redemption.
nameStringName of the vendor redemption.
redemptionTypeStringType of redemption (e.g. MILES).
enabledBooleanIndicates if the vendor redemption is enabled.
lastUpdatedOnLongIndicates the timestamp when the vendor redemption was updated. The timestamp is in Epoch time format.
lastUpdatedOnDateTimeStringIndicates the date and time when the vendor redemption was updated, formatted in ISO 8601
actionCountIntegerNumber of actions configured for this redemption setup.
createdByLongThe unique identifier of the user who created the vendor redemption.
lastUpdatedByLongThe unique identifier of the user who last updated the vendor redemption record.
createdOnDateTimeStringIndicates the date and time when the vendor redemption was created, formatted in ISO 8601.
createdOnLongIndicates the timestamp when the vendor redemption was created. The timestamp is in Epoch time format.

Response Codes

CodeMessageDescription
5011Vendor redemption fetched successfullyRedemption configurations were retrieved.
400Bad RequestRequest is malformed or missing required parameters.
401UnauthorizedInvalid or missing authentication credentials.
404Not FoundVendor or brand not found.
500Internal Server ErrorAn error occurred on the server.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!