Choose a version:

inventoryItem

query

Retrieves an inventory item by its ID. An inventory item represents the inventory for a product variant, and holds the stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information.

Use the inventoryLevels field to get the inventory level for each location that stocks the item, and the level's quantities field to read its inventory quantities by name.

Learn more about inventory object relationships.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to InventoryItemInventoryItem

•InventoryItem

An inventory item represents the inventory for a product variant. It holds the stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information.

Use the inventoryLevels field to get the inventory level for each location that stocks the item, and the level's quantities field to read its inventory quantities by name. Quantity names represent the inventory states that merchants use to track inventory.

Learn more about inventory object relationships.

Show fields

Anchor to countryCodeOfOrigincountryCodeOfOrigin

•CountryCode

The ISO 3166-1 alpha-2 country code of where the item originated from.

Show enum values

Anchor to countryHarmonizedSystemCodescountryHarmonizedSystemCodes

•CountryHarmonizedSystemCodeConnection!

non-null

A list of country specific harmonized system codes.

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 n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the underlying list.

Anchor to createdAtcreatedAt

•DateTime!

non-null

The date and time when the inventory item was created.

Anchor to duplicateSkuCountduplicateSkuCount

•Int!

non-null

The number of inventory items that share the same SKU with this item.

Anchor to harmonizedSystemCodeharmonizedSystemCode

•String

The harmonized system code of the item. This must be a number between 6 and 13 digits.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to inventoryHistoryUrlinventoryHistoryUrl

•URL

The URL that points to the inventory history for the item.

Anchor to inventoryLevelinventoryLevel

•InventoryLevel

The inventory item's quantities at the specified location.

Show fields

Anchor to includeInactiveincludeInactive •Boolean Default:false: Whether to return the inventory level if it is inactive.
Anchor to locationIdlocationId •ID! required: ID of the location for which the inventory level is requested.

Anchor to inventoryLevelsinventoryLevels

•InventoryLevelConnection!

non-null

A list of the inventory item's quantities for each location that the inventory item can be stocked at.

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 includeInactiveincludeInactive

•Boolean

Default:false

Whether to include inactive inventory levels.

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 created_at •time
Anchor to id •id: Filter by id range.
Anchor to inventory_group_id •id
Anchor to inventory_item_id •id
Anchor to updated_at •time

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to legacyResourceIdlegacyResourceId

•UnsignedInt64!

non-null

The ID of the corresponding resource in the REST Admin API.

Anchor to locationsCountlocationsCount

•Count

The number of locations where this inventory item is stocked.

Show fields

Anchor to measurementmeasurement

•InventoryItemMeasurement!

non-null

The packaging dimensions of the inventory item.

Show fields

Anchor to provinceCodeOfOriginprovinceCodeOfOrigin

•String

The ISO 3166-2 alpha-2 province code of where the item originated from.

Anchor to requiresShippingrequiresShipping

•Boolean!

non-null

Whether a customer needs to provide a shipping address when placing an order containing the inventory item.

Anchor to skusku

•String

Inventory item SKU. Case-sensitive string.

Anchor to trackedtracked

•Boolean!

non-null

Whether inventory levels are tracked for the item.

Anchor to trackedEditabletrackedEditable

•EditableProperty!

non-null

Whether the value of the tracked field for the inventory item can be changed.

Show fields

Anchor to unitCostunitCost

•MoneyV2

Unit cost associated with the inventory item. The shop's currency is used. Note: the user must have "View product costs" permission granted in order to access this field once product granular permissions are enabled.

Show fields

Anchor to updatedAtupdatedAt

•DateTime!

non-null

The date and time when the inventory item was updated.

Anchor to variantsvariants

•ProductVariantConnection

A paginated list of the variants that reference this inventory item.

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 n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.

Anchor to variantvariant

•ProductVariant!

non-nullDeprecated

Show fields

Was this section helpful?

Examples

Get details about a specified inventory item

Query

query inventoryItem {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    tracked
    sku
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryItem { inventoryItem(id: \"gid://shopify/InventoryItem/30322695\") { id tracked sku } }"
}'

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 inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }`,
  );
  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 inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query inventoryItem {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    tracked
    sku
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query inventoryItem {
        inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
          id
          tracked
          sku
        }
      }
    `,
  }),
});

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

