Get Point Redemption Details for Redemption Events

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 methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

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

ParameterDatatypeDescription
request_idStringUnique identifier for the API request
dataObjectContains the main response data
-recordsArrayList of records returned in the response
-- fieldsObjectKey-value pairs representing attributes of the redemption event
--- notesStringNotes or comments related to the redemption
--- redemptionTypeStringType of redemption (e.g., REDEMPTION)
--- purposeStringPurpose of the redemption (may be empty)
--- redemptionIdStringUnique identifier for the redemption
--- pointsRedeemedNumberNumber of points redeemed
--- pointsRedemptionTimeNumberTimestamp when the points were redeemed (in milliseconds)
--- processingTimeNumberTimestamp when the event was processed (in milliseconds)
--- eventTypeIdNumberUnique identifier for the event type
--- billIdNumberUnique identifier for the bill
--- customerIdNumberUnique identifier of the customer
--- eventTimeNumberTimestamp of when the event occurred (in milliseconds)
--- redemptionTimeNumberTimestamp when the redemption was recorded (in milliseconds)
--- externalReferenceNumberNullExternal reference number, if available
--- eventLogIdNumberUnique identifier of the event log
--- tillIdNumberIdentifier for the till (point-of-sale terminal)
--- billNumberStringBill number associated with the redemption
--- uniqueIdStringUnique 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 CodeDescription
400Bad Request
404Not Found
500Internal Server Error
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!