InventoryTransfer

object

Requires read_inventory_transfers access scope.

Represents the intention to move inventory between locations.

Anchor to Fields and connectionsFields and connections

Anchor to dateCreateddateCreated • DateTime: The date and time the inventory transfer was created in UTC format.
Anchor to destinationdestination • InventoryTransferLocation!non-null: The destination location for the transfer.
Anchor to eventsevents • EventConnection!non-null: The list of events associated with the inventory transfer.
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 lineItemCountlineItemCount • Int!non-null: The number of line items associated with the inventory transfer.
Anchor to lineItemslineItems • InventoryTransferLineItemConnection!non-null: The line items associated with the inventory transfer.
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.
Anchor to metafieldsmetafields • MetafieldConnection!non-null: A list of custom fields that a merchant associates with a Shopify resource.
Anchor to metafieldsByIdentifiersmetafieldsByIdentifiers • [Metafield]!non-null: The metafields associated with the resource matching the supplied list of namespaces and keys.
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 • InventoryTransferLocation!non-null: The origin location for the transfer.
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.
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: List of metafield definitions. This field will be removed in a future version. Use the root metafieldDefinitions field instead.

Was this section helpful?

Anchor to QueriesQueries

Anchor to inventoryTransfer inventoryTransfer • query: Returns an inventory transfer by ID.
Anchor to inventoryTransfers inventoryTransfers • query: Returns a paginated list of transfers.

Was this section helpful?

Anchor to MutationsMutations

Anchor to inventoryTransferCancel inventoryTransferCancel • mutation: Cancels an inventory transfer.
Anchor to inventoryTransferCreate inventoryTransferCreate • mutation: Creates an inventory transfer.
Anchor to inventoryTransferCreateAsReadyToShip inventoryTransferCreateAsReadyToShip • mutation: Creates an inventory transfer in ready to ship.
Anchor to inventoryTransferDuplicate 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.
Anchor to inventoryTransferEdit inventoryTransferEdit • mutation: Edits an inventory transfer.
Anchor to inventoryTransferMarkAsReadyToShip inventoryTransferMarkAsReadyToShip • mutation: Sets an inventory transfer to ready to ship.
Anchor to inventoryTransferRemoveItems inventoryTransferRemoveItems • mutation: This mutation allows removing line items of a Transfer. It removes all quantities of the item from the transfer that are not associated with shipments.
Anchor to inventoryTransferSetItems inventoryTransferSetItems • mutation: This mutation allows for the setting of line items on a Transfer. Will replace the items already set, if any. Note, this mutation cannot be called after the transfer has been marked In Progress.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to CommentEventSubject CommentEventSubject • interface
Anchor to HasEvents HasEvents • interface
Anchor to HasMetafieldDefinitions HasMetafieldDefinitions • interface
Anchor to HasMetafields HasMetafields • interface
Anchor to Node Node • interface

Was this section helpful?