younifyd
Menu

inventoryTransferCreateAsReadyToShip

Creates an inventory transfer in ready to ship. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the inventoryTransferCreateAsReadyToShip action (under Inventory).
  3. Fill in the fields below, then reference the result from later steps as {{inventorytransfercreateasreadytoship.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 InventoryTransferCreateAsReadyToShip($input: InventoryTransferCreateAsReadyToShipInput!) {
  inventoryTransferCreateAsReadyToShip(input: $input) {
    inventoryTransfer {
      dateCreated
      destination {
        address
        location
        name
        snapshottedAt
      }
      hasTimelineComment
      id
      name
      note
      origin {
        address
        location
        name
        snapshottedAt
      }
      receivedQuantity
      referenceName
      status
      tags
      totalQuantity
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

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

inputobjectrequired

The input fields for the inventory transfer.

originLocationIdstring
destinationLocationIdstring
lineItemsarray<object>required2 fields
dateCreatedstring
notestring
tagsarray<string>
referenceNamestring
metafieldsarray<object>5 fields
json
{
  "input": {
    "lineItems": [
      {
        "inventoryItemId": "string",
        "quantity": "string"
      }
    ],
    "originLocationId": "string",
    "destinationLocationId": "string",
    "dateCreated": "string",
    "note": "string",
    "tags": [
      "string"
    ],
    "referenceName": "string",
    "metafields": [
      {
        "id": "string",
        "namespace": "string",
        "key": "string",
        "value": "string",
        "type": "string"
      }
    ]
  }
}

Response

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

inventoryTransferobject
dateCreatedstring
destinationobject4 fields
hasTimelineCommentboolean
idstring
namestring
notestring
originobject4 fields
receivedQuantitynumber
referenceNamestring
statusstring

One ofDRAFTREADY_TO_SHIPIN_PROGRESSTRANSFERREDCANCELEDOTHER

tagsarray<object>
totalQuantitynumber
userErrorsarray<object>
codeobject
fieldobject
messageobject

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