Skip to content

WarehouseStockState ​

Type: Object

A warehouse stock record tracking inventory at a location

Fields ​

NameTypeArgsDescriptionDeprecated
availableQuantityFloat!Quantity free to reserve or issue: quantity minus reservedQuantity. Derived, not stored.
batchNumberStringSupplier or production batch this stock belongs to. Null when the stock is not batch-tracked.
createdAtString!ISO8601 timestamp the stock record was created.
expiryDateISO8601ISO8601 date after which this stock should not be consumed. Null when the item does not expire. Advisory — nothing blocks issuing expired stock.
idWarehouseStockID!The stock record's id, as a TypeID (e.g. "wst_01K…").
lastCountedAtISO8601ISO8601 timestamp of the last physical stock count that set quantity. Null if the record has never been counted, only transacted.
locationIdWarehouseLocationID!Warehouse location holding this stock, as a TypeID (e.g. "wlc_01K…"). A stockable item held in two locations is two records, not one.
notesStringFree-text operator notes on this stock record.
quantityFloat!Total quantity on hand at this location, in unit. Never negative. Includes stock that is reserved but not yet issued.
reservedQuantityFloat!Quantity committed to jobs but not yet issued. Never negative, and never more than quantity — reserved stock is still physically on hand.
stockableStockable!The catalog entity this row stocks, moves, reserves or consumes, resolved from the row's stockable type and id. Members of the Stockable union are contributed by the active vertical (PrintVertical contributes SubstrateState); with no vertical loaded the union holds only the platform fallback. Rows the vertical cannot resolve — an unmodelled kind such as ink or tooling, or a partner-supplied id with no local record — surface as a StockableMarker carrying the original type, id, external id and label. Never null.
unitMeasurementUnit!Unit quantity is measured in. Defaults to PC (pieces).
updatedAtString!ISO8601 timestamp the stock record was last modified.

Connect machines, automate workflows, and build custom apps for print production.