inventorySetOnHandQuantities
mutation
deprecated

Choose a version:

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

Set inventory on-hand quantities using absolute values. Use inventorySetQuantities to set on_hand or available quantites instead.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input InventorySetOnHandQuantitiesInput! required: The information required to set inventory on hand quantities.

Was this section helpful?

Anchor to section titled 'InventorySetOnHandQuantitiesPayload returns'

InventorySetOnHandQuantitiesPayload returns

Anchor to InventorySetOnHandQuantitiesPayload.inventoryAdjustmentGroup inventoryAdjustmentGroup InventoryAdjustmentGroup: The group of changes made by the operation.
Anchor to InventorySetOnHandQuantitiesPayload.userErrors userErrors [InventorySetOnHandQuantitiesUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: inventorySetOnHandQuantities

Query Reference for MUTATION: inventorySetOnHandQuantities

"mutation inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n  inventorySetOnHandQuantities(input: $input) {\n    inventoryAdjustmentGroup {\n      # InventoryAdjustmentGroup fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: inventorySetOnHandQuantities

"{\n  \"input\": {\n    \"reason\": \"<your-reason>\",\n    \"referenceDocumentUri\": \"<your-referenceDocumentUri>\",\n    \"setQuantities\": [\n      {\n        \"inventoryItemId\": \"gid://shopify/<objectName>/10079785100\",\n        \"locationId\": \"gid://shopify/<objectName>/10079785100\",\n        \"quantity\": 1\n      }\n    ]\n  }\n}"

Schema Reference for MUTATION: inventorySetOnHandQuantities

"input InventorySetOnHandQuantitiesInput {\n  reason: String!\n  referenceDocumentUri: String\n  setQuantities: [InventorySetQuantityInput!]!\n}\n\ninput InventorySetQuantityInput {\n  inventoryItemId: ID!\n  locationId: ID!\n  quantity: Int!\n}\n"

Display Examples for MUTATION: inventorySetOnHandQuantities

[
  {
    "example": {
      "type_name": "inventorysetonhandquantities",
      "title": "Adjust on_hand quantity for 2 items, with reason 'correction'.",
      "query_string": "mutation inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n  inventorySetOnHandQuantities(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    inventoryAdjustmentGroup {\n      createdAt\n      reason\n      referenceDocumentUri\n      changes {\n        name\n        delta\n      }\n    }\n  }\n}",
      "variables": {
        "input": {
          "reason": "correction",
          "referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
          "setQuantities": [
            {
              "inventoryItemId": "gid://shopify/InventoryItem/30322695",
              "locationId": "gid://shopify/Location/124656943",
              "quantity": 42
            },
            {
              "inventoryItemId": "gid://shopify/InventoryItem/113711323",
              "locationId": "gid://shopify/Location/124656943",
              "quantity": 13
            }
          ]
        }
      },
      "response": {
        "data": {
          "inventorySetOnHandQuantities": {
            "userErrors": [],
            "inventoryAdjustmentGroup": {
              "createdAt": "2024-09-12T01:05:46Z",
              "reason": "Inventory correction",
              "referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
              "changes": [
                {
                  "name": "available",
                  "delta": 31
                },
                {
                  "name": "available",
                  "delta": 12
                },
                {
                  "name": "on_hand",
                  "delta": 31
                },
                {
                  "name": "on_hand",
                  "delta": 12
                }
              ]
            }
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/inventory/test/unit/graph_api/admin/mutations/inventory_set_on_hand_quantities_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) { inventorySetOnHandQuantities(input: $input) { userErrors { field message } inventoryAdjustmentGroup { createdAt reason referenceDocumentUri changes { name delta } } } }\",\n \"variables\": {\n    \"input\": {\n      \"reason\": \"correction\",\n      \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n      \"setQuantities\": [\n        {\n          \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n          \"locationId\": \"gid://shopify/Location/124656943\",\n          \"quantity\": 42\n        },\n        {\n          \"inventoryItemId\": \"gid://shopify/InventoryItem/113711323\",\n          \"locationId\": \"gid://shopify/Location/124656943\",\n          \"quantity\": 13\n        }\n      ]\n    }\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n    inventorySetOnHandQuantities(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"reason\": \"correction\",\n        \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n        \"setQuantities\": [\n          {\n            \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n            \"locationId\": \"gid://shopify/Location/124656943\",\n            \"quantity\": 42\n          },\n          {\n            \"inventoryItemId\": \"gid://shopify/InventoryItem/113711323\",\n            \"locationId\": \"gid://shopify/Location/124656943\",\n            \"quantity\": 13\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 inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n    inventorySetOnHandQuantities(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"reason\": \"correction\",\n    \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n    \"setQuantities\": [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>42}, {\"inventoryItemId\"=>\"gid://shopify/InventoryItem/113711323\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>13}]\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 inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n      inventorySetOnHandQuantities(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        inventoryAdjustmentGroup {\n          createdAt\n          reason\n          referenceDocumentUri\n          changes {\n            name\n            delta\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"reason\": \"correction\",\n        \"referenceDocumentUri\": \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n        \"setQuantities\": [\n          {\n            \"inventoryItemId\": \"gid://shopify/InventoryItem/30322695\",\n            \"locationId\": \"gid://shopify/Location/124656943\",\n            \"quantity\": 42\n          },\n          {\n            \"inventoryItemId\": \"gid://shopify/InventoryItem/113711323\",\n            \"locationId\": \"gid://shopify/Location/124656943\",\n            \"quantity\": 13\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 inventorySetOnHandQuantities($input: InventorySetOnHandQuantitiesInput!) {\n    inventorySetOnHandQuantities(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"reason\" => \"correction\",\n    \"referenceDocumentUri\" => \"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\n    \"setQuantities\" => [{\"inventoryItemId\"=>\"gid://shopify/InventoryItem/30322695\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>42}, {\"inventoryItemId\"=>\"gid://shopify/InventoryItem/113711323\", \"locationId\"=>\"gid://shopify/Location/124656943\", \"quantity\"=>13}],\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 on hand quantities.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "InventorySetOnHandQuantitiesInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "InventorySetOnHandQuantitiesInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "input",
        "argValue": " {\"reason\":\"correction\",\"referenceDocumentUri\":\"logistics://some.warehouse/take/2023-01-23T13:14:15Z\",\"setQuantities\":[{\"inventoryItemId\":\"gid://shopify/InventoryItem/30322695\",\"locationId\":\"gid://shopify/Location/124656943\",\"quantity\":42},{\"inventoryItemId\":\"gid://shopify/InventoryItem/113711323\",\"locationId\":\"gid://shopify/Location/124656943\",\"quantity\":13}]}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

inventorySetOnHandQuantitiesmutationdeprecated

Arguments

InventorySetOnHandQuantitiesPayload returns

inventorySetOnHandQuantities
mutation
deprecated