Anchor to section titled 'undefined'inventory
inventory
mutation
Unstable
Requires write access scope. Also: The user must have a permission to activate an inventory item.
Activate an inventory item at a location.
Anchor to section titled 'Arguments'
Arguments
- Anchor to availableavailable
The initial available quantity of the inventory item being activated at the location.
The ID of the inventory item to activate.
The ID of the location of the inventory item being activated.
- Anchor to onHandonHand
The initial on_hand quantity of the inventory item being activated at the location.
Allow activation at or away from fulfillment service location with sku sharing off. This will deactivate inventory at all other locations.
Was this section helpful?
Anchor to section titled 'InventoryActivatePayload returns'
InventoryActivatePayload returns
The inventory level that was activated.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: inventoryActivate
Query Reference for MUTATION: inventoryActivate
"mutation inventoryActivate($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n # InventoryLevel fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: inventoryActivate
"{\n \"available\": 1,\n \"inventoryItemId\": \"gid://shopify/<objectName>/10079785100\",\n \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n \"onHand\": 1,\n \"stockAtLegacyLocation\": true\n}"Schema Reference for MUTATION: inventoryActivate
""
Display Examples for MUTATION: inventoryActivate
[
{
"example": {
"type_name": "inventoryactivate",
"title": "Activate an inventory item at a location with an initial available quantity",
"query_string": "mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n}",
"variables": {
"inventoryItemId": "gid://shopify/InventoryItem/43729076",
"locationId": "gid://shopify/Location/346779380",
"available": 42
},
"response": {
"data": {
"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"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_activate_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"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 } } } }\",\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\",\n \"available\": 42\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\",\n \"available\": 42\n },\n },\n);\n\nconst data = await response.json();\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 ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\",\n \"available\": 42\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\",\n \"available\": 42\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!, $available: Int) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId, available: $available) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"inventoryItemId\" => \"gid://shopify/InventoryItem/43729076\",\n \"locationId\" => \"gid://shopify/Location/346779380\",\n \"available\" => 42,\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "inventoryItemId",
"description": "The ID of the inventory item to activate.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "inventoryItemId",
"argValue": " \"gid://shopify/InventoryItem/43729076\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "locationId",
"description": "The ID of the location of the inventory item being activated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locationId",
"argValue": " \"gid://shopify/Location/346779380\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "available",
"description": "The initial available quantity of the inventory item being activated at the location.",
"type": {
"kind": "SCALAR",
"name": "Int",
"list": false,
"non_null": false
},
"defaultValue": null,
"typeSignature": "Int",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "available",
"argValue": " 42",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "inventoryactivate",
"title": "Activate an inventory item at a location without setting an available quantity",
"query_string": "mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n}",
"variables": {
"inventoryItemId": "gid://shopify/InventoryItem/43729076",
"locationId": "gid://shopify/Location/346779380"
},
"response": {
"data": {
"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"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_activate_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) { inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) { inventoryLevel { id quantities(names: [\\\"available\\\"]) { name quantity } item { id } location { id } } } }\",\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }`,\n {\n variables: {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\"\n },\n },\n);\n\nconst data = await response.json();\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 ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }`,\n \"variables\": {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/43729076\",\n \"locationId\": \"gid://shopify/Location/346779380\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation ActivateInventoryItem($inventoryItemId: ID!, $locationId: ID!) {\n inventoryActivate(inventoryItemId: $inventoryItemId, locationId: $locationId) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n item {\n id\n }\n location {\n id\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"inventoryItemId\" => \"gid://shopify/InventoryItem/43729076\",\n \"locationId\" => \"gid://shopify/Location/346779380\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "inventoryItemId",
"description": "The ID of the inventory item to activate.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "inventoryItemId",
"argValue": " \"gid://shopify/InventoryItem/43729076\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "locationId",
"description": "The ID of the location of the inventory item being activated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "locationId",
"argValue": " \"gid://shopify/Location/346779380\"",
"typeKind": "MUTATION"
}
]
}
]