Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunityDoc feedbackLog In

Set order cancellation

This topic describes how to cancel an order in Optimizely Configured Commerce.

Optimizely Configured Commerce allows users to cancel orders in the Admin Console or website. Enabling this option requires some initial setup:

  • Change two three settings to expose the cancel options.
  • Build the cancel order integration job.

📘

IMPORTANT

If an order is canceled without a Cancel Order integration job, Configured Commerce will show that the order has been canceled. However, this cancellation has only occurred on the Configured Commerce side, and without the integration job, it will not have been communicated to the ERP. To correctly send the order cancellation to the ERP, the Order Cancel integration job must be built.

Cancel order settings

The following steps must be completed to display the option to cancel an order:

Setting up the option to cancel orders is a two step process:

  1. Create the correct order statuses via the Order Status Mapping tool (See the Order Status Mapping article for more details).
  2. Identify which statuses allow for order cancellation.

Create and map the order statuses

  1. Go to Admin Console > Administration > System > Order Status Mapping.

  2. Create the mapping and select the option to Allow Cancellation (See the Order Status Mapping article for more details).

  3. Click Save.

Identify the cancellable order statuses

  1. Go to Admin Console > Administration > System > Settings.

  2. Search for Cancellable Order Statuses.

  3. Enter the cancellable order statuses listed within the Order Status Mapping screen that will allow an order to be canceled. As necessary. use the Plus sign to add additional statuses.

  4. Click Save.

Create the integration processor

A custom coded integration processor needs to be created first, which calls the API to update the ERP. The integration processor is then referenced as a part of the integration job, which is described below.

Create the cancel order integration job

  1. Go to Admin Console > Administration > Jobs > Job Definitions.

  2. In the Primary toolbar, click Add New Job Definition.

  3. In the Details finger tab, populate the following fields:

    Field NameValueNotes
    Job NameOrderCancelThis is the recommended name.
    Job TypeExecution 
    ConnectionERP ConnectionTypically done through the API connection, if any
    PreprocessorNone 
    Integration Processor This is custom per the customer ERP
    Post ProcessorNone 
  4. Click Save.

  5. Next, click the Parameters finger tab and click Add Job Definition Parameter.

  6. Populate the following fields:

    Field NameValueNote
    NameOrderNumber 
    Value TypeString 
    Default Value Leave blank
    PromptOrder NumberThis can be left blank
  7. Click the Save .