younifyd
Menu

inventoryTransfers

Returns a paginated list of InventoryTransfer objects between locations. Transfers track the movement of InventoryItem objects between Location objects.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the inventoryTransfers action (under Inventory).
  3. Fill in the fields below, then reference the result from later steps as {{inventorytransfers.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 InventoryTransfers($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: TransferSortKeys, $query: String, $savedSearchId: ID) {
  inventoryTransfers(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        dateCreated
        destination
        hasTimelineComment
        id
        name
        note
        origin
        receivedQuantity
        referenceName
        status
        tags
        totalQuantity
      }
    }
    nodes {
      dateCreated
      destination {
        address
        location
        name
        snapshottedAt
      }
      hasTimelineComment
      id
      name
      note
      origin {
        address
        location
        name
        snapshottedAt
      }
      receivedQuantity
      referenceName
      status
      tags
      totalQuantity
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

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

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofCREATED_ATDESTINATION_NAMEEXPECTED_SHIPMENT_ARRIVALIDNAMEORIGIN_NAMESOURCE_NAMESTATUS

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`<br/> - `query=title:green hoodie` | | created_at | time | | destination_id | id | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | origin_id | id | | product_id | id | | product_variant_id | id | | source_id | id | | status | string | | tag | string | Filter objects by the `tag` field. | | | - `tag:my_tag` | | tag_not | string | Filter by objects that don’t have the specified tag. | | | - `tag_not:my_tag` | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.

json
{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "CREATED_AT",
  "query": "string",
  "savedSearchId": "string"
}

Response

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

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
dateCreatedobject
destinationobject
hasTimelineCommentobject
idobject
nameobject
noteobject
originobject
receivedQuantityobject
referenceNameobject
statusobject
tagsobject
totalQuantityobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

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