Skip to main content

supplyCancelShipments

Cancels multiple supply shipments.

Authentication​

Requires authentication and the supply:cancel_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 transitioned to the canceled status.
  • If a shipment fails to cancel (e.g., validation error or invalid status), it will be logged, but the operation continues processing remaining shipments.
  • The mutation processes shipments in batches of 100.
  • Canceled shipments can be restored using the uncancelSupplyShipments mutation.

Validation Rules​

  • At least one shipment ID must be provided.
  • Each shipment must exist and belong to the authenticated user's brand.
  • Shipments must be in a cancelable status according to the shipment status rules.

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 cannot be canceled from current status - The shipment is in a status that does not allow cancellation.
supplyCancelShipments(
  input: CancelSupplyShipmentsInput!
): AsynchronousActionResponse!

Arguments​

supplyCancelShipments.input ● CancelSupplyShipmentsInput! non-null input common​

Parameters for CancelSupplyShipments

Type​

AsynchronousActionResponse object common​

Asynchronous action response type