Skip to main content

supplyUncancelShipments

Restores previously canceled supply shipments to their previous status.

Authentication​

Requires authentication and the supply:uncancel_shipment permission.

Behavior​

  • This mutation processes shipments asynchronously. It returns immediately with a processId that can be used to track the operation's progress.
  • Each shipment is restored to the status it had before being canceled.
  • If a shipment fails to uncancel (e.g., not in canceled status, or previous status cannot be determined), it will be logged, but the operation continues processing remaining shipments.
  • The mutation processes shipments in batches of 100.

Validation Rules​

  • At least one shipment ID must be provided.
  • Each shipment must exist and belong to the authenticated user's brand.
  • Shipments must currently be in canceled status.
  • The system must be able to determine the previous status before cancellation.

Possible Errors​

  • No shipment IDs provided - The shipment ID list is empty.
  • Shipment not found - One or more shipments do not exist or do not belong to the brand.
  • Shipment must be in canceled status - The shipment is not currently canceled.
  • Cannot determine previous status - The system cannot find the status the shipment had before being canceled.
supplyUncancelShipments(
  input: UncancelSupplyShipmentsInput!
): AsynchronousActionResponse!

Arguments​

supplyUncancelShipments.input ● UncancelSupplyShipmentsInput! non-null input common​

Parameters for UncancelSupplyShipments

Type​

AsynchronousActionResponse object common​

Asynchronous action response type