API documentation
Method list
Test your request
Changelog


getInventoryProductsList
The method allows to retrieve a basic data of chosen products from BaseLinker catalogs.


Input parameters
inventory_idintCatalog ID. The list of identifiers can be retrieved using the method getInventories.
filter_idint(optional) limiting results to a specific product id
filter_category_idint(optional) Retrieving products from a specific category (optional)
filter_eanvarchar(32)(optional) limiting results to a specific ean
filter_skuvarchar(50)(optional) limiting the results to a specific SKU (stock keeping number)
filter_namevarchar(200)(optional) item name filter (part of the searched name or an empty field)
filter_price_fromfloat(optional) minimum price limit (not displaying products with lower price)
filter_price_tofloat(optional) maximum price limit
filter_stock_fromint(optional) minimum quantity limit
filter_stock_toint(optional) maximum quantity limit
pageint(optional) Results paging (1000 products per page for BaseLinker warehouse)
filter_sortvarchar(30)(optional) the value for sorting the product list. Possible values: "id [ASC|DESC]"



Output data
The method returns the data in JSON format.
statusvarchar(30)SUCCESS - request executed correctly
ERROR - an error occurred during an API request. Error details will be described in 2 additional returned fields: error_message and error_code
productsarrayA list of products where the key is the product id and the value is an array of fields listed below.
| - eanvarchar(32)Product EAN number.
| - skuvarchar(32)Product SKU number.
| - namevarchar(200)Product name
| - pricesarrayA list containg product gross prices, where the key is the price group ID and value is a product gross price for a given price group. The list of price groups can be retrieved with getInventoryPriceGroups method.
| - stockarrayA list containing product stocks, where the key is the warehouse ID and value is a product stock for a given warehouse. Warehouse ID should have this format: "[type:bl|shop|warehouse]_[id:int]" (e.g. "bl_123").The list of warehouse IDs can be retrieved with getInventoryWarehouses method.



Sample
Input data:
Output data:
A sample request in php: