Choose a version:

inventoryLevel

query

Retrieves an inventory level by its ID. An inventory level exists for an inventory item at each location that stocks it. Each inventory level has a quantities field to read the inventory quantity by name. Quantity names represent the inventory states that merchants use to track inventory.

The InventoryItem and Location objects each have an inventoryLevels field. Use it to find the ID of an inventory level.

Learn more about inventory object relationships.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the InventoryLevel to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to InventoryLevelInventoryLevel

•InventoryLevel

The quantities of an inventory item at a specific location. Each inventory level connects one InventoryItem 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.

Show fields

Anchor to canDeactivatecanDeactivate

•Boolean!

non-null

Whether the inventory items associated with the inventory level can be deactivated.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the inventory level was created.

Anchor to deactivationAlertdeactivationAlert

•String

Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to itemitem

•InventoryItem!

non-null

Inventory item associated with the inventory level.

Show fields

Anchor to locationlocation

•Location!

non-null

The location associated with the inventory level.

Show fields

Anchor to quantitiesquantities

•[InventoryQuantity!]!

non-null

The quantity of an inventory item at a specific location, for a quantity name.

Show fields

Anchor to namesnames •[String!]! required: The names of the requested inventory quantities.

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the inventory level was updated.

Anchor to scheduledChangesscheduledChanges

•InventoryScheduledChangeConnection!

non-nullDeprecated

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 expected_at •time
Anchor to id •id: Filter by id range.
Anchor to quantity_names •string

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•ScheduledChangeSortKeys

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.

Show enum values

Was this section helpful?

Examples

Get the location, inventory item, and quantities for an inventory level

Query

query {
  inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
    id
    quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
      name
      quantity
    }
    item {
      id
      sku
    }
    location {
      id
      name
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") { id quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) { name quantity } item { id sku } location { id name } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
    id
    quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
      name
      quantity
    }
    item {
      id
      sku
    }
    location {
      id
      name
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2025-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
          id
          quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
            name
            quantity
          }
          item {
            id
            sku
          }
          location {
            id
            name
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "inventoryLevel": {
    "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695",
    "quantities": [
      {
        "name": "available",
        "quantity": 2
      },
      {
        "name": "incoming",
        "quantity": 146
      },
      {
        "name": "committed",
        "quantity": 1
      },
      {
        "name": "damaged",
        "quantity": 0
      },
      {
        "name": "on_hand",
        "quantity": 33
      },
      {
        "name": "quality_control",
        "quantity": 0
      },
      {
        "name": "reserved",
        "quantity": 30
      },
      {
        "name": "safety_stock",
        "quantity": 0
      }
    ],
    "item": {
      "id": "gid://shopify/InventoryItem/30322695",
      "sku": "element-151"
    },
    "location": {
      "id": "gid://shopify/Location/346779380",
      "name": "Ottawa Store"
    }
  }
}

Get the location, inventory item, and quantities for an inventory level

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query {

inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {

quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {

name

quantity

}

item {

sku

}

location {

name

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query {
  inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
    id
    quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
      name
      quantity
    }
    item {
      id
      sku
    }
    location {
      id
      name
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") { id quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) { name quantity } item { id sku } location { id name } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }`,
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
      id
      quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
        name
        quantity
      }
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query {
  inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
    id
    quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
      name
      quantity
    }
    item {
      id
      sku
    }
    location {
      id
      name
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2025-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query {
        inventoryLevel(id: "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695") {
          id
          quantities(names: ["available", "incoming", "committed", "damaged", "on_hand", "quality_control", "reserved", "safety_stock"]) {
            name
            quantity
          }
          item {
            id
            sku
          }
          location {
            id
            name
          }
        }
      }
    `,
  }),
});

const { data } = await response.json();
console.log(data);

Response

JSON

{

"inventoryLevel": {

"id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695",

"quantities": [

{

"name": "available",

"quantity": 2

{

"name": "incoming",

"quantity": 146

{

"name": "committed",

"quantity": 1

{

"name": "damaged",

"quantity": 0

{

"name": "on_hand",

"quantity": 33

{

"name": "quality_control",

"quantity": 0

{

"name": "reserved",

"quantity": 30

{

"name": "safety_stock",

"quantity": 0

}

"item": {

"id": "gid://shopify/InventoryItem/30322695",

"sku": "element-151"

"location": {

"id": "gid://shopify/Location/346779380",

"name": "Ottawa Store"

}