inventoryActivate

mutation

Requires write_inventory access scope. Also: The user must have a permission to activate an inventory item.

Activate an inventory item at a location.

Arguments

Anchor to availableavailable • Int: The initial available quantity of the inventory item being activated at the location.
Anchor to inventoryItemIdinventoryItemId • ID!required: The ID of the inventory item to activate.
Anchor to locationIdlocationId • ID!required: The ID of the location of the inventory item being activated.
Anchor to onHandonHand • Int: The initial on_hand quantity of the inventory item being activated at the location.

Was this section helpful?

Anchor to InventoryActivatePayload returnsInventoryActivatePayload returns

Anchor to inventoryLevelinventoryLevel • InventoryLevel: The inventory level that was activated.
Anchor to userErrorsuserErrors • [UserError!]!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 ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {
6    inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {
7      inventoryLevel {
8        id
9        quantities(names: ["available"]) {
10          name
11          quantity
12        }
13        item {
14          id
15        }
16        location {
17          id
18        }
19      }
20    }
21  }`,
22  {
23    variables: {
24      "inventoryItemId": "gid://shopify/InventoryItem/43729076",
25      "locationId": "gid://shopify/Location/346779380",
26      "available": 42
27    },
28  },
29);
30
31const data = await response.json();
32

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

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

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

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

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)

Input variables

JSON

1{
2  "inventoryItemId": "gid://shopify/InventoryItem/43729076",
3  "locationId": "gid://shopify/Location/346779380",
4  "available": 42
5}

Response

JSON

1{
2  "inventoryActivate": {
3    "inventoryLevel": {
4      "id": "gid://shopify/InventoryLevel/523463154?inventory_item_id=43729076",
5      "quantities": [
6        {
7          "name": "available",
8          "quantity": 42
9        }
10      ],
11      "item": {
12        "id": "gid://shopify/InventoryItem/43729076"
13      },
14      "location": {
15        "id": "gid://shopify/Location/346779380"
16      }
17    }
18  }
19}