Choose a version:

inventoryTransferRemoveItems

mutation

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

This mutation allows removing the shippable quantities of line items on a Transfer. It removes all quantities of the item from the transfer that are not associated with shipments.

Arguments

Anchor to inputinput •InventoryTransferRemoveItemsInput! required: The input fields for the InventoryTransferRemoveItems mutation.

Was this section helpful?

Anchor to InventoryTransferRemoveItemsPayload returnsInventoryTransferRemoveItemsPayload returns

Anchor to inventoryTransferinventoryTransfer •InventoryTransfer: The transfer with line items removed.
Anchor to removedQuantitiesremovedQuantities •[InventoryTransferLineItemUpdate!]: The line items that have had their shippable quantity removed.
Anchor to userErrorsuserErrors •[InventoryTransferRemoveItemsUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation inventoryTransferRemoveItems($input: InventoryTransferRemoveItemsInput!) {

inventoryTransferRemoveItems(input: $input) {

inventoryTransfer {

# InventoryTransfer fields

}

removedQuantities {

# InventoryTransferLineItemUpdate fields

}

userErrors {

field

message

}

Input

{

"input": {

"id": "gid://shopify/<objectName>/10079785100",

"transferLineItemIds": [

"gid://shopify/<objectName>/10079785100"

]

}

{
  "input": {
    "id": "gid://shopify/<objectName>/10079785100",
    "transferLineItemIds": [
      "gid://shopify/<objectName>/10079785100"
    ]
  }
}

input InventoryTransferRemoveItemsInput {
  id: ID!
  transferLineItemIds: [ID!]
}