Skip to main content

warehouseTransfersCancel

Cancels a transfer and returns it. Canceling cannot be undone.

Business Rules​

  • Allowed from Draft, Allocated, In Transit, Delivered, and In Receiving
  • Refused while any line has received units; lower them to zero first
  • Retrying a canceled transfer finishes any remaining release and inventory refresh
  • A held transfer releases its hold. A shipped transfer puts its units back in the origin locations they left, then releases them. The units stop counting as incoming
  • Allowed when the destination’s counts come from an integration. The integration is not asked what it received, so units it already counted at the destination can also count at the origin
  • In the background, also cancels the transfer’s order in the destination’s warehouse system and its confirmed delivery appointments. The transfer stays canceled when either refuses, and its activity log records what was not canceled

Error Scenarios​

  • “Transfers are not enabled for this company”
  • “Transfer not found.”
  • “A transfer cannot move from Received to Canceled.”

Permissions Required​

  • warehouse:cancel_transfer
warehouseTransfersCancel(
  input: WarehouseTransfersCancelInput!
): WarehouseTransfer!

Arguments​

warehouseTransfersCancel.input ● WarehouseTransfersCancelInput! non-null input common​

Parameters for WarehouseTransfersCancel

Type​

WarehouseTransfer object inventory​

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.