Skip to main content

warehouseTransferWmsReceivingPlan

Returns the packages and warnings a transfer would be sent with for the chosen receiving details, so they can be reviewed before sending.

Business Rules​

  • Reads the transfer in the active company (X-Company-Id) only
  • Null when the destination’s integration does not ask for receiving details
  • Quantities are whole amounts in each line’s unit of measure; a line with a decimal amount is refused. Transfers do not send lot numbers

Error Scenarios​

  • **GraphQL::ExecutionError**: “Transfer not found.”

Permissions Required​

  • warehouse:read_transfers
warehouseTransferWmsReceivingPlan(
  integrationId: ID
  receivingOptions: WmsReceivingOptionsInput!
  transferId: ID!
): WmsReceivingPlan

Arguments​

warehouseTransferWmsReceivingPlan.integrationId ● ID scalar common​

The integration the transfer will be sent to, when more than one can receive it. Ignored once the transfer is linked to an order, which uses that order’s integration.

warehouseTransferWmsReceivingPlan.receivingOptions ● WmsReceivingOptionsInput! non-null input common​

The receiving choices to preview.

warehouseTransferWmsReceivingPlan.transferId ● ID! non-null scalar common​

The transfer that will be sent.

Type​

WmsReceivingPlan object common​

Receiving contents calculated from shipment totals and product packaging.