--- title: inventoryActivate - GraphQL Admin description: >- Activates an inventory item at a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) by creating an [`InventoryLevel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) that tracks stock quantities. This enables you to manage inventory for a [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) at the specified location. When you activate an inventory item, you can set its initial quantities. The [`available`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-available) argument sets the quantity that's available for sale. [`onHand`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-onHand) argument sets the total physical quantity at the location. If you don't specify quantities, then `available` and `onHand` default to zero. > Caution: > As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests). Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states). api_version: 2026-01 api_name: admin type: mutation api_type: graphql source_url: html: >- https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate md: >- https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate.md --- # inventory​Activate mutation Requires `write_inventory` access scope. Also: The user must have a permission to activate an inventory item. Activates an inventory item at a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) by creating an [`InventoryLevel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) that tracks stock quantities. This enables you to manage inventory for a [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) at the specified location. When you activate an inventory item, you can set its initial quantities. The [`available`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-available) argument sets the quantity that's available for sale. [`onHand`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-onHand) argument sets the total physical quantity at the location. If you don't specify quantities, then `available` and `onHand` default to zero. *** Caution As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests). *** Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states). ## Arguments * available * inventoryItemId * locationId * onHand * stockAtLegacyLocation *** ## Inventory​Activate​Payload returns * inventoryLevel * userErrors *** ## Examples * ### Activate an inventory item at a location with an initial available quantity #### Query ```graphql mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } } ``` #### Variables ```json { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380", "available": 42 } ``` #### cURL ```bash 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": "mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) { inventoryLevel { id quantities(names: [\"available\"]) { name quantity } item { id } location { id } } } }", "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380", "available": 42 } }' ``` #### React Router ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } }`, { variables: { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380", "available": 42 }, }, ); const json = await response.json(); return json.data; } ``` #### Ruby ```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 mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } } QUERY variables = { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380", "available": 42 } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } }`, "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380", "available": 42 }, }, }); ``` #### Response ```json { "inventoryActivate": { "inventoryLevel": { "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076", "quantities": [ { "name": "available", "quantity": 42 } ], "item": { "id": "gid://shopify/InventoryItem/43729076" }, "location": { "id": "gid://shopify/Location/346779380" } } } } ``` * ### Activate an inventory item at a location without setting an available quantity #### Query ```graphql mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } } ``` #### Variables ```json { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } ``` #### cURL ```bash 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": "mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: [\"available\"]) { name quantity } item { id } location { id } } } }", "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } }' ``` #### React Router ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } }`, { variables: { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" }, }, ); const json = await response.json(); return json.data; } ``` #### Ruby ```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 mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } } QUERY variables = { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: ["available"]) { name quantity } item { id } location { id } } } }`, "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" }, }, }); ``` #### Response ```json { "inventoryActivate": { "inventoryLevel": { "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076", "quantities": [ { "name": "available", "quantity": 0 } ], "item": { "id": "gid://shopify/InventoryItem/43729076" }, "location": { "id": "gid://shopify/Location/346779380" } } } } ``` * ### Connects an inventory item to a location #### Query ```graphql mutation InventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id canDeactivate createdAt item { id } location { id } quantities(names: ["available"]) { name quantity } updatedAt } } } ``` #### Variables ```json { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } ``` #### cURL ```bash 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": "mutation InventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id canDeactivate createdAt item { id } location { id } quantities(names: [\"available\"]) { name quantity } updatedAt } } }", "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } }' ``` #### React Router ```javascript import { authenticate } from "../shopify.server"; export const loader = async ({request}) => { const { admin } = await authenticate.admin(request); const response = await admin.graphql( `#graphql mutation InventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id canDeactivate createdAt item { id } location { id } quantities(names: ["available"]) { name quantity } updatedAt } } }`, { variables: { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" }, }, ); const json = await response.json(); return json.data; } ``` #### Ruby ```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 mutation InventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id canDeactivate createdAt item { id } location { id } quantities(names: ["available"]) { name quantity } updatedAt } } } QUERY variables = { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" } response = client.query(query: query, variables: variables) ``` #### Node.js ```javascript const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation InventoryActivate($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id canDeactivate createdAt item { id } location { id } quantities(names: ["available"]) { name quantity } updatedAt } } }`, "variables": { "inventoryItemId": "gid://shopify/InventoryItem/43729076", "locationId": "gid://shopify/Location/346779380" }, }, }); ``` #### Response ```json { "inventoryActivate": { "inventoryLevel": { "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076", "canDeactivate": true, "createdAt": "2024-11-07T20:59:45Z", "item": { "id": "gid://shopify/InventoryItem/43729076" }, "location": { "id": "gid://shopify/Location/346779380" }, "quantities": [ { "name": "available", "quantity": 0 } ], "updatedAt": "2024-11-07T20:59:45Z" } } } ``` * ### inventoryActivate reference