Skip to main content

supplySendShipmentToWms

Sends one or more shipments to their respective downstream WMS (Warehouse Management System) integration for processing.

Authentication Requirements​

Requires the supply:send_to_wms permission for the brand.

Business Rules​

  • At least one shipment ID must be provided
  • Maximum of 50 shipments can be processed per request
  • Each shipment must exist and belong to the authenticated brand
  • Shipments cannot be in 'closed' or 'canceled' status
  • Each shipment must have at least one item
  • Each shipment must have a destination warehouse assigned
  • The destination warehouse must have a fulfillment integration configured

Behavior​

This mutation initiates an asynchronous process to send the specified shipments to their respective WMS integrations. A process ID is returned that can be used to track the status of the operation. If some shipments fail validation or cannot be sent, the process will complete with a partial failure status indicating which shipments failed.

Possible Errors​

  • **GraphQL::ExecutionError**: "At least one shipment ID must be provided" - Empty shipment IDs array
  • **GraphQL::ExecutionError**: Authentication error - Missing or insufficient permissions
supplySendShipmentToWms(
  input: SupplySendShipmentToWmsInput!
): AsynchronousActionResponse!

Arguments​

supplySendShipmentToWms.input ● SupplySendShipmentToWmsInput! non-null input​

Parameters for SupplySendShipmentToWms

Type​

AsynchronousActionResponse object​

Asynchronous action response type