inventoryAdjustQuantity mutation

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

On this page

Interactive example

This is an example mutation query.

mutation inventoryAdjustQuantity($input: InventoryAdjustQuantityInput!) { inventoryAdjustQuantity(input: $input) { 
  1. <font style="color:#1F61A0;">inventoryLevel</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “input”: { 
  1. <font style="color:#8B2BB9;">"inventoryLevelId"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE="</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"availableDelta"</font><font style="color:#555555;">:</font> <font style="color:#2882F9;">1</font>
} }

Arguments

Argument Description
input
(
[InventoryAdjustQuantityInput!](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventoryadjustquantityinput)

) REQUIRED		 Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

  • availableDelta ([Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)) REQUIRED
    Count by which to adjust the available quantity.
  • inventoryLevelId ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)) REQUIRED
    ID of the inventory level to adjust.

Return fields

  • inventoryLevel ([InventoryLevel](https://shopify.dev/docs/admin-api/graphql/reference/inventory/inventorylevel))
    Represents the updated inventory quantity of an inventory item at a specific location.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.