inventoryTransferRemoveItems

This mutation removes InventoryTransferLineItems, or portions of them, from a DRAFT or READYTOSHIP Transfer.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the inventoryTransferRemoveItems action (under Inventory).
Fill in the fields below, then reference the result from later steps as {{inventorytransferremoveitems.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation InventoryTransferRemoveItems($input: InventoryTransferRemoveItemsInput!) {
  inventoryTransferRemoveItems(input: $input) {
    inventoryTransfer {
      dateCreated
      destination {
        address
        location
        name
        snapshottedAt
      }
      hasTimelineComment
      id
      name
      note
      origin {
        address
        location
        name
        snapshottedAt
      }
      receivedQuantity
      referenceName
      status
      tags
      totalQuantity
    }
    removedQuantities {
      deltaQuantity
      inventoryItemId
      newQuantity
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

inputobjectrequired

The input fields for the InventoryTransferRemoveItems mutation.

idstringrequired

transferLineItemIdsarray<string>

json

{
  "input": {
    "id": "string",
    "transferLineItemIds": [
      "string"
    ]
  }
}

Response

Read the result with {{inventorytransferremoveitems.response.data.data.inventoryTransferRemoveItems}}. If the API returns errors, the step fails and they are at {{inventorytransferremoveitems.response.data.errors}}.

inventoryTransferobject

dateCreatedstring

destinationobject4 fields

hasTimelineCommentboolean

idstring

namestring

notestring

originobject4 fields

receivedQuantitynumber

referenceNamestring

statusstring

One ofDRAFTREADY_TO_SHIPIN_PROGRESSTRANSFERREDCANCELEDOTHER

tagsarray<object>

totalQuantitynumber

removedQuantitiesarray<object>

deltaQuantityobject

inventoryItemIdobject

newQuantityobject

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?