Skip to main content
Anchor to inventoryTransfers

inventoryTransfers

query

Requires read_inventory_transfers access scope. Also: The user must have permission to view products.

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

Supports filtering transfers using query parameters and sorting by various criteria. Use the connection's edges to access transfer details including InventoryTransferLineItem objects, quantities, and shipment status.

Anchor to Arguments

InventoryTransferConnection arguments

•InventoryTransferConnection!
Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to created_at
•time
Anchor to destination_id
•id
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to origin_id
•id
Anchor to product_id
•id
Anchor to product_variant_id
•id
Anchor to source_id
•id
Anchor to status
•string
Anchor to tag
•string

Filter objects by the tag field.

Example:

  • tag:my_tag
Anchor to tag_not
•string

Filter by objects that don’t have the specified tag.

Example:

  • tag_not:my_tag
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId
•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to sortKeysortKey
•TransferSortKeys
Default:ID

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[InventoryTransferEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[InventoryTransfer!]!
non-null

A list of nodes that are contained in InventoryTransferEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?