API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

inventoryAdjustQuantity mutation

Version unstable

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2021-01 (Release candidate)

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-10 (Latest)

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-07

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-04

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2020-01

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-10 (Unsupported)

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-07 (Unsupported)

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.

Version 2019-04 (Unsupported)

Adjusts the inventory by a certain quantity.

Required access

write_inventory access scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

input ( InventoryAdjustQuantityInput! ) required

Provides the input fields required to update an inventory level.

InventoryAdjustQuantityInput fields

availableDelta (Int!) Required

Count by which to adjust the available quantity.

inventoryLevelId (ID!) Required

ID of the inventory level to adjust.

Return fields

inventoryLevel (InventoryLevel)

Represents the updated inventory quantity of an inventory item at a specific location.

userErrors ([UserError!]!)

List of errors that occurred executing the mutation.