Stock positions

The current quantity of an item at a specific site, area, location and identifier.

Fields

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

Name	API name	Type	Required	Description
ID	`id`	Record ID	Yes
Item	`productitemId`	Reference
Customer	`customerId`	Reference		Customer that owns consigned or maquila stock. Empty when ownership is Company.
On hand	`onhand`	Quantity	Yes	Current quantity at the location, regardless of physical conformity. On hand equals available plus on hold plus reserved. Does not include In transit.
Available	`available`	Quantity	Yes	Quantity at the location that can be allocated. Calculated as on hand minus on hold minus reserved.
On hold	`onhold`	Quantity	Yes	Quantity blocked due to operational reasons, such as quality inspection, discrepancies, or administrative review.
Reserved	`reserved`	Quantity	Yes	Quantity staged for an issue and still at this location.
Item	`customitemId`	Reference
Identifier	`inventoryidentifierId`	Reference
Catalog	`catalog`	Constant	Yes	Fixed option from the allowed set for this field.
Unit	`catalogunit`	Unit
Ownership	`ownership`	Constant	Yes	Beneficial owner of the stock. The custodial company remains the record's company.
Nominal	`isNominal`	Boolean	Yes	Whether the referenced identity conforms to the product's nominal definition. Quantity-tracked rows are always nominal because they have no identity.
Location	`sitelocationId`	Reference	Yes
Zone	`siteareaId`	Reference	Yes
Created at	`createdAt`	Date and Time	Yes
Updated at	`updatedAt`	Date and Time	Yes

Field	Points to	Kind
Customer `customerId`	Customers	reference
Identifier `inventoryidentifierId`	Inventory identifiers	reference
Location `sitelocationId`	Site locations	reference
Zone `siteareaId`	Site areas	reference