Merchant API
List Warehouses
Returns a list of all warehouses set up in CartRover. Any filters should be passed with the URL as GET arguments.
Filters
| Argument | Description |
|---|---|
| include_disabled | Y or N. Default N Also return warehouses listed as disabled in CartRover? |
Array Response Fields
| Field | Data Type | Length | Description |
|---|---|---|---|
| inventory_warehouse | String | Warehouse Name within CartRover | |
| wms_warehouse_name | String | Optional Warehouse Name provided by WMS | |
| wms_warehouse_id | String | Optional Warehouse ID provided by WMS | |
| extra_params | Array | List of "addresses" and "contacts" for this warehouse. | |
| disabled | boolean | true if this warehouse is disabled. Disabled warehouses are not used for inventory sync in CartRover. | |
| is_default | boolean | true if this is the default warehouse. | |
| restock_level | Int | Global requested restock level if inventory drops below this level for any item |
The key for each warehouse in the array is the internal CartRover warehouyse id. This is needed for modifying the warehouse fields via the API.
get/v1/merchant/warehouse/list
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Headers
Content-Typestring
Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.