The input fields required to set inventory quantities.
Access Scopes
Fields
ignoreCompareQuantity:
Boolean -
Skip the compare quantity check in the quantities field.
name:
String! -
The name of quantities to be changed. The only accepted values are: `available` or `on_hand`.
quantities:
InventoryQuantityInput! -
The values to which each quantities will be set.
reason:
String! -
The reason for the quantity changes. The value must be one of the [possible
reasons](https://shopify.dev/docs/apps/fulfillment/inventory-management-apps/quantities-states#set-inventory-quantities-on-hand).
referenceDocumentUri:
String -
A freeform URI that represents why the inventory change happened. This can be the entity adjusting inventory
quantities or the Shopify resource that's associated with the inventory adjustment. For example, a unit in a
draft order might have been previously reserved, and a merchant later creates an order from the draft order.
In this case, the `referenceDocumentUri` for the inventory adjustment is a URI referencing the order ID.