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.
References
- Concept - IOM Order Change
- Reference - IOM REST API - Order 2.2 and later
- Cookbook - IOM Order Change for selected use cases
Business Process
Order change requests pass through a defined business process.
The business process flow is as follows:
- 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.
Once the change request successfully passed validations and security checks, it will be stored with the status
OPENand 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:- 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. - The change request will be applied to the order. If successfully the status of the change request will be set to
APPLIEDand 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.
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:
| Status | Comment |
|---|---|
| OPEN | The change request was successfully created. START-STATE |
| ACCEPTED | The 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.
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