Skip to main content
Anchor to InventoryTransferRemoveItemsPayload

InventoryTransferRemoveItemsPayload

payload

Return type for inventoryTransferRemoveItems mutation.

•InventoryTransfer

The transfer with line items removed.

Show fields
•[InventoryTransferLineItemUpdate!]

The line items that have had their shippable quantity removed.

Show fields
•[InventoryTransferRemoveItemsUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•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.

Show payload

Arguments

•InventoryTransferRemoveItemsInput!
required

The input fields for the InventoryTransferRemoveItems mutation.

Show input fields


Was this section helpful?