Returns the item category with the given identifier.

GET /inventory/item-categories/{id}

Group: Inventory › Item Categories · Operation ID: getItemCategory

Returns one item category by id. The response uses the same schema as GET inventory/item-categories and POST inventory/item-categories/search.

Names are not unique, so there is no name-keyed variant of this endpoint. To look one up by name, filter the collection with GET inventory/item-categories?filter[name][eq]=Hardware, which returns the same schema in an array.

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 category to return.

Response

200 Success

Under data (getItemCategoryOutput):

Field Type Required Description
id string yes The unique identifier for the item category.
name string yes The display name of the category, for example 'Hardware'. Not unique: two categories can share a name, so use id to address one.
description string no A free-form description of what the category covers. Absent when none was set.
active boolean no Whether the category can be chosen on new items. When false the category is retired: existing items keep it and new ones cannot be assigned to it.
idealTurnoverRatio string (decimal) no The target inventory turnover for items in this category, in times per year. For analytics only. A ratio rather than an amount, so it has no currency.
lastModifiedDate string (date-time) no The date and time the category last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
parentId string no The identifier of the category this one sits under. Absent for a top-level category. See id on GET inventory/item-categories/:id.

Errors

Code Status
NOT_FOUND 400

Statuses