Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all vendor redemptions

get/api_gateway/rewards/core/v1/vendor/redemptions

Query parameters

pageinteger

Specify the number of page you want to view.

sizeinteger

Specifies the size of page

vendorIdsinteger

Unique ID of Vendor.

redemptionType''

Type of reward redemption .

orderstring

Specifies the order in which you want to view the list.

sortOnstring

Filter used to sort the list.

Response

200

OR
OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 5011,
    "message": "Vendor redemption fetched successfully"
  },
  "redemptionList": [
    {
      "id": 27802,
      "name": "jotest",
      "enabled": true,
      "responseKeys": [
        "voucher"
      ],
      "lastUpdatedOn": 1748344737000,
      "lastUpdatedOnDateTime": "2025-05-27T11:18:57Z",
      "redemptionType": "VOUCHER",
      "vendorId": 133,
      "vendorName": "VENDORHIRE",
      "createdBy": 75161973,
      "lastUpdatedBy": 75161973,
      "createdOn": 1748344737000,
      "createdOnDateTime": "2025-05-27T11:18:57Z",
      "redemptionActionList": [
        {
          "id": 22310,
          "name": "add good will points",
          "enabled": true,
          "apiType": "POST",
          "apiUrl": "https://crm-nightly-new.cc.capillarytech.com/v1.1/request/add?program_id=2851",
          "apiHeaders": {
            "Authorization": "Basic bHVjaWF1dG9fdGlsbF8xMDoyMDJjYjk2MmFjNTkwNzViOTY0YjA3MTUyZDIzNGI3MA==",
            "accept": "application/json",
            "Content-Type": "application/json"
          },
          "apiBody": "{\"customFields_property\": {\"customField_1_property\": \"${customfield_CF1}\"}, \"transactionId_property\": \"${rewardTransactionId}\", \"fulfillmentStatus_property\": \"${fulfillmentStatus}\"}",
          "execOrder": 1,
          "contextKeys": {
            "voucher": "response.requests.request.get(0).id"
          }
        }
      ]
    }
  ],
  "pagingDetails": {
    "last": true,
    "totalElements": 8,
    "totalPages": 1,
    "numberOfElements": 8,
    "first": true,
    "size": 50
  }
}