Inventory
The input fields for the quantity to be set for an inventory item at a location.
Anchor to FieldsFields
- changeFromQuantity (Int)
- inventoryItemId (ID!)
- locationId (ID!)
- quantity (Int!)
- Anchor to changeFromQuantitychange•Int
From Quantity The quantity currently expected at this location, before setting the new quantity.
This field enables a compare-and-swap (CAS) safety check. If the location’s current quantity doesn't match the value you provide, then the mutation fails with a
error. This helps prevent unintended overwrites when the request is based on stale inventory data.To skip the CAS check, pass
null. Use this only when your system is the source of truth for this inventory and you don’t need to protect against concurrent updates. This field is mandatory: you must explicitly pass in a value, even if that value isnull, or the mutation returns an error.For more information, refer to the compare and swap documentation.
- Anchor to inventoryItemIdinventory•ID!
Item Id non-null Specifies the inventory item to which the quantity will be set.
- Anchor to locationIdlocation•ID!
Id non-null Specifies the location at which the quantity will be set.
- Anchor to quantityquantity•Int!non-null
The quantity to which the inventory quantity will be set.
Anchor to Input objects using this inputInput objects using this input
- •INPUT OBJECT
The input fields required to set inventory quantities.