InventoryMoveQuantityTerminalInput

input_object

The input fields representing the change to be made to an inventory item at a location.

Anchor to FieldsFields

Anchor to changeFromQuantitychangeFromQuantity •Int: The quantity currently expected at this location, before the move is applied.

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 CHANGE_FROM_QUANTITY_STALE error. This helps prevent unintended overwrites when the request is based on stale inventory data.

To skip the CAS check, pass null. This is appropriate when your system is the source of truth for inventory at this location and you don’t need to guard against concurrent updates.

For more information, refer to the compare and swap documentation.
Anchor to ledgerDocumentUriledgerDocumentUri •String: A non-Shopify URI that identifies what specific inventory transaction or ledger entry was changed. Represents the exact inventory movement being referenced, distinct from the business reason for the change.

Preferred format - Global ID (GID): gid://[your-app-name]/[transaction-type]/[id]

Examples:

gid://warehouse-app/InventoryTransaction/TXN-2024-001 (specific transaction)

gid://3pl-system/StockMovement/SM-2024-0125 (stock movement record)

gid://pos-app/InventoryUpdate/UPD-98765 (POS inventory update)

gid://erp-connector/LedgerEntry/LE-2024-11-21-001 (ledger entry)

Requirements: Valid non-Shopify URI with scheme and content. Required for all quantity names except available. Cannot use gid://shopify/* format.
Anchor to locationIdlocationId •ID! non-null: Specifies the location at which the change will be applied.
Anchor to namename •String! non-null: The quantity name to be moved.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to InventoryMoveQuantityChange.from InventoryMoveQuantityChange.from •INPUT OBJECT: Represents the change to be made to an inventory item at a location. The change can either involve the same quantity name between different locations, or involve different quantity names between the same location.
Anchor to InventoryMoveQuantityChange.to InventoryMoveQuantityChange.to •INPUT OBJECT: Represents the change to be made to an inventory item at a location. The change can either involve the same quantity name between different locations, or involve different quantity names between the same location.

Was this section helpful?