Public Release Note - Intershop Order Management 2.1

Product Version

2.1

Product To Version

2.1
Status

final

1 Introduction

Welcome to the Intershop Order Management 2.1!

Intershop Order Management is an Intershop Commerce Suite application that is designed to combine omni-channel commerce processes into one system. It automates and streamlines the life-cycle of orders and payments. Intershop Order Management processes orders from multiple touch points (web shop, mobile shop, call center, etc.), allocates them to multiple fulfillment solutions (fulfillment centers, drop-ship distributors, physical stores, etc.), and tracks all order and payment transactions.

Intershop Order Management offers a centralized platform for managing distributed inventory, order, invoice and payment life cycles, and provides call center functionality, enabling real-time visibility into customers' purchasing behavior, stock levels, payments, and more. As part of Intershop Commerce Suite, it utilizes the suite's transaction, PIM and merchandising features.

Intershop Order Management (IOM) offers the possibility to tailor your business models as flexible and free as you need and depict them in your e-commerce environment. The order management system adjusts the order processing for various sales channels and suppliers and can be seamlessly integrated with existing components of your IT environment.

1.1 Dependency Version Information


Intershop Order ManagementIntershop Commerce Management B2XIOM Connector
Version2.17.62.0
7.73.0
7.84.0

1.2 Glossary

TermDescription
IOMThe abbreviation for Intershop Order Management
ICMThe abbreviation for Intershop Commerce Management

2 General Information

3 Additional Information

4 New Features and Enhancements

4.1 Integration

As mentioned before, the IOM Connector is to be set up alongside a standard ICM installation. It adds additional cartridges that define the following managed services:

  • IOM Order Service - Exports order data from ICM to IOM
  • IOM Order State Service - Changes the order history section in a way that orders' statuses are fetched from IOM whenever the customer requests them
  • IOM Download Service - After customers request a return, they will be able to download, or directly print a return slip. This return slip can be downloaded from the link shown on the Prepare Return Documents page.
  • IOM Reverse Service - Ensures order cancellation is available to the customer (so customers can even print a return slip, which can be used for order returns)
  • IOM Inventory Service - Provides a way to obtain the inventory levels from Intershop Order Management to Intershop Commerce Management and perform product reservations 

IOM Connector - Systems  

4.2 Channels and Shops

Both ICM and IOM follow the same hierarchical concept of organizations that have expandable entities. These entities differ, however. In ICM one sales organization may have multiple channels, while in IOM one sales organization may have multiple shops.

Intershop recommends to consider channels and shops as synonyms in the context of this document and your setup. Although not the same, they are in close relation to each other.

As mentioned before, a couple IOM Services, although not mandatory, are to be created in the context of channel. This way you can ensure that the communication exchange between ICM and IOM is realized on the intended level.

IOM Connector - Channels

4.3 Communication

4.3.1 End Points

The services mentioned in the previous chapter are realized with web services. They are exchanging data between the two systems in a specific format, but they also need to be configured. Web services require an end point that is different for each of them. In the table below you can see the end points, with IOM server host/address shown as a placeholder.

ServiceEnd point
IOM Order Servicehttps://<iom-host>/webservices/OrderService/v1.1
IOM Order State Servicehttps://<iom-host>/webservices/OrderStateService/v1.0
IOM Download Servicehttps://<iom-host>/webservices/DownloadService/v1.0
IOM Reverse Servicehttps://<iom-host>/webservices/ReverseService/v1.0
IOM Inventory Servicehttps://<iom-host>/servlets/services/

4.3.2 Shop

When doing the configuration mentioned in the step above, you must also specify a shop. Usually, a channel in ICM represents a shop in IOM.

4.3.3 Authorization

Consumers of the services must authorize themselves to IOM before any data is processed - either as input or output. To realize this, you must create a user in IOM with permissions necessary for the operations performed by the service. An easy way to ensure this is to assign the ShopServiceClient role to the corresponding user. However, you may fine grain the permissions for each service as they all will need a user name/password combination.

If you want to use prepared demo data (you do not if you do not know what this is) here are some prepared values:

Consumer Web-Serviceconsumer_ws
CompanyinSPIRED
Shop(s)inTRONICS
inTRONIC Business

4.3.4 Identifiers

Both systems exchange data so they need a common ground as a base for this communication. The following table shows the mappings between IOM and ICM:

IdentifierIOMICM
ProductShop's product IDChannel's product SKU
CustomerShop's customer numberCustomer No
OrderShop's order NoOrder document number

These identifiers must be identical for each item in both systems. For example, if an order with a line item that has the SKU 00910 is placed and then exported to IOM, the web services layer will report an error if the product with this product ID is not present in IOM.

4.4 Order Export

IOM Connector provides instruments that route any order placed from ICM to IOM. To use this feature, you must configure the order export (see Snippet - ICM IOM Configuration - Order Export  ), which depends on an existing service configuration (see Configure IOM Order Service). As mentioned before, on the configuration page you may tweak the export settings, but we generally use "on order creation" trigger.

The look and feel and the business processes in the standard ICM is not altered in any way, but placed orders are routed to IOM.

