Categories

A category groups related parts in your inventory catalog. Categories are created and managed in the Desktop application; this API provides read access and the ability to discontinue them.

The Category Object

{
  "categoryID": 5,
  "name": "Fasteners",
  "description": "Bolts, nuts, screws, and related hardware",
  "active": true,
  "created": "2020-01-08T10:00:00",
  "modified": "2023-07-14T09:30:00"
}

List Active Categories

GET /Category

Returns active categories with standard pagination parameters.

{
  "value": [
    {
      "categoryID": 5,
      "name": "Fasteners",
      "description": "Bolts, nuts, screws, and related hardware",
      "active": true,
      "created": "2020-01-08T10:00:00",
      "modified": "2023-07-14T09:30:00"
    },
    {
      "categoryID": 9,
      "name": "Electrical",
      "description": "Wiring, connectors, and components",
      "active": true,
      "created": "2020-01-08T10:00:00",
      "modified": "2024-03-05T14:00:00"
    }
  ],
  "totalCount": 18,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

List All Categories

GET /Category/All

Includes discontinued categories. Uses the same response shape as the active list.

{
  "value": [
    {
      "categoryID": 3,
      "name": "Legacy Parts",
      "description": "Discontinued product line",
      "active": false,
      "created": "2018-05-01T00:00:00",
      "modified": "2022-10-01T00:00:00"
    },
    {
      "categoryID": 5,
      "name": "Fasteners",
      "description": "Bolts, nuts, screws, and related hardware",
      "active": true,
      "created": "2020-01-08T10:00:00",
      "modified": "2023-07-14T09:30:00"
    }
  ],
  "totalCount": 22,
  "page": 1,
  "pageSize": 25,
  "pageCount": 1,
  "hasMore": false
}

Get a Category

GET /Category/{id}

Returns 404 if the category does not exist.

GET /Category/5

{
  "categoryID": 5,
  "name": "Fasteners",
  "description": "Bolts, nuts, screws, and related hardware",
  "active": true,
  "created": "2020-01-08T10:00:00",
  "modified": "2023-07-14T09:30:00"
}

Discontinue a Category

DELETE /Category/{id}

Marks the category as discontinued. Parts assigned to this category are not affected. Returns 204 on success.

DELETE /Category/5

Permissions