Stock by site

The current on-hand, available, on-hold, reserved and allocated quantities of an item for one site.

Fields

The API name is what the API, MCP and the CLI use.

NameAPI nameTypeRequiredDescription
IDidRecord IDYes
ItemproductitemIdReference
CustomercustomerIdReferenceCustomer that owns consigned or maquila stock. Empty when ownership is Company.
On handonhandQuantityYesCurrent quantity at the site, regardless of tracking identity or physical conformity. Does not mean every unit is an interchangeable instance of the nominal product. On hand equals available plus on hold plus reserved plus allocated. Does not include In transit.
AvailableavailableQuantityYesQuantity at the site that can be allocated. Calculated as on hand minus on hold minus reserved minus allocated.
On holdonholdQuantityYesQuantity blocked due to operational reasons, such as quality inspection, discrepancies, or administrative review.
In transitintransitQuantityYesQuantity shipped and not yet received at this site. It is not part of on hand.
ReservedreservedQuantityYesQuantity committed to demand and still at the site.
AllocatedallocatedQuantityYesQuantity set aside for a demand document. Available subtracts it.
ItemcustomitemIdReference
CatalogcatalogConstantYesFixed option from the allowed set for this field.
UnitcatalogunitUnit
OwnershipownershipConstantYesBeneficial owner of the stock. The custodial company remains the record's company.
Has non-nominal stockhasNonNominalBooleanYesTrue when at least one identity at this site has on hand greater than zero and is not nominal.
Created atcreatedAtDate and TimeYes
Updated atupdatedAtDate and TimeYes

Relations

FieldPoints toKind
Customer customerIdCustomersreference