Choose a version:

inventoryLevel

query

Returns an InventoryLevel object by ID.

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

InventoryLevel

•

InventoryLevel

The quantities of an inventory item that are related to a specific location. Learn more about the relationships between inventory objects.

canDeactivate• Boolean! non-null: Whether the inventory items associated with the inventory level can be deactivated.
createdAt• DateTime! non-null: The date and time when the inventory level was created.
deactivationAlert• String: Describes either the impact of deactivating the inventory level, or why the inventory level can't be deactivated.
id• ID! non-null: A globally-unique ID.
item• InventoryItem! non-null: Inventory item associated with the inventory level.
location• Location! non-null: The location associated with the inventory level.
quantities• [InventoryQuantity!]! non-null: Quantities for the requested names.
scheduledChanges • InventoryScheduledChangeConnection! non-null: Scheduled changes for the requested quantity names.
updatedAt• DateTime! non-null: The date and time when the inventory level was updated.

Was this section helpful?

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

Open in GraphiQL

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 data = await response.json();

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

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 data = await response.json();

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

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)

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"

}