Skip to main content

supplyShipmentWmsReceivingOptions

Returns the receiving details to ask for before sending a shipment to its warehouse integration, with defaults derived from the shipment.

Business Rules​

  • supported is false when the destination warehouse has no integration, or its integration does not ask for receiving details. The send action needs no dialog in that case.

Error Scenarios​

  • **GraphQL::ExecutionError**: "SupplyShipment not found"

Permissions Required​

  • supply:read_shipments
supplyShipmentWmsReceivingOptions(
  integrationId: ID
  receivingOptions: WmsReceivingOptionsInput
  shipmentId: ID!
): WmsReceivingOptions!

Arguments​

supplyShipmentWmsReceivingOptions.integrationId ● ID scalar common​

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

supplyShipmentWmsReceivingOptions.receivingOptions ● WmsReceivingOptionsInput input common​

Receiving choices to preview before sending.

supplyShipmentWmsReceivingOptions.shipmentId ● ID! non-null scalar common​

The shipment 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.