This API is used to retrieve list of rewards owned by them based on filters.
👍
Note
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
The "Get all reward transactions for a user" API lists all reward issuance attempts, including failures, while the "Get Purchased Rewards for user" API shows only the rewards successfully received by the user.
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.
pointsRefIds
String
The pointsRedemptionRefIds filters data based on Points Redemption Reference IDs which enables the users to trace back points redemption. Multiple pointsRefIds can be passed. The limit is 10. The reward with pointsRedemptionRefIds will only be populated when this filter is passed. You get the pointsRedemptionRefIds when you redeem points using Issue Reward. Example:pointsRefIds=4xyMsS,s74PLp.
redemptionType
Enum
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
Enum
Module for which the reward was created. Supported values: Loyalty program, Milestones, Campaigns, Journeys, Goodwill.
ownerId
String
Unique identifier of the owner.
groupName
String
Retrieves rewards associated with a specific group name.
rewardId
Integer
Use the rewardId parameter to filter and return specific reward details.
Descriptive message about the operation's outcome.
rewardTransactionId
Unique identifier for the reward transaction.
rewardIssueRefId
Reference ID associated with the reward issue.
rewardTransactionDate
Date and time of the reward transaction in milliseconds since epoch.
status
Nested object containing the status of the reward issue.
success
Indicates if the reward was issued successfully.
code
Status code for the reward issue transaction.
message
Status message for the reward issue transaction.
rewardDetails
Nested object containing details of the issued reward.
rewardId
Unique identifier of the reward.
languageCode
Language code of the reward details (e.g., "en" for English).
name
Name of the reward.
description
Description of the reward.
termNConditionsId
Unique identifier for the terms and conditions of the reward.
termNConditionsUrl
URL to the terms and conditions of the reward.
imageId
Unique identifier for the image associated with the reward.
imageUrl
URL to the image associated with the reward.
thumbnailId
Unique identifier for the thumbnail image associated with the reward.
thumbnailUrl
URL to the thumbnail image associated with the reward.
enabled
Indicates whether the reward is enabled.
ownerType
Type of the owner associated with the reward transaction.
ownerId
Identifier of the owner associated with the reward transaction.
pointsRedemptionRefIds
A unique identifier generated each time rewards are issued. This field stores a list of these identifiers, allowing you to track multiple points redemption transactions. You have to pass the pointsRefId as a Query param to populate the data of Points Redemption Reference IDs.
fulfillmentStatus
Details about the fulfillment status.
eventDateTime
Date and time when a triggering event (transactional or behavioural) occurred, initiating the reward earning. Time format: UTC time format (YYYY-MM-DDTHH:MM:SSZ).
issueDateTime
Date and time when the reward was awarded to the customer. Time format: UTC time format (YYYY-MM-DDTHH:MM:SSZ).
