Skip to content

Warehouse Master

GET    /api/warehouse-master
POST   /api/warehouse-master
PUT    /api/warehouse-master/{id}
DELETE /api/warehouse-master/{id}

Required privilege: Warehouse Master / View (read) ยท Warehouse Master / Edit (write)

The Warehouse Master defines the physical or logical stocking locations used across all order types, inventory records, and planning.


Warehouse Object

{
  "id": 3,
  "Warehouse Number": "WH-01",
  "Warehouse Name": "Main Distribution Center",
  "Warehouse Address": "789 Logistics Ave, Chicago, IL",
  "Warehouse Status": "Active",
  "Warehouse Servicenow Id": null
}
Field Type Description
id integer Internal warehouse identifier
Warehouse Number string Unique reference code
Warehouse Name string Display name
Warehouse Status string Active or Inactive
Warehouse Servicenow Id string | null External ServiceNow reference

GET - List Warehouses

curl -b cookies.txt "https://acme.knosc.com/api/warehouse-master"

POST - Create Warehouse

POST /api/warehouse-master HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Warehouse Number": "WH-NEW",
  "Warehouse Name": "West Coast DC",
  "Warehouse Status": "Active"
}

PUT - Update Warehouse

PUT /api/warehouse-master/{id} HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "Warehouse Name": "Main DC - Chicago",
  "Warehouse Status": "Inactive"
}

DELETE - Delete Warehouse

Error: Returns WarehouseMaster.StillInUse if the warehouse has inventory or order records.


Default Filtering

Inactive warehouses are excluded by default from all list endpoint responses across the API. They can be included by explicitly filtering on Warehouse Status.


Errors

Status Code Description
400 WarehouseMaster.NotFound No warehouse with this ID
400 WarehouseMaster.AlreadyExists Warehouse Number already in use
400 WarehouseMaster.StillInUse Warehouse has dependent records
403 User.NotPrivileged Insufficient privilege