Inventory
Requires access scope.
Represents the intention to move inventory between locations.
Anchor to Fields and connectionsFields and connections
- Anchor to dateCreateddate•Date
Created Time The date and time the inventory transfer was created in UTC format.
- Anchor to destinationdestination•Location
Snapshot! non-null 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 hasTimelineCommenthas•Boolean!
Timeline Comment non-null Whether the merchant has added timeline comments to the inventory transfer.
- •ID!non-null
A globally-unique ID.
- Anchor to lineItemsline•Inventory
Items Transfer Line Item Connection! non-null The line items associated with the inventory transfer.
- Anchor to lineItemsCountline•Count
Items Count The number of line items associated with the inventory transfer. Limited to a maximum of 10000 by default.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers 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•Location
Snapshot! non-null 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 receivedQuantityreceived•Int!
Quantity non-null The total quantity of items received in the transfer.
- Anchor to referenceNamereference•String
Name The reference name of the inventory transfer.
- Anchor to shipmentsshipments•Inventory
Shipment Connection! non-null The shipments associated with the inventory transfer.
- Anchor to statusstatus•Inventory
Transfer Status! non-null The current status of the transfer.
- •[String!]!non-null
A list of tags that have been added to the inventory transfer.
- Anchor to totalQuantitytotal•Int!
Quantity non-null The total quantity of items being transferred.
Deprecated fields and connections
- Anchor to lineItemCountline•Int!
Item Count non-nullDeprecated - Anchor to metafieldDefinitionsmetafield•Metafield
Definitions Definition Connection! non-nullDeprecated
Anchor to QueriesQueries
- •query
Returns an inventory transfer by ID.
- •query
Returns a paginated list of transfers.
Anchor to MutationsMutations
- •mutation
Cancels an inventory transfer.
- •ID
The ID of the inventory transfer to cancel.
- Anchor to transferIdtransfer•ID
Id Deprecated
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The cancelled inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Cancel User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates an inventory transfer.
- Anchor to inputinput•Inventory
Transfer Create Input! required The input fields for the inventory transfer.
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The created inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Create User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates an inventory transfer in ready to ship.
- Anchor to inputinput•Inventory
Transfer Create Input! required The input fields for the inventory transfer.
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The created inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Create As Ready To Ship User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- •ID
The ID of the inventory transfer to duplicate.
- Anchor to transferIdtransfer•ID
Id Deprecated
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The duplicated inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Duplicate User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Edits an inventory transfer.
- •ID!required
The ID of the inventory Transfer to be edited.
- Anchor to inputinput•Inventory
Transfer Edit Input! required The input fields to edit the inventory transfer.
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The edited inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Edit User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •ID!
- •mutation
Sets an inventory transfer to ready to ship.
- •ID
The ID of the inventory transfer to mark as ready to ship.
- Anchor to transferIdtransfer•ID
Id Deprecated
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The ready to ship inventory transfer.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Mark As Ready To Ship User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •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.
- Anchor to inputinput•Inventory
Transfer Remove Items Input! required The input fields for the InventoryTransferRemoveItems mutation.
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The transfer with line items removed.
- Anchor to removedQuantitiesremoved•[Inventory
Quantities Transfer Line Item Update!] The line items that have had their shippable quantity removed.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Remove Items User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
This mutation allows for the setting of line items on a Transfer. Will replace the items already set, if any.
- Anchor to inputinput•Inventory
Transfer Set Items Input! required The input fields for the InventoryTransferSetItems mutation.
Arguments
- Anchor to inventoryTransferinventory•Inventory
Transfer Transfer The Transfer with its line items updated.
- Anchor to updatedLineItemsupdated•[Inventory
Line Items Transfer Line Item Update!] The updated line items.
- Anchor to userErrorsuser•[Inventory
Errors Transfer Set Items User Error!]! non-null The list of errors that occurred from executing the mutation.
Fields