Method list

Test your request

Changelog

The method allows you to retrieve the list of warehouse zones. The returned list is sorted alphabetically by name.





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
zones	array	An array of warehouse zones containing the fields listed below.
| - zone_id	int	Zone identifier. Use this value as zone_id when calling addInventoryWarehouseRack (to assign a rack to a zone) or addInventoryWarehouseLocation (to assign a location to a zone).
| - name	varchar(50)	Zone name.
| - color	char(6)	Zone color in 6-character lowercase hex format (without "#"), e.g. "5cb85c".
| - location_prefix	varchar(10)	Prefix applied to location names within this zone. Empty string if not set.

Input data:
{} Output data:
{ "status": "SUCCESS", "zones": [ { "zone_id": 101, "name": "Cold Storage", "color": "4285f4", "location_prefix": "CS" }, { "zone_id": 102, "name": "Receiving Area", "color": "5cb85c", "location_prefix": "" } ] } A sample request in PHP:
<?php $methodParams = '{}'; $apiParams = [ "method" => "getInventoryWarehouseZones", "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);