Skip to main content
Anchor to InventoryTransferLineItemUpdate

InventoryTransferLineItemUpdate

object

Requires read_inventory access scope.

Represents an update to a single transfer line item.

•Int

The delta quantity for the transfer line item.

•ID

The inventory item ID for the transfer line item.

•Int

The new quantity for the transfer line item.


Was this section helpful?

•mutation

This mutation removes InventoryTransferLineItems, or portions of them, from a DRAFT or READY_TO_SHIP Transfer.

For each referenced line item, if its entire quantity is still unallocated to a shipment, the line item is removed; otherwise the line item remains on the transfer with its quantity reduced to the allocated portion. Quantity allocated to a shipment (whether the shipment is in draft, in transit, or already received) is preserved.

On READY_TO_SHIP transfers, removing items also returns the affected reserved quantity to available inventory at the origin location.

To change the quantity of a line item without removing it, use inventoryTransferSetItems.

Arguments

•InventoryTransferRemoveItemsInput!
required

The input fields for the InventoryTransferRemoveItems mutation.


•mutation

This mutation sets the quantity for one or more line items on a Transfer.

Only the items you include in the lineItems field are updated. Items already on the transfer but not referenced in your update will stay unchanged. Each inventory item may appear at most once in lineItems; duplicate inventoryItemId entries are rejected.

For each entry in lineItems:

  • If the inventory item isn't yet on the transfer, a new line item is added with the provided quantity.
  • If the inventory item is already on the transfer, the provided quantity replaces the line item's processableQuantity. Any quantity outside the processable portion (for example, already shipped or picked for shipment) is preserved, so the resulting total quantity equals the preserved portion plus the provided quantity.

Passing a quantity of 0 is only allowed for transfers in DRAFT status; on READY_TO_SHIP or IN_PROGRESS transfers it returns an INVALID_QUANTITY error. On DRAFT transfers, quantity: 0 leaves a zero-quantity line item on the transfer; it does not remove the item. To remove a line item from a transfer, use inventoryTransferRemoveItems.


Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.


Arguments

•InventoryTransferSetItemsInput!
required

The input fields for the InventoryTransferSetItems mutation.



Was this section helpful?