Inventory
Requires access scope.
Records a batch of inventory changes made together in a single operation. Tracks which App or initiated the changes, when they occurred, and why they were made.
Provides an audit trail through its reason and reference document URI. The reference document URI links to the source that triggered the adjustment, such as an Order, , or external system event. Use the changes field to retrieve the specific quantity adjustments for each inventory state at affected locations.
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
Adjusts quantities for inventory items by applying incremental changes at specific locations. Each adjustment modifies the quantity by a delta value rather than setting an absolute amount.
The mutation tracks adjustments with a reason code and optional reference URI for audit trails. Returns an
that records all changes made in the operation.Learn more about managing inventory quantities and states.
CautionAs of version
2026-01, this mutation supports an optional idempotency key using the@idempotentdirective. As of version2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.- •mutation
Moves inventory quantities for a single inventory item between different states at a single location. Use this mutation to reallocate inventory across quantity states without moving it between locations.
Each change specifies the quantity to move, the source state and location, and the destination state and location. The mutation returns an
that tracks all changes made in a single operation, providing an audit trail with the reason and reference document URI.CautionAs of version
2026-01, this mutation supports an optional idempotency key using the@idempotentdirective. As of version2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.- •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.CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.- •mutationDeprecated