getInventoryMaps
The method allows you to retrieve a list of warehouse maps available in the BaseLinker inventory system. Each warehouse map represents a location with assigned warehouses and an optional visual map layout.
Input parameters
Output data:
A sample request in PHP:
Output data
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 |
| maps | array | An array of warehouse maps containing the fields listed below |
| | - 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. |
Sample
Input data:Output data:
A sample request in PHP: