Choose a version:

inventoryItem

query

Returns an InventoryItem object by ID.

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

A product variant's inventory information across all locations. The inventory item connects the product variant to its inventory levels at different locations, tracking stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information for the product.

Learn more about inventory object relationships.

Anchor to countryCodeOfOrigincountryCodeOfOrigin

•CountryCode

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

Anchor to countryHarmonizedSystemCodescountryHarmonizedSystemCodes

•CountryHarmonizedSystemCodeConnection!

non-null

A list of country specific harmonized system codes.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.
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.

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.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying 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.

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

Anchor to measurementmeasurement

•InventoryItemMeasurement!

non-null

The packaging dimensions of the inventory item.

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 the inventory item requires shipping.

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.

Anchor to unitCostunitCost

•MoneyV2

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

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.

Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to lastlast •Int: The last n elements from the paginated list.
Anchor to beforebefore •String: The elements that come before the specified cursor.

Anchor to variantvariant

•ProductVariant!

non-nullDeprecated

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-01/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
    }
  }`,
});

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-01/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
        }
      }
    }
  }`,
});

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

Open in GraphiQL

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-01/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)

Response

JSON

{

"inventoryItem": {

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

"tracked": true,

"sku": "element-151"

}