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
Output data:
A sample request in PHP:
| warehouse_id | int | Warehouse identifier returned by getInventoryWarehouses (the warehouse_id field). |
| warehouse_type | varchar(20) | Warehouse type returned by getInventoryWarehouses (the warehouse_type field). |
| page | int | (optional) Results page number (100 locations per page, numbered from 1). Default: 1. |
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 |
| locations | array | An array of warehouse locations containing the fields listed below. |
| | - location_id | int | Location identifier. Use this value as location_id when calling addInventoryWarehouseLocation (update) or deleteInventoryWarehouseLocation. |
| | - name | varchar(20) | Location name (e.g. "A-01-A-1"). |
| | - color | char(6) | Location label color in 6-character lowercase hex format (without "#"), e.g. "5cb85c". |
| | - is_pickable | bool | Whether the location is pickable. |
| | - priority | int | Priority value (1-99999). |
| | - location_type_id | int | Identifier of the location type. |
| | - zone_id | int | Identifier of the zone the location belongs to, or 0 if not assigned. |
| | - rack_id | int | Identifier of the rack the location belongs to, or 0 if not assigned. |
Sample
Input data:Output data:
A sample request in PHP: