get https://{host}/das/getPointsRedemptionExplodeLedger
The API fetches points redemption details for event log IDs related to points redemption events
Note
This 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. |
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 |
---|---|---|
request_id | String | Unique identifier for the API request |
data | Object | Contains the main response data |
-records | Array | List of records returned in the response |
-- fields | Object | Key-value pairs representing attributes of the redemption event |
--- notes | String | Notes or comments related to the redemption |
--- redemptionType | String | Type of redemption (e.g., REDEMPTION) |
--- purpose | String | Purpose of the redemption (may be empty) |
--- redemptionId | String | Unique identifier for the redemption |
--- pointsRedeemed | Number | Number of points redeemed |
--- pointsRedemptionTime | Number | Timestamp when the points were redeemed (in milliseconds) |
--- processingTime | Number | Timestamp when the event was processed (in milliseconds) |
--- eventTypeId | Number | Unique identifier for the event type |
--- billId | Number | Unique identifier for the bill |
--- customerId | Number | Unique identifier of the customer |
--- eventTime | Number | Timestamp of when the event occurred (in milliseconds) |
--- redemptionTime | Number | Timestamp when the redemption was recorded (in milliseconds) |
--- externalReferenceNumber | Null | External reference number, if available |
--- eventLogId | Number | Unique identifier of the event log |
--- tillId | Number | 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
{
"request_id": "c251a627-d470-4849-8bda-1084730c9893",
"data": {
"records": [
{
"fields": {
"notes": {
"string_value": "Sample notes"
},
"redemptionType": {
"string_value": "REDEMPTION"
},
"purpose": {
"string_value": ""
},
"redemptionId": {
"string_value": "C2gPJ1"
},
"pointsRedeemed": {
"number_value": 5
},
"pointsRedemptionTime": {
"number_value": 1749066544000
},
"processingTime": {
"number_value": 1748869864000
},
"eventTypeId": {
"number_value": 3
},
"billId": {
"number_value": 387970841
},
"customerId": {
"number_value": 387970841
},
"eventTime": {
"number_value": 1748869864000
},
"redemptionTime": {
"number_value": 1749062944000
},
"externalReferenceNumber": {
"null_value": "NULL_VALUE"
},
"eventLogId": {
"number_value": 38797923
},
"tillId": {
"number_value": 50692627
},
"billNumber": {
"string_value": "wefsadefdfdasfds"
},
"uniqueId": {
"string_value": "qTxqAg2pe9"
}
}
}
]
}
}
Error Code
Error Code | Description |
---|---|
400 | Bad Request |
404 | Not Found |
500 | Internal Server Error |