Inventory
Requires access scope. Also: The shop must have access to the physical inventory feature preview.
The quantities of an inventory item at a location.
is summed across every bin at the location. available, committed, and incoming
are location-level quantities and aren't tracked per bin.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
This object is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This object is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Anchor to FieldsFields
- active (Boolean!)
- available (Int!)
- committed (Int!)
- id (ID!)
- incoming (Int!)
- inventoryBinItems (InventoryBinItemConnection!)
- inventoryItem (InventoryItem!)
- location (Location!)
- onHand (Int!)
- Anchor to activeactive•Boolean!non-null
Whether the inventory item is stocked at the location.
- Anchor to availableavailable•Int!non-null
The quantity available for sale at the location: on-hand in bins that are available for sale, minus committed.
- Anchor to committedcommitted•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.
- Anchor to incomingincoming•Int!non-null
The quantity on its way to the location. Location-level and not tracked per bin.
- Anchor to inventoryBinItemsinventory•Inventory
Bin Items Bin Item Connection! non-null A paginated list of the inventory item's on-hand quantities in each bin at the location. Excludes the location's default bin.
NoteThis query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note:This query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This query is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Show filters
- Anchor to is_available_for_sale•boolean
Filter by whether inventory in the bin is available for sale.
is_available_for_sale:true- Anchor to is_default_bin•boolean
Filter by whether the bin is the default bin for its location.
is_default_bin:false- Anchor to quantity•integer
Filter by the on-hand quantity of the inventory item in the bin.
quantity:0quantity:>10- Anchor to updated_at•time
Filter by when the on-hand quantity of the inventory item in the bin last changed.
updated_at:>2025-01-01
Example:
Example:
Example:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Inventory
Key Bin Item Sort Keys Default:BIN_NAME Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
Show enum values
Arguments
- Anchor to inventoryIteminventory•Inventory
Item Item! non-null The inventory item that these quantities are for.
Show fields
- Anchor to locationlocation•Location!non-null
The location that these quantities are for.
Show fields
- Anchor to onHandon•Int!
Hand non-null The on-hand quantity summed across every bin at the location, including the default bin.
Anchor to QueriesQueries
- inventoryLocationItem (InventoryLocationItem)
- •query
Returns an
object by ID.NoteThis query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note:This query is available only in the unstable API version and to development stores that have enabled the Physical inventory feature preview.
Note: This query is available only in the unstable API version and to development stores that have enabled the <a href="https://shopify.dev/changelog/physical-inventory-feature-preview">Physical inventory feature preview</a>.
Show fields
- •ID!required
The ID of the
to return.
Arguments
- •ID!