Get Customer’s Earned and Expired Points by Year

The API retrieves a year-wise summary of points earned and expired for a customer enrolled in a specified program.

🚧

Note

This is a private API and is accessible only through Neo dataflows.

Prerequisites

  • Access to Neo
  • Authentication - Basic or OAuth authentication details
  • Access group resource - NA

Resource Information

URI to be used in Neo dataflow/das/getExpiredPointsByCustomerIdAndYear
HTTP methodGET
Pagination supported?Yes
Rate limitBased on Neo
Batch supportNA

Request Query Parameters

Parameter(Parameters marked with * are mandatory)Data TypeDescription
point_category_id*IntegerIdentifier of the category under which the points were awarded.
program_id*IntegerUnique identifier of the loyalty program.
entity_id*LongUnique customer ID of the customer whose details are retrieved.
pageIntegerRetrieve details of a specific page. Page count starts from 1. Example: page=2 retrieves data on page 2.
countIntegerNumber of results to display per page. The default value is 10. The maximum supported value is 100.

Response Parameters

ParameterData TypeDescription
customerIdLongUnique customer ID of the customer whose details are retrieved.
yearDateTimeYear from which the point details are retrieved.
earnedBigDecimalPoints earned during the specified year
expiredBigDecimalPoints expired during the specified year
[
    {
        "customerId": 387910941,
        "year": 2025,
        "earned": 160,
        "expired": 0
    }
]

Error Codes

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!