identifierName*

String

Identifier of the customer. Supported values mobile , id, email and externalid

identifierValue*

Integer

Value for the identifier. For example, the mobile number or customer ID.

source*

String

Source in which the identifier is available. For example,INSTORE, MARTJACK, WECHAT, FACEBOOK, WEB_ENGAGE, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL

eventIds*

String

The list of eventIDs with comma separated values. These are eventLogIds, corresponding to the events in loyalty like TransactionAdd, CustomerRegistration etc.

accountId

String

For a source with multiple accounts, pass the specific accountId in which the customer identifier is available.

getBillDetails

Boolean

Setting this to true will return Bill details like the bill no, amount, discount, line items etc

getPointsEarnedBreakup

Boolean

Setting this to true will return the points breakup details like points category Name, points allocation strategy Name, expiry strategy etc

getCustomFields

Boolean

Setting this value will return the custom fields set up by the brand

getExtendedFields

Boolean

Setting this field will return the extended fields set up by the brand

getMaxConversionDetails

Boolean

Setting this field to true will return the max conversion details which is set for Add Transation, for all line items where delayed accrual is based on fixed or return date, max of all dates is calculated and show in the field name “maxConversionDate”

getPaymentMode

String

Setting this field will show an array of payment modes used ex UPI, CASH etc

type

String

Setting this filed returns entries for type of user, whether individual customer or a group. Only two values are allowed here - CUSTOMER, USERGROUP2

isPrimaryUser

Boolean

Returns entry for the primary member of a group, in case of usergroups.

includeAlternateCurrencies

Boolean

Pass includeAlternateCurrencies=true to retrieve all alternate currencies available with the customer.

alternateCurrencyNames

String

Filter alternate currencies for the customer based on the name. You can also pass a list of comma-separated alternate currency names. Set the parameter includeAlternateCurrencies to false when you use this. If the value is true, includeAlternateCurrencies lists all the available currencies.

eventName

String

Name of the event (GenericEvent, TransactionAdd, ReturnBill). An event refers to any activity performed by a customer, whether in an online store or a physical store.

GenericEvent: A generic event refers to a customizable behavioral event where specific attributes like Customer ID or Product SKU are used to track events.\ TransactionAdd: A transaction add refers to the addition of a new transaction to the system.

eventReferenceIds

Integer

A reference ID is a unique identifier that links to an event.
For TransactionAdd and ReturnBill, the reference ID is the billId of the transaction. For GenericEvent, the reference ID is the unique request ID for the event.

You can add up to ten reference IDs for the specified eventName separated by commas.

Refer to the documentation on getting transaction details and getting event details for more information.