Merchant API

Edit Warehouse

Edit specified warehouse info. Any fields left off will be unchanged.

Array Request Fields

Field NameData TypeLengthRequired?Description
inventory_warehouseString45YName of Warehouse in CartRover
wms_warehouse_nameStringNOptional Name of Warehouse in WMS
wms_warehouse_idStringNOptional ID of Warehouse in WMS
defaultBooleanNDefault false. Make this warehouse the default warehouse?
disabledBooleanNDefault false. Setting true will disable this warehouse.

Array Response Fields

FieldData TypeLengthDescription
inventory_warehouseStringWarehouse Name within CartRover
wms_warehouse_nameStringOptional Warehouse Name provided by WMS
wms_warehouse_idStringOptional Warehouse ID provided by WMS
extra_paramsArrayList of "addresses" and "contacts" for this warehouse.
disabledBooleanTrue if this warehouse is disabled. Disabled warehouses are not used for inventory sync in CartRover.
is_defaultBooleanTrue if this is the default warehouse.
restock_levelIntGlobal 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

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.