InventoryLevel - admin-graphql - OBJECT

Version: 2024-07

Description:

The quantities of an inventory item that are related to a specific location. Learn [more about the relationships between inventory objects](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).

Access Scopes

`read_inventory` access scope.

Fields

• canDeactivate: Boolean! - Whether the inventory items associated with the inventory level can be deactivated.
• createdAt: DateTime! - 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! - A globally-unique ID.
• item: InventoryItem! - Inventory item associated with the inventory level.
• location: Location! - The location associated with the inventory level.
• quantities: InventoryQuantity! - Quantities for the requested names.
• updatedAt: DateTime! - The date and time when the inventory level was updated.

Connections

• scheduledChanges: InventoryScheduledChangeConnection!

Related queries

• inventoryLevel Returns an [InventoryLevel](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) object by ID.

Related mutations

• inventoryActivate Activate an inventory item at a location.
• inventoryBulkToggleActivation Modify the activation status of an inventory item at locations. Activating an inventory item at a particular location allows that location to stock that inventory item. Deactivating an inventory item at a location removes the inventory item's quantities and turns off the inventory item from that location.

Related Unions

Examples

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

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") {\n      id\n      quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) {\n        name\n        quantity\n      }\n      item {\n        id\n        sku\n      }\n      location {\n        id\n        name\n      }\n    }\n  }`,\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") {\n      id\n      quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) {\n        name\n        quantity\n      }\n      item {\n        id\n        sku\n      }\n      location {\n        id\n        name\n      }\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") {\n      id\n      quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) {\n        name\n        quantity\n      }\n      item {\n        id\n        sku\n      }\n      location {\n        id\n        name\n      }\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") {\n      id\n      quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) {\n        name\n        quantity\n      }\n      item {\n        id\n        sku\n      }\n      location {\n        id\n        name\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  inventoryLevel(id: \"gid://shopify/InventoryLevel/523463154?inventory_item_id=30322695\") {\n    id\n    quantities(names: [\"available\", \"incoming\", \"committed\", \"damaged\", \"on_hand\", \"quality_control\", \"reserved\", \"safety_stock\"]) {\n      name\n      quantity\n    }\n    item {\n      id\n      sku\n    }\n    location {\n      id\n      name\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "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"
        }
      }
    }
  }