InventorySetQuantitiesUserError
object

Choose a version:

An error that occurs during the execution of InventorySetQuantities.

Fields

Anchor to InventorySetQuantitiesUserError.code code InventorySetQuantitiesUserErrorCode: The error code.
Anchor to InventorySetQuantitiesUserError.field field [String!]: The path to the input field that caused the error.
Anchor to InventorySetQuantitiesUserError.message message String! non-null: The error message.

Was this section helpful?

Map

No referencing fields

InventorySetQuantitiesUserError

Anchor to inventorySetQuantities inventorySetQuantities mutation: 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 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.