inventoryAdjustQuantity

mutationDeprecated

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

Adjusts the inventory by a certain quantity. Use inventoryAdjustQuantities instead.

Arguments

Anchor to inputinput • InventoryAdjustQuantityInput!required: Provides the input fields required to update an inventory level.

Was this section helpful?

Anchor to InventoryAdjustQuantityPayload returnsInventoryAdjustQuantityPayload returns

Anchor to inventoryLevelinventoryLevel • InventoryLevel: Represents the updated inventory quantity of an inventory item at a specific location.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Decrease the available inventory of an item at a location by 2
Increase the available inventory of an item at a location by 3
inventoryAdjustQuantity reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {
6    inventoryAdjustQuantity(input: $input) {
7      inventoryLevel {
8        id
9        quantities(names: ["available"]) {
10          name
11          quantity
12        }
13        incoming
14        item {
15          id
16          sku
17        }
18        location {
19          id
20          name
21        }
22      }
23    }
24  }`,
25  {
26    variables: {
27      "input": {
28        "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
29        "availableDelta": -2
30      }
31    },
32  },
33);
34
35const data = await response.json();
36

mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {
  inventoryAdjustQuantity(input: $input) {
    inventoryLevel {
      id
      quantities(names: ["available"]) {
        name
        quantity
      }
      incoming
      item {
        id
        sku
      }
      location {
        id
        name
      }
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) { inventoryAdjustQuantity(input: $input) { inventoryLevel { id quantities(names: [\"available\"]) { name quantity } incoming item { id sku } location { id name } } } }",
 "variables": {
    "input": {
      "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
      "availableDelta": -2
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {
    inventoryAdjustQuantity(input: $input) {
      inventoryLevel {
        id
        quantities(names: ["available"]) {
          name
          quantity
        }
        incoming
        item {
          id
          sku
        }
        location {
          id
          name
        }
      }
    }
  }`,
  {
    variables: {
      "input": {
        "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
        "availableDelta": -2
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {
      inventoryAdjustQuantity(input: $input) {
        inventoryLevel {
          id
          quantities(names: ["available"]) {
            name
            quantity
          }
          incoming
          item {
            id
            sku
          }
          location {
            id
            name
          }
        }
      }
    }`,
    "variables": {
      "input": {
        "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
        "availableDelta": -2
      }
    },
  },
});

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 AdjustInventoryQuantity($input: InventoryAdjustQuantityInput!) {
    inventoryAdjustQuantity(input: $input) {
      inventoryLevel {
        id
        quantities(names: ["available"]) {
          name
          quantity
        }
        incoming
        item {
          id
          sku
        }
        location {
          id
          name
        }
      }
    }
  }
QUERY

variables = {
  "input": {
    "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
    "availableDelta": -2
  }
}

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

Input variables

JSON

1{
2  "input": {
3    "inventoryLevelId": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
4    "availableDelta": -2
5  }
6}

Response

JSON

1{
2  "inventoryAdjustQuantity": {
3    "inventoryLevel": {
4      "id": "gid://shopify/InventoryLevel/964427794?inventory_item_id=43729076",
5      "quantities": [
6        {
7          "name": "available",
8          "quantity": -1
9        }
10      ],
11      "incoming": 0,
12      "item": {
13        "id": "gid://shopify/InventoryItem/43729076",
14        "sku": "draft-151"
15      },
16      "location": {
17        "id": "gid://shopify/Location/124656943",
18        "name": "Shipping Origin"
19      }
20    }
21  }
22}