Inventory
Requires access scope.
The quantities of an inventory item at a specific location. Each inventory level connects one to one Location, tracking multiple quantity states like available, on-hand, incoming, and committed.
The quantities field provides access to different inventory states. Learn more about inventory states and relationships.
Anchor to FieldsFields
- Anchor to canDeactivatecan•Boolean!
Deactivate non-null Whether the inventory items associated with the inventory level can be deactivated.
- Anchor to createdAtcreated•Date
At Time! non-null The date and time when the inventory level was created.
- Anchor to deactivationAlertdeactivation•String
Alert Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.
- •ID!non-null
A globally-unique ID.
- Anchor to itemitem•Inventory
Item! non-null Inventory item associated with the inventory level.
- Anchor to locationlocation•Location!non-null
The location associated with the inventory level.
- Anchor to quantitiesquantities•[Inventory
Quantity!]! non-null The quantity of an inventory item at a specific location, for a quantity name.
- Anchor to namesnames•[String!]!required
The names of the requested inventory quantities.
Arguments
- Anchor to scheduledChangesscheduled•Inventory
Changes Scheduled Change Connection! non-null Scheduled changes for the requested quantity names.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Scheduled
Key Change Sort Keys Default:ID 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.
- 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.
Arguments
- Anchor to updatedAtupdated•Date
At Time! non-null The date and time when the inventory level was updated.
Anchor to QueriesQueries
- •query
Returns an InventoryLevel object by ID.
- •ID!required
The ID of the
to return.
Arguments
- •ID!
Anchor to MutationsMutations
- •mutation
Activates an inventory item at a
Locationby creating anthat tracks stock quantities. This enables you to manage inventory for aat the specified location.When you activate an inventory item, you can set its initial quantities. The
availableargument sets the quantity that's available for sale.argument sets the total physical quantity at the location. If you don't specify quantities, thenavailableanddefault to zero.CautionAs of version
2026-01, this mutation supports an optional idempotency key using the@idempotentdirective. As of version2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Learn more about managing inventory quantities and states.
- Anchor to inventoryItemIdinventory•ID!
Item Id required The ID of the inventory item to activate.
- Anchor to locationIdlocation•ID!
Id required The ID of the location of the inventory item being activated.
- Anchor to availableavailable•Int
The initial available quantity of the inventory item being activated at the location.
- Anchor to onHandon•Int
Hand The initial on_hand quantity of the inventory item being activated at the location.
- Anchor to stockAtLegacyLocationstock•Boolean
At Legacy Location Default:false Allow activation at or away from fulfillment service location with sku sharing off. This will deactivate inventory at all other locations.
Arguments
- •mutation
Activates or deactivates an inventory item at multiple locations. When you activate an
at aLocation, that location can stock and track quantities for that item. When you deactivate an inventory item at a location, the inventory item is no longer stocked at that location.The mutation accepts an inventory item ID and a list of location-specific activation settings. It returns the updated inventory item and any activated
objects.Learn more about managing inventory quantities and states.
- Anchor to inventoryItemIdinventory•ID!
Item Id required The ID of the inventory item to modify the activation status locations for.
- Anchor to inventoryItemUpdatesinventory•[Inventory
Item Updates Bulk Toggle Activation Input!]! required A list of pairs of locations and activate status to update for the specified inventory item.
Arguments