Skip to main content
Anchor to InventoryTransfer

InventoryTransfer

object

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

Tracks the movement of InventoryItem objects between Location objects. A transfer includes origin and destination information, InventoryTransferLineItem objects with quantities, and shipment details.

Transfers progress through multiple statuses. The transfer maintains LocationSnapshot objects of location details to preserve historical data even if locations change or are deleted later.

Anchor to FieldsFields

Anchor to dateCreateddateCreated
•DateTime

The date and time the inventory transfer was created in UTC format.

Anchor to destinationdestination
•LocationSnapshot

Snapshot of the destination location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil.

Anchor to eventsevents
•EventConnection!
non-null

The list of events associated with the inventory transfer.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•EventSortKeys
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.

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 action
•string

The action that occured.

Example:

  • action:create
Anchor to comments
•boolean

Whether or not to include comment-events in your search, passing false will exclude comment-events, any other value will include comment-events.

Example:

  • false
  • true
Anchor to created_at
•time

Filter by the date and time when the event occurred. Event data is retained for 1 year.

Example:

  • created_at:>2025-10-21
  • created_at:<now
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to subject_type
•string

The resource type affected by this event. See EventSubjectType for possible values.

Example:

  • PRODUCT_VARIANT
  • PRODUCT
  • COLLECTION
Anchor to hasTimelineCommenthasTimelineComment
•Boolean!
non-null

Whether the merchant has added timeline comments to the inventory transfer.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to lineItemslineItems
•InventoryTransferLineItemConnection!
non-null

The line items associated with the inventory transfer.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying 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 id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to lineItemsCountlineItemsCount
•Count

The number of line items associated with the inventory transfer. Limited to a maximum of 10000 by default.

Arguments

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 id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to limitlimit
•Int
Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The key for the metafield.

Anchor to metafieldsmetafields
•MetafieldConnection!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to namespacenamespace
•String

The metafield namespace to filter by. If omitted, all metafields are returned.

Anchor to keyskeys
•[String!]

List of keys of metafields in the format namespace.key, will be returned in the same format.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to namename
•String!
non-null

The name of the inventory transfer.

Anchor to notenote
•String

Additional note attached to the inventory transfer.

Anchor to originorigin
•LocationSnapshot

Snapshot of the origin location (name, address, when snapped) with an optional link to the live Location object. If the original location is deleted, the snapshot data will still be available but the location link will be nil.

Anchor to receivedQuantityreceivedQuantity
•Int!
non-null

The total quantity of items received in the transfer.

Anchor to referenceNamereferenceName
•String

The reference name of the inventory transfer.

Anchor to shipmentsshipments
•InventoryShipmentConnection!
non-null

The shipments associated with the inventory transfer.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to statusstatus
•InventoryTransferStatus!
non-null

The current status of the transfer.

Anchor to tagstags
•[String!]!
non-null

A list of tags that have been added to the inventory transfer.

Anchor to totalQuantitytotalQuantity
•Int!
non-null

The total quantity of items being transferred.

Anchor to metafieldDefinitionsmetafieldDefinitions
•MetafieldDefinitionConnection!
non-nullDeprecated

Arguments

Anchor to namespacenamespace
•String

Filter metafield definitions by namespace.

Anchor to pinnedStatuspinnedStatus
•MetafieldDefinitionPinnedStatus
Default:ANY

Filter by the definition's pinned status.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•MetafieldDefinitionSortKeys
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.

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

Filter by the date and time when the metafield definition was created.

Example:

  • created_at:>2020-10-21T23:39:20Z
  • created_at:<now
  • created_at:<=2024
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to key
•string

Filter by the metafield definition key field.

Example:

  • key:some-key
Anchor to namespace
•string

Filter by the metafield definition namespace field.

Example:

  • namespace:some-namespace
Anchor to owner_type
•string

Filter by the metafield definition ownerType field.

Example:

  • owner_type:PRODUCT
Anchor to type
•string

Filter by the metafield definition type field.

Example:

  • type:single_line_text_field
Anchor to updated_at
•time

Filter by the date and time when the metafield definition was last updated.

Example:

  • updated_at:>2020-10-21T23:39:20Z
  • updated_at:<now
  • updated_at:<=2024
Was this section helpful?

Anchor to QueriesQueries

Anchor to inventoryTransferinventoryTransfer
•query

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

Arguments

Anchor to idid
•ID!
required

The ID of the inventory transfer.

Anchor to inventoryTransfersinventoryTransfers
•query

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.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

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.

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 savedSearchIdsavedSearchId
•ID

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

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryTransferCancelinventoryTransferCancel
•mutation

Cancels an inventory transfer.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory transfer to cancel.

Anchor to inventoryTransferCreateinventoryTransferCreate
•mutation

Creates a draft inventory transfer to move inventory items between Location objects in your store. The transfer tracks which items to move, their quantities, and the origin and destination locations.

Use inventoryTransferMarkAsReadyToShip to mark the transfer as ready to ship.

Caution

As of version 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of version 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput
•InventoryTransferCreateInput!
required

The input fields for the inventory transfer.

Anchor to inventoryTransferCreateAsReadyToShipinventoryTransferCreateAsReadyToShip
•mutation

Creates an inventory transfer in ready to ship.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput
•InventoryTransferCreateAsReadyToShipInput!
required

The input fields for the inventory transfer.

Anchor to inventoryTransferDuplicateinventoryTransferDuplicate
•mutation

This mutation allows duplicating an existing inventory transfer. The duplicated transfer will have the same line items and quantities as the original transfer, but will be in a draft state with no shipments.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory transfer to duplicate.

Anchor to inventoryTransferEditinventoryTransferEdit
•mutation

Edits an inventory transfer.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory Transfer to be edited.

Anchor to inputinput
•InventoryTransferEditInput!
required

The input fields to edit the inventory transfer.

Anchor to inventoryTransferMarkAsReadyToShipinventoryTransferMarkAsReadyToShip
•mutation

Sets an inventory transfer to ready to ship.

Arguments

Anchor to idid
•ID!
required

The ID of the inventory transfer to mark as ready to ship.

Anchor to inventoryTransferRemoveItemsinventoryTransferRemoveItems
•mutation

This mutation allows removing the shippable quantities of line items on a Transfer. It removes all quantities of the item from the transfer that are not associated with shipments.

Arguments

Anchor to inputinput
•InventoryTransferRemoveItemsInput!
required

The input fields for the InventoryTransferRemoveItems mutation.

Anchor to inventoryTransferSetItemsinventoryTransferSetItems
•mutation

This mutation allows for the setting of line items on a Transfer. Will replace the items already set, if any.

Caution

As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive. As of 2026-04, the idempotency key is required and must be provided using the @idempotent directive. For more information, see the idempotency documentation.

Arguments

Anchor to inputinput
•InventoryTransferSetItemsInput!
required

The input fields for the InventoryTransferSetItems mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to CommentEventSubjectCommentEventSubject
•interface
Anchor to HasEventsHasEvents
•interface
Anchor to HasMetafieldDefinitionsHasMetafieldDefinitions
•interface
Anchor to HasMetafieldsHasMetafields
•interface
Anchor to NodeNode
•interface
Was this section helpful?