Response

{
  "inventoryItem": {
    "id": "gid://shopify/InventoryItem/30322695",
    "tracked": true,
    "sku": "element-151"
  }
}

Get inventory item levels and product/variant information

Query

query inventoryItemToProductVariant {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    inventoryLevels(first: 1) {
      edges {
        node {
          id
          location {
            id
            name
          }
          quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
            name
            quantity
          }
        }
      }
    }
    variant {
      id
      title
      product {
        id
        title
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryItemToProductVariant { inventoryItem(id: \"gid://shopify/InventoryItem/30322695\") { id inventoryLevels(first: 1) { edges { node { id location { id name } quantities(names: [\"available\", \"committed\", \"incoming\", \"on_hand\", \"reserved\"]) { name quantity } } } } variant { id title product { id title } } } }"
}'

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 inventoryItemToProductVariant {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      inventoryLevels(first: 1) {
        edges {
          node {
            id
            location {
              id
              name
            }
            quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
              name
              quantity
            }
          }
        }
      }
      variant {
        id
        title
        product {
          id
          title
        }
      }
    }
  }`,
  );
  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 inventoryItemToProductVariant {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      inventoryLevels(first: 1) {
        edges {
          node {
            id
            location {
              id
              name
            }
            quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
              name
              quantity
            }
          }
        }
      }
      variant {
        id
        title
        product {
          id
          title
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryItemToProductVariant {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      inventoryLevels(first: 1) {
        edges {
          node {
            id
            location {
              id
              name
            }
            quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
              name
              quantity
            }
          }
        }
      }
      variant {
        id
        title
        product {
          id
          title
        }
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query inventoryItemToProductVariant {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    inventoryLevels(first: 1) {
      edges {
        node {
          id
          location {
            id
            name
          }
          quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
            name
            quantity
          }
        }
      }
    }
    variant {
      id
      title
      product {
        id
        title
      }
    }
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query inventoryItemToProductVariant {
        inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
          id
          inventoryLevels(first: 1) {
            edges {
              node {
                id
                location {
                  id
                  name
                }
                quantities(names: ["available", "committed", "incoming", "on_hand", "reserved"]) {
                  name
                  quantity
                }
              }
            }
          }
          variant {
            id
            title
            product {
              id
              title
            }
          }
        }
      }
    `,
  }),
});

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

Response

{
  "inventoryItem": {
    "id": "gid://shopify/InventoryItem/30322695",
    "inventoryLevels": {
      "edges": [
        {
          "node": {
            "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695",
            "location": {
              "id": "gid://shopify/Location/346779380",
              "name": "Ottawa Store"
            },
            "quantities": [
              {
                "name": "available",
                "quantity": 2
              },
              {
                "name": "committed",
                "quantity": 1
              },
              {
                "name": "incoming",
                "quantity": 0
              },
              {
                "name": "on_hand",
                "quantity": 33
              },
              {
                "name": "reserved",
                "quantity": 30
              }
            ]
          }
        }
      ]
    },
    "variant": {
      "id": "gid://shopify/ProductVariant/30322695",
      "title": "151cm",
      "product": {
        "id": "gid://shopify/Product/20995642",
        "title": "Element"
      }
    }
  }
}

Examples

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

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

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

const response = await admin.graphql(

`#graphql

query inventoryItem {

inventoryItem(id: "gid://shopify/InventoryItem/30322695") {

tracked

sku

}

}`,

);

const json = await response.json();

return json.data;

}

GQL

query inventoryItem {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    tracked
    sku
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-07/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryItem { inventoryItem(id: \"gid://shopify/InventoryItem/30322695\") { id tracked sku } }"
}'

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 inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }`,
});

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 inventoryItem {
    inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
      id
      tracked
      sku
    }
  }
QUERY

response = client.query(query: query)

Shopify CLI

shopify app execute \
--query \
'query inventoryItem {
  inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
    id
    tracked
    sku
  }
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-07/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      query inventoryItem {
        inventoryItem(id: "gid://shopify/InventoryItem/30322695") {
          id
          tracked
          sku
        }
      }
    `,
  }),
});

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

Response

JSON

{

"inventoryItem": {

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

"tracked": true,

"sku": "element-151"

}