# inventoryBulkToggleActivation - admin-graphql - MUTATION Version: 2024-04 ## Description 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. ### Access Scopes `write_inventory` access scope. Also: The user must have a permission to update the activation status of an inventory. ## Arguments * [inventoryItemId](/docs/api/admin-graphql/2024-04/scalars/ID): ID! - The ID of the inventory item to modify the activation status locations for. * [inventoryItemUpdates](/docs/api/admin-graphql/2024-04/input-objects/InventoryBulkToggleActivationInput): InventoryBulkToggleActivationInput! - A list of pairs of locations and activate status to update for the specified inventory item. ## Returns * [inventoryItem](/docs/api/admin-graphql/2024-04/objects/InventoryItem): InventoryItem The inventory item that was updated. * [inventoryLevels](/docs/api/admin-graphql/2024-04/objects/InventoryLevel): InventoryLevel The activated inventory levels. * [userErrors](/docs/api/admin-graphql/2024-04/objects/InventoryBulkToggleActivationUserError): InventoryBulkToggleActivationUserError! The list of errors that occurred from executing the mutation. ## Examples ### Activate an inventory item at a location Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) { inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) { inventoryItem { id } inventoryLevels { id quantities(names: [\\\"available\\\"]) { name quantity } location { id } } userErrors { field message code } } }\",\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\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 mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [{\"locationId\"=>\"gid://shopify/Location/648019273\", \"activate\"=>true}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "inventoryItemId": "gid://shopify/InventoryItem/30322695", "inventoryItemUpdates": [ { "locationId": "gid://shopify/Location/648019273", "activate": true } ] } #### Graphql Response { "data": { "inventoryBulkToggleActivation": { "inventoryItem": { "id": "gid://shopify/InventoryItem/30322695" }, "inventoryLevels": [ { "id": "gid://shopify/InventoryLevel/30691503?inventory_item_id=30322695", "quantities": [ { "name": "available", "quantity": 0 } ], "location": { "id": "gid://shopify/Location/648019273" } } ], "userErrors": [] } } } ### Deactivate an inventory item at a location Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) { inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) { inventoryItem { id } inventoryLevels { id } userErrors { field message code } } }\",\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n }\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 mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [{\"locationId\"=>\"gid://shopify/Location/124656943\", \"activate\"=>false}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "inventoryItemId": "gid://shopify/InventoryItem/30322695", "inventoryItemUpdates": [ { "locationId": "gid://shopify/Location/124656943", "activate": false } ] } #### Graphql Response { "data": { "inventoryBulkToggleActivation": { "inventoryItem": { "id": "gid://shopify/InventoryItem/30322695" }, "inventoryLevels": [], "userErrors": [] } } } ### Toggle an inventory item's activation at two locations Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) { inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) { inventoryItem { id } inventoryLevels { id quantities(names: [\\\"available\\\"]) { name quantity } location { id } } userErrors { field message code } } }\",\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n },\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\n ]\n }\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n },\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\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 mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }\nQUERY\n\nvariables = {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [{\"locationId\"=>\"gid://shopify/Location/124656943\", \"activate\"=>false}, {\"locationId\"=>\"gid://shopify/Location/648019273\", \"activate\"=>true}]\n}\n\nresponse = client.query(query: query, variables: variables)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n }`,\n {\n variables: {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"inventoryItemUpdates\": [\n {\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"activate\": false\n },\n {\n \"locationId\": \"gid://shopify/Location/648019273\",\n \"activate\": true\n }\n ]\n },\n },\n);\n\nconst data = await response.json();\n" Graphql query: "mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {\n inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {\n inventoryItem {\n id\n }\n inventoryLevels {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n location {\n id\n }\n }\n userErrors {\n field\n message\n code\n }\n }\n}" #### Graphql Input { "inventoryItemId": "gid://shopify/InventoryItem/30322695", "inventoryItemUpdates": [ { "locationId": "gid://shopify/Location/124656943", "activate": false }, { "locationId": "gid://shopify/Location/648019273", "activate": true } ] } #### Graphql Response { "data": { "inventoryBulkToggleActivation": { "inventoryItem": { "id": "gid://shopify/InventoryItem/30322695" }, "inventoryLevels": [ { "id": "gid://shopify/InventoryLevel/30691503?inventory_item_id=30322695", "quantities": [ { "name": "available", "quantity": 0 } ], "location": { "id": "gid://shopify/Location/648019273" } } ], "userErrors": [] } } }