getRedeemedCoupons

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.

Input parameters

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 retrive the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". Integer

Response

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 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 Unix timestamp Creation time.
lastModified Unix timestamp Last modification time.

getRedeemedCoupons requires promotions module and returns error 1006 if that module has not been enabled on your account.