Retrieve an item type

Operation ID: getItemType

Group: Inventory › Item Types

Open in the interactive reference

GET /inventory/item-types/{id}

Read-only: Reads and returns; changes nothing.

Retrieves an item type. The item type comes back with itemCount, the number of items that use it. The collection GET inventory/item-types leaves itemCount out. POST inventory/item-types/search returns the same fields as this endpoint.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier of the item type you want to retrieve.

Response

200 Success

Under data (getItemTypeOutput):

Field Type Required Description
id string yes The unique identifier for the item type. Example: "66aea173-07b8-4c4e-bc4a-5c35dedfdc16".
name string no The display name of the item type, for example 'Stocked good'. Two item types cannot share a name. Example: "Stocked good".
description string no A free-form description of the item type. Example: "Physical goods held in a warehouse".
procurable boolean no Whether items of this type can appear on purchase documents. Example: true.
stockable boolean no Whether items of this type hold stock. Example: true.
active boolean no Whether the item type can be chosen for new items. Example: true.
itemCount number no The number of items that name this item type. Example: 42.
createdDate date-time no The date and time the item type was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate date-time no The date and time the item type record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. Example: "2026-08-18T09:14:22.517Z". 
{
  "data": {
    "id": "66aea173-07b8-4c4e-bc4a-5c35dedfdc16",
    "name": "Stocked good",
    "description": "Physical goods held in a warehouse",
    "procurable": true,
    "stockable": true,
    "active": true,
    "itemCount": 42,
    "createdDate": "2026-01-15T09:30:00.000Z",
    "lastModifiedDate": "2026-08-18T09:14:22.517Z"
  },
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Errors

Code Status
NOT_FOUND 400

Statuses