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
Output data:
A sample request in PHP:
| 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 (optional) |
| filter_limit | varchar(30) | (OBSOLETE) (optional) limit of returned categories in SQL format ("quantity skipped, quantity downloaded") |
| 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(32) | (optional) limiting the results to a specific SKU (stock keeping number) |
| 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(100) | (optional) item name filter (part of the searched name or an empty field) |
| filter_price_from | float | (optional) minimum price limit (not displaying products with lower price) |
| 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) or all (empty value) |
| page | int | (optional) Results paging (for BaseLinker storage 1000 products per page) |
Output data
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 containig the fields listed below |
| | - product_id | varchar(30) | The main Product ID. |
| | - sku | varchar(32) | Product SKU number. |
| | - ean | varchar(32) | Product EAN number. |
| | - asin | varchar(50) | Product ASIN number. |
| | - name | varchar(200) | Product name |
| | - quantity | int | Stock quantity |
| | - price_brutto | float | Product gross price (net price is not available from this function). |
Sample
Input data:Output data:
A sample request in PHP: