inventorySetQuantities - admin-graphql - MUTATION

Version: 2024-07

Description:

Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle concurrent requests properly. If `ignoreCompareQuantity` is not set to true, the mutation will only update the quantity if the persisted quantity matches the `compareQuantity` value. If the `compareQuantity` value does not match the persisted value, the mutation will return an error. In order to opt out of the `compareQuantity` check, the `ignoreCompareQuantity` 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](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) mutation. > > > Opting out of the `compareQuantity` check can lead to inaccurate inventory quantities if multiple requests are made concurrently. > It is recommended to always include the `compareQuantity` value to ensure the accuracy of the inventory quantities and to opt out > of the check using `ignoreCompareQuantity` only when necessary.

Access Scopes

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

Arguments

• input: InventorySetQuantitiesInput! - The information required to set inventory quantities.

Returns

• inventoryAdjustmentGroup: InventoryAdjustmentGroup The group of changes made by the operation.
• userErrors: InventorySetQuantitiesUserError! The list of errors that occurred from executing the mutation.

Examples

• Sets the inventory level for an inventory item at a location

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation InventorySet($input: InventorySetQuantitiesInput!) { inventorySetQuantities(input: $input) { inventoryAdjustmentGroup { createdAt reason referenceDocumentUri changes { name delta } } userErrors { 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"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation InventorySet($input: InventorySetQuantitiesInput!) {\n      inventorySetQuantities(input: $input) {\n        inventoryAdjustmentGroup {\n          createdAt\n          reason\n          referenceDocumentUri\n          changes {\n            name\n            delta\n          }\n        }\n        userErrors {\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"
          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 InventorySet($input: InventorySetQuantitiesInput!) {\n    inventorySetQuantities(input: $input) {\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n      userErrors {\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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation InventorySet($input: InventorySetQuantitiesInput!) {\n    inventorySetQuantities(input: $input) {\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n      userErrors {\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"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation InventorySet($input: InventorySetQuantitiesInput!) {\n    inventorySetQuantities(input: $input) {\n      inventoryAdjustmentGroup {\n        createdAt\n        reason\n        referenceDocumentUri\n        changes {\n          name\n          delta\n        }\n      }\n      userErrors {\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"
          Graphql query: "mutation InventorySet($input: InventorySetQuantitiesInput!) {\n  inventorySetQuantities(input: $input) {\n    inventoryAdjustmentGroup {\n      createdAt\n      reason\n      referenceDocumentUri\n      changes {\n        name\n        delta\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"
        

  input: {
    "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": {
          "createdAt": "2024-11-07T22:03:12Z",
          "reason": "Inventory correction",
          "referenceDocumentUri": "logistics://some.warehouse/take/2023-01-23T13:14:15Z",
          "changes": [
            {
              "name": "available",
              "delta": 10
            },
            {
              "name": "on_hand",
              "delta": 10
            }
          ]
        },
        "userErrors": []
      }
    }
  }

  Setting available quantity at a location with compare-and-swap (CAS) enabled

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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"
          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"
          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"
          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"
          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"
          Graphql 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}"
        

  input: {
    "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": []
      }
    }
  }

  Setting available quantity at a location without compare-and-swap (CAS) enabled

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/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"
          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"
          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"
          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"
          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"
          Graphql 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}"
        

  input: {
    "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": []
      }
    }
  }