Inventory
An error that occurs during the execution of .
Anchor to FieldsFields
- code (InventorySetQuantitiesUserErrorCode)
- field ([String!])
- message (String!)
- Anchor to codecode•Inventory
Set Quantities User Error Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- inventorySetQuantities (InventorySetQuantitiesPayload)
- •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.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 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.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 <a href="https://shopify.dev/api/admin-graphql/latest/mutations/inventoryAdjustQuantities">inventoryAdjustQuantities</a> mutation.</p> <p>Opting out of the <code><span class="PreventFireFoxApplyingGapToWBR">compare<wbr/>Quantity</span></code> check can lead to inaccurate inventory quantities if multiple requests are made concurrently. It is recommended to always include the <code><span class="PreventFireFoxApplyingGapToWBR">compare<wbr/>Quantity</span></code> value to ensure the accuracy of the inventory quantities and to opt out of the check using <code><span class="PreventFireFoxApplyingGapToWBR">ignore<wbr/>Compare<wbr/>Quantity</span></code> only 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.Caution:As 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.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
- Anchor to inputinput•Inventory
Set Quantities Input! required The information required to set inventory quantities.
Arguments