Set up order cancellation

  • Updated

Optimizely Configured Commerce lets users cancel orders through the Admin Console or website and send that information to the ERP through an integration job. If an order is canceled without a Cancel Order integration job, Configured Commerce shows that the order was canceled. However, you must build the integration job to send the order cancellation to the ERP.

Follow these steps to configure the option to cancel orders:

  1. Create the correct order statuses with the Order Status Mapping tool.
  2. Identify which statuses allow order cancellation.
  3. Create the integration job.

Create and map the order statuses

  1. Go to Admin Console > Administration > Order Status Mapping.
  2. Create the mapping and select the option to Allow Cancellation. See Order Status Mapping for more details.

    AllowCancellation.png

  3. Click Save.

Identify the cancellable order statuses

  1. Go to Admin Console > Administration > Settings.
  2. Search for Cancellable Order Statuses.

    CancellableOrderStatuses.png

  3. Enter the cancellable order statuses you mapped on Order Status Mapping. Click Add (+) to add additional statuses.
  4. Click Save.

Create the cancel order integration job

You must create a custom-coded integration processor to call the API to update the ERP. The integration processor is then referenced in the integration job.

Follow these steps to set up the integration job:

  1. Go to Admin Console > Administration > Job Definitions.
  2. Click Add Job Definition.
  3. Populate the following fields in Details:

    OrderCancel.png

    • Job Name – OrderCancel
    • Job Type – Execution
    • Connection – ERP Connection
    • Preprocessor – None
    • Integration Processor – None
    • Post Processor – None
    • Standard Job Name – Order Cancel
  4. Click Save.
  5. Go to Steps and click + Job Definition Step to create a new job step.
  6. Populate the following fields:
    • Sequence – 1
    • Step Name – Order Cancel Step
  7. Click Save.
  8. Go to Parameters and click + Job Definition Step Parameter.
  9. Populate the following fields:
    • Name – ERP Order Number or Web Order Number. This depends on if you want to use the ERP order number or the Configured Commerce web order number.
    • Value Type – String
    • Default Value – Leave blank
    • Prompt – ERP Order Number, Web Order Number, or leave blank

    Repeat these steps if you need to populate both the ERP order number and web order number.

  10. Click Save.