Get Point Allocation Details by Event ID

The API retrieves information about points allocated to customers based on the event ID.

🚧
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/getPaDetailsByEventId
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*	String / Integer (based on event_type_id)	Specifies the identifier used to fetch event-specific details. This can be: The event ID (Example: `TransactionAdd` or behavioural events) A unique event ID The server-generated request ID of a behavioural event.
customer_id*	Long	Unique Customer ID
event_type_id*	Integer	Unique identifier for the type of event.
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	Data Type	Description
till_id	Long	Identifier of the store/till where the transaction occurred
point_category_id	Long	Unique identifier that indicates the type or category of points awarded or deducted
program_id	Long	ID of the loyalty program
event_log_id	Long	ID of the event log that recorded the transaction
event_type_id	Integer	ID indicating the type of event
points_source_type_id	Integer	ID of the source type from which points were earned
original_points	Integer	Number of points initially awarded
awarded_date	Long	Timestamp when the points were awarded in milliseconds
returned_exclusive_value	Integer	Exclusive value of points returned
points_source_id	Long	ID of the source entity awarding the points
id	Long	Unique ID of the point allocation entry
cps_id	Long	ID of the customer program state
original_customer_id	Long	ID of the customer before the merge or update
expiry_strategy_id	Long	ID of the strategy used to determine point expiry
returned_value	Integer	Total value of returned points
redeemed_exclusive_value	Integer	Exclusive value of redeemed points
expiry_date	Long	Expiry timestamp of the awarded points in milliseconds
auto_update_time	Long	Timestamp of the last auto-update to the entry
redeemed_value	Integer	Value of points redeemed
expired_exclusive_value	Integer	Exclusive value of points that have expired
allocation_strategy_id	Long	ID of the strategy used to allocate points
points_value	Integer	Total value of the points awarded
org_id	Long	Organization ID
expired_value	Integer	Value of points that expired
customer_id	Long	ID of the customer to whom the points are allocated
points_exclusive	Integer	Exclusive points that are available
status	String	Current status of the point entry

Sample response

[
    {
        "till_id": 50140377,
        "point_category_id": 17383,
        "program_id": 2282,
        "event_log_id": 10072893,
        "event_type_id": 15,
        "points_source_type_id": 1,
        "original_points": 0,
        "awarded_date": 1648489472000,
        "returned_exclusive_value": 0,
        "points_source_id": 2148434124,
        "id": 31787856,
        "cps_id": 51368957,
        "original_customer_id": 374819205,
        "expiry_strategy_id": 105602,
        "returned_value": 0,
        "redeemed_exclusive_value": 0,
        "expiry_date": 1648578599000,
        "auto_update_time": 1648596913000,
        "redeemed_value": 0,
        "expired_exclusive_value": 50,
        "allocation_strategy_id": 105773,
        "points_value": 0,
        "org_id": 50914,
        "expired_value": 0,
        "customer_id": 374819205,
        "points_exclusive": 50,
        "status": "EXPIRED"
    }
]

Error code

Error Code	Description
400	Bad Request
404	Not Found
500	Internal Server Error