Search

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 nameDescriptionPossible valueRequired
supplierPriceListIDPrice List IDInteger
supplierIDSupplier IDInteger
searchAttributeNameSearch from attribute name.searchAttributeName and searchAttributeValue have to be specified bothString
searchAttributeValueSearch from attribute valueString
changedSinceGet 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)
recordsOnPageNumber of records API should return. By default 20, at most 100.Integer
pageNoAPI 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 nameTypeDescription
supplierPriceListIDIntegerPrice List ID.
supplierIDIntegerSupplier ID.
supplierNameStringSupplier name.
nameStringPrice list name
startDateISO date (yyyy-mm-dd)Valid From date.
endDateISO date (yyyy-mm-dd)Valid Until date.
activeInteger0 or 1
addedSince
changedSince
pricelistRulesArrayThis list contains the products and their prices. Each array item looks as follows:

Field nameTypeDescription
productIDIntegerID of the product.
priceDecimalList price.
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.
attributesArrayAdditional attributes. Each item looks like this:

Field nameTypeDescription
attributeNameStringAttribute name
attributeTypeStringAttribute type
attributeValueStringAttribute value