Skip to main content
Anchor to InventoryMoveQuantityTerminalInput

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 to compare against before applying the move. This field is mandatory- you must explicitly pass in a value (even if it's null), or else you will get an error. 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.fromInventoryMoveQuantityChange.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.toInventoryMoveQuantityChange.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?