Items

The Items endpoint manages your part catalog — the master list of everything you stock, track, or sell. Items are identified by a shortID (your SKU or part number string) and an internal partNo (auto-assigned integer).

The Item Object

{
  "partNo": 42,
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm",
  "category": 5,
  "subCategory": 12,
  "uOM": "EA",
  "putUp": "Box/100",
  "units": 1.0,
  "dfltOwner": 0,
  "created": "2024-03-15T10:30:00Z",
  "modified": "2025-01-20T14:22:00Z",
  "discontinued": false
}

Endpoints

List Items

GET /Item?page=1&pageSize=25

Returns active (non-discontinued) items, sorted by ShortID.

Parameters

Standard pagination parameters apply.

Response

{
  "value": [
    {
      "partNo": 42,
      "shortID": "BOLT-M8-30",
      "description": "Hex Bolt M8x30mm",
      "category": 5,
      "subCategory": 12,
      "uOM": "EA",
      "putUp": "Box/100",
      "units": 1.0,
      "dfltOwner": 0,
      "created": "2024-03-15T10:30:00Z",
      "modified": "2025-01-20T14:22:00Z",
      "discontinued": false
    }
  ],
  "totalCount": 2340,
  "page": 1,
  "pageSize": 25,
  "pageCount": 94,
  "hasMore": true
}

Each item in value contains the fields documented in The Item Object above.

List All Items (Including Discontinued)

GET /Item/All?page=1&pageSize=25

Same as the standard list, but includes discontinued items. Use this when you need a complete catalog export.

Get Item by ShortID

GET /Item?key=BOLT-M8-30&type=id

Returns the full item record for the given ShortID. Returns 404 if not found.

Get Item by Alias

GET /Item?key=ALT-BOLT-M8&type=alias

Looks up an item using an alias (alternate part number). Returns the item that the alias points to. Returns 404 if the alias doesn’t exist.

Get Items by Category

GET /Item?Category=5

Returns all items in the given category. This endpoint returns a flat array (not paginated).

Create an Item

POST /Item

Request Body

{
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm",
  "uOM": "EA",
  "category": 5,
  "putUp": "Box/100"
}

The request body accepts the same fields as the Item Object. Only shortID is required — include whichever other fields you want to set.

Required Fields

Optional Fields

Response

{
  "shortID": "BOLT-M8-30",
  "status": "created"
}

Error Cases

Update an Item

PUT /Item

Updates an existing item. Only the fields you include in the request body are changed — omitted fields are left as-is.

Request Body

{
  "shortID": "BOLT-M8-30",
  "description": "Hex Bolt M8x30mm Zinc Plated"
}

shortID is required to identify which item to update. The ShortID itself cannot be changed.

Immutable Fields

These fields are preserved regardless of what you send:

• partNo — internal ID, never changes
• shortID — identifies the item, cannot be renamed
• created / createdBy — original creation audit

Response

{
  "shortID": "BOLT-M8-30",
  "status": "updated"
}

Error Cases

Discontinue an Item

DELETE /Item/BOLT-M8-30

Marks the item as discontinued. The item remains in the system (for historical data) but won’t appear in the default active item list.

This does not delete inventory records — it’s a soft delete.

Response

{
  "shortID": "BOLT-M8-30",
  "status": "discontinued"
}

Error Cases

Permissions