Returns the item type with the given identifier.

GET /inventory/item-types/{id}

Group: Inventory › Item Types · Operation ID: getItemType

Returns the same fields as POST inventory/item-types/search. The collection GET inventory/item-types omits itemCount.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "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 for the item type to return.

Response

200 Success

Under data (getItemTypeOutput):

Field Type Required Description
id string yes The unique identifier for the item type.
name string no The display name of the item type, for example 'Stocked good'. Two item types cannot share a name.
description string no A free-form description of the item type.
procurable boolean no Whether items of this type can appear on purchase documents.
stockable boolean no Whether items of this type hold stock.
active boolean no Whether the item type can be chosen for new items.
itemCount number no The number of items that name this item type.
createdDate string (date-time) no The date and time the item type was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the item type record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses