API documentation
Method list
Test your request
Changelog


getProductsQuantity
The method allows to retrieve stock from the BaseLinker storage or the 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").
pageint(optional) Results paging (for BaseLinker storage 1000 products per page)



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.
| - quantityintStock quantity
| - variantsarrayAn array of variants containing the fields listed below
| - | - variant_idvarchar(30)Variant main identifier.
| - | - quantityintStock quantity



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