inventoryTransferSetItems

mutation

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

This mutation allows for the setting of line items on a Transfer. Will replace the items already set, if any. Note, this mutation cannot be called after the transfer has been marked In Progress.

Arguments

Anchor to inputinput • InventoryTransferSetItemsInput!required: The input fields for the InventoryTransferSetItems mutation.

Was this section helpful?

Anchor to InventoryTransferSetItemsPayload returnsInventoryTransferSetItemsPayload returns

Anchor to inventoryTransferinventoryTransfer • InventoryTransfer: The Transfer with its line items updated.
Anchor to updatedLineItemsupdatedLineItems • [InventoryTransferLineItemUpdate!]: The updated line items.
Anchor to userErrorsuserErrors • [InventoryTransferSetItemsUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation inventoryTransferSetItems($input: InventoryTransferSetItemsInput!) {

inventoryTransferSetItems(input: $input) {

inventoryTransfer {

# InventoryTransfer fields

}

updatedLineItems {

# InventoryTransferLineItemUpdate fields

}

userErrors {

field

message

}

Input

{

"input": {

"lineItems": [

{

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

"quantity": 1

}

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

}

{
  "input": {
    "lineItems": [
      {
        "inventoryItemId": "gid://shopify/<objectName>/10079785100",
        "quantity": 1
      }
    ],
    "transferId": "gid://shopify/<objectName>/10079785100"
  }
}

input InventoryTransferSetItemsInput {
  lineItems: [InventoryTransferLineItemInput!]!
  transferId: ID!
}

input InventoryTransferLineItemInput {
  inventoryItemId: ID!
  quantity: Int!
}