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 transferring points history from one customer to another, or for correcting errors in points history. To add or remove points, use subtractCustomerRewardPoints and addCustomerRewardPoints instead.)
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| customerID | Customer ID. | integer | |
| customerIDs | Comma-separated list of customer IDs. Retrieve transactions associated with multiple customers. | string | |
| invoiceID | Invoice ID. | integer | |
| createdUnixTimeFrom | Unix timestamp | ||
| createdUnixTimeTo | Unix timestamp | ||
| orderBy | Possible values: 'transactionID' and 'createdUnixTime'. By default: 'transactionID'. | string | |
| orderByDir | Sort direction: 'asc' (ascending order) or 'desc' (descending order). By default, items are sorted in ascending order. | string |
| 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 | integer | Unix timestamp. Transaction timestamp. |
| expiryUnixTime | integer | 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.