Anchor to section titled 'undefined'inventory
inventory
mutation
deprecated
Unstable
Requires write access scope. Also: The user must have a permission to adjusts an inventory quantity.
Adjusts the inventory by a certain quantity. Use inventory instead.
Anchor to section titled 'Arguments'
Arguments
Provides the input fields required to update an inventory level.
Was this section helpful?
Anchor to section titled 'InventoryAdjustQuantityPayload returns'
InventoryAdjustQuantityPayload returns
Represents the updated inventory quantity of an inventory item at a specific location.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: inventoryAdjustQuantity
Query Reference for MUTATION: inventoryAdjustQuantity
"mutation inventoryAdjustQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n # InventoryLevel fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: inventoryAdjustQuantity
"{\n \"input\": {\n \"availableDelta\": 1,\n \"inventoryLevelId\": \"gid://shopify/<objectName>/10079785100\"\n }\n}"Schema Reference for MUTATION: inventoryAdjustQuantity
"input InventoryAdjustQuantityInput {\n availableDelta: Int!\n inventoryLevelId: ID!\n}\n"Display Examples for MUTATION: inventoryAdjustQuantity
[
{
"example": {
"type_name": "inventoryadjustquantity",
"title": "Decrease the available inventory of an item at a location by 2",
"query_string": "mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n}",
"variables": {
"input": {
"inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
"availableDelta": -2
}
},
"response": {
"data": {
"inventoryAdjustQuantity": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
"quantities": [
{
"name": "available",
"quantity": -1
}
],
"incoming": 0,
"item": {
"id": "gid://shopify/InventoryItem/43729076",
"sku": "draft-151"
},
"location": {
"id": "gid://shopify/Location/124656943",
"name": "Shipping Origin"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_adjust_quantity_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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) { inventoryAdjustQuantity(input: $input) { inventoryLevel { id quantities(names: [\\\"available\\\"]) { name quantity } incoming item { id sku } location { id name } } } }\",\n \"variables\": {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": -2\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": -2\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": -2\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": -2\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"inventoryLevelId\" => \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\" => -2,\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Provides the input fields required to update an inventory level.",
"type": {
"kind": "INPUT_OBJECT",
"name": "InventoryAdjustQuantityInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "InventoryAdjustQuantityInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"inventoryLevelId\":\"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\"availableDelta\":-2}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "inventoryadjustquantity",
"title": "Increase the available inventory of an item at a location by 3",
"query_string": "mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n}",
"variables": {
"input": {
"inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
"availableDelta": 3
}
},
"response": {
"data": {
"inventoryAdjustQuantity": {
"inventoryLevel": {
"id": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
"quantities": [
{
"name": "available",
"quantity": 4
}
],
"incoming": 0,
"item": {
"id": "gid://shopify/InventoryItem/43729076",
"sku": "draft-151"
},
"location": {
"id": "gid://shopify/Location/124656943",
"name": "Shipping Origin"
}
}
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_adjust_quantity_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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) { inventoryAdjustQuantity(input: $input) { inventoryLevel { id quantities(names: [\\\"available\\\"]) { name quantity } incoming item { id sku } location { id name } } } }\",\n \"variables\": {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": 3\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": 3\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": 3\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"inventoryLevelId\": \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\": 3\n }\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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {\n inventoryAdjustQuantity(input: $input) {\n inventoryLevel {\n id\n quantities(names: [\"available\"]) {\n name\n quantity\n }\n incoming\n item {\n id\n sku\n }\n location {\n id\n name\n }\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"inventoryLevelId\" => \"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\n \"availableDelta\" => 3,\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "Provides the input fields required to update an inventory level.",
"type": {
"kind": "INPUT_OBJECT",
"name": "InventoryAdjustQuantityInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "InventoryAdjustQuantityInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"inventoryLevelId\":\"gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076\",\"availableDelta\":3}",
"typeKind": "MUTATION"
}
]
}
]