get https://{host}/v2/pointsLedger/getCustomerLedgerInfo
Retrieves the points ledger records of a customer, usergroup or alternate currencies for each event.
For detailed information about our APIs and for hands-on testing, refer documentation in API overview and step-by-step guide on making your first API call in Make your first API call .
Prerequisites
- Make sure you have access to the Points access group resource. For more information, see access group documentation.
API Specification
| HTTP Method | GET |
| Pagination | Yes |
| Batch support | No |
| Rate limit information | Refer to rate limit documentation . |
API endpoint example
- Retrieve points ledger entries of a User group -
/v2/pointsLedger/getCustomerLedgerInfo?type=USERGROUP2&identifierName=id&identifierValue=381335652&source=INSTORE&offset=0&limit=10&sortOrder=ASC - Retrieve points ledger entries of a customer -
v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=98662653&source=INSTORE&limit=10 - Retrieve points ledger entries of Alternate Currencies for a customer-
/v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=423725119&source=INSTORE&includeAlternateCurrencies=trueor/v2/pointsLedger/getCustomerLedgerInfo?identifierName=id&identifierValue=423725119&source=INSTORE&alternateCurrencyNames=acNjnkvfgfdeun
Query parameters (Customer)
You can use the below query parameters and retrieve points ledger entries of a customer.
| Parameter (Parameters marked with * sign are mandatory) | Data Type | Description |
|---|---|---|
| identifierName* | Enum | Identifier type to identify the customer. (id, email, mobile, externalId) |
| identifierValue* | String | Value of the specified identifier type of the customer. |
| source* | Enum | The source of the customer's registration. Supported values: FACEBOOK, WEB_ENGAGE, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. |
| accountId* | String | For sources with multiple accounts, pass the specific accountId to retrieve the ledger information. |
| tillId | String | Get the customer’s ledger information from a specific till. |
| limit | Integer | Number of ledger records to display per page. For example, if the total records are fifteen and the limit is five, the first page will display the first five records only. The maximum supported limit is 100. |
| offset | Integer | Page number to retrieve. To view the first page, set the value to 0. |
| programId | Integer | Retrieve the ledger details of a specific program. |
| isFilterBasedOnDate | Boolean | Indicates whether the date filter should be applied when fetching data from the database. When the start date and end date are not passed in the API request parameters, the value is false and the API fetches the user’s entire past purchase history. Default value: True |
| includeLastOneYearData | Booolean | If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days when only startDate or endDate is passed in the API query parameter.Default value: False |
| startDate | String | Get ledger information from a specific date range. Format: YYYY-MM-DDThh:mm:ss.Notes: - The maximum difference between startDate and endDate should not exceed 90 days.- If only startDate or endDate is passed in the API query parameter, the ledger data for 90 days is retrieved based on the provided startDate or endDate.- If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days.- When the start date and end date are not passed in the API request parameters, the value of isFilterBasedOnDate is false and the API fetches the user’s entire past purchase history. |
| endDate | String | Get ledger information till a specific date range. Format: YYYY-MM-DDThh:mm:ss.Notes: - The maximum difference between startDate and endDate should not exceed 90 days.- If only startDate or endDate is passed in the API query parameter, the ledger data for 90 days is retrieved based on the provided startDate or endDate.- If includeLastOneYearData is set to true, the API response will include data from the last year instead of the last 90 days.- When the start date and end date are not passed in the API request parameters, the value of isFilterBasedOnDate is false and the API fetches the user’s entire past purchase history. |
| includeTillConceptEvents | Boolean | Pass true to fetch deduction entries that were triggered at the tills mapped to the Concept of the Program ID even if the deductions are from a different program. Default value is false. When true, pass the programId also, else it will be qualified as invalid input combination. |
| ledgerEntryType | Enum | Specify the type of ledger entries you want to fetch. Supported values: CREDIT, DEBIT, OPENING_BALANCE. If not defined, all ledger entry types are fetched. |
| pointCategoryType | Enum | Specify the point category type for which you want to fetch ledger details. Supported values: REGULAR, PROMISED, TRIGGER_BASED. If not defined, all point category types are fetched. |
| includeAlternateCurrencies | Boolean | Set includeAlternateCurrencies=true to retrieve all alternate currencies available with the customer. |
| alternateCurrencyNames | Boolean | 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. |
| excludePointCategories | Boolean | You can use this parameter with includeAlternateCurrencies=true to include ledger records only with respect to alternate currencies. Refer to the behaviour of alternate currency and point category parameters section for more information. |
Query parameters (User Group)
You can use the below query parameters and retrieve points ledger entries of a usergroup.
| Parameter (Parameters marked with * sign are mandatory) | Data Type | Description |
|---|---|---|
| type | Enum | Type of user group entity. Supported values USERGROUP2 and FLEET |
| identifierName* | Enum | The identifier of the group to search for the ledger information. The following identifiers are applicable: groupId, externalId, and primaryUserId |
| identifierValue* | String | Value of the specified identifier type of the user group. |
| source* | Enum | The source of the user group's registration. Supported values: FACEBOOK, WEB_ENGAGE, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. |
| limit | Integer | Number of ledger records to display per page. For example, if the total records are fifteen and the limit is five, the first page will display the first five records only. The maximum supported limit is 100. |
| offset | Integer | The starting index for data retrieval. |
| sort | Enum | Sort the order of entries from date. The supported values are ASC and DESC. |
| role | String | Role of the customer in the user group. For example, a company enrolled in a fleet loyalty program can have roles such as owner, associate, driver. |
| includeAlternateCurrencies | Boolean | Set includeAlternateCurrencies=true to retrieve all alternate currencies available with the group. |
| alternateCurrencyNames | Boolean | Filter alternate currencies for the group 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. |
| excludePointCategories | Boolean | You can use this parameter with includeAlternateCurrencies=true to include ledger records only with respect to alternate currencies. Refer to the behaviour of alternate currency and point category parameters section for more information. |
Behaviour of alternate currency and point category parameters
The following table details how different combinations of includeAlternateCurrencies, pointCategoryType, and excludePointCategories the parameters affect the API response:
includeAlternateCurrencies | pointCategoryType | excludePointCategories | Behaviour |
|---|---|---|---|
true | REGULAR, PROMISED, or TRIGGER_BASED | Not provided/ false | Only points and alternate currencies entries with the provided category types are displayed. |
true | Not provided | Not provided/ false | Points and alternate currencies across all categories are displayed. |
true | Not provided | true | Only alternate currency entries are displayed. |
true | REGULAR | true | Only alternate currency entries are displayed; pointCategoryType is ignored when excludePointCategories=true. |
false | Not provided | Not provided/ false | Only entries for points across all categories are displayed. |
false | REGULAR, PROMISED, or TRIGGER_BASED | Not provided/ false | Only entries matching the provided point category types are displayed, excluding alternate currencies. |
Response parameter (Customer and User Group)
| Parameter | Data Type | Description |
|---|---|---|
| customerDetails | Object | Contains information on the customer. |
| - firstName | String | Registered first name of the customer. Character limit: 100 characters |
| - lastName | String | Registered last name of the customer. Character limit: 100 characters |
| - userId | Integer | Unique ID of the customer. |
| - entityType | Enum | Type of entity. Supported values: CUSTOMER, USERGROUP2, FLEET |
| ledgerDetails | Object | Details on the ledger record. |
| - pageNumber | Integer | Current page number of the ledger. |
| - pageSize | Integer | Current page size of the ledger. |
| - totalEntries | Integer | Total number of entries in the ledger. |
| - pageCount | Integer | Total number of pages in the ledger. |
| ledgerEntries | Object | Contains information on the ledger entry. |
| - eventLogId | Integer | Unique ID of the event that is triggered. |
| - eventName | Enum | Name of the event. Supported values: GenericEvent, TransactionAdd, TransactionUpdate, TargetCompleted, PointsRedemption, VoucherRedemption, DelayedAccrual, PointsTransfer, PointsRedemptionReversal, CustomerRegistration, CustomerUpdate.Refer to the documentation on event notifications for more details. |
| - customerId | Integer | Unique ID of the customer who triggered the event. |
| - ledgerCreatedDate | String | Date when the ledger entry was created in YYYY-MM-DD HH:MM:SS.s format. |
| - customerDetails | Object | Contains information on the customer within a user group who triggered the event. The value is null if not a user group. |
| -- firstName | String | Registered first name of the customer in the user group. Character limit: 100 characters |
| -- lastName | String | Registered last name of the customer in the user group. Character limit: 100 characters |
| -- identifier | Object | Contains information on the identifiers of a customer in the user group. |
| --- type | Enum | Type of identifier for the customer in the user group. Supported values: email, mobile. |
| --- value | String | Registered identifier of the customer in the user group based on the type. Character limit for email: 255 characters. |
| --- role | String | Role of the customer in the user group. For example, a company enrolled in a fleet loyalty program can have roles such as owner, associate, driver. |
| -- userId | String | Unique ID of the customer in the user group who triggered the event. |
| - entryDetails | Object | Contains information on the ledger entry. |
| -- ledgerEntryType | Enum | Type of ledger entry. Supported values: OPENING_BALANCE, CREDIT, DEBITRefer to the documentation on points liability for more details. |
| -- points | Float | Number of points transacted. |
| -- pointsCategory | String | Category of points transacted. Supported values: Main (redeemable account), DelayedAccrualPointCategory (promised points), ExternalTriggerBasedPointCategory (points awarded based on external events or triggers.).Refer to the documentation on points for more information. |
| -- programName | String | Name of the program where the event occurred. Character limit: 255 characters |
| -- programId | Integer | Unique ID of the program where the event occurred. |
| - netPointsOnEvent | Float | Net amount of points transacted. |
| - transactionDetails | Object | Contains information on the transactions that occurred. |
| -- transactionId | Integer | Unique ID of the transaction that is generated after a transaction is completed. |
| -- transactionNumber | String | Unique reference number for a transaction. This can be used to reference a transaction for a return. |
| -- date | String | Date of the transaction in YYYY-MM-DD HH:MM:SS.s format. |
| -- amount | Float | The total amount that was transacted, after all adjustments such as discounts or taxes. |
| -- grossBillAmount | Float | Total value of the transaction before any adjustments like discounts or taxes are applied. |
| -- source | String | Source where the transaction occurred. Supported values: FACEBOOK, WEB_ENGAGE, INSTORE, MARTJACK, TMALL, TAOBAO, JD, ECOMMERCE, WEBSITE, LINE, ALL. |
| - store | String | Unique name of the store where the transaction occurred. |
| - storeCode | String | Unique code of the store where the transaction occurred. |
| - tillCode | String | Till code of the POS machine where the transaction occurred. |
| - eventDetails | Object | Contains details about the triggered event and the promotion associated with it. Promotion details are included for TargetCompleted, Behavioural Events and Import type events |
| -- eventDisplayName | String | Unique name of the event that is triggered. |
| -- promotionName | String | Name of the promotion. The character limit for the name is 255 characters. |
| -- promotionDescription | String | Description of the promotion. The character limit for the description is 255 characters. |
| -- promotionIdentifier | String | Unique external identifier of the promotion that is configured for the program. |
| -- promotionId | Integer | Unique ID of the promotion. |
| -- eventDate | String | Date when the event is triggered in YYYY-MM-DD HH:MM:SS.s format. |
| - sourceProgramId | Integer | Unique ID of the source program for the ledger entry. |
| - sourceProgramName | String | Unique name of the source program for the ledger entry. |
| - orgId | Integer | Unique ID of the organisation. |
| warnings | Object | Warnings, if any. |
{
"ledgerDetails": {
"pageNumber": 0,
"pageSize": 10,
"totalEntries": 2,
"pageCount": 1
},
"ledgerEntries": [
{
"eventLogId": 508308379,
"eventName": "AllocateGoodwillPoints",
"customerId": -2860,
"ledgerCreatedDate": "2023-06-21 13:34:16.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "350.000",
"pointsCategory": "Main",
"programName": "Default Program",
"programId": 469
}
],
"netPointsOnEvent": "350.000",
"transactionDetails": {},
"store": "test",
"storeCode": "teststore",
"tillCode": "neestoretillssnee23",
"eventDetails": {
"reason": "POINTS_ISSUE"
}
},
{
"eventLogId": 508308319,
"eventName": "AllocateGoodwillPoints",
"customerId": -2860,
"ledgerCreatedDate": "2023-06-21 13:32:44.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "Default Program",
"programId": 469
}
],
"netPointsOnEvent": "100.000",
"transactionDetails": {},
"store": "test",
"storeCode": "teststore",
"tillCode": "neestoretillssnee23",
"eventDetails": {
"reason": "POINTS_ISSUE"
}
}
],
"warnings": []
}
{
"customerDetails": {
"firstName": "huhu",
"lastName": "supplementary1",
"userId": 345843428,
"entityType": "CUSTOMER"
},
"ledgerDetails": {
"pageNumber": 0,
"pageSize": 10,
"totalEntries": 1,
"pageCount": 1
},
"ledgerEntries": [
{
"eventLogId": 12379266,
"eventName": "TargetCompleted",
"customerId": 345843428,
"ledgerCreatedDate": "2024-06-19 11:58:07.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "DefaultProgram",
"programId": 890
}
],
"netPointsOnEvent": "100.000",
"transactionDetails": {},
"store": "tillhuhu",
"storeCode": "tillhuhu",
"tillCode": "tillhuhu",
"eventDetails": {
"eventDisplayName": "TargetCompletePromos",
"promotionName": "TargetCompletePromos",
"promotionDescription": "TargetCompletePromos",
"promotionIdentifier": "7c73ef03-5745-4d82-b089-aebefa53d10d",
"promotionId": 1120363,
"eventDate": "2024-06-19 11:57:37.0"
},
"sourceProgramId": 890,
"sourceProgramName": "DefaultProgram",
"orgId": null
}
],
"warnings": []
}
{
"customerDetails": {
"firstName": "naresh",
"lastName": "silla",
"userId": 64035151,
"entityType": "CUSTOMER"
},
"ledgerDetails": {
"pageNumber": 0,
"pageSize": 10,
"totalEntries": 34,
"pageCount": 4
},
"ledgerEntries": [
{
"eventLogId": 183281908,
"eventName": "GenericEvent",
"customerId": 64035151,
"ledgerCreatedDate": "2024-05-04 07:16:34.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Tier-points"
}
],
"netPointsOnEvent": "100.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {
"eventDisplayName": "ThankYouSanta",
"displayName": "ThankYouSanta"
},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
},
{
"eventLogId": 183267939,
"eventName": "GenericEvent",
"customerId": 64035151,
"ledgerCreatedDate": "2024-05-04 06:35:44.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "OPENING_BALANCE",
"points": "0.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Pebbles"
},
{
"ledgerEntryType": "OPENING_BALANCE",
"points": "0.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Boost"
},
{
"ledgerEntryType": "OPENING_BALANCE",
"points": "0.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Tier-points"
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Tier-points"
}
],
"netPointsOnEvent": "100.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {
"eventDisplayName": "ThankYouSanta",
"displayName": "ThankYouSanta"
},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
},
{
"eventLogId": 178283044,
"eventName": "BulkAllocatePoints",
"customerId": 626,
"ledgerCreatedDate": "2024-04-19 07:39:11.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "2000.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
}
],
"netPointsOnEvent": "2000.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {},
"sourceProgramId": 626,
"sourceProgramName": "David Jones- Default Program"
},
{
"eventLogId": 178283042,
"eventName": "TransactionAdd",
"customerId": 64035151,
"ledgerCreatedDate": "2024-04-19 07:39:12.0",
"customerDetails": {
"userId": 0
},
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "20.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stars"
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stamps"
}
],
"netPointsOnEvent": "220.000",
"transactionDetails": {
"transactionId": 130717557,
"transactionNumber": "1542280708645",
"date": "2024-04-19 07:39:11.0",
"amount": 200.0,
"grossBillAmount": 200.0,
"source": "instore"
},
"store": "supermarketdemo",
"storeCode": "supermarketdemo",
"tillCode": "till.marketsuper",
"eventDetails": {},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
},
{
"eventLogId": 178282122,
"eventName": "BulkAllocatePoints",
"customerId": 626,
"ledgerCreatedDate": "2024-04-19 07:36:17.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "2000.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
}
],
"netPointsOnEvent": "2000.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {},
"sourceProgramId": 626,
"sourceProgramName": "David Jones- Default Program"
},
{
"eventLogId": 178282119,
"eventName": "TransactionAdd",
"customerId": 64035151,
"ledgerCreatedDate": "2024-04-19 07:36:18.0",
"customerDetails": {
"userId": 0
},
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "20.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stars"
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stamps"
}
],
"netPointsOnEvent": "220.000",
"transactionDetails": {
"transactionId": 130716752,
"transactionNumber": "1542280708644",
"date": "2024-04-19 07:36:17.0",
"amount": 200.0,
"grossBillAmount": 200.0,
"source": "instore"
},
"store": "supermarketdemo",
"storeCode": "supermarketdemo",
"tillCode": "till.marketsuper",
"eventDetails": {},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
},
{
"eventLogId": 178277003,
"eventName": "BulkAllocatePoints",
"customerId": 626,
"ledgerCreatedDate": "2024-04-19 07:21:31.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "2000.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
}
],
"netPointsOnEvent": "2000.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {},
"sourceProgramId": 626,
"sourceProgramName": "David Jones- Default Program"
},
{
"eventLogId": 178276992,
"eventName": "TransactionAdd",
"customerId": 64035151,
"ledgerCreatedDate": "2024-04-19 07:21:32.0",
"customerDetails": {
"userId": 0
},
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "20.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stars"
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stamps"
}
],
"netPointsOnEvent": "220.000",
"transactionDetails": {
"transactionId": 130712377,
"transactionNumber": "1542280708643",
"date": "2024-04-19 07:21:29.0",
"amount": 200.0,
"grossBillAmount": 200.0,
"source": "instore"
},
"store": "supermarketdemo",
"storeCode": "supermarketdemo",
"tillCode": "till.marketsuper",
"eventDetails": {},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
},
{
"eventLogId": 178061276,
"eventName": "BulkAllocatePoints",
"customerId": 626,
"ledgerCreatedDate": "2024-04-18 11:53:07.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "2000.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
}
],
"netPointsOnEvent": "2000.000",
"transactionDetails": {},
"store": "default",
"storeCode": "default",
"tillCode": "default",
"eventDetails": {},
"sourceProgramId": 626,
"sourceProgramName": "David Jones- Default Program"
},
{
"eventLogId": 178061275,
"eventName": "TransactionAdd",
"customerId": 64035151,
"ledgerCreatedDate": "2024-04-18 11:53:07.0",
"customerDetails": {
"userId": 0
},
"entryDetails": [
{
"ledgerEntryType": "CREDIT",
"points": "20.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stars"
},
{
"ledgerEntryType": "CREDIT",
"points": "100.000",
"pointsCategory": "Main",
"programName": "David Jones- Default Program",
"programId": 626,
"alternateCurrencyName": "Stamps"
}
],
"netPointsOnEvent": "220.000",
"transactionDetails": {
"transactionId": 130540500,
"transactionNumber": "1542280708642",
"date": "2024-04-18 11:53:06.0",
"amount": 200.0,
"grossBillAmount": 200.0,
"source": "instore"
},
"store": "supermarketdemo",
"storeCode": "supermarketdemo",
"tillCode": "till.marketsuper",
"eventDetails": {},
"sourceProgramId": 817,
"sourceProgramName": "David Jones- Card Program"
}
],
"warnings": []
}
{
"customerDetails": {
"firstName": "Kamal",
"lastName": "H",
"userId": 170940055,
"externalId": "000000043488",
"entityType": "CUSTOMER"
},
"ledgerDetails": {
"pageNumber": 0,
"pageSize": 10,
"totalEntries": 1,
"pageCount": 1
},
"ledgerEntries": [
{
"eventLogId": 569437706,
"eventName": "CustomerUpdate",
"customerId": 170940055,
"ledgerCreatedDate": "2024-04-25 14:34:52.0",
"customerDetails": null,
"entryDetails": [
{
"ledgerEntryType": "OPENING_BALANCE",
"points": "0.00",
"pointsCategory": "Main",
"programName": "Default Program",
"programId": 469,
"alternateCurrencyName": "Stars"
},
{
"ledgerEntryType": "OPENING_BALANCE",
"points": "0.00",
"pointsCategory": "Main",
"programName": "Default Program",
"programId": 469,
"alternateCurrencyName": "Coins"
}
],
"netPointsOnEvent": "0.000",
"transactionDetails": {},
"store": "demostorebukl Mobile",
"storeCode": "demostorebukl",
"tillCode": "demostorebukl.1",
"eventDetails": {},
"sourceProgramId": 805,
"sourceProgramName": "Seven Entertainment",
"orgId": null
}
],
"warnings": []
}
API error codes
| Error Code | Description | Reason |
|---|---|---|
| 11012 | Invalid userId passed in request | The userId is wrong. |
| 8013 | Lookup, Invalid identifier passed | The identifier type is wrong or invalid |
| 11029 | Limit cannot be greater than 100 | The page limit is higher than the supported limit |
| 11003 | There are no ledger entries present for the given parameters. Try removing parameters to widen the search | The offset value is greater than the total number of pages. |
| 11007 | Invalid ledgerEntryType passed in request | The type of ledger entry is wrong or invalid. |
| 11008 | Invalid pointCategoryType passed in request | The type of point category is wrong or invalid. |
| 9003 | No CPS entry for the given points type. | No matching record found in the Customer Points Summary (CPS) table for that specific combination of customer and points type. Verify the customer ID is correct and confirm the points type is valid. Contact the Capillary support team if the issue persists. |