Skip to main content
Anchor to inventoryLocationItem

inventoryLocationItem

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.

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the InventoryLocationItem to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to InventoryLocationItemInventoryLocationItem
•InventoryLocationItem

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.

Show fields
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.

Anchor to idid
•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 inventoryBinItemsinventoryBinItems
•InventoryBinItemConnection!
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.

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

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 n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements 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 bin_name
•string

Filter by the bin name.

Example:

  • bin_name:"Aisle 1"
Anchor to is_available_for_sale
•boolean

Filter by whether inventory in the bin is available for sale.

Example:

  • is_available_for_sale:true
Anchor to is_default_bin
•boolean

Filter by whether the bin is the default bin for its location.

Example:

  • is_default_bin:false
Anchor to quantity
•integer

Filter by the on-hand quantity of the inventory item in the bin.

Example:

  • quantity:0
  • quantity:>10
Anchor to updated_at
•time

Filter by when the on-hand quantity of the inventory item in the bin last changed.

Example:

  • updated_at:>2025-01-01
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•InventoryBinItemSortKeys
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
Anchor to inventoryIteminventoryItem
•InventoryItem!
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 onHandonHand
•Int!
non-null

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

Was this section helpful?