Update a specific item
Path parameters
Request body
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.
Item description.
Accounting code key identifier. Please reference /api/accounting-codes endpoint.
Accounting code key identifier. Please reference /api/accounting-codes endpoint.
Item material code key identifier. Please reference /api/material-codes endpoint.
Item grade code key identifier. Please reference /api/grade-codes endpoint.
Item shape code key identifier. Please reference /api/shape-codes endpoint.
Item gauge code key identifier. Please reference /api/gauge-codes endpoint.
Item category code key identifier. Please reference /api/item-categories endpoint.
Item width
Item height
Item length
Item weight
Item minimum stock on hand.
Item minimum production quantity for a manufacturing run.
Internal item notes.
The item's stocking unit of measure — the unit every inventory quantity, cost, and transaction on the item is expressed in. If omitted — or sent as null, or as a string that is empty or only whitespace — the current unit of measure is kept; there is no way to clear it. The unit must belong to the item's existing unit type (a Pieces item accepts Piece, Set or Case); the unit type itself cannot be changed after the item is created. Changing the unit is rejected while anything already carries a unit that the change would invalidate — the item being in use by a quote, sales order, purchase order, job, invoice or another item's routing, holding inventory on hand, or having a price break that carries a price (item, vendor, customer, or customer-tier) — because none of those is converted when the unit changes. The 400 names which one blocked the change. Each condition is read as the item stands before the update, so clearing a blocker and changing the unit in one request is still rejected — clear it first, then change the unit in a second request. Sales unit of measure conversions are the exception: they are replaced wholesale by every update, so changing the unit while sending none is accepted, and a request that changes the unit while conversions are present — sent on the update, or carried forward from the item by a patch — is rejected. An item with no unit type recorded cannot have its unit changed at all. Surrounding whitespace is trimmed; the remainder is matched case-sensitively, as on item create.
Whether or not this item is taxable (default)
Whether this item is lot-tracked. If omitted, the current setting is kept.
Whether this item is a non-inventory item — one that supports the business but is never held in inventory. Turning it on is rejected with a 400 unless the item is a buy item that is not sellable; an item that is already non-inventory can restate that value, so a read-modify-write update of a legacy item does not start failing. Setting this also keeps the item's inventoried state in step: a non-inventory item is never inventoried. If omitted, the current setting is kept.
Arbitrary key-value-pair like data that can be used to later on search for this line item.
Response
Item
Id
The number to give the item.
The description to give the item.
The unit of measure type, ex: Piece, Volume or Weight
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.
The barcode number to give the item.
Define if this item is able to be sold/sellable.
Indicate if this item is archived.
Indicate if this item is considered a non-inventory item.
Accounting code key identifier. Please reference /api/accounting-codes endpoint.
Accounting code 2 key identifier. Please reference /api/accounting-codes endpoint.
Item material code key identifier. Please reference /api/material-codes endpoint.
Item grade code key identifier. Please reference /api/grade-codes endpoint.
Item shape code key identifier. Please reference /api/shape-codes endpoint.
Item gauge code key identifier. Please reference /api/gauge-codes endpoint.
Item category code key identifier. Please reference /api/item-categories endpoint.
Item width
Item height
Item length
Item weight
The weight of material item (calculated)
Item minimum stock on hand.
Item minimum production quantity for a manufacturing run.
Custom fields that have been defined on this entity.
Internal item notes.
External references associated with this entity.
Whether this item is taxable
Whether or not this item is build to order (jobs are made from sales orders, not overall demand)
Whether or not this item is build to stock (jobs are created from overall demand, not sales orders)
Indicate if this item is intended for single use.
Indicate if this item is lot-tracked.
The date the item was created
The date the item was last modified
Whether this item requires an approved quality plan. When true, the item has an approved quality plan only if FulcrumProduct.PublicApi.Dto.Item.ItemDto.QualityPlanStatus is Approved; when false, no quality plan approval is required. Read-only: returned on item reads but not settable through the create/update endpoints.