Cancel Return

Cancel the return and reset all associated financial values.

Overview

The Cancel Return step cancels a return request and resets all financial calculations. This is used when a return needs to be voided, such as when items are not actually returned or the return was created in error.

Identifier

PropertyValue
KeyCancelReturn
GroupStatus

Configuration Properties

This step has no configurable properties. It performs a complete cancellation reset.

Behavior

What It Does

  1. Marks the return as cancelled
  2. Resets all refund/credit amounts to zero
  3. Removes any pending payment transactions
  4. Clears return charges
  5. Records cancellation in return history

Prerequisites

  • Return must be in a cancellable state
  • Any processed refunds should be handled separately

Side Effects

  • Return marked as cancelled
  • Financial totals reset to zero
  • Return excluded from reporting
  • Original order status may need updating

This step does not reverse already-processed refunds. If payments have been credited, those transactions remain. Handle payment reversals separately before cancelling.

Business Cases

When to Use

  • Customer decides not to return items
  • Return created in error
  • Items never received by warehouse
  • Duplicate return entries

Example Scenarios

Customer Changed Mind Customer requested return but decided to keep items. Return cancelled before processing.

Items Not Received Return created with shipping label, but items never arrived after timeout period. Return cancelled.

Duplicate Entry Same items accidentally entered on two returns. Duplicate cancelled.

Sample Configuration

{
  "Name": "CancelReturn",
  "Active": true,
  "IsInvisible": true,
  "TranslateKey": "WorkflowStep_CancelReturn"
}

Note: IsInvisible: true is commonly used to hide this step from the workflow log since cancellation is self-evident.

Error Handling

ConditionResultContinues Workflow?
Return cancelledSuccessYes
Return already cancelledSuccess (no action)Yes
Return has processed paymentsWarningYes
Cancellation failedErrorDepends on StopOnError

On this page