Skip to main content

warehouseTransferWmsReceivingOptions

Returns the receiving details to ask for before sending a transfer to its destination’s warehouse integration, with defaults derived from the transfer.

Business Rules​

  • Reads the transfer in the active company (X-Company-Id) only
  • supported is false when the destination building has no integration that receives transfers, or its integration does not ask for receiving details. The send action does not need a dialog in that case
  • existingOrder is the order the warehouse system holds from an earlier send, checked live

Error Scenarios​

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

Permissions Required​

  • warehouse:read_transfers
warehouseTransferWmsReceivingOptions(
  integrationId: ID
  transferId: ID!
): WmsReceivingOptions!

Arguments​

warehouseTransferWmsReceivingOptions.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.

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

The transfer that will be sent.

Type​

WmsReceivingOptions object common​

The receiving details to ask for when sending a shipment to its warehouse integration, with prefilled defaults.