Document Properties
Kbid
29M909
Last Modified
22-Jun-2021
Added to KB
22-Jun-2021
Public Access
Everyone
Status
Online
Doc Type
Guidelines, Concepts & Cookbooks
Product
IOM 3.5

Concept - IOM Order Change

Product Version

3.5

Product To Version


Status

final


1 Introduction

Intershop Order Management (IOM) has the ability to change orders in certain statuses by creating change requests that can be applied to an order. This document describes the general process, status model and limitations of IOM's order changes.

The target audience of this concept are consultants.

1.1 References

2 Business Process

Order change requests pass through a defined business process. 

The business process flow is as follows:

  1. An order change request for an existing order is created. This can only be done by using the REST API, see Reference - IOM REST API - Order 2.2 and later.
  2. Once the change request successfully passed validations and security checks, it will be stored with the status OPEN and any other processing of the order will be stopped. This happens synchronously within the REST call.

    Info

    The following steps are performed asynchronously, i.e. they will be triggered by a message/ consuming a message, which must not be synchronous:
  3. Approvals will be checked. Because this is currently a placeholder for future implementations, the status of the change request will be set to ACCEPTED; always.
  4. The change request will be applied to the order. If successfully the status of the change request will be set to APPLIED and the order continues processing if no further open change requests exist.
    Otherwise all open change request must reach an end-state too before the order continues processing.
    If not successfully the status of the change request will be set to FAILED_TO_APPLY. For failed change requests there is currently no option to retry. The order continues processing if no open change requests exist.

Concept - IOM Order Change - BP #1

3 Order Change Request Status Model

Order change requests are aligned to a defined status model, that will be explained in this section.

The following table explains the currently available statuses:

StatusComment
OPEN

The change request was successfully created. START-STATE

ACCEPTEDThe change request was accepted. All approvals are accepted (or none are required). 
APPLIED

The change request was successfully applied to the order. END-STATE

FAILED_TO_APPLY

Applying the change request failed because of one or more reasons. END-STATE

This state model explains the currently available statuses and transitions.

Concept - IOM Order Change - Status Model #1

4 Limitations

The order change feature will be enhanced stepwise. Therefore there are limitations because of not yet implemented enhancements.

The following list of known limitations should be considered:

  • A change request cannot be cancelled.
  • The order number cannot be changed.
  • Approvals for change requests are not possible.
  • There are no business events configurable within the order change business process.
  • Change requests or any other behavior is not visible in the OMT.
  • Custom validation of a change request additionally to the specified ones e.g. for order creation is not possible.
  • and more

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Tickets