API documentation
Method list
Test your request
Changelog


getInventoryProductsStock
The method allows you to retrieve stock data of products from BaseLinker catalogs


Input parameters
inventory_idintCatalog ID. The list of identifiers can be retrieved using the method getInventories.
pageint(optional) Results paging (1000 products per page for BaseLinker warehouse)



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 containing product stocks, where the key is the product ID and the value is an array containing the fields listed below.
| - stockfloatA list where the key is the warehouse ID and the value is a stock for this 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.
| - variantsarrayA list containing variants stocks, where the key is the variant ID. The value is a list where a key is a warehouse ID and value is a stock in this warehouse.



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