Merchant API
Edit Warehouse
Edit specified warehouse info. Any fields left off will be unchanged.
Array Request Fields
| Field Name | Data Type | Length | Required? | Description |
|---|---|---|---|---|
| inventory_warehouse | String | 45 | Y | Name of Warehouse in CartRover |
| wms_warehouse_name | String | N | Optional Name of Warehouse in WMS | |
| wms_warehouse_id | String | N | Optional ID of Warehouse in WMS | |
| default | Boolean | N | Default false. Make this warehouse the default warehouse? | |
| disabled | Boolean | N | Default false. Setting true will disable this warehouse. |
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 |
If successful, the warehouse will be returend in the same format as the List Warehouses API call.
post/v1/merchant/warehouse/{WAREHOUSE_PK}
Request
- Base URLhttp://{{base_url}}
- AuthHTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
WAREHOUSE_PKstring required
Headers
Content-Typestring
Request body */*
string required
Example request
"\"{\\n \\\"inventory_warehouse\\\": \\\"New WHS\\\",\\n \\\"wms_warehouse_name\\\": \\\"New WHS Name\\\",\\n \\\"wms_warehouse_id\\\": \\\"New WHS ID\\\",\\n \\\"default\\\": false\\n}\""Response
OK
object required
Changes
No recorded changes to this operation across all 1 revision of this API.