getInventoryProductsList
The method allows to retrieve a basic data of chosen products from BaseLinker catalogs.
Input parameters
Output data:
A sample request in PHP:
inventory_id | int | Catalog ID. The list of identifiers can be retrieved using the method getInventories. |
filter_id | int | (optional) limiting results to a specific product id |
filter_category_id | int | (optional) Retrieving products from a specific category (optional) |
filter_ean | varchar(32) | (optional) limiting results to a specific ean |
filter_sku | varchar(50) | (optional) limiting the results to a specific SKU (stock keeping number) |
filter_name | varchar(200) | (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_stock_from | int | (optional) minimum quantity limit |
filter_stock_to | int | (optional) maximum quantity limit |
page | int | (optional) Results paging (1000 products per page for BaseLinker warehouse) |
filter_sort | varchar(30) | (optional) the value for sorting the product list. Possible values: "id [ASC|DESC]" |
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 |
products | array | A list of products where the key is the product id and the value is an array of fields listed below. |
| - id | int | Product ID number. |
| - ean | varchar(32) | Product EAN number. |
| - sku | varchar(32) | Product SKU number. |
| - name | varchar(200) | Product name |
| - prices | array | A list containing 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. |
| - stock | array | A 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 the following 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: