Get all reward transactions for a user in connected orgs

get

https://{host}/api_gateway/rewards/core/v1.1/reward-transactions?customerId={customerId}

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

Query Params

customerId

string

required

Unique identifier of the customer.

page

int32

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.

size

int64

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

status

boolean

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

string

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.

Allowed:

ownerType

string

enum

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

Allowed:

ownerId

string

Unique identifier of the owner.

groupName

string

Retrieves rewards associated with a specific group name.

Headers

DATA-SCOPE-ORG

string

List of Organization IDs

DATA-SCOPE

string

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.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200200

400400