API documentation
Method list
Test your request
Changelog


getInventoryWarehouseLocations
The method allows you to retrieve the list of warehouse locations (slots/bins) defined for a given Base inventory warehouse. Locations are returned in pages of 100 entries, sorted by name.


Input parameters
warehouse_idintWarehouse identifier returned by getInventoryWarehouses (the warehouse_id field).
warehouse_typevarchar(20)Warehouse type returned by getInventoryWarehouses (the warehouse_type field).
pageint(optional) Results page number (100 locations per page, numbered from 1). Default: 1.



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
locationsarrayAn array of warehouse locations containing the fields listed below.
| - location_idintLocation identifier. Use this value as location_id when calling addInventoryWarehouseLocation (update) or deleteInventoryWarehouseLocation.
| - namevarchar(20)Location name (e.g. "A-01-A-1").
| - colorchar(6)Location label color in 6-character lowercase hex format (without "#"), e.g. "5cb85c".
| - is_pickableboolWhether the location is pickable.
| - priorityintPriority value (1-99999).
| - location_type_idintIdentifier of the location type.
| - zone_idintIdentifier of the zone the location belongs to, or 0 if not assigned.
| - rack_idintIdentifier of the rack the location belongs to, or 0 if not assigned.



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