Method list

Test your request

Changelog

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

storage_id	varchar(30)	Storage ID in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
filter_category_id	varchar(30)	(optional) Retrieving products from a specific category
filter_sort	varchar(30)	(optional) the value for sorting the product list. Possible values: "id [ASC|DESC]", "name [ASC|DESC]", "quantity [ASC|DESC]", "price [ASC|DESC]"
filter_id	varchar(30)	(optional) limiting results to a specific product id
filter_sku	varchar(50)	(optional) limiting the results to a specific SKU
filter_ean	varchar(320)	(optional) limiting results to a specific ean
filter_asin	varchar(50)	(optional) limiting results to a specific asin
filter_name	varchar(255)	(optional) item name filter
filter_price_from	float	(optional) minimum price limit
filter_price_to	float	(optional) maximum price limit
filter_quantity_from	int	(optional) minimum quantity limit
filter_quantity_to	int	(optional) maximum quantity limit
filter_available	int	(optional) displaying only products marked as available (value 1) or not available (0)
page	int	(optional) Results paging (for BaseLinker storage 1000 products per page)

The method returns the data in JSON format.

status	varchar(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_id	varchar(30)	Storage ID in format "[type:bl|shop|warehouse]_[id:int]" (e.g. "shop_2445").
products	array	An array of products containing the fields listed below
| - product_id	varchar(30)	The main Product ID.
| - sku	varchar(50)	Product SKU number.
| - ean	varchar(50)	Product EAN number.
| - asin	varchar(50)	Product ASIN number.
| - name	varchar(255)	Product name
| - quantity	int	Stock quantity
| - price_brutto	float	Product gross price

Input data:
{ "storage_id": "bl_1", "filter_category_id": "123", "page": 1 } Output data:
{ "status": "SUCCESS", "storage_id": "bl_1", "products": [ { "product_id": "12345", "ean": "5901234123457", "asin": "", "sku": "SKU123", "name": "Sample product", "quantity": 100, "price_brutto": 99.99 } ] } A sample request in PHP:
<?php $methodParams = '{ "storage_id": "bl_1", "filter_category_id": "123", "page": 1 }'; $apiParams = [ "method" => "getProductsList", "parameters" => $methodParams ]; $curl = curl_init("https://api.baselinker.com/connector.php"); curl_setopt($curl, CURLOPT_POST, 1); curl_setopt($curl, CURLOPT_HTTPHEADER, ["X-BLToken: xxx"]); curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($apiParams)); $response = curl_exec($curl);