Order Confirmation in ICMOrder details in IOM

4.4.1 Extended B2B Features

Order approval and additional order information work out of the box with order export to IOM. Orders are exported to IOM once they are approved by the responsible user(s) in the customer's organization. All approval and additional information details are exported to IOM upon order placement. They are accessible in the Attributes section.

4.4.2 Mapping

The table below lists the mapping of data exchanged between ICM and IOM.

ICMIOM
Order details
Order Document NumberShop Order ID
Creation DateSales Information / Order
Payment MethodPayment Method
Tax RateTax Rate
Order totalOrder total
Invoice & Shipping Address
CompanyCompany
SalutationSalutation
First NameFirst Name
Last NameLast Name
Address 1Street
Address 2Address Suffix 1
Address 3Address Suffix 2
ZIP/Postal CodeZIP/Postal Code
CityCity
CountryCountry
PhonePhone
EmailEmail
Line Item Information
Product SKUShop product ID
QiantityQuantity
Tax RateTax Rate
PricePrice

4.5 Order History

This feature is governed by IOM Order State Service. Once this service is configured and activated, order status information in My Account -> Order history is taken in real time from IOM.

My Account -> Order HistoryOrder search in IOM

Real time means that order statuses are updated the moment they are updated in IOM. Thus any action taken in IOM, for example Confirmation of delivery, will be shown in ICM the moment when someone requests their order history. In the table below you find the mapping between order statuses in the two systems.

Intershop Commerce ManagementIntershop Order Management
transmittedcommissioned
shippedshipped
in validationcheck failed
returnedreturned

4.6 Order Return

4.6.1 Return Line Item(s)

Customers are able to trigger returns of orders. Once the order is shipped, and its delivery confirmation is tracked in IOM, its status is changed to shipped. From the order history page, every order that has been shipped can be triggered for return by clicking the Return link. For each individual item, a return quantity and a reason can be specified. Return reasons are requested from IOM and available for selection to the customers.

The required service for order return is IOM Reverse Service. Without it configured and activated, customers will not be able to use this feature.

4.6.2 Print the Return Slip

Once someone has requested a return, they will be able to download or directly print a return slip. This return slip can be downloaded from the link shown on the Prepare Return Documents page.

As with the rest of IOM features, this one is also realized by using managed service - IOM Download Service. You must configure it first before using it.

4.7 Inventory Service

The main task that the Inventory Service does is to check the product availability status for a particular product in IOM. IOM Inventory Service performs in real time, but at the same time it supports caching the results for a given time interval (e.g., 5 seconds). When the page with the customer's desired product is open, the Inventory Service sends a request to IOM that asks for the ATP (available to promise) status. If the product is available then the customer will see the button Add to Cart and a field in which to specify the desired quantity of the product. On the other hand, if the product is not available, on the screen will be shown the following: a button with the text Notify me when available. If in the service configuration the checkbox Availability check on failure is not selected, then in the case of a problem with the communication with the IOM system, the Simple Inventory Service will be activated and the selected product will be checked for ATP (ICM) in the local database.

5 Setup & Configuration

The distribution package that contains the binary distribution of Intershop Order Management 2.1 is available in the Product Calendar and consists only of this file:

  • IOM_2.1.0.0.tgz

For installation instructions please read:

Please note that the installation requires installed and preconfigured:

  • JDK 8
  • WildFly 9
  • Postgres 9.5

6 Interface Descriptions

6.1 REST API

6.2 SOAP API

The commented WSDLs are part of the IOM distribution package and can be found in this directory /doc/SOAP.

6.3 Asynchronous Interfaces

7 Changelog

7.1 Version Intershop Order Management / 2.1.12

7.1.1 Fixed Defects

7.2 Version Intershop Order Management / 2.1.11

7.2.1 Fixed Defects

7.3 Version Intershop Order Management / 2.1.10

7.3.1 Fixed Defects

7.4 Version Intershop Order Management / 2.1.9

7.4.1 New Features

7.4.2 Fixed Defects

7.5 Version Intershop Order Management / 2.1.8

7.5.1 Fixed Defects

7.6 Version Intershop Order Management / 2.1.7

7.6.1 Fixed Defects

7.7 Version Intershop Order Management / 2.1.6

7.7.1 Fixed Defects

7.8 Version Intershop Order Management / 2.1.5

7.8.1 New Features

7.9 Version Intershop Order Management / 2.1.4

7.9.1 Fixed Defects

7.10 Version Intershop Order Management / 2.1.3

7.10.1 New Features

  • Invoice action buttons are available in the invoice details view

7.10.2 Fixed Defects

7.11 Version Intershop Order Management / 2.1.2

7.11.1 New Features

  • Added calculation model to be compliant with ICM calculation ruleset V2

7.11.2 Fixed Defects

7.12 Version Intershop Order Management / 2.1.1

7.12.1 New Features

  • Distinguish B2B- and B2C-customers for one shop
  • Enhanced article import to support a "preferred supplier" classification

7.12.2 Fixed Defects

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
Support Tickets