getSupplierPriceLists

Retrieve supplier price lists and the contents of each price list.

Contact ERPLY Helpdesk to enable Supplier Price Lists module on your account. (If not enabled, API returns error 1006.) Entering your supplier price lists into ERPLY is useful when creating Purchase Orders, or when receiving supplies; ERPLY will automatically populate the Price field for each item.

Input parameters

Parameter name Description Possible value Required
supplierPriceListID  Price List ID  Integer    
supplierID  Supplier ID  Integer    
searchAttributeName  Search from attribute name.searchAttributeName and searchAttributeValue have to be specified both  String    
searchAttributeValue  Search from attribute value  String    
changedSince  Get price lists that have been modified since the specified timestamp. Useful for synchronizing data. Price lists will be returned with their full contents.  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
supplierPriceListID  Integer  Price List ID.  
supplierID  Integer  Supplier ID.  
supplierName  String  Supplier name.  
name  String  Price list name  
startDate  ISO date (yyyy-mm-dd)  Valid From date.  
endDate  ISO date (yyyy-mm-dd)  Valid Until date.  
active  Integer  0 or 1  
added  Unix timestamp  Creation time.  
addedByUserName  String    
lastModified  Unix timestamp  Last modification time.  
lastModifiedByUserName  String    
pricelistRules  Array  This list contains the products and their prices. Each array item looks as follows:

Field nameTypeDescription
productIDIntegerID of the product.</td
priceDecimalList price.</td
amountIntegerIf you have Quantity Discounts module enabled, this is the minimum ordering quantity at which the specified price applies. Therefore, one product may have multiple prices in the price list, for example: one price for quantity 100 and up (amount = 100); another price for quantity 25...99 (amount = 25); and a default price (amount = 0).

Contact ERPLY Helpdesk if you need Quantity Discounts module to be enabled on your account.
 
attributes  Array  Additional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value