Item Master¶

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

Required privilege: Item Master / View (read) · Item Master / Edit (write)

The Item Master contains the canonical list of all items (products, components, raw materials) used across purchase orders, sales orders, manufacturing orders, forecasts, and inventory.

Item Object¶

{
  "id": 55,
  "Item Number": "ITEM-A",
  "Item Description": "Widget Assembly - Type A",
  "Item Type": "Finished Good",
  "Item Unit": "EA",
  "Item Status": "Active",
  "Item Servicenow Id": null,
  "Item Weight": 0.5,
  "Item Weight Unit": "KG"
}

Field	Type	Description
`id`	integer	Internal item identifier
`Item Number`	string	Unique item reference code
`Item Description`	string	Display name
`Item Type`	string	Classification (e.g., `Finished Good`, `Component`, `Raw Material`)
`Item Unit`	string	Unit of measure reference
`Item Status`	string	`Active` or `Inactive`
`Item Servicenow Id`	string \| null	External ServiceNow reference

GET - List Items¶

GET /api/item-master HTTP/1.1

Returns a paginated, filterable list of all items.

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

GET - Get Item¶

GET /api/item-master/{id} HTTP/1.1

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

POST - Create Item¶

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

{
  "Item Number": "ITEM-NEW",
  "Item Description": "New Widget",
  "Item Type": "Finished Good",
  "Item Unit": "EA",
  "Item Status": "Active"
}

Validation: Item Number must be unique.

PUT - Update Item¶

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

{
  "Item Description": "Updated Widget Description",
  "Item Status": "Inactive"
}

DELETE - Delete Item¶

DELETE /api/item-master/{id} HTTP/1.1
X-XSRF-TOKEN: <csrf>

Error: Returns ItemMaster.StillInUse if the item is referenced by any orders, inventory, or forecasts.

Errors¶

Status	Code	Description
400	`ItemMaster.NotFound`	No item with this ID
400	`ItemMaster.AlreadyExists`	Item Number already in use
400	`ItemMaster.StillInUse`	Item referenced by other records
403	`User.NotPrivileged`	Insufficient privilege