Get Points Ledger Explode Info

get

https://{host}/v2/pointsLedger/getLedgerExplodeInfo

Retrieves the points ledger explode info for customer/ user group.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

identifierName

string

required

Identifier type to identify the customer. The allowed values are = email, mobile, cuid, externalId, id, primaryUserId

identifierValue

string

required

Value of the specified identifier type of the customer

source

string

required

Source in which the identifier is available. The allowed values are = INSTORE, MARTJACK, WECHAT, FACEBOOK, WEB_ENG,TMALL,TAOBAO,JD, ECOMMERCE, WEBSITE,LINE,ALL

eventIds

integer

required

The list of eventId’s 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 txn, 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 field returns entries for type of user, whether individual customer or a group. Supported values: 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).

eventReferenceIds

int32

A reference ID is a unique identifier that links to an event.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200200