The API fetches points redemption details for event log IDs related to points redemption events
NoteThis is a private API and is accessible only through Neo dataflows.
Prerequisites
- Access to Neo
- Basic or OAuth authentication details
- Access group resource - NA
Resource information
URI to be used in Neo dataflow | /das/getPointsRedemptionExplodeLedger |
HTTP method | GET |
Pagination supported? | Yes |
Rate limit | Based on Neo |
Batch support | NA |
Request query parameters
Parameter (Parameters marked with * are mandatory) | Data Type | Description |
---|---|---|
entity_id* | Long | Unique customer ID of the customer |
event_log_ids* | String | Unique identifier generated for the event at the time of its creation |
page | Integer | Retrieve details of a specific page. Page count starts from 1. Example: page=2 retrieves data on page 2. |
count | Integer | Number of results to display per page. The default value is 10. The maximum supported value is 100. |
Response parameters
Parameter | Datatype | Description |
---|---|---|
notes | String | Notes or comments related to the redemption |
redemptionType | String | Type of redemption
Example: |
purpose | String | Purpose of the redemption |
redemptionId | String | Unique identifier for the redemption |
pointsRedeemed | Float | Number of points redeemed |
pointsRedemptionTime | Long | Timestamp when the points were redeemed in milliseconds |
processingTime | Long | Timestamp when the event was processed in milliseconds |
eventTypeId | Integer | Unique identifier for the event type |
billId | Long | Unique identifier for the bill |
customerId | Long | Unique identifier of the customer |
eventTime | Long | Timestamp of when the event occurred in milliseconds |
redemptionTime | Long | Timestamp when the redemption was recorded in milliseconds |
externalReferenceNumber | String | External reference number, if available |
eventLogId | Long | Unique identifier of the event log |
tillId | Long | Identifier for the till (point-of-sale terminal) |
billNumber | String | Bill number associated with the redemption |
uniqueId | String | Unique ID associated with the redemption record |
Sample response
[
{
"notes": "general",
"redemptionType": "REDEMPTION",
"purpose": "",
"redemptionId": "d5hrMK",
"pointsRedeemed": 26,
"pointsRedemptionTime": 1748950582000,
"processingTime": 1748950581000,
"eventTypeId": 3,
"billId": 387970841,
"customerId": 387970841,
"eventTime": 1748950581000,
"redemptionTime": 1748950581000,
"externalReferenceNumber": null,
"eventLogId": 38731921,
"tillId": 50691660,
"billNumber": "",
"uniqueId": "X17nAIlTJ3"
},
{
"notes": "Sample notes",
"redemptionType": "REDEMPTION",
"purpose": "",
"redemptionId": "C2gPJ1",
"pointsRedeemed": 5,
"pointsRedemptionTime": 1749066544000,
"processingTime": 1748869864000,
"eventTypeId": 3,
"billId": 387970841,
"customerId": 387970841,
"eventTime": 1748869864000,
"redemptionTime": 1749062944000,
"externalReferenceNumber": null,
"eventLogId": 38797923,
"tillId": 50692627,
"billNumber": "wefsadefdfdasfds",
"uniqueId": "qTxqAg2pe9"
}
]
Error code
Error Code | Description |
---|---|
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |