inventoryBulkToggleActivation

mutation

Requires write_inventory access scope. Also: The user must have a permission to update the activation status of an inventory.

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.

Arguments

Anchor to inventoryItemIdinventoryItemId • ID!required: The ID of the inventory item to modify the activation status locations for.
Anchor to inventoryItemUpdatesinventoryItemUpdates • [InventoryBulkToggleActivationInput!]!required: A list of pairs of locations and activate status to update for the specified inventory item.

Was this section helpful?

Anchor to InventoryBulkToggleActivationPayload returnsInventoryBulkToggleActivationPayload returns

Anchor to inventoryIteminventoryItem • InventoryItem: The inventory item that was updated.
Anchor to inventoryLevelsinventoryLevels • [InventoryLevel!]: The activated inventory levels.
Anchor to userErrorsuserErrors • [InventoryBulkToggleActivationUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation inventoryBulkToggleActivation($inventoryItemId: ID!, $inventoryItemUpdates: [InventoryBulkToggleActivationInput!]!) {
6    inventoryBulkToggleActivation(inventoryItemId: $inventoryItemId, inventoryItemUpdates: $inventoryItemUpdates) {
7      inventoryItem {
8        id
9      }
10      inventoryLevels {
11        id
12        quantities(names: ["available"]) {
13          name
14          quantity
15        }
16        location {
17          id
18        }
19      }
20      userErrors {
21        field
22        message
23        code
24      }
25    }
26  }`,
27  {
28    variables: {
29      "inventoryItemId": "gid://shopify/InventoryItem/30322695",
30      "inventoryItemUpdates": [
31        {
32          "locationId": "gid://shopify/Location/648019273",
33          "activate": true
34        }
35      ]
36    },
37  },
38);
39
40const data = await response.json();
41

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
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } }",
 "variables": {
    "inventoryItemId": "gid://shopify/InventoryItem/30322695",
    "inventoryItemUpdates": [
      {
        "locationId": "gid://shopify/Location/648019273",
        "activate": true
      }
    ]
  }
}'

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

const response = await admin.graphql(
  `#graphql
  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
      }
    }
  }`,
  {
    variables: {
      "inventoryItemId": "gid://shopify/InventoryItem/30322695",
      "inventoryItemUpdates": [
        {
          "locationId": "gid://shopify/Location/648019273",
          "activate": true
        }
      ]
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
        }
      }
    }`,
    "variables": {
      "inventoryItemId": "gid://shopify/InventoryItem/30322695",
      "inventoryItemUpdates": [
        {
          "locationId": "gid://shopify/Location/648019273",
          "activate": true
        }
      ]
    },
  },
});

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 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
      }
    }
  }
QUERY

variables = {
  "inventoryItemId": "gid://shopify/InventoryItem/30322695",
  "inventoryItemUpdates": [{"locationId"=>"gid://shopify/Location/648019273", "activate"=>true}]
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "inventoryItemId": "gid://shopify/InventoryItem/30322695",
3  "inventoryItemUpdates": [
4    {
5      "locationId": "gid://shopify/Location/648019273",
6      "activate": true
7    }
8  ]
9}

Response

JSON

1{
2  "inventoryBulkToggleActivation": {
3    "inventoryItem": {
4      "id": "gid://shopify/InventoryItem/30322695"
5    },
6    "inventoryLevels": [
7      {
8        "id": "gid://shopify/InventoryLevel/30691503?inventory_item_id=30322695",
9        "quantities": [
10          {
11            "name": "available",
12            "quantity": 0
13          }
14        ],
15        "location": {
16          "id": "gid://shopify/Location/648019273"
17        }
18      }
19    ],
20    "userErrors": []
21  }
22}