--- title: InventoryTransfer - GraphQL Admin description: Represents the intention to move inventory between locations. api_version: unstable api_name: admin source_url: html: >- https://shopify.dev/docs/api/admin-graphql/unstable/objects/InventoryTransfer md: >- https://shopify.dev/docs/api/admin-graphql/unstable/objects/InventoryTransfer.md --- # Inventory​Transfer object Requires `read_inventory_transfers` access scope. Also: The user must have permission to view products. Represents the intention to move inventory between locations. ## Fields * date​Created [Date​Time](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/DateTime) The date and time the inventory transfer was created in UTC format. * destination [Location​Snapshot](https://shopify.dev/docs/api/admin-graphql/unstable/objects/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. * events [Event​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/EventConnection) non-null The list of events associated with the inventory transfer. * has​Timeline​Comment [Boolean!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Boolean) non-null Whether the merchant has added timeline comments to the inventory transfer. * id [ID!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/ID) non-null A globally-unique ID. * line​Items [Inventory​Transfer​Line​Item​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/InventoryTransferLineItemConnection) non-null The line items associated with the inventory transfer. * line​Items​Count [Count](https://shopify.dev/docs/api/admin-graphql/unstable/objects/Count) The number of line items associated with the inventory transfer. Limited to a maximum of 10000 by default. * metafield [Metafield](https://shopify.dev/docs/api/admin-graphql/unstable/objects/Metafield) A [custom field](https://shopify.dev/docs/apps/build/custom-data), including its `namespace` and `key`, that's associated with a Shopify resource for the purposes of adding and storing additional information. * metafields [Metafield​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/MetafieldConnection) non-null A list of [custom fields](https://shopify.dev/docs/apps/build/custom-data) that a merchant associates with a Shopify resource. * metafields​By​Identifiers [\[Metafield\]!](https://shopify.dev/docs/api/admin-graphql/unstable/objects/Metafield) non-null The metafields associated with the resource matching the supplied list of namespaces and keys. * name [String!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) non-null The name of the inventory transfer. * note [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) Additional note attached to the inventory transfer. * origin [Location​Snapshot](https://shopify.dev/docs/api/admin-graphql/unstable/objects/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. * received​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) non-null The total quantity of items received in the transfer. * reference​Name [String](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) The reference name of the inventory transfer. * shipments [Inventory​Shipment​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/InventoryShipmentConnection) non-null The shipments associated with the inventory transfer. * status [Inventory​Transfer​Status!](https://shopify.dev/docs/api/admin-graphql/unstable/enums/InventoryTransferStatus) non-null The current status of the transfer. * tags [\[String!\]!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/String) non-null A list of tags that have been added to the inventory transfer. * total​Quantity [Int!](https://shopify.dev/docs/api/admin-graphql/unstable/scalars/Int) non-null The total quantity of items being transferred. * metafield​Definitions [Metafield​Definition​Connection!](https://shopify.dev/docs/api/admin-graphql/unstable/connections/MetafieldDefinitionConnection) non-nullDeprecated *** ## Map ### Fields and connections with this object * <->[InventoryTransferConnection.nodes](https://shopify.dev/docs/api/admin-graphql/unstable/connections/InventoryTransferConnection#returns-nodes) * {}[InventoryTransferEdge.node](https://shopify.dev/docs/api/admin-graphql/unstable/objects/InventoryTransferEdge#field-InventoryTransferEdge.fields.node) ### Possible type in * [Comment​Event​Embed](https://shopify.dev/docs/api/admin-graphql/unstable/unions/CommentEventEmbed) *** ## Queries * [inventory​Transfer](https://shopify.dev/docs/api/admin-graphql/unstable/queries/inventoryTransfer) query Returns an inventory transfer by ID. * [inventory​Transfers](https://shopify.dev/docs/api/admin-graphql/unstable/queries/inventoryTransfers) query Returns a paginated list of transfers. *** ## \InventoryTransfer Queries ### Queried by * \[inventory​Transfer](https://shopify.dev/docs/api/admin-graphql/unstable/queries/inventoryTransfer) * \[inventory​Transfers](https://shopify.dev/docs/api/admin-graphql/unstable/queries/inventoryTransfers) *** ## Mutations * [inventory​Transfer​Cancel](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCancel) mutation Cancels an inventory transfer. * [inventory​Transfer​Create](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCreate) mutation Creates an inventory transfer. * [inventory​Transfer​Create​As​Ready​To​Ship](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCreateAsReadyToShip) mutation Creates an inventory transfer in ready to ship. * [inventory​Transfer​Duplicate](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferDuplicate) 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. * [inventory​Transfer​Edit](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferEdit) mutation Edits an inventory transfer. * [inventory​Transfer​Mark​As​Ready​To​Ship](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferMarkAsReadyToShip) mutation Sets an inventory transfer to ready to ship. * [inventory​Transfer​Remove​Items](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferRemoveItems) 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. * [inventory​Transfer​Set​Items](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferSetItems) mutation This mutation allows for the setting of line items on a Transfer. Will replace the items already set, if any. *** ## <\~> InventoryTransfer Mutations ### Mutated by * <\~>[inventory​Transfer​Cancel](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCancel) * <\~>[inventory​Transfer​Create](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCreate) * <\~>[inventory​Transfer​Create​As​Ready​To​Ship](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferCreateAsReadyToShip) * <\~>[inventory​Transfer​Duplicate](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferDuplicate) * <\~>[inventory​Transfer​Edit](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferEdit) * <\~>[inventory​Transfer​Mark​As​Ready​To​Ship](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferMarkAsReadyToShip) * <\~>[inventory​Transfer​Remove​Items](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferRemoveItems) * <\~>[inventory​Transfer​Set​Items](https://shopify.dev/docs/api/admin-graphql/unstable/mutations/inventoryTransferSetItems) *** ## Interfaces * * [Comment​Event​Subject](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/CommentEventSubject) interface * [Has​Events](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasEvents) interface * [Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasMetafieldDefinitions) interface * [Has​Metafields](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasMetafields) interface * [Node](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/Node) interface *** ## ||-InventoryTransfer Implements ### Implements * ||-[Comment​Event​Subject](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/CommentEventSubject) * ||-[Has​Events](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasEvents) * ||-[Has​Metafield​Definitions](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasMetafieldDefinitions) * ||-[Has​Metafields](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/HasMetafields) * ||-[Node](https://shopify.dev/docs/api/admin-graphql/unstable/interfaces/Node)