# Order cancellation reasons

Maintain the names that staff can use when an order is assigned the cancelled-order
state.

## Order cancellation reasons

An order cancellation reason is a name available when an order is assigned
`JobStatusE.Cancelled_Order`. Maintain those names for order cancellations; operational
order-cancellation work takes place in the sales workflow.

For example, `Customer withdrew order` can describe why an order was cancelled when
that wording matches your process.

| If you need to… | Go to |
|---|---|
| Check access and prepare a reason name | [Before you start](#before-you-start) |
| Open the maintained list | [Find the order cancellation reasons list](#find-the-order-cancellation-reasons-list) |
| Recognize the list and entry form | [Understand the list and entry form](#understand-the-list-and-entry-form) |
| Add a reason | Maintain a reason |
| Understand subscription and permission differences | [Handle access and list variations](#handle-access-and-list-variations) |
| Correct a validation or maintenance message | [When maintenance does not succeed](#when-maintenance-does-not-succeed) |
| Continue to operational order work | [Use the maintained reasons in the sales workflow](#use-the-maintained-reasons-in-the-sales-workflow) |
| Maintain general sales cancellation reasons | [Cancellation reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-cancellation-reasons) |
| Work with orders | [Orders](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/orders) |
| Follow the order-to-outcome hand-off | [From orders to delivered](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/from-orders-to-delivered) |

## Before you start

Prepare the reason name before opening the entry form. Confirm that your account exposes
the actions you need.

| Before you start | What to confirm | Why it matters |
|---|---|---|
| Subscription | The subscription includes the order-cancellation-reason feature | The list is available when the feature is included. |
| Edit access | Your account is allowed to edit | The row edit action depends on edit access. |
| Delete access | Your account is allowed to delete | The row delete action depends on delete access. |
| Entry information | The reason name you want to maintain | **Name** is the required entry field. |

## Find the order cancellation reasons list

Open the list to review or maintain the names used with cancelled orders.

Prerequisites

- You are signed in.
- The subscription includes the order-cancellation-reason feature.

Steps

1. Open **Configuration**.
2. Open **Sales**.
3. Select **Order Cancellation Reasons**.
4. Select **New** to open the new-item form.

The list opens with **New**. The new-item form contains **Name**; selecting **Cancel**
leaves the existing data unchanged.

![Open the list from Configuration > Sales and locate New](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/02861d9529fd9dcaf5e197860674aa8b.png)

**Result:** The order cancellation reasons list or the new-item form is open.

## Understand the list and entry form

The list displays one visible column, **Name**. The entry form maintains that reason
name.

| Surface | What you see |
|---|---|
| List column | **Name** |
| List size | The list shows four rows and `Count: 4`. |
| New-entry dialog | The dialog title is `New Order Cancellation Reason`. |
| Entry field | **Name** is required. |
| Entry control | **OK** is shown in the new-entry dialog. |
| Grid headers | Column headers are hidden for this entity. |

The visible field set is the set configured for the list when you open it. Only **Name**
appears as a visible field. It has no select box, date box, percentage box,
amount box, or array field.

The configured list determines which columns and fields appear. Work from the columns
and fields visible on your screen.

> **Note:** The list shows four rows with `Count: 4` when four reasons are maintained.

![Recognize the New Order Cancellation Reason dialog and its required Name field](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/f6c26962233165f8008d4a79a73031f8.png)

## Add, change, and remove a reason

Use **New** to add a reason. The actions available for existing reasons depend on the
subscription and access conditions in [Before you start](#before-you-start).

Add a reason when staff need another explanation for a cancelled order.

Prerequisites

- The order cancellation reasons list is open.
- **New** is visible.
- You have the reason name to enter.

Steps

1. Select **New**.

   The `New Order Cancellation Reason` dialog opens.

2. Enter the reason in **Name**.

3. Select **Save**.

   The form validates the entry, saves it after validation succeeds, and closes after a
   successful response. The success message is `Data saved Successfully`.

**Result:** The new reason is saved and the entry form closes after success.

If you need a different outcome, use this choice:

| If you need to… | Select |
|---|---|
| Leave the new or edit form without saving | **Cancel** |

The shared popup closes without saving the entry.

**Result:** The new reason is saved, or the form closes without saving when you select
**Cancel**.

## Handle access and list variations

The subscription, permissions, and list configuration determine which maintenance
surfaces you see.

| What changes | What you see or do |
|---|---|
| Subscription feature is included | The list is shown. **New** is shown when the action is not hidden. |
| Subscription feature is not included | A subscription-upgrade surface is shown instead of the list. |
| Edit access is allowed | Row editing is available. |
| Delete access is allowed | Row deletion is available. |
| Runtime list configuration differs | The visible columns and fields follow your configured list. |
| **Cancel** is selected | The entry form closes and the order cancellation reasons list is available again. |

If **New** is absent, check that the subscription includes the feature and that the
action is available to your account.

![Confirm the list surface after cancelling the new-entry form](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/7908c98f08e107b18cb6966ae064403a.png)

## When maintenance does not succeed

Use the message you see to correct the entry or keep a protected reason in the list.

| Message | Corrective action |
|---|---|
| `Name is required` | Enter a value in **Name** before selecting **Save**. |
| `Just '_' '-' And '.' Characters Accepted` | Correct the **Name** value to meet the accepted-character rule, then select **Save**. |
| `Data updated Successfully` | The edited reason was saved successfully. |
| `Data Deleted Successfully` | The selected reason was deleted successfully. |
| `Forbidden characters detected. Please remove them and try again.` | Remove the forbidden characters from **Name**, then select **Save** again. |
| `Related to Saved data, Can't be deleted` | Keep the reason because saved data is related to it. |
| `Must have at least one item` | Keep at least one reason in the list. |

## Use the maintained reasons in the sales workflow

Maintained order-cancellation reason names are available for the `Cancelled_Order`
order state. Maintaining this list does not itself perform an operational order
cancellation or change a business stage.

When an order is cancelled because the customer withdrew it, a reason such as
`Customer withdrew order` gives staff a direct explanation to select if that name is in
the maintained list.

Continue with [Orders](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/orders) for operational order work. For the hand-off from
orders to later outcomes, go to [From orders to delivered](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/from-orders-to-delivered).
