API documentation
Method list
Test your request
Changelog


getProductsList
The method allows to download detailed data of selected products from the BaseLinker storage or a shop/wholesaler storage connected to BaseLinker.


Input parameters
storage_idvarchar(30)Storage ID in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
filter_category_idvarchar(30)(optional) Retrieving products from a specific category (optional)
filter_limitvarchar(30)(OBSOLETE) (optional) limit of returned categories in SQL format ("quantity skipped, quantity downloaded")
filter_sortvarchar(30)(optional) the value for sorting the product list. Possible values: "id [ASC|DESC]", "name [ASC|DESC]", "quantity [ASC|DESC]", "price [ASC|DESC]"
filter_idvarchar(30)(optional) limiting results to a specific product id
filter_eanvarchar(320)(optional) limiting results to a specific ean
filter_skuvarchar(32)(optional) limiting the results to a specific SKU (stock keeping number)
filter_namevarchar(100)(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_quantity_fromint(optional) minimum quantity limit
filter_quantity_toint(optional) maximum quantity limit
filter_availableint(optional) displaying only products marked as available (value 1) or not available (0) or all (empty value)
pageint(optional) Results paging (for BaseLinker storage 1000 products per page)
include_variantsbool(optional) Include product variants additonally to products



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
storage_idvarchar(30)Storage ID in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
productsarrayAn array of products containig the fields listed below
| - product_idvarchar(30)The main Product ID.
| - eanvarchar(32)Product EAN number.
| - skuvarchar(32)Product SKU number.
| - namevarchar(200)Product name
| - quantityintStock quantity
| - price_bruttofloatProduct gross price (net price is not available from this function).



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