Skip to main content

supplyStepBackShipments

Moves multiple shipments backwards in their lifecycle by reverting each to its previous status.

Asynchronous Processing​

This mutation processes shipments asynchronously. The response includes a processId that can be used to track the operation's progress through the process status tracking system.

Authentication & Permissions​

Requires authentication and the supply:change_shipment_status permission for the current company.

Business Rules​

Each shipment will be moved to its previous status according to the shipment lifecycle. For example, a shipment in IN_TRANSIT status will move back to PENDING.

Validation & Errors​

  • Cannot step back shipments that are in their initial state (PENDING)
  • Cannot step back shipments with CANCELED status
  • Shipments that fail validation will be logged individually, and the process will continue for remaining shipments
  • If any shipment fails, the process status will reflect the failure with details about which shipments could not be processed
supplyStepBackShipments(
  input: StepBackShipmentsInput!
): AsynchronousActionResponse!

Arguments​

supplyStepBackShipments.input ● StepBackShipmentsInput! non-null input​

Parameters for StepBackShipments

Type​

AsynchronousActionResponse object​

Asynchronous action response type