inventoryItems

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 sku • string: Filter by the inventory item sku field. Learn more about SKUs.
Anchor to updated_at • time

reverse

•

BooleanDefault:false

Reverse the order of the underlying list.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges • [InventoryItemEdge!]!non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes • [InventoryItem!]!non-null: A list of nodes that are contained in InventoryItemEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo • PageInfo!non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?

Get details about the first 2 inventory items
Get details about the first inventory item matching an SKU
Get details about the first two inventory item with created_at or matching sku
Retrieves a detailed list for inventory items by IDs

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  query inventoryItems {
6    inventoryItems(first: 2) {
7      edges {
8        node {
9          id
10          tracked
11          sku
12        }
13      }
14    }
15  }`,
16);
17
18const data = await response.json();
19

query inventoryItems {
  inventoryItems(first: 2) {
    edges {
      node {
        id
        tracked
        sku
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryItems { inventoryItems(first: 2) { edges { node { id tracked sku } } } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query inventoryItems {
    inventoryItems(first: 2) {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query inventoryItems {
    inventoryItems(first: 2) {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
});

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 inventoryItems {
    inventoryItems(first: 2) {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

1{
2  "inventoryItems": {
3    "edges": [
4      {
5        "node": {
6          "id": "gid://shopify/InventoryItem/30322695",
7          "tracked": true,
8          "sku": "element-151"
9        }
10      },
11      {
12        "node": {
13          "id": "gid://shopify/InventoryItem/43729076",
14          "tracked": true,
15          "sku": "draft-151"
16        }
17      }
18    ]
19  }
20}