Get a list of coupons that have been redeemed at the register.
For a more generally useful API call, see getIssuedCoupons. getIssuedCoupons lists coupons with ALL statuses — active, expired, redeemed — and you can also use a status filter to retrieve any of the three.
| Parameter name | Description | Possible value | Required |
|---|---|---|---|
| uniqueIdentifier | Unique identifier of the coupon | string | |
| changedSince | Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. | Integer (Unix timestamp) | |
| recordsOnPage | Number of records API should return. By default 20, at most 100. | integer | |
| pageNo | API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". | integer |
| Field name | Type | Description |
|---|---|---|
| issuedCouponID | integer | ID of the redeemed coupon. |
| couponID | integer | ID of coupon code. |
| couponCode | string | Coupon code. |
| uniqueIdentifier | string | Unique identifier of the coupon. |
| timestamp | integer | Unix timestamp. Accept time. |
| invoiceID | integer | Invoice the coupon was redeemed with. |
| invoiceNo | string | Invoice number. |
| customerID | integer | Customer who redeemed the coupon. |
| warehouseID | integer | Store or location where the coupon was accepted. |
| warehouseCode | string | Store or location code. |
| pointOfSaleID | integer | Register where the coupon was accepted. |
| employeeID | integer | Salesperson who accepted the coupon. |
| added | integer | Unix timestamp. Creation time. |
| lastModified | integer | Unix timestamp. Last modification time. |
getRedeemedCoupons requires promotions module and returns error 1006 if that module has not been enabled on your account.