Retrieve Points‐Award Records Associated with a Specific Transaction ID

This API retrieves the points‐award records associated with a specific transaction ID. Each record shows the category under which points were awarded, the unique award ID, the customer who earned them, and the loyalty program.

👍

Note

  • Only host url https://dev.api.capillarytech.com is supported

Prerequisites

  • Header x-cap-neo-dag-scope set to a valid scope value (e.g. global)
  • transaction_id (integer)

Resource information

URL/x/neo/pointsAllocationId/transactionId?transaction_id={transactionId}
HTTP MethodGET
AuthenticationBasic & OAuth
PaginationLimit and Offset parameters are supported

API endpoint example

https://dev.api.capillarytech.com/x/neo/pointsAllocationId/transactionId?transaction_id=2151090345

Request query parameters

ParameterData TypeDescription
transaction_id*IntegerUnique identifier of the transaction for which to retrieve points‐award records.
offsetIntegetThis parameter specifies the starting point for the records to be returned.
limitIntegerThis parameter sets the maximum number of records to return in a single response.

* Mandatory parameter

Sample Request

curl --location 'https://dev.api.capillarytech.com/x/neo/pointsAllocationId/transactionId?transaction_id=2151090345' \
  --header 'Content-Type: application/json' \
  --header 'x-cap-neo-dag-scope: global' \
  --header 'Authorization: Basic ZGV2LmRzLnRpbGwwMjoyMDJjYjk2MmFjNTkwNiOTY0YjA3MTUyZDIzNGI3MA==' \
  --header 'Cookie: _cfuvid=Azq8pU.vLFQFz1dokJOcKQlnOdEJB31.pqwBHrepJ14-1747219493263-0.0.1.1-604800000'

Response parameters

ParameterData TypeDescription
pointsCategoryIdIntegerIdentifier of the category under which these points were awarded.
pointsAwardedIdIntegerUnique identifier for this specific points‐award record.
customerIdIntegerUnique identifier of the customer who earned these points.
programIdIntegerIdentifier of the loyalty program in which points were awarded.

Sample Response

[
  {
    "pointsCategoryId": 131,
    "pointsAwardedId": 38060732,
    "customerId": 381618579,
    "programId": 33
  },
  {
    "pointsCategoryId": 134,
    "pointsAwardedId": 38060733,
    "customerId": 381618579,
    "programId": 33
  }
]

API Error Codes

Error codeMessageDescription
400Bad RequestMissing or invalid transaction_id parameter.
401UnauthorizedMissing or invalid authentication credentials.
404Not FoundNo points‐award records found for the given transaction.
500Server ErrorUnexpected server error.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!