v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get available brand rewards

get/api_gateway/rewards/core/v1/reward/brand/{Brand ID}/available?startDate={YYYY-MM-DDTHH:MMZ}&endDate={YYYY-MM-DDTHH:MMZ}

Path parameters

brandIdinteger required

Unique identifier of the brand.

Query parameters

startDatestring required

endDatestring required

language''

Filters the response based on the reward language. Use this parameter to retrieve rewards in a specific language. For example, to display rewards in English, set the parameter to en

Response

200

Example response

{
  "status": {
    "success": true,
    "code": 6101,
    "message": "Reward details fetched successfully"
  },
  "rewardList": [
    {
      "id": 4,
      "name": "10% off on clothing",
      "status": "ENDED",
      "startTime": "2021-05-10 18:45:14",
      "endTime": "2021-05-10 18:45:14",
      "type": "VOUCHER",
      "priority": 1,
      "intouchPoints": 100,
      "redemptionType": "INTOUCH_REWARD"
    }
  ]
}