Inventory
Requires access scope.
Represents a group of adjustments made as part of the same operation.
Anchor to FieldsFields
- •App
The app that triggered the inventory event, if one exists.
- Anchor to changeschanges•[Inventory
Change!]!non-null The set of inventory quantity changes that occurred in the inventory event.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time the inventory adjustment group was created.
- •ID!non-null
A globally-unique ID.
- Anchor to reasonreason•String!non-null
The reason for the group of adjustments.
- Anchor to referenceDocumentUrireference•String
Document Uri 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
for the inventory adjustment is a URI referencing the order ID.- Anchor to staffMemberstaff•Staff
Member Member The staff member associated with the inventory event.
Anchor to MutationsMutations
- •mutation
Apply changes to inventory quantities.
- Anchor to inputinput•Inventory
Adjust Quantities Input!required The information required to adjust inventory quantities.
Arguments
- Anchor to inventoryAdjustmentGroupinventory•Inventory
Adjustment Group Adjustment Group The group of changes made by the operation.
- Anchor to userErrorsuser•[Inventory
Errors Adjust Quantities User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Moves inventory between inventory quantity names at a single location.
- Anchor to inputinput•Inventory
Move Quantities Input!required The information required to move inventory quantities.
Arguments
- Anchor to inventoryAdjustmentGroupinventory•Inventory
Adjustment Group Adjustment Group The group of changes made by the operation.
- Anchor to userErrorsuser•[Inventory
Errors Move Quantities User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Set quantities of specified name using absolute values. This mutation supports compare-and-set functionality to handle concurrent requests properly. If
is not set to true, the mutation will only update the quantity if the persisted quantity matches thevalue. If thevalue does not match the persisted value, the mutation will return an error. In order to opt out of thecheck, theargument can be set to true.NoteOnly 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 mutation.
Opting out of the
check can lead to inaccurate inventory quantities if multiple requests are made concurrently. It is recommended to always include thevalue to ensure the accuracy of the inventory quantities and to opt out of the check usingonly when necessary.- Anchor to inputinput•Inventory
Set Quantities Input!required The information required to set inventory quantities.
Arguments
- Anchor to inventoryAdjustmentGroupinventory•Inventory
Adjustment Group Adjustment Group The group of changes made by the operation.
- Anchor to userErrorsuser•[Inventory
Errors Set Quantities User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutationDeprecated