Sign in

v2

latestOpenAPI 3.0.42026-08-084694591.6 MB
Item

Create a new item

post/api/items

Request body

numberstring required

The name to give the item. Must be unique to all active items.

descriptionstring

The verbose description to give the item.

revisionstring nullable

Revision name

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

The unit of measure type, ex: Pieces, Volume, Weight, Area

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.

isSellableboolean nullable

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

isSingleUseItemboolean nullable

Indicate if this item is intended for single use.

isLotTrackedboolean nullable

Indicate if this item is going to be lot-tracked.

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.

categoryIdstring nullable

Item category code key identifier. Please reference /api/item-categories 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.

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)

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)

externalReferencesobject nullable

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

Response

Item created

idstring required

The id of the created record