getEarnedRewardPointRecords

Retrieve all transactions where customers have earned reward points.

This API call is for building custom loyalty programs. For other related calls, see addCustomerRewardPoints (to add points to a customer manually) and getUsedRewardPointRecords (to retrieve transactions where customers have spent reward points}.

For simpler integrations, you will more likely need getCustomerRewardPoints to retrieve a customer's point balance, and subtractCustomerRewardPoints to subtract points from customer.

To edit one specific record, use editEarnedRewardPointRecord. (Under normal circumstances, you should not use that method; this is only for transfering points history from one customer to another, or for correcting errors in points history. To add or remove points, use subtractCustomerRewardPoints and addCustomerRewardPoints instead.)

Input parameters

Parameter name Description Possible value Required
customerID Customer ID. Integer
customerIDs Comma-separated list of customer IDs. Retrieve transactions associated with multiple customers. String
createdUnixTimeFrom Unix timestamp
createdUnixTimeTo Unix timestamp

Response

Field name Type Description
transactionID Integer Transaction ID.
customerID Integer Customer ID.
customerCardNumber String Code of customer's loyalty/membership card.
invoiceID Integer Invoice ID. Sale that earned the points.
invoiceNo String Invoice number.
earnedPoints Integer
remainingPoints Integer
createdUnixTime Unix timestamp Transaction timestamp.
expiryUnixTime Unix timestamp Expiry timestamp.
pointOfSaleID Integer Register ID.
pointOfSaleName String
employeeID Integer Cashier who processed the sale.
employeeName String
description String Available only if "Reward point extras" module is enabled on your account.

This API call returns error 1006 if "Reward points" module is not enabled on your account.