Sign in

v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Purchased Rewards for User in Connected Orgs

get/v1.1/user/user_rewards?username={tillid}&mobile={mobile}

Query parameters

mobile/email/externalIdstring

Mobile number/email/externalId of the customer to fetch rewards.

usernamestring

till id used in the authorization of the request

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

orderBy''

Pass asc to order the results in ascending order of sortBy value, desc to order in descending order.

sortBy'"createdOn" "rewardId"'

Sort the results by a specific parameter. Possible Value (column names in User Rewards table) : "createdOn" "rewardId"

pageinteger

To retrieve details of a specific page. Pass 0 to not apply pagination. For example, page=2&size=10 shows 10 results of page 2.

sizeinteger

Results to show per page. Default - 100

typeOfReward'Intouch_Reward' | 'Vendor_Intouch_Reward' | 'Vendor_Only_Reward' | 'Cart_Promotion'

filter to be used to fetch specific type of rewards instead of all, possible values:- Intouch_Reward, Vendor_Intouch_Reward, Vendor_Only_Reward, Cart_Promotion

fromPurchaseDateinteger

filter to be used to fetch rewards by fetching the info based on given inputs like fromPurchaseDate and toPurchaseDate which can serve multiple purpose like Filter rewards by Purchase date : Last 30 days ( from → last 30 days date, to-> todays date in epoch time)

toPurchaseDateinteger

filter to be used to fetch rewards by fetching the info based on given inputs like fromPurchaseDate and toPurchaseDate which can serve multiple purpose like Filter rewards by Purchase date : Last 30 days ( from → last 30 days date, to-> todays date in epoch time)

Response

200

OR
OR
OR
OR

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "User Reward fetched successfully"
  },
  "rewards": [
    {
      "typeOfReward": "INTOUCH_REWARD",
      "pointsRedeemed": 1000,
      "rewardId": 154444,
      "transactionId": 232254,
      "issueRewardRefId": "TX2262531",
      "rewardIssueDate": 1723525599000,
      "userRewardExpiry": "2035-04-30 00:00:00",
      "userRewardDetails": {
        "id": 154444,
        "name": "50% off on planet fitness subscription",
        "description": "Burn 1000 points and get 50% off on planet fitness subscription",
        "imageId": "733aa751-6772-40a4-a3a1-38e64178410d",
        "imageUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/3b4d33c3-230e-446f-b987-cae428a6.jpg",
        "thumbnailId": "c11743a8-f353-4449-8242-1af679840a31",
        "thumbnailUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/e7391686-2952-4c92-ad61-9684e938.jpg",
        "termAndConditionsId": "fe4a03ef-8749-45ae-9c28-59e4dc066eff",
        "termAndConditionsUrl": "https://eucrm-solutions.s3.amazonaws.com/rewards/a7862c4c-1545-4d43-a696-8094402.html",
        "priority": 1,
        "intouchPoints": 1000,
        "group": "Health",
        "startTime": "2024-04-17 12:54:00",
        "endTime": "2030-10-31 11:59:30",
        "categoryList": [
          {
            "id": 20,
            "name": "groceries",
            "enabled": true
          }
        ],
        "groups": [
          {
            "groupName": "Recommended Rewards"
          }
        ],
        "rewardRank": 4
      },
      "code": "C1TH8O7S",
      "seriesId": "16745"
    }
  ],
  "intouchUserId": "62090013",
  "pagingDto": {
    "last": true,
    "totalElements": 5,
    "totalPages": 1,
    "numberOfElements": 5,
    "size": 5,
    "number": 5
  },
  "orgLevelRestrictions": [
    {
      "isValid": true,
      "orgId": 4000084
    }
  ]
}