map_id

int

Warehouse map identifier. The list of identifiers can be retrieved by the getInventoryMaps method (map_id field).

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
map_id	int	Warehouse map identifier
name	varchar(255)	Warehouse map name
is_default	bool	Whether this is the default warehouse map
address_street	varchar(255)	Street address of the warehouse map location
address_city	varchar(255)	City of the warehouse map location
address_postcode	varchar(20)	Postal code of the warehouse map location
address_country	varchar(2)	Country code of the warehouse map location (ISO 3166-1 alpha-2)
warehouses	array	An array of warehouses assigned to this map. Identifiers match those returned by getInventoryWarehouses.
| - warehouse_id	int	Warehouse identifier, matching the warehouse_id field from getInventoryWarehouses
| - warehouse_type	varchar(30)	Warehouse type, matching the warehouse_type field from getInventoryWarehouses. The value "bl" identifies native warehouses; other values reflect the integration type.
map_data	array	The full visual map layout as a JSON object. Contains the complete map structure with cells, positions, and configurations. Returns an empty object if no map layout has been created.

Input data:
{ "map_id": 1 } Output data:
{ "status": "SUCCESS", "map_id": 1, "name": "Main warehouse", "is_default": true, "address_street": "123 Logistics Avenue", "address_city": "London", "address_postcode": "EC1A 1BB", "address_country": "GB", "warehouses": [ { "warehouse_id": 205, "warehouse_type": "bl" }, { "warehouse_id": 2334, "warehouse_type": "shop" } ], "map_data": { "cells": [ { "type": "standard.Warehouse", "warehouseName": "Default", "position": { "x": 100, "y": 200 }, "size": { "width": 300, "height": 200 }, "attrs": { "label": { "text": "Default" } } } ] } } A sample request in PHP:
<?php $methodParams = '{ "map_id": 1 }'; $apiParams = [ "method" => "getInventoryMapDetails", "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);