Setting up order cancellation

InsiteCommerce allows users to cancel orders via 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.

Cancel order settings

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

Update the application setting

1. Go to Admin Console > Administration > System > Application Settings.
2. Using the Name filter, search for OrderCancelStatuses.
3. Enter the value of Submitted into the Value field.

Update the website settings

1. Go to Admin Console > Websites.
2. Find the desired website and click Edit.
3. Click the Settings finger tab.
4. To enable the Cancel option, search for the Website Setting AllowCancellationRequest, click Edit and enter True in the Value field.

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

As is standard with most submission based integration workflows, an 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 Name	Value	Notes
   Job Name	OrderCancel	This is the recommended name.
   Job Type	Execution
   Connection	ERP Connection	Typically done through the API connection, if any
   Preprocessor	None
   Integration Processor		This is custom per the customer ERP
   Post Processor	None

4. Click Save.
5. Next, click the Parameters finger tab and click Add Job Definition Parameter.
6. Populate the following fields:

   Field Name	Value	Note
   Name	OrderNumber
   Value Type	String
   Default Value		Leave blank
   Prompt	Order Number	This can be left blank

7. Click the Save .

Related topics

• Working with Order History
• Canceling an Order