Choose a version:

inventoryAdjustQuantities

mutation

Requires write_inventory access scope. Also: The user must have a permission to apply changes to inventory quantities.

Adjusts quantities for inventory items by applying incremental changes at specific locations. Each adjustment modifies the quantity by a delta value rather than setting an absolute amount.

The mutation tracks adjustments with a reason code and optional reference URI for audit trails. Returns an InventoryAdjustmentGroup that records all changes made in the operation.

Learn more about managing inventory quantities and states.

Caution

As of version 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of version 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Anchor to Arguments

Arguments

Anchor to inputinput •InventoryAdjustQuantitiesInput! required: The information required to adjust inventory quantities.

Was this section helpful?

Anchor to InventoryAdjustQuantitiesPayload returnsInventoryAdjustQuantitiesPayload returns

Anchor to inventoryAdjustmentGroupinventoryAdjustmentGroup •InventoryAdjustmentGroup: The group of changes made by the operation.
Anchor to userErrorsuserErrors •[InventoryAdjustQuantitiesUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Adjusts the inventory level of an inventory item at a location

Query

mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
  inventoryAdjustQuantities(input: $input) {
    userErrors {
      field
      message
    }
    inventoryAdjustmentGroup {
      createdAt
      reason
      referenceDocumentUri
      changes {
        name
        delta
      }
    }
  }
}

Variables

{
  "input": {
    "reason": "correction",
    "name": "available",
    "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
    "changes": [
      {
        "delta": -4,
        "inventoryItemId": "gid://shopify/InventoryItem/30322695",
        "locationId": "gid://shopify/Location/124656943"
      }
    ]
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) { inventoryAdjustQuantities(input: $input) { userErrors { field message } inventoryAdjustmentGroup { createdAt reason referenceDocumentUri changes { name delta } } } }",
 "variables": {
    "input": {
      "reason": "correction",
      "name": "available",
      "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
      "changes": [
        {
          "delta": -4,
          "inventoryItemId": "gid://shopify/InventoryItem/30322695",
          "locationId": "gid://shopify/Location/124656943"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
    inventoryAdjustQuantities(input: $input) {
      userErrors {
        field
        message
      }
      inventoryAdjustmentGroup {
        createdAt
        reason
        referenceDocumentUri
        changes {
          name
          delta
        }
      }
    }
  }`,
  {
    variables: {
        "input": {
            "reason": "correction",
            "name": "available",
            "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
            "changes": [
                {
                    "delta": -4,
                    "inventoryItemId": "gid://shopify/InventoryItem/30322695",
                    "locationId": "gid://shopify/Location/124656943"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
    inventoryAdjustQuantities(input: $input) {
      userErrors {
        field
        message
      }
      inventoryAdjustmentGroup {
        createdAt
        reason
        referenceDocumentUri
        changes {
          name
          delta
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "reason": "correction",
    "name": "available",
    "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
    "changes": [
      {
        "delta": -4,
        "inventoryItemId": "gid://shopify/InventoryItem/30322695",
        "locationId": "gid://shopify/Location/124656943"
      }
    ]
  }
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
      inventoryAdjustQuantities(input: $input) {
        userErrors {
          field
          message
        }
        inventoryAdjustmentGroup {
          createdAt
          reason
          referenceDocumentUri
          changes {
            name
            delta
          }
        }
      }
    }`,
    "variables": {
        "input": {
            "reason": "correction",
            "name": "available",
            "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
            "changes": [
                {
                    "delta": -4,
                    "inventoryItemId": "gid://shopify/InventoryItem/30322695",
                    "locationId": "gid://shopify/Location/124656943"
                }
            ]
        }
    },
  },
});

Response

{
  "inventoryAdjustQuantities": {
    "userErrors": [],
    "inventoryAdjustmentGroup": {
      "createdAt": "2024-11-07T21:47:12Z",
      "reason": "Inventory correction",
      "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
      "changes": [
        {
          "name": "available",
          "delta": -4
        },
        {
          "name": "on_hand",
          "delta": -4
        }
      ]
    }
  }
}

inventoryAdjustQuantities reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {

inventoryAdjustQuantities(input: $input) {

userErrors {

field

message

}

inventoryAdjustmentGroup {

createdAt

reason

referenceDocumentUri

changes {

name

delta

}

}`,

{

variables: {

"input": {

"reason": "correction",

"name": "available",

"referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",

"changes": [

{

"delta": -4,

"inventoryItemId": "gid://shopify/InventoryItem/30322695",

"locationId": "gid://shopify/Location/124656943"

}

]

}

);

const json = await response.json();

return json.data;

}

GQL

mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
  inventoryAdjustQuantities(input: $input) {
    userErrors {
      field
      message
    }
    inventoryAdjustmentGroup {
      createdAt
      reason
      referenceDocumentUri
      changes {
        name
        delta
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) { inventoryAdjustQuantities(input: $input) { userErrors { field message } inventoryAdjustmentGroup { createdAt reason referenceDocumentUri changes { name delta } } } }",
 "variables": {
    "input": {
      "reason": "correction",
      "name": "available",
      "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
      "changes": [
        {
          "delta": -4,
          "inventoryItemId": "gid://shopify/InventoryItem/30322695",
          "locationId": "gid://shopify/Location/124656943"
        }
      ]
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
    inventoryAdjustQuantities(input: $input) {
      userErrors {
        field
        message
      }
      inventoryAdjustmentGroup {
        createdAt
        reason
        referenceDocumentUri
        changes {
          name
          delta
        }
      }
    }
  }`,
  {
    variables: {
        "input": {
            "reason": "correction",
            "name": "available",
            "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
            "changes": [
                {
                    "delta": -4,
                    "inventoryItemId": "gid://shopify/InventoryItem/30322695",
                    "locationId": "gid://shopify/Location/124656943"
                }
            ]
        }
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
      inventoryAdjustQuantities(input: $input) {
        userErrors {
          field
          message
        }
        inventoryAdjustmentGroup {
          createdAt
          reason
          referenceDocumentUri
          changes {
            name
            delta
          }
        }
      }
    }`,
    "variables": {
        "input": {
            "reason": "correction",
            "name": "available",
            "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
            "changes": [
                {
                    "delta": -4,
                    "inventoryItemId": "gid://shopify/InventoryItem/30322695",
                    "locationId": "gid://shopify/Location/124656943"
                }
            ]
        }
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation inventoryAdjustQuantities($input: InventoryAdjustQuantitiesInput!) {
    inventoryAdjustQuantities(input: $input) {
      userErrors {
        field
        message
      }
      inventoryAdjustmentGroup {
        createdAt
        reason
        referenceDocumentUri
        changes {
          name
          delta
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "reason": "correction",
    "name": "available",
    "referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",
    "changes": [
      {
        "delta": -4,
        "inventoryItemId": "gid://shopify/InventoryItem/30322695",
        "locationId": "gid://shopify/Location/124656943"
      }
    ]
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

"reason": "correction",

"name": "available",

"referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",

"changes": [

{

"delta": -4,

"inventoryItemId": "gid://shopify/InventoryItem/30322695",

"locationId": "gid://shopify/Location/124656943"

}

]

}

Response

JSON

{

"inventoryAdjustQuantities": {

"userErrors": [],

"inventoryAdjustmentGroup": {

"createdAt": "2024-11-07T21:47:12Z",

"reason": "Inventory correction",

"referenceDocumentUri": "logistics://some.warehouse/take/2023-01/13",

"changes": [

{

"name": "available",

"delta": -4

{

"name": "on_hand",

"delta": -4

}

]

}