Stock Object
Caution: use freeToAllocateQuantity (FTA) unless you have a good reason to opt for another field.
Quantities other than FTA require more expensive calculations, which are reflected in query complexity scores.
Quantities in Stock have the following meaning
Caution: neither stockOffset from ProductVariant, nor threshold from Warehouse are included in the returned
freeToAllocate. If your integration requires them for stock calculation, you can fetch these numbers and compare
to the returned stock values.
Fields
#
availableNowQuantity
This is the amount of products available to allocate to orders minus the stock that has created demand.
availableQuantity
Total stock, which is or will be available: FTA - demand + unlinked incoming quantity.
demandQuantity
What is ordered, but not allocated yet, and not linked to a purchase (supplier) order. Usually backorder and/or preorder.
freeToAllocateQuantity
Free to allocate (FTA) is the quantity to use in most cases: what is available for purchase and allocation to new orders at the moment. The FTA does not include possible warehouse threshold nor variant's stock offset.
incomingQuantity
This field is only populated if you are using the Supplier Module and have purchase orders with products that are not yet delivered.
linkedIncomingQuantity
The part of incomingQuantity, which is already linked to orders. It decreases demandQuantity.
onDeliveryQuantity
This field is populated if a product is on a purchase order delivery that has not yet been accepted.
physicalQuantity
Physical is what is on warehouse shelf, both FTA and already allocated to orders.
unlinkedIncomingQuantity
The part of incomingQuantity, which is not linked to orders. It also increases available quantity.
unshippedQuantity
The quantity of ordered products, allocated or demand, but not yet shipped.
Usages
#
References
#
- Field stock from ProductSize
- Field stock from ProductVariant
- Field stock from Warehouse
Status
StockChange