v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Get Points Ledger Explode info

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

Note: This API returns promotion details and behavioral event metadata (field schema). It does not return custom payload attributes submitted with a behavioral event (such as dollars_to_award or vendor_reference_id). To retrieve those attributes, use GET v2/events/event_data/{userId} instead.

get/pointsLedger/getLedgerExplodeInfo

Query parameters

identifierNamestring required

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

identifierValuestring required

Value of the specified identifier type of the customer

sourcestring 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

eventIdsinteger required

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

accountIdstring

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

getBillDetailsboolean

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

getPointsEarnedBreakupboolean

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

getCustomFieldsboolean

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

getExtendedFieldsboolean

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

getMaxConversionDetailsboolean

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”

getPaymentModestring

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

typestring

Setting this field returns entries for type of user, whether individual customer or a group. Supported values: CUSTOMER, USERGROUP2

isPrimaryUserboolean

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

includeAlternateCurrenciesboolean

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

alternateCurrencyNamesstring

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.

eventNamestring

Name of the event (GenericEvent, TransactionAdd, ReturnBill).

eventReferenceIdsinteger

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

Response

200

Example response

{
  "events": [
    {
      "eventLogId": 549393345,
      "eventName": "TransactionAdd",
      "eventDetails": {
        "eventTime": "2023-08-02 16:24:44.0",
        "tillId": 100004318
      },
      "billDetails": {
        "type": "loyalty",
        "billNumber": "TC300051690458",
        "billAmount": 11691,
        "source": "instore",
        "lineItems": [
          {
            "id": 310201424,
            "itemCode": "243593",
            "source": "instore",
            "amount": 11691,
            "qty": 1,
            "pointsEarned": {
              "regular": [
                {
                  "expiresOn": "2024-08-01 23:59:59.0",
                  "programId": 1000013,
                  "programName": "Croma",
                  "expiryType": "rolling"
                }
              ],
              "promo": [
                {
                  "promotionId": 9418,
                  "promotionName": "Min 5% Drop 2_Croma",
                  "programId": 1000007,
                  "programName": "TataNeu",
                  "expiresOn": "2024-08-01 23:59:59.0",
                  "expiryType": "rolling"
                }
              ]
            }
          }
        ]
      },
      "customFields": [
        {
          "name": "txn_source",
          "value": "tcp"
        }
      ],
      "paymentModes": [
        "Others"
      ],
      "pointInTimeSlabs": [
        {
          "pointInTimeSlabNumber": 1,
          "pointInTimeSlabName": "NONE",
          "programId": 1000007,
          "isDefaultProgram": true
        }
      ]
    }
  ]
}