Get Point Allocation Details by Event ID

get https://{host}/x/neo/pointsAllocation/event

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

🚧
Note
This API is a private API that has been exposed through Neo and made public.

Prerequisites

Basic or OAuth authentication details
Access group resource - NA
Header x-cap-neo-dag-scope set to global

Resource information


URI	/x/neo/pointsAllocation/event
HTTP method	GET
Pagination supported?	Yes
Rate limit	Based on Neo
Batch support	NA

Example request

curl --location 'https://eu.api.capillarytech.com/x/neo/pointsAllocation/event?entity_id=890697432&customer_id=566135941&event_type_id=15' \
--header 'x-cap-neo-dag-scope: global' \
--header 'Authorization: Basic ZGl2eWFfZG9jOmVjMzFiZWY3ZTNhNTdlYTI0YTYyZTZm' \
--header 'Cookie: _cfuvid=nkdqRjD57tAqwEjeR8HFwvTH0opPqch.Nf9wK366n4k-1758113514799-0.0.1.1-604800000'

Request query parameters

Parameter	Data Type	Required	Description
entity_id	String	Yes	Specifies the identifier used to fetch event-specific details. See the list below. The event ID (eventID in the Get customer Event API response) of the event, such as TransactionAdd or a behavioural event The server-generated request ID of a behavioural event. For a `TransactionAdd` event, the Request ID can be retrieved from the Evaluation Log in the Member Care UI under Events > Transactions for the respective transaction. Transaction ID (createdId from the Add transaction response)
customer_id	Long	Yes	Unique Customer ID
event_type_id	Integer	Yes	Unique identifier for the type of event. This depends on the kind of event. Refer to thetable belowfor the event type ID associated with your event.
page	Integer	No	Retrieve details of a specific page. Page count starts from 1. Example: `page=2` retrieves data on page 2.
count	Integer	No	Number of results to display per page. The default value is 10. The maximum supported value is 100.

Event type ID

Event Type	ID
NewBill	1
CustomerRegistration	2
PointsRedemption	3
VoucherRedemption	4
ReturnBill	5
TrackerConditionSuccess	6
SocialConnect	7
NewBillDVS	8
TransactionFinished	9
ReferralPostProcessing	10
TransactionUpdate	11
CustomerUpdate	12
EmailOpen	13
EmailClick	14
TransactionAdd	15
DelayedAccrual	16
Scan	17
GroupTransactionAdd	18
GroupTransactionUpdate	19
GroupReturnBill	20
GroupMemberJoin	21
GroupMemberLeave	22
GenericEvent	23
PointsTransfer	24
TargetCompleted	25
PointsRedemptionReversal	26
PartnerProgramDeLinking	27
PartnerProgramLinking	28
PartnerProgramTierUpdate	29
TierReassessment	30
PointsContributionToGroup	31
AllocateGoodwillPoints	32
AllocatePromotionPoints	33
PointsExpiry	34
PointsExpiryReminder	35
TierDowngrade	36
TierDowngradeReminder	37
TierDowngradeOnReturn	38
PromotionPointsExpiryAdjustment	39
PartnerProgramExpiryReminder	40
MergeCustomer	41
BulkAllocatePoints	42
TrackerDataImport	43
TrackerReturnsDataImport	44
CustomerProgramEnrollmentImport	45
CustomerPromotionImport	46
BillPointsPromotionImport	47
ExpireBillPromotionImport	48
ExpireCustomerPromotionImport	49
LineItemsPointsPromotionImport	50
RedemptionsImport	51
TransactionDeductionImport	52
TransactionMLPImport	53
PartnerProgramLinkingImport	54
PartnerProgramDeLinkingImport	55
PartnerProgramTierRenewImport	56
SuppPartnerProgramLinkingImport	57
SuppPartnerProgramDelinkingImport	58
SuppPartnerProgramUpdateImport	59
WarehouseBasedSlabImport	60
LoyaltyBenefitsImport	61
BillImport	62
BillLineItemsImport	63
CustomerImport	64
HistoricalPointsImport	65
PartnerProgramTierUpdateImport	66
PointsExpiryUpdateByRefTypeAndIdImport	67
UpdatePromotionsPointsExpiryDateImport	68
PointsLedgerBulkJob	69
UpdatePointsExpiryInDateRangeImport	70
UserGroup2Create	71
LoyaltySlabEarlyExpiry	72
TransactionCleanupImport	73
OutlierStatusImport	74
ManualPointsAdjustment	75
ManualPointsAdjustmentImport	76
ManualPointsConversion	77
ReturnTargetCompletedEvent	78
IssuePromotionForEntityEvent	79
PointsLedgerRecreation	80
ConvertPointsToReward	81
EarnPromotionForEntityEvent	82
RevokeIssuePromotionEvent	83
RevokeEarnPromotionEvent	84
ManualSlabAdjustment	85
ManualCurrencyAllocation	86
TierAgnosticPartnerProgramExpiry	87
TierDowngradeEvent	88
TierRenewEvent	89

Sample request

curl --location 'https://nightly.api.capillarytech.com/x/neo/pointsAllocation/event?entity_id=hfjWDK0dek&customer_id=374819205&event_type_id=15' \
--header 'Content-Type: application/json' \
--header 'x-cap-neo-dag-scope: global' \
--header 'Authorization: Basic MDcxNTJkMjM0Yjcw' \
--header 'Cookie: _cfuvid=aipDF8qJJabNkC6ofNg0_4.3nMtpbVSQI9mVehJNjMw-1749448275226-0.0.1.1-604800000; _cfuvid=5YjVQ2SkBWELRCgtes5wkbXKRpcYNHnhogmQk5roBL4-1750314849268-0.0.1.1-604800000'

Response parameters

Parameter	Data Type	Description
till_id	Integer	Identifier of the store/till where the transaction occurred
point_category_id	Integer	Unique identifier that indicates the type or category of points awarded or deducted
program_id	Integer	ID of the loyalty program
event_log_id	Integer	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	Integer	ID of the source entity awarding the points
id	Integer	Unique ID of the point allocation entry
cps_id	Integer	ID of the customer program state
original_customer_id	Integer	ID of the customer before the merge or update
expiry_strategy_id	Integer	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	Integer	ID of the strategy used to allocate points
points_value	Integer	Total value of the points awarded
org_id	Integer	Organization ID
expired_value	Integer	Value of points that expired
customer_id	Integer	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 codes

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

Language

Credentials

Basic

base64

URL

Click Try It! to start a request and see the response here!