Skip to main content

WarehouseTransfer

A movement of the company’s own inventory from one of its buildings to another.

Allocating holds the units at the origin. Shipping takes them out of the origin’s stock and counts them as incoming at the destination. Receiving adds them to the destination’s stock. Marking the transfer Received writes off the units not received: they stop counting as incoming.

type WarehouseTransfer {
  actualArrivalDate: ISO8601DateTime
  actualReceivedDate: ISO8601DateTime
  actualShipDate: ISO8601DateTime
  attachmentCount: Int!
  attachments: [File!]
  bolNumber: String
  canBeSentToWms: Boolean!
  carrierName: String
  containerNumber: String
  containerSize: SupplyContainerSizeEnum
  costs: WarehouseTransferCosts
  createdAt: ISO8601DateTime!
  destinationBuilding: Warehouse!
  destinationLocation: Location
  expectedArrivalDate: ISO8601DateTime
  expectedShipDate: ISO8601DateTime
  externalDocuments: [SupplyShipmentExternalDocument!]!
  externalId: String
  forwarderName: String
  id: ID!
  incoterms: SupplyIncotermsEnum
  items: [WarehouseTransferItem!]!
  originBuilding: Warehouse!
  refNumber: String
  stats: WarehouseTransferStats!
  status: WarehouseTransferStatusEnum!
  trackingNumber: String
  transferNumber: String!
  transportMode: SupplyTransportModeEnum
  updatedAt: ISO8601DateTime!
  vesselName: String
  wmsIntegration: Integration
  wmsSendIntegrations: [Integration!]!
  wmsUrl: Url
}

Fields

`WarehouseTransfer.actualArrivalDate` ● `ISO8601DateTime` scalar common

When the units arrived. Recorded when the transfer is delivered.

`WarehouseTransfer.actualReceivedDate` ● `ISO8601DateTime` scalar common

When receiving finished. Recorded when the transfer is received.

`WarehouseTransfer.actualShipDate` ● `ISO8601DateTime` scalar common

When the units left the origin. Recorded when the transfer ships.

`WarehouseTransfer.attachmentCount` ● `Int!` non-null scalar common

How many documents are attached to this transfer.

`WarehouseTransfer.attachments` ● `[File!]` list object common

The documents attached to this transfer. S3 links expire after 24 hours; query the documents again for fresh links.

`WarehouseTransfer.bolNumber` ● `String` scalar common

The bill of lading number.

`WarehouseTransfer.canBeSentToWms` ● `Boolean!` non-null scalar common

Whether the transfer can be sent now: it is Allocated, In Transit, or Delivered, and a warehouse system linked to the destination can receive it.

`WarehouseTransfer.carrierName` ● `String` scalar common

The carrier moving the units.

`WarehouseTransfer.containerNumber` ● `String` scalar common

The container number.

`WarehouseTransfer.containerSize` ● `SupplyContainerSizeEnum` enum common

The container size.

`WarehouseTransfer.costs` ● `WarehouseTransferCosts` object inventory

Costs recorded on the transfer; requires warehouse:read_transfer_costs.

`WarehouseTransfer.createdAt` ● `ISO8601DateTime!` non-null scalar common

When the transfer was created.

`WarehouseTransfer.destinationBuilding` ● `Warehouse!` non-null object warehouses

The building the units go to.

`WarehouseTransfer.destinationLocation` ● `Location` object warehouses

The location in the destination building received units are added to. Null until chosen or until the first receipt records it.

`WarehouseTransfer.expectedArrivalDate` ● `ISO8601DateTime` scalar common

When the units are expected at the destination.

`WarehouseTransfer.expectedShipDate` ● `ISO8601DateTime` scalar common

When the units are expected to leave the origin.

`WarehouseTransfer.externalDocuments` ● `[SupplyShipmentExternalDocument!]!` non-null object shipments

The documents this transfer became in other systems, with links to open them.

`WarehouseTransfer.externalId` ● `String` scalar common

The order id in the destination’s warehouse system. Present once the transfer was sent there.

`WarehouseTransfer.forwarderName` ● `String` scalar common

The freight forwarder.

`WarehouseTransfer.id` ● `ID!` non-null scalar common

Unique identifier of the transfer.

`WarehouseTransfer.incoterms` ● `SupplyIncotermsEnum` enum common

The Incoterms code.

`WarehouseTransfer.items` ● `[WarehouseTransferItem!]!` non-null object inventory

The products moved, one line per product.

`WarehouseTransfer.originBuilding` ● `Warehouse!` non-null object warehouses

The building the units leave.

`WarehouseTransfer.refNumber` ● `String` scalar common

A reference number for the transfer.

`WarehouseTransfer.stats` ● `WarehouseTransferStats!` non-null object inventory

Unit, line, carton, pallet, weight, and volume totals.

`WarehouseTransfer.status` ● `WarehouseTransferStatusEnum!` non-null enum inventory

Current transfer status.

`WarehouseTransfer.trackingNumber` ● `String` scalar common

The carrier’s tracking number.

`WarehouseTransfer.transferNumber` ● `String!` non-null scalar common

The transfer’s number, unique in the company.

`WarehouseTransfer.transportMode` ● `SupplyTransportModeEnum` enum common

How the units travel.

`WarehouseTransfer.updatedAt` ● `ISO8601DateTime!` non-null scalar common

When the transfer last changed.

`WarehouseTransfer.vesselName` ● `String` scalar common

The vessel, when moved by sea.

`WarehouseTransfer.wmsIntegration` ● `Integration` object integrations

The integration holding the order the transfer was sent as. Null until sent.

`WarehouseTransfer.wmsSendIntegrations` ● `[Integration!]!` non-null object integrations

Integrations linked to the destination building that the transfer can be sent to.

`WarehouseTransfer.wmsUrl` ● `Url` scalar common

Link to the order in the destination’s warehouse system. Null until sent.

Returned By

warehouseTransfer query ● warehouseTransfersAdvance mutation ● warehouseTransfersCancel mutation ● warehouseTransfersCreate mutation ● warehouseTransfersMarkReceived mutation ● warehouseTransfersRecordReceipts mutation ● warehouseTransfersStartReceiving mutation ● warehouseTransfersStepBack mutation ● warehouseTransfersUpdate mutation

Member Of

WarehouseTransferConnection object ● WarehouseTransferEdge object

Fields
Returned By
Member Of