Skip to main content
Anchor to InventoryLocationItem

InventoryLocationItem

object

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

The quantities of an inventory item at a location.

onHand is summed across every bin at the location. available, committed, and incoming are location-level quantities and aren't tracked 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.


•Boolean!
non-null

Whether the inventory item is stocked at the location.

•Int!
non-null

The quantity available for sale at the location: on-hand in bins that are available for sale, minus committed.

•Int!
non-null

The quantity committed to orders at the location. Location-level and not tracked per bin.

•ID!
non-null

A globally-unique ID.

•Int!
non-null

The quantity on its way to the location. Location-level and not tracked per bin.

•InventoryItem!
non-null

The inventory item that these quantities are for.

Show fields
•Location!
non-null

The location that these quantities are for.

Show fields
•Int!
non-null

The on-hand quantity summed across every bin at the location, including the default bin.


Was this section helpful?

•query

Returns an InventoryLocationItem object by ID.


Note

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


Show fields

Arguments

•ID!
required

The ID of the InventoryLocationItem to return.



Was this section helpful?

•interface

Was this section helpful?