Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all brand rewards using Brand ID

get/api_gateway/rewards/core/v1/reward/list/brand/{BrandID}?ownerId={ownerId}&ownerType={ownerType}

Path parameters

BrandIdinteger required

Unique identifier of the brand

Query parameters

ownerType'Loyalty program' | 'Milestones' | 'Campaigns' | 'Journeys' | 'Goodwill.'

Module for which the reward was created.

ownerIdstring

Unique identifier of the owner to claim the reward.

sizestring

Results to show per page. Default - 100

pagestring

Allows to retrieve details of a specific page.

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

OR

Example response

{
  "status": {
    "success": true,
    "code": 6101,
    "message": "Reward details fetched successfully"
  },
  "rewardList": [
    {
      "id": 345839,
      "name": "New year tes",
      "startTime": "2025-04-02 10:20:10",
      "startDateTime": "2025-04-02T10:20:10Z",
      "endTime": "2025-04-02 10:25:10",
      "endDateTime": "2025-04-02T10:25:10Z",
      "type": "VOUCHER",
      "priority": 1,
      "enabled": true,
      "redemptionType": "MILES",
      "customFields": {
        "A": "1",
        "CF1233": "1",
        "EnumCF2": "r1",
        "EnumCF1": "white"
      },
      "paymentConfigs": [
        {
          "paymentMode": "FREE",
          "id": 5717
        }
      ],
      "status": "ENDED",
      "vendorRedemptionId": 13417,
      "vendorRedemptionName": "Delta",
      "vendorId": 21,
      "vendorName": "Delta",
      "lastUpdatedOn": 1743667380000,
      "lastUpdatedOnDateTime": "2025-04-03T08:03:00Z",
      "lastUpdatedBy": 75106389,
      "createdBy": 75106389
    }
  ],
  "pagingDto": {
    "totalElements": 759,
    "totalPages": 380,
    "numberOfElements": 2,
    "size": 2,
    "number": 2
  }
}