OBJECT

Stock

Quantities in Stock have the following meaning

         physical      ordered             incoming*
          /      \      /     \             /      \
freeToAllocate  allocated     demand - linked*    unlinked*

demand is decreased by linked quantity when supplier module is enabled

unshipped = all ordered items which are not in a "sent" shipment

availableNow = freeToAllocate - demand

available* = availableNow + unlinked*

on delivery* = number of incoming items from supplier orders, which are present in supplier deliveries

*from the Supplier Module

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.

More information

link GraphQL Schema definition

1type Stock {
2physicalQuantity: Int!
3
4# Returned FTA does not include possible warehouse threshold nor variant's stock offset
5freeToAllocateQuantity: Int!
6
7allocatedQuantity: Int!
8
9demandQuantity: Int!
10
11unshippedQuantity: Int!
12
13availableNowQuantity: Int!
14
15# Required permission: ProductSize:read
16productSize: ProductSize!
17
18# Required permission: Warehouse:read
19warehouse: Warehouse!
20
21incomingQuantity: Int!
22
23linkedIncomingQuantity: Int!
24
25unlinkedIncomingQuantity: Int!
26
27onDeliveryQuantity: Int!
28
29availableQuantity: Int!
30
31}