InventoryAdjustmentGroup - admin-graphql - OBJECT

Version: 2024-10

Description:

Represents a group of adjustments made as part of the same operation.

`read_inventory` access scope.

app: App - The app that triggered the inventory event, if one exists.
changes: InventoryChange! - The set of inventory quantity changes that occurred in the inventory event.
createdAt: DateTime! - The date and time the inventory adjustment group was created.
id: ID! - A globally-unique ID.
reason: String! - The reason for the group of adjustments.
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.
staffMember: StaffMember - The staff member associated with the inventory event.

inventoryAdjustQuantities Apply changes to inventory quantities.
inventoryMoveQuantities Moves inventory between inventory quantity names at a single location.
inventorySetOnHandQuantities Set inventory on-hand quantities using absolute values.
inventorySetQuantities Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle concurrent requests properly. If `ignoreCompareQuantity` is not set to true, the mutation will only update the quantity if the persisted quantity matches the `compareQuantity` value. If the `compareQuantity` value does not match the persisted value, the mutation will return an error. In order to opt out of the `compareQuantity` check, the `ignoreCompareQuantity` argument can be set to true. > Note: > Only use this mutation if calling on behalf of a system that acts as the source of truth for inventory quantities, > otherwise please consider using the [inventoryAdjustQuantities](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) mutation. > > > Opting out of the `compareQuantity` check can lead to inaccurate inventory quantities if multiple requests are made concurrently. > It is recommended to always include the `compareQuantity` value to ensure the accuracy of the inventory quantities and to opt out > of the check using `ignoreCompareQuantity` only when necessary.