Method list

Test your request

Changelog

The method allows you to retrieve a list of warehouses available in BaseLinker inventories. The method also returns information about the warehouses created automatically for the purpose of keeping external stocks (shops, wholesalers etc.)





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
warehouses	array	An array of warehouses containing the fields listed below
| - warehouse_type	varchar(30)	Warehouse type. The "bl" value identifies BaseLinker-native warehouses; other values reflect the integration type that owns the warehouse (e.g. "shop", "warehouse", "fulfillment", "blconnect").
| - warehouse_id	int	Warehouse identifier
| - name	varchar(100)	Warehouse name
| - description	text	Warehouse description
| - stock_edition	bool	Is manual stock editing permitted. A false value means that you can only edit your stock through the API.
| - is_default	bool	Is this warehouse a default warehouse
| - address	varchar(200)	Warehouse street address. May be an empty string if no address is set.
| - postcode	varchar(20)	Warehouse postal code. May be an empty string if no postal code is set.
| - city	varchar(80)	Warehouse city. May be an empty string if no city is set.
| - country	char(2)	Warehouse country as a 2-letter ISO 3166-1 country code (e.g. "PL", "DE", "GB"). May be an empty string if no country is set.

Input data:
{} Output data:
{ "status": "SUCCESS", "warehouses": [ { "warehouse_type": "bl", "warehouse_id": 205, "name": "Default", "description": "Default warehouse located in London", "stock_edition": true, "is_default": true, "address": "10 Downing Street", "postcode": "SW1A 2AA", "city": "London", "country": "GB" }, { "warehouse_type": "shop", "warehouse_id": 2334, "name": "MyShop.com", "description": "Warehouse keeping stocks for Myshop.com", "stock_edition": false, "is_default": false, "address": "", "postcode": "", "city": "", "country": "" } ] } A sample request in PHP:
<?php $methodParams = '{}'; $apiParams = [ "method" => "getInventoryWarehouses", "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);