Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Item

Update a specific item

put/api/items/{itemId}

Path parameters

itemIdstring required

Request body

numberstring nullable

The item number. If omitted, the current number is kept. Renaming enforces number uniqueness (400 on collision) and updates every reference to the item — BOM inputs, usage, purchase orders, and the system lot. Uniqueness is scoped to number + revision: when renaming an item with multiple revisions, rename every revision of the family or the revisions will split under different numbers.

descriptionstring nullable

Item description.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

accountingCode2Idstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

materialCodeIdstring nullable

Item material code key identifier. Please reference /api/material-codes endpoint.

gradeIdstring nullable

Item grade code key identifier. Please reference /api/grade-codes endpoint.

shapeIdstring nullable

Item shape code key identifier. Please reference /api/shape-codes endpoint.

gaugeIdstring nullable

Item gauge code key identifier. Please reference /api/gauge-codes endpoint.

categoryIdstring nullable

Item category code key identifier. Please reference /api/item-categories endpoint.

widthnumber double nullable

Item width

heightnumber double nullable

Item height

lengthnumber double nullable

Item length

weightnumber double nullable

Item weight

minimumStockOnHandnumber double nullable

Item minimum stock on hand.

minimumProductionQuantitynumber double nullable

Item minimum production quantity for a manufacturing run.

internalNotesstring nullable

Internal item notes.

isTaxableboolean nullable

Whether or not this item is taxable (default)

externalReferencesobject nullable

Arbitrary key-value-pair like data that can be used to later on search for this line item.

Response

Item

idstring required

Id

numberstring required

The number to give the item.

descriptionstring required

The description to give the item.

itemOrigin'make' | 'buy' | 'makeOrBuy' | 'customerSupplied' | 'kit' | 'none' required
unitTypeNamestring required

The unit of measure type, ex: Piece, Volume or Weight

unitOfMeasureNamestring required

The unit of measure name. Options available depend on the selected UnitTypeName. For Pieces, you might have a UOM of Piece, Set or Case. For Volume, options include Liter, Milliliter, etc.

barCodeNumberstring nullable

The barcode number to give the item.

isSellableboolean

Define if this item is able to be sold/sellable.

isArchivedboolean

Indicate if this item is archived.

isNonInventoryboolean

Indicate if this item is considered a non-inventory item.

accountingCodeIdstring nullable

Accounting code key identifier. Please reference /api/accounting-codes endpoint.

accountingCode2Idstring nullable

Accounting code 2 key identifier. Please reference /api/accounting-codes endpoint.

materialCodeIdstring nullable

Item material code key identifier. Please reference /api/material-codes endpoint.

gradeIdstring nullable

Item grade code key identifier. Please reference /api/grade-codes endpoint.

shapeIdstring nullable

Item shape code key identifier. Please reference /api/shape-codes endpoint.

gaugeIdstring nullable

Item gauge code key identifier. Please reference /api/gauge-codes endpoint.

categoryIdstring nullable

Item category code key identifier. Please reference /api/item-categories endpoint.

widthnumber double nullable

Item width

heightnumber double nullable

Item height

lengthnumber double nullable

Item length

weightnumber double nullable

Item weight

materialWeightnumber double nullable

The weight of material item (calculated)

minimumStockOnHandnumber double nullable

Item minimum stock on hand.

minimumProductionQuantitynumber double nullable

Item minimum production quantity for a manufacturing run.

customFieldsobject nullable

Custom fields that have been defined on this entity.

internalNotesstring nullable

Internal item notes.

externalReferencesobject nullable

External references associated with this entity.

isTaxableboolean nullable

Whether this item is taxable

buildToOrderboolean nullable

Whether or not this item is build to order (jobs are made from sales orders, not overall demand)

buildToStockboolean nullable

Whether or not this item is build to stock (jobs are created from overall demand, not sales orders)

isSingleUseItemboolean nullable

Indicate if this item is intended for single use.

isLotTrackedboolean nullable

Indicate if this item is lot-tracked.

createdUtcstring date-time

The date the item was created

modifiedUtcstring date-time

The date the item was last modified

qualityPlanStatus'needsApproval' | 'approved'