inventoryTransfer

Returns an InventoryTransfer by ID. Inventory transfers track the movement of inventory between locations, including origin and destination details, InventoryTransferLineItem objects, quantities, and…

Use it in a workflow

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

Query

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

graphql

query InventoryTransfer($id: ID!) {
  inventoryTransfer(id: $id) {
    dateCreated
    destination {
      address {
        address1
        address2
        city
        country
        countryCode
        formatted
        latitude
        longitude
        phone
        province
        provinceCode
        zip
      }
      location {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      name
      snapshottedAt
    }
    hasTimelineComment
    id
    name
    note
    origin {
      address {
        address1
        address2
        city
        country
        countryCode
        formatted
        latitude
        longitude
        phone
        province
        provinceCode
        zip
      }
      location {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      name
      snapshottedAt
    }
    receivedQuantity
    referenceName
    status
    tags
    totalQuantity
  }
}

Variables

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

idstringrequired

The ID of the inventory transfer.

json

{
  "id": "string"
}

Response

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

dateCreatedstring

destinationobject

addressobject12 fields

locationobject21 fields

namestring

snapshottedAtstring

hasTimelineCommentboolean

idstring

namestring

notestring

originobject

addressobject12 fields

locationobject21 fields

namestring

snapshottedAtstring

receivedQuantitynumber

referenceNamestring

statusstring

One ofDRAFTREADY_TO_SHIPIN_PROGRESSTRANSFERREDCANCELEDOTHER

tagsarray<string>

totalQuantitynumber

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

Was this page helpful?