Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get rewards for user

get/api_gateway/rewards/core/v1/user/reward/brand/{BrandName}?userId={userID}

Path parameters

BrandNamestring required

Name of the brand.

Query parameters

userIdstring

User ID of the customer

groupNamestring

Enter the group name to fetch all the rewards associated with the group.

Response

200

OR
OR
OR
OR
OR
OR
OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "User Reward fetched successfully"
  },
  "rewardList": [
    {
      "id": 367568,
      "name": "jogoldnamechange check",
      "description": "testreward1",
      "intouchPoints": 500,
      "startTime": "2025-01-26 20:00:00",
      "startDateTime": "2025-01-26T20:00:00Z",
      "endTime": "2026-10-31 11:59:30",
      "endDateTime": "2026-10-31T11:59:30Z",
      "started": true,
      "enabled": true,
      "categoryList": [
        {
          "id": 229,
          "name": "joreward",
          "enabled": true
        }
      ],
      "status": "LIVE",
      "redemptionType": "VOUCHER",
      "rewardRestrictions": {
        "isValid": true
      },
      "paymentConfigs": [
        {
          "paymentMode": "POINTS",
          "id": 6930,
          "points": 300
        }
      ]
    }
  ],
  "pagingDto": {
    "last": true,
    "totalElements": 134,
    "totalPages": 1,
    "numberOfElements": 134,
    "first": true,
    "size": 134
  },
  "orgLevelRestrictions": {
    "isValid": true,
    "customerRedemptionTypeLevel": [
      {
        "rewardConstraintId": 29700,
        "orgId": 100737,
        "kpi": "POINTS",
        "constraintLevel": "CUSTOMER_REDEMPTION_TYPE",
        "frequencyType": "DAILY",
        "constraintLimitValue": 15,
        "isActive": true,
        "intervalValue": 1,
        "isValid": true,
        "redemptionType": "POINTS"
      }
    ]
  }
}