Inventory Transfer Set Items Payload
Return type for mutation.
Anchor to FieldsFields
- inventoryTransfer (InventoryTransfer)
- updatedLineItems ([InventoryTransferLineItemUpdate!])
- userErrors ([InventoryTransferSetItemsUserError!]!)
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The Transfer with its line items updated.
- Anchor to updatedLineItemsupdated•[Inventory
Line Items Transfer Line Item Update!] The updated line items.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Set Items User Error!]! non-null The list of errors that occurred from executing the mutation.
Anchor to Mutations with this payloadMutations with this payload
- inventoryTransferSetItems (InventoryTransferSetItemsPayload)
- •mutation
This mutation sets the quantity for one or more line items on a Transfer.
Only the items you include in the
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; duplicateentries are rejected.For each entry in
:- 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
. 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
0is only allowed for transfers instatus; onortransfers it returns anerror. Ontransfers,quantity: 0leaves a zero-quantity line item on the transfer; it does not remove the item. To remove a line item from a transfer, use.CautionAs of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution:As of 2026-01, this mutation supports an optional idempotency key using the
@idempotentdirective. As of 2026-04, the idempotency key is required and must be provided using the@idempotentdirective. For more information, see the idempotency documentation.Caution: As of 2026-01, this mutation supports an optional idempotency key using the <code>@idempotent</code> directive. As of 2026-04, the idempotency key is required and must be provided using the <code>@idempotent</code> directive. For more information, see the <a href="https://shopify.dev/docs/api/usage/idempotent-requests">idempotency documentation</a>.
- Anchor to inputinput•Inventory
Transfer Set Items Input! required The input fields for the InventoryTransferSetItems mutation.
Arguments