Get Points Ledger Explode info

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

The Customer Ledger Explode Info API retrieves additional points ledger info for a customer or user group.

A customer points ledger is essentially a record that tracks the points earned, spent, and adjusted within an organization and its affiliates. These points are treated like currency and can be redeemed across various units or loyalty programs within the organization.

For more information, refer to the documentation on Points Ledgers.

API endpoint example

(https://eucrm.cc.capillarytech.com/v2/pointsLedger/getLedgerExplodeInfo?identifierName=mobile&identifierValue=917406401004&source=INSTORE&eventIds=18608683

With event name and response ID:
https://eu.api.capillarytech.com/v2/pointsLedger/getLedgerExplodeInfo?identifierName=id&identifierValue=1709400643455&source=INSTORE&offset=0&limit=10&eventName=TransactionAdd&eventReferenceIds=37195406289&getBillDetails=true&getCustomFields=true&getPaymentModes=true&getMaxConversionDetails=true

Prerequisites

  • Authentication: Basic or OAuth credentials
  • Access points group resource: Read access to customer points group resource

Resource information

URIv2/pointsLedger/getLedgerExplodeInfo
HTTP MethodGET
PaginationYes
Batch supportNo
Rate limit informationNA

Query parameters

Parameter NameData TypeDescription
Identifier type to identify the customer.StringIdentifier type to identify the customer. Supported values MOBILE , ID, EMAIL, CustomerID, primaryUserId and EXTERNALID
identifierValue*IntegerValue for the identifier. For example, the mobile number or customer ID.
source*StringSource in which the identifier is available. For example, INSTORE, MARTJACK, WECHAT, FACEBOOK , WEB_ENGAGE, , TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL
eventIds\StringThe list of eventLogId with comma separated values. These are eventLogIds, corresponding to the events in loyalty like TransactionAdd, CustomerRegistration etc.
accountIdStringFor a source with multiple accounts, pass the specific accountId in which the customer identifier is available.
getBillDetailsBooleanSetting this to true will return Bill details like the bill no, amount, discount, line items etc
getPointsEarnedBreakupBooleanSetting this to true will return the points breakup details like points category Name, points allocation strategy Name, expiry strategy etc
getCustomFieldsBooleanSetting this value will return the custom fields set up by the brand
getExtendedFieldsBooleanSetting this field will return the extended fields set up by the brand
getMaxConversionDetailsBooleanSetting 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”
getPaymentModesBooleanSetting this field will show an array of payment modes used ex UPI, CASH etc
typeStringSetting this filed returns entries for type of user, whether individual customer or a group. Only two values are allowed here - CUSTOMER, USERGROUP2
isPrimaryUserBooleanReturns entry for the primary member of a group, in case of usergroups.
includeAlternateCurrenciesBooleanPass includeAlternateCurrencies=true to retrieve all alternate currencies available with the customer.
alternateCurrencyNamesStringFilter 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.
eventNameStringName of the event. Supports both Behavioural and Transaction events.
eventReferenceIdsIntegerReference ID for the event.
For a transactional event, the reference ID is the billId of the transaction.
For a behavioral event, 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 behavioral event details for more information on getting reference IDs for an event.

Sample Response

{
    "events": [
        {
            "eventLogId": 30527930,
            "eventName": "TargetCompleted",
            "eventDetails": {
                "eventTime": "2024-10-25 22:59:12.0",
                "tillId": 50137565
            },
            "targetCompletedDetails": {
                "targetGroupID": 46750,
                "targetGroupName": "TGName",
                "targetId": 76041,
                "targetName": "TName",
                "targetDescription": "TDescription",
                "targetPeriodID": 66277,
                "targetPeriodName": "Cycle_4",
                "targetValue": "1000.000",
                "achievedValue": "1200.000",
                "sourceId": 641554,
                "sourceType": "USERTARGET",
                "pointsEarned": {
                    "promo": [
                        {
                            "promotionId": 1133572888,
                            "promotionName": "Progname",
                            "programId": 1933,
                            "programName": "DefaultProgram",
                            "value": 100.0,
                            "expiresOn": "2025-10-31 23:59:59.0",
                            "expiryType": "fixed"
                        }
                    ],
                    "promised": []
                }
            },
            "eventReferenceId": "263985",
            "uniqueId": "71730c8b628d0978e21e5e374f50fae606779fd412"
        },
        {
            "eventLogId": 30527931,
            "eventName": "TargetCompleted",
            "eventDetails": {
                "eventTime": "2024-10-25 22:59:12.0",
                "tillId": 50137565
            },
            "targetCompletedDetails": {
                "targetGroupID": 46750,
                "targetGroupName": "TGName1",
                "targetId": 76041,
                "targetName": "TName1",
                "targetDescription": "TDesc1",
                "targetPeriodID": 66277,
                "targetPeriodName": "Cycle_4",
                "triggerValue": "300.000",
                "sourceId": 78104,
                "sourceType": "MILESTONE",
                "pointsEarned": {
                    "promo": [
                        {
                            "promotionId": 1133572888,
                            "promotionName": "Promoname",
                            "programId": 1933,
                            "programName": "Progname",
                            "value": 100.0,
                            "expiresOn": "2025-10-31 23:59:59.0",
                            "expiryType": "fixed"
                        }
                    ],
                    "promised": []
                },
                "mileStoneName": "Sub target 1"
            },
            "eventReferenceId": "263986",
            "uniqueId": "88248bc99f945f1778f85af7c6ba69e4b90651c6"
        },
        {
            "eventLogId": 30527932,
            "eventName": "TargetCompleted",
            "eventDetails": {
                "eventTime": "2024-10-25 22:59:12.0",
                "tillId": 50137565
            },
            "targetCompletedDetails": {
                "targetGroupID": 46750,
                "targetGroupName": "TGName1",
                "targetId": 76041,
                "targetName": "TName1",
                "targetDescription": "TDesc1",
                "targetPeriodID": 66277,
                "targetPeriodName": "Cycle_4",
                "triggerValue": "600.000",
                "sourceId": 78104,
                "sourceType": "MILESTONE",
                "pointsEarned": {
                    "promo": [
                        {
                            "promotionId": 1133572888,
                            "promotionName": "Promoname",
                            "programId": 1933,
                            "programName": "Progname",
                            "value": 100.0,
                            "expiresOn": "2025-10-31 23:59:59.0",
                            "expiryType": "fixed"
                        }
                    ],
                    "promised": []
                },
                "mileStoneName": "Sub target 2"
            },
            "eventReferenceId": "263987",
            "uniqueId": "7470f2457563461f66bc1aasgf1760d8ga71ec3ee0174c267"
        }
    ],
    "warnings": []
}
{
    "events": [
        {
            "eventLogId": 27909380,
            "eventName": "CustomerRegistration",
             “eventReferenceIds“:{RefId1},
            "eventDetails": {
                "eventTime": "2024-01-18 17:18:00.0",
                "tillId": 50697469
            },
            "pointsEarned": {
                "regular": [],
                "promo": [],
                "promised": []
            }
        },

{
            "eventLogId": 27909380,
            "eventName": "CustomerRegistration",
             “eventReferenceIds“:{RefId2},
            "eventDetails": {
                "eventTime": "2024-01-18 17:18:00.0",
                "tillId": 50697469
            },
            "pointsEarned": {
                "regular": [],
                "promo": [],
                "promised": []
            }
        }
    ],
    "warnings": []
}

Response Parameters

Parameter NameTypeDescription
eventLogIdIntegerA unique identifier for the event.
eventNameStringThe name of the event, in this case, "GenericEvent".
eventDetailsObjectContains details about the event.
- eventDisplayNameStringDisplay name of the event, e.g., "CupSeries2024".
- tillIdIntegerID of the till where the event was recorded.
- displayNameStringName to display for the event, e.g., "CUP SERIES CHECK-IN".
- redemptionDetailsArrayIncludes the details related to the redemption of points.
- - pointsRedeemedStringThe number of points that were redeemed in the transaction.
- - redemptionPurposeStringPurpose of points redemption.
- - transactionNumberStringThe transaction/bill number associated with the points redemption.
- - redemptionIdStringA unique identifier for the redemption transaction.
targetCompletedDetailsArrayObject containing details of a completed target.
- targetGroupIDStringThe unique group ID of the target.
- targetGroupNameStringThe unique name of the target group.
- targetIdIntegerThe unique ID of the target.
- targetNameStringThe unique name of the target.
- targetDescriptionStringDescription of the target (if added).
- targetPeriodIDIntegerThe unique ID of the target period.
- targetPeriodNameStringThe unique name of the target period.
- sourceIdIntegerThe unique ID of the target source.
- sourceTypeStringThe type of source (MILESTONE, STREAKS, UNIFIED).
pointsEarnedObjectContains details of points earned in the event.
- regularArrayArray of regular points earned (empty in this case).
- promoArrayArray of promotional points earned during the event.
- - promotionIdIntegerThe ID of the promotion, e.g., 8166.
- - promotionNameStringThe name of the promotion, e.g., "CupSeriesatClashColiseumBuschLightTrack_4Feb-5Feb".
- - programIdIntegerThe ID of the loyalty program associated with the promotion, e.g., 1155.
- - programNameStringThe name of the loyalty program, e.g., "NASCAR LoyaltyDefaultProgram".
- - valueFloatThe value of the points earned from the promotion, e.g., 200.0.
- - promotionStartDateStringThe start date of the promotion, e.g., "2024-02-04 00:00:00.0".
- - promotionEndDateStringThe end date of the promotion, e.g., "2024-03-05 23:59:59.0".
- - promisedArrayArray of promised points (empty in this case).
behavioralEventMetadataObjectMetadata about the behavioral event associated with the check-in.
- labelStringThe label for the behavioral event, e.g., "CUP SERIES CHECK-IN".
- fieldsArrayAn array of fields related to the event's metadata.
- - fieldNameStringThe name of the field, e.g., "activity_date".
- - fieldTypeStringThe type of the field, e.g., "DATE".
- attributes.isRequired.valueTypeStringThe type of value for the isRequired attribute for the event, e.g., "BOOLEAN". This is configured during the creation of the event.
- attributes.isRequired.valueStringThe value indicating if the field is required, e.g., "false".
- isUniqueKeyField.valueTypeStringThe type of value for the isUniqueKeyField attribute, e.g., "BOOLEAN". This is configured during the creation of the event.
- isUniqueKeyField.valueStringThe value indicating if the field is a unique key, e.g., "false".
eventReferenceIdStringThe event request ID. This is generated when the event is sent. This helps to trace the event.
uniqueIdStringA unique identifier for this specific event instance, e.g., "70375599-a144-4065-8db5-a6abd061ddf7". This can be the same as requestId or a hash of the payload when the isUniqueKeyField is enabled.
billDetailsArrayIncludes the following information: type (type of transaction), bill number (unique transaction number), gross amount, discount, bill amount, note, source, bill date (time in ISO 8601 format), and points earned details.
warningsArrayWarnings, if any.

API specific errors

Error CodeDescription
9022Event reference IDs are invalid
11014Event name not found
11023Valid identifiers not found
11012Invalid userId passed in request
Language
Authorization
Basic
base64
:
URL
Click Try It! to start a request and see the response here!