Anchor to section titled 'undefined'inventory
inventory
mutation
Unstable
Requires write access scope. Also: The user must have a permission to update an inventory.
Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle
concurrent requests properly. If ignore is not set to true,
the mutation will only update the quantity if the persisted quantity matches the compare value.
If the compare value does not match the persisted value, the mutation will return an error. In order to opt out
of the compare check, the ignore argument can be set to true.
Note
Only use this mutation if calling on behalf of a system that acts as the source of truth for inventory quantities,
otherwise please consider using the inventoryAdjustQuantities mutation.
Opting out of the compare check can lead to inaccurate inventory quantities if multiple requests are made concurrently.
It is recommended to always include the compare value to ensure the accuracy of the inventory quantities and to opt out
of the check using ignore only when necessary.
Anchor to section titled 'Arguments'
Arguments
The information required to set inventory quantities.
Was this section helpful?
Anchor to section titled 'InventorySetQuantitiesPayload returns'
InventorySetQuantitiesPayload returns
- Anchor to InventorySetQuantitiesPayload.inventoryAdjustmentGroupinventory
Adjustment Group The group of changes made by the operation.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: inventorySetQuantities
Query Reference for MUTATION: inventorySetQuantities
"mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n # InventoryAdjustmentGroup fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: inventorySetQuantities
"{\n \"input\": {\n \"ignoreCompareQuantity\": true,\n \"name\": \"<your-name>\",\n \"quantities\": [\n {\n \"compareQuantity\": 1,\n \"inventoryItemId\": \"gid://shopify/<objectName>/10079785100\",\n \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n \"quantity\": 1\n }\n ],\n \"reason\": \"<your-reason>\",\n \"referenceDocumentUri\": \"<your-referenceDocumentUri>\"\n }\n}"Schema Reference for MUTATION: inventorySetQuantities
"input InventorySetQuantitiesInput {\n ignoreCompareQuantity: Boolean\n name: String!\n quantities: [InventoryQuantityInput!]!\n reason: String!\n referenceDocumentUri: String\n}\n\ninput InventoryQuantityInput {\n compareQuantity: Int\n inventoryItemId: ID!\n locationId: ID!\n quantity: Int!\n}\n"Display Examples for MUTATION: inventorySetQuantities
[
{
"example": {
"type_name": "inventorysetquantities",
"title": "Setting available quantity at a location with compare-and-swap (CAS) enabled",
"query_string": "mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"input": {
"name": "available",
"reason": "correction",
"referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
"quantities": [
{
"inventoryItemId": "gid://shopify/InventoryItem/30322695",
"locationId": "gid://shopify/Location/124656943",
"quantity": 11,
"compareQuantity": 1
}
]
}
},
"response": {
"data": {
"inventorySetQuantities": {
"inventoryAdjustmentGroup": {
"reason": "Inventory correction",
"referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
"changes": [
{
"name": "available",
"delta": 10,
"quantityAfterChange": null
},
{
"name": "on_hand",
"delta": 10,
"quantityAfterChange": null
}
]
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-07",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_set_quantities_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 inventorySetQuantities($input: InventorySetQuantitiesInput!) { inventorySetQuantities(input: $input) { inventoryAdjustmentGroup { reason referenceDocumentUri changes { name delta quantityAfterChange } } userErrors { code field message } } }\",\n \"variables\": {\n \"input\": {\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 11,\n \"compareQuantity\": 1\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 11,\n \"compareQuantity\": 1\n }\n ]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>11, \"compareQuantity\"=>1}]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 11,\n \"compareQuantity\": 1\n }\n ]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"name\" => \"available\",\n \"reason\" => \"correction\",\n \"referenceDocumentUri\" => \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\" => [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>11, \"compareQuantity\"=>1}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The information required to set inventory quantities.",
"type": {
"kind": "INPUT_OBJECT",
"name": "InventorySetQuantitiesInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "InventorySetQuantitiesInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"name\":\"available\",\"reason\":\"correction\",\"referenceDocumentUri\":\"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\"quantities\":[{\"inventoryItemId\":\"gid://shopify/InventoryItem/30322695\",\"locationId\":\"gid://shopify/Location/124656943\",\"quantity\":11,\"compareQuantity\":1}]}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "inventorysetquantities",
"title": "Setting available quantity at a location without compare-and-swap (CAS) enabled",
"query_string": "mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n}",
"variables": {
"input": {
"ignoreCompareQuantity": true,
"name": "available",
"reason": "correction",
"referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
"quantities": [
{
"inventoryItemId": "gid://shopify/InventoryItem/30322695",
"locationId": "gid://shopify/Location/124656943",
"quantity": 42,
"compareQuantity": null
}
]
}
},
"response": {
"data": {
"inventorySetQuantities": {
"inventoryAdjustmentGroup": {
"reason": "Inventory correction",
"referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
"changes": [
{
"name": "available",
"delta": 41,
"quantityAfterChange": null
},
{
"name": "on_hand",
"delta": 41,
"quantityAfterChange": null
}
]
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-07",
"maximum_api_version": "unstable",
"location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_set_quantities_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 inventorySetQuantities($input: InventorySetQuantitiesInput!) { inventorySetQuantities(input: $input) { inventoryAdjustmentGroup { reason referenceDocumentUri changes { name delta quantityAfterChange } } userErrors { code field message } } }\",\n \"variables\": {\n \"input\": {\n \"ignoreCompareQuantity\": true,\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 42,\n \"compareQuantity\": null\n }\n ]\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"ignoreCompareQuantity\": true,\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 42,\n \"compareQuantity\": null\n }\n ]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"ignoreCompareQuantity\": true,\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>42, \"compareQuantity\"=>nil}]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"ignoreCompareQuantity\": true,\n \"name\": \"available\",\n \"reason\": \"correction\",\n \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\": [\n {\n \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n \"locationId\": \"gid://shopify/Location/124656943\",\n \"quantity\": 42,\n \"compareQuantity\": null\n }\n ]\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 inventorySetQuantities($input: InventorySetQuantitiesInput!) {\n inventorySetQuantities(input: $input) {\n inventoryAdjustmentGroup {\n reason\n referenceDocumentUri\n changes {\n name\n delta\n quantityAfterChange\n }\n }\n userErrors {\n code\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"ignoreCompareQuantity\" => true,\n \"name\" => \"available\",\n \"reason\" => \"correction\",\n \"referenceDocumentUri\" => \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n \"quantities\" => [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>42, \"compareQuantity\"=>nil}],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The information required to set inventory quantities.",
"type": {
"kind": "INPUT_OBJECT",
"name": "InventorySetQuantitiesInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "InventorySetQuantitiesInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"ignoreCompareQuantity\":true,\"name\":\"available\",\"reason\":\"correction\",\"referenceDocumentUri\":\"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\"quantities\":[{\"inventoryItemId\":\"gid://shopify/InventoryItem/30322695\",\"locationId\":\"gid://shopify/Location/124656943\",\"quantity\":42,\"compareQuantity\":null}]}",
"typeKind": "MUTATION"
}
]
}
]