Skip to main content
Anchor to LocationItemQuantity

LocationItemQuantity

object

Requires read_inventory access scope. Also: The shop must have access to the physical inventory feature preview.

The aggregate quantities of an inventory item at a location, summed across the location's bins.

onHand is the unbinned residual (unbinnedQuantity) plus the quantity held in every bin. available is the location-level sellable quantity. committed is location-level and is not split per bin.


Note

This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.


•Int!
non-null

The available (sellable) quantity at this location.

•Int!
non-null

The committed quantity at this location (committed plus reserved holds). Location-level and not split per bin.

•ID!
non-null

A globally-unique ID.

•InventoryItem!
non-null

The inventory item (catalog identity) that these quantities are for.

•Int!
non-null

The total on-hand quantity at this location: the unbinned residual plus the quantity in every bin.

•Int!
non-null

The on-hand quantity that hasn't been placed in any bin (the location residual).


Was this section helpful?

•interface

Was this section helpful?