v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get all reward transactions for a user in connected orgs

This API is used to retrieve reward transactions for a user using filters.

get/api_gateway/rewards/core/v1.1/reward-transactions?customerId={customerId}

Query parameters

customerIdstring required

Unique identifier of the customer.

pageinteger

Retrieve information for a specific page. Set the page value to 0 to disable pagination. Example: page=2&size=10 retrieves 10 results from page 2.

sizeinteger

Number of results to display per page. Default value is 10. Maximum supported value is 50.

statusboolean

Filter the reward transactions based on status of the issued reward. Set status=true to view successful transactions and status=false to view failed transactions. Successful transactions are the ones where the reward was issued whereas failed transactions are ones where the reward was not issued. If this parameter is not applied, the response by default gives both successful and failed transactions.

redemptionType''

Retrieves rewards based on their redemption type. Reward redemption is when a customer uses their points/ cash to redeem a reward. Supported values: GAMES, AUCTION, CART_PROMOTION, CASH_WALLET, VENDOR_ONLY_REWARD, VOUCHER, CASH_BACK, INTOUCH_REWARD, PHYSICAL_REWARD, CHARITY, MILES, GIFT_CARD, SWEEPSTAKES, VENDOR_INTOUCH_REWARD, CARD_DISC. Use comma separated values to retrieve reward details for multiple redemption types. Example: INTOUCH_REWARD, MILES The values are case sensitive. This parameter fetches both, failed and successful reward issue transactions. To filter successful transactions for a specific redemption type, set status=true.

ownerType''

Module for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.

ownerIdstring

Unique identifier of the owner.

groupNamestring

Retrieves rewards associated with a specific group name.

Headers

DATA-SCOPE-ORGstring

List of Organization IDs

DATA-SCOPEstring

Scopes define what data can be accessed using the API. You can use scopes to control access to data from a parent or child organization. Defining a scope ensures that the response contains only data from the respective organization. Supported headers: SELF, OTHER and ALL.

Response

200

Example response

{
  "status": {
    "success": true,
    "code": 200,
    "message": "Reward issue transactions fetched successfully"
  },
  "rewardIssueTransactions": [
    {
      "rewardTransactionId": "321583",
      "rewardIssueRefId": "transactionNumber",
      "rewardTransactionDate": 1736755804000,
      "status": {
        "code": 8004,
        "message": "fail to issue reward as  points are not redeemable"
      },
      "rewardDetails": {
        "rewardId": 299166,
        "languageCode": "en",
        "name": "PointsRewardTest",
        "description": "test",
        "enabled": true
      },
      "orgId": 100737,
      "redemptionType": "INTOUCH_REWARD"
    }
  ],
  "pagingDto": {
    "last": true,
    "totalElements": 9,
    "totalPages": 1,
    "numberOfElements": 9,
    "first": true,
    "size": 10
  }
}