Choose a version:

inventoryItems

query

Returns a list of inventory items.

InventoryItemConnection arguments

•InventoryItemConnection!

after

•String

The elements that come after the specified cursor.

before

•String

The elements that come before the specified cursor.

first

•Int

The first n elements from the paginated list.

last

•Int

The last n elements from the paginated list.

query

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

reverse

•Boolean

Default: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?

Examples

Get details about the first 2 inventory items

Query

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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 } } } }"
}'

Remix

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();

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

Response

{
  "inventoryItems": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/InventoryItem/30322695",
          "tracked": true,
          "sku": "element-151"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryItem/43729076",
          "tracked": true,
          "sku": "draft-151"
        }
      }
    ]
  }
}

Get details about the first inventory item matching an SKU

Query

query inventoryItems {
  inventoryItems(first: 1, query: "sku:'element-151'") {
    edges {
      node {
        id
        tracked
        sku
      }
    }
  }
}

cURL

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

Remix

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

const response = await admin.graphql(
  `#graphql
  query inventoryItems {
    inventoryItems(first: 1, query: "sku:'element-151'") {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
);

const data = await response.json();

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 inventoryItems {
    inventoryItems(first: 1, query: "sku:'element-151'") {
      edges {
        node {
          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 inventoryItems {
    inventoryItems(first: 1, query: "sku:'element-151'") {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
});

Response

{
  "inventoryItems": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/InventoryItem/30322695",
          "tracked": true,
          "sku": "element-151"
        }
      }
    ]
  }
}

Get details about the first two inventory item with created_at or matching sku

Query

query inventoryItems {
  inventoryItems(first: 2, query: "(created_at:>2023-10-10) OR (sku:'element-151')") {
    edges {
      node {
        id
        tracked
        sku
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query inventoryItems { inventoryItems(first: 2, query: \"(created_at:>2023-10-10) OR (sku:'\''element-151'\'')\") { edges { node { id tracked sku } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query inventoryItems {
    inventoryItems(first: 2, query: "(created_at:>2023-10-10) OR (sku:'element-151')") {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
);

const data = await response.json();

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 inventoryItems {
    inventoryItems(first: 2, query: "(created_at:>2023-10-10) OR (sku:'element-151')") {
      edges {
        node {
          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 inventoryItems {
    inventoryItems(first: 2, query: "(created_at:>2023-10-10) OR (sku:'element-151')") {
      edges {
        node {
          id
          tracked
          sku
        }
      }
    }
  }`,
});

Response

{
  "inventoryItems": {
    "edges": [
      {
        "node": {
          "id": "gid://shopify/InventoryItem/30322695",
          "tracked": true,
          "sku": "element-151"
        }
      },
      {
        "node": {
          "id": "gid://shopify/InventoryItem/43729076",
          "tracked": true,
          "sku": "draft-151"
        }
      }
    ]
  }
}

Retrieves a detailed list for inventory items by IDs

Query

query InventoryItemList {
  inventoryItems(first: 20, query: "id:>=30322695") {
    nodes {
      id
      createdAt
      countryCodeOfOrigin
      harmonizedSystemCode
      provinceCodeOfOrigin
      requiresShipping
      sku
      tracked
      unitCost {
        currencyCode
        amount
      }
      updatedAt
      countryHarmonizedSystemCodes(first: 250) {
        nodes {
          harmonizedSystemCode
          countryCode
        }
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query InventoryItemList { inventoryItems(first: 20, query: \"id:>=30322695\") { nodes { id createdAt countryCodeOfOrigin harmonizedSystemCode provinceCodeOfOrigin requiresShipping sku tracked unitCost { currencyCode amount } updatedAt countryHarmonizedSystemCodes(first: 250) { nodes { harmonizedSystemCode countryCode } } } } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query InventoryItemList {
    inventoryItems(first: 20, query: "id:>=30322695") {
      nodes {
        id
        createdAt
        countryCodeOfOrigin
        harmonizedSystemCode
        provinceCodeOfOrigin
        requiresShipping
        sku
        tracked
        unitCost {
          currencyCode
          amount
        }
        updatedAt
        countryHarmonizedSystemCodes(first: 250) {
          nodes {
            harmonizedSystemCode
            countryCode
          }
        }
      }
    }
  }`,
);

const data = await response.json();

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 InventoryItemList {
    inventoryItems(first: 20, query: "id:>=30322695") {
      nodes {
        id
        createdAt
        countryCodeOfOrigin
        harmonizedSystemCode
        provinceCodeOfOrigin
        requiresShipping
        sku
        tracked
        unitCost {
          currencyCode
          amount
        }
        updatedAt
        countryHarmonizedSystemCodes(first: 250) {
          nodes {
            harmonizedSystemCode
            countryCode
          }
        }
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query InventoryItemList {
    inventoryItems(first: 20, query: "id:>=30322695") {
      nodes {
        id
        createdAt
        countryCodeOfOrigin
        harmonizedSystemCode
        provinceCodeOfOrigin
        requiresShipping
        sku
        tracked
        unitCost {
          currencyCode
          amount
        }
        updatedAt
        countryHarmonizedSystemCodes(first: 250) {
          nodes {
            harmonizedSystemCode
            countryCode
          }
        }
      }
    }
  }`,
});

Response

{
  "inventoryItems": {
    "nodes": [
      {
        "id": "gid://shopify/InventoryItem/30322695",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "DE",
        "harmonizedSystemCode": "123456",
        "provinceCodeOfOrigin": "QC",
        "requiresShipping": true,
        "sku": "element-151",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "1.23"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": [
            {
              "harmonizedSystemCode": "123456999333",
              "countryCode": "CA"
            }
          ]
        }
      },
      {
        "id": "gid://shopify/InventoryItem/43729076",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": null,
        "harmonizedSystemCode": null,
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "draft-151",
        "tracked": true,
        "unitCost": null,
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/113711323",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "CA",
        "harmonizedSystemCode": "555555",
        "provinceCodeOfOrigin": "",
        "requiresShipping": true,
        "sku": "element-155",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "15.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/138327650",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": null,
        "harmonizedSystemCode": null,
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "boots-10",
        "tracked": true,
        "unitCost": null,
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/236948360",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "FR",
        "harmonizedSystemCode": "654321",
        "provinceCodeOfOrigin": "",
        "requiresShipping": true,
        "sku": "element-158",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "20.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/330284860",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": null,
        "harmonizedSystemCode": null,
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "unpublished_boots-12",
        "tracked": true,
        "unitCost": null,
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/389013007",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "CA",
        "harmonizedSystemCode": "123456",
        "provinceCodeOfOrigin": "ON",
        "requiresShipping": true,
        "sku": "crappy_shoes_red",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "20.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/419425742",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "DE",
        "harmonizedSystemCode": "999999",
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "crappy_shoes_pink",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "20.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/438458761",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": null,
        "harmonizedSystemCode": null,
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "IPOD2008RED",
        "tracked": true,
        "unitCost": null,
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/445365074",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "IT",
        "harmonizedSystemCode": "654321",
        "provinceCodeOfOrigin": "",
        "requiresShipping": true,
        "sku": "crappy_shoes_green",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "20.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/498744621",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": null,
        "harmonizedSystemCode": null,
        "provinceCodeOfOrigin": null,
        "requiresShipping": true,
        "sku": "seo-boots-10",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "15.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      },
      {
        "id": "gid://shopify/InventoryItem/715806386",
        "createdAt": "2024-11-07T16:22:10Z",
        "countryCodeOfOrigin": "FR",
        "harmonizedSystemCode": "555555",
        "provinceCodeOfOrigin": "",
        "requiresShipping": true,
        "sku": "crappy_shoes_blue",
        "tracked": true,
        "unitCost": {
          "currencyCode": "USD",
          "amount": "20.0"
        },
        "updatedAt": "2024-11-07T16:22:10Z",
        "countryHarmonizedSystemCodes": {
          "nodes": []
        }
      }
    ]
  }
}

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query inventoryItems {

inventoryItems(first: 2) {

edges {

node {

tracked

sku

}

}`,

);

const data = await response.json();

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/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

{

"inventoryItems": {

"edges": [

{

"node": {

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

"tracked": true,

"sku": "element-151"

}

{

"node": {

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

"tracked": true,

"sku": "draft-151"

}

]

}