Get Loyalty Promotions List for a Customer

get

https://{host}/v2/customers/lookup/promotionData

Retrieve promotion data of a specific customer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

identifierName

string

required

Identifier type to identify the customer.

identifierValue

string

required

Value of the identifier.

source

string

required

Specifies the source from where customer details are retrieved.

limit

string

Number of results that need to be displayed. The values from zero to a maximum of 100 are supported.

offset

string

Start index for data retrieval. This value should not be negative.

programs

string

Comma separated list of program ids

sourceType

string

enum

Pass any one values among UI, API, CAMPAIGN , if want to filter promotion data based on its source type

Allowed:

promotionType

string

enum

Specify the type of the promotions Supported values: GENERIC, DIRECT_ISSUE, ENROL_AND_ISSUE

Allowed:

promotionStatusForCustomer

string

Provides information about customer enrollment and issuances in the promotion. Supported values are:- AVAILABLE_TO_ENROL:- Promotions of the "Enrol & Issue" type that customers can still enroll in. AVAILABLE_TO_EARN:- Promotions the customer is eligible to earn, including "Direct Issue" promotions and "Enrol & Issue" promotions where the customer is already enrolled. AVAILABLE_TO_REDEEM:- Active promotions that the customer can currently redeem (get benefits) across all types of promotionns including "Enrol & Issue", "Direct Issue" and "Available to Issue" EXPIRED:- Promotions that have expired, i.e. promotion's end date is in past.

fetchAllUsage

boolean

Defaults to false

Set to true to fetch details of all redemption restrictions. If a restriction is not enabled and fetchAllUsage=true, the maxLimit value is -1 for that restriction.

Responses

200200

400400