Returns the item with the given identifier.

GET /inventory/items/{id}

Group: Inventory › Items · Operation ID: getItem

Returns the item with the given identifier. POST inventory/items/search returns the same fields. The collection GET inventory/items omits standardCost, itemPurchasePrice and currency.

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

Response

200 Success

Under data (getItemOutput):

Field Type Required Description
id string yes The unique identifier for the item.
itemCode string no The item code, for example 'WIDGET-01'. Unique within the tenant. It is set when the item is created and cannot be changed.
itemName string no The display name of the item.
externalItemId string no Your own identifier for this item in an external system.
brandName string no The display name of the brand.
notes string no Free text on the item.
imageAvatar string no The URL of the item's avatar image. Absent when none is set.
itemTypeId string no The unique identifier of the item's type. It is set when the item is created and cannot be changed. See id on GET inventory/item-types/:id.
itemTypeName string no The display name of the item's type.
categoryId string no The unique identifier of the item's category. See id on GET inventory/item-categories/:id.
categoryName string no The display name of the item's category.
inventoryUnitId string no The unique identifier of the unit stock is counted in. Every quantity on an inventory level or transaction is in this unit. See id on GET inventory/unit-of-measures/:id.
inventoryUnitCode string no The code of the inventory unit.
salesUnitId string no The unique identifier of the unit used on sales documents. Absent when it is the same as the inventory unit. See id on GET inventory/unit-of-measures/:id.
salesUnitCode string no The code of the sales unit.
purchaseUnitId string no The unique identifier of the unit used on purchase documents. Absent when it is the same as the inventory unit. See id on GET inventory/unit-of-measures/:id.
purchaseUnitCode string no The code of the purchase unit.
unitGroupId string no The unique identifier of the unit of measure group that has the conversions between the item's units. See id on GET inventory/unit-of-measure-groups/:id.
unitGroupName string no The display name of the unit of measure group.
valuationMethod string no How the item's stock is valued. Possible values: 'movingAverage', 'batch', 'serials', 'none'. 'none' is for an item that is not stocked. 'fifo' can be returned but cannot be written, because it is under development.
isBatch boolean no Whether the item is tracked by batch. Receipts and shipments of it name batches.
isSerial boolean no Whether the item is tracked by serial number. Receipts and shipments of it name one serial per unit.
isInventory boolean no Whether stock levels are kept for the item. False for a service or charge item.
isSalesItem boolean no Whether the item can appear on sales documents.
isPurchaseItem boolean no Whether the item can appear on purchase documents.
active boolean no Whether the item can be selected on new documents. False means it is retired, and historical records keep it.
eccnNumber string no The Export Control Classification Number.
htsCode string no The Harmonized Tariff Schedule code.
countryOfOrigin string no The country the item originates from.
minStockLevel string (decimal) no The stock level below which the item should be reordered, in the inventory unit.
minimumTransactionQuantity string (decimal) no The smallest quantity any document can move. Absent when there is no restriction.
leadTime string (decimal) no The number of days between ordering the item and receiving it.
standardCost string (decimal) no The standard cost carried for planning, in the item's currency. It is not the value of the stock on hand. Read that from GET inventory/inventory-levels.
itemPurchasePrice string (decimal) no The expected purchase price, in the item's currency.
currency string no The currency of standardCost and itemPurchasePrice. Format ISO 4217, for example 'USD'.
weight string (decimal) no The weight of one item, in weightUnit. A landed cost Weight allocation fails rather than falling back when an item on the receipt has none.
weightUnit string no The unit weight is expressed in. Possible values: 'G', 'Kg', 'Lbs'.
grossWeight string (decimal) no The weight including packaging, in weightUnit.
netWeight string (decimal) no The weight excluding packaging, in weightUnit.
length string (decimal) no The length of one item. A landed cost Volume allocation needs length, width and height together, and fails when the set is incomplete.
width string (decimal) no The width of one item.
height string (decimal) no The height of one item.
volumePerUnit string (decimal) no The volume of one item, in volumeUnit.
volumeUnit string no The unit volumePerUnit is expressed in. Possible values: 'L'.
defaultAllocationMode string no The allocation mode a landed cost charge for this item falls back to when it names none. Possible values: 'Equal', 'Quantity', 'LineTotal', 'Weight', 'Volume'.
isPerishable boolean no Whether the item expires.
shelfLifeDays number no The number of days the item keeps from production.
minShelfLifeDaysOnReceipt number no The least remaining shelf life a receipt of this item will accept.
minShelfLifeDaysOnDispatch number no The least remaining shelf life a dispatch of this item will accept.
bestBeforeOffsetDays number no The number of days between the expiry date and the best-before date printed on it.
storageTempMin string (decimal) no The lowest temperature the item can be stored at, in degrees Celsius.
storageTempMax string (decimal) no The highest temperature the item can be stored at, in degrees Celsius.
createdDate string (date-time) no The date and time the item was created, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
lastModifiedDate string (date-time) no The date and time the item record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.

Errors

Code Status
NOT_FOUND 400

Statuses