Returns a list of item types.

GET /inventory/item-types

Group: Inventory › Item Types · Operation ID: itemTypes

Use this collection to find a valid itemTypeId before creating an item. It does not include itemCount, the number of items that name each type. Read that from GET inventory/item-types/:id or POST inventory/item-types/search.

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`.

Query surface

id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
name — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
procurable — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
stockable — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
Orderable: id, name, active, createdDate, lastModifiedDate
Selectable: id, name, description, procurable, stockable, active, createdDate, lastModifiedDate

Response

200 Success

Under data, an array of itemTypesRow:

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

Statuses

400 — Invalid request or business failure
401 — Missing or invalid access token
403 — Not authorized
404 — Not found
429 — Too many requests
500 — Internal server error