getGiftCards

Retrieve gift cards.

To create a new gift card, or update the balance of an existing gift card, use saveGiftCard. To get a log of gift card redeemings, see getGiftCardRedeemings.

In ERPLY, gift cards have a "balance". A gift card can be used multiple times, until all the balance has been spent. A customer can use any gift card that has not expired and has a non-zero balance.

Input parameters

Parameter name Description Possible value Required
giftCardID  ID of gift card  Integer    
code  Gift card's code  String    
purchaseInvoiceID  Available only if "Gift card extras" module is enabled on your account.  Integer    
purchasedUnixTimeFrom  Filter gift cards by the "time of purchase" timestamp.  Unix timestamp    
purchasedUnixTimeTo  Filter gift cards by the "time of purchase" timestamp.  Unix timestamp    
redeemedUnixTimeFrom  Filter gift cards by the "time when redeemed" timestamp.  Unix timestamp    
redeemedUnixTimeTo  Filter gift cards by the "time when redeemed" timestamp.  Unix timestamp    
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
giftCardID  Integer  ID of gift card  
code  String    
value  Decimal    
balance  Decimal  Remaining balance  
purchasingCustomerID  Integer    
purchaseDateTime  Unix timestamp  Date and time of purchase  
redeemingCustomerID  Integer    
redemptionDateTime  Unix timestamp  Date and time of redemption  
expirationDate  Date (yyyy-mm-dd)  Gift card expiration date. Note that gift card expiration is not enabled by default. Contact us if you need to enable gift card expiration. If not enabled, this field's value will always be an empty string. If this gift card does not have an expiration date, value will be an empty string.  
purchaseInvoiceID  Integer  Invoice with which the gift card was purchased. Available only if "Gift card extras" module is enabled on your account.  
added  Unix timestamp  Creation time.  
lastModified  Unix timestamp  Last modification time.