Skip to main content
Anchor to inventoryTransferRemoveItems

inventoryTransferRemoveItems

mutation

Requires write_inventory_transfers access scope. Also: The user must have permission to manage inventory.

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.

•InventoryTransferRemoveItemsInput!
required

The input fields for the InventoryTransferRemoveItems mutation.


Was this section helpful?

Anchor to InventoryTransferRemoveItemsPayload returnsInventoryTransferRemoveItemsPayload returns

•InventoryTransfer

The transfer with line items removed.

•[InventoryTransferLineItemUpdate!]

The line items that have had their shippable quantity removed.

•[InventoryTransferRemoveItemsUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?