Personal Library

Kbid	2G9423
Last Modified	20-Apr-2021
Added to KB	05-Jun-2020
Public Access	Everyone
Status	Online
Doc Type	Guidelines, Concepts & Cookbooks
Product	IOM 2.9 IOM 2.15 IOM 2.16 IOM 2.17 IOM 3.0 IOM 3.1 IOM 3.2

Overview - Order Management REST API

https://support.intershop.com/kb/2G9423

Share this document

Product Version	2.17
Product To Version
Status	final

1 Introduction

This overview documents the IOM (Intershop Order Management) REST API. The included references are addressed at developers who want to make use of an easy-to-use API when connecting IOM to a 3^rd party warehouse management system.

1.1 Glossary

Term	Description
IOM	The abbreviation for Intershop Order Management
REST	Representational State Transfer

2 Version Matrix

IOM Version REST Version	3.4	3.3	3.2	3.1	3.0	2.17.1	2.17	2.15	2.14	2.13	2.12	2.11	2.10	2.9.4.0	2.9.3.0	2.9.2.0	2.9.0.0
Inventory Service / ATP
Reference - IOM REST API - Inventory Service 2.0	✓	✓	✓	✓	✓	✓	✓
Cache
Reference - IOM REST API - Cache 1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Communication (responses, dispatches and returns)
Reference - IOM REST API - Communication 2.11	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Communication 2.10	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Communication 2.9.4.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Communication 2.9.3.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Communication 2.9.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Order Service
Reference - IOM REST API - Order 2.1	✓
Reference - IOM REST API - Order 2.0	✓	✓	✓	✓
Order State Service
Reference - IOM REST API - Order State 1.0	✓*	✓*	✓*	✓*	✓	✓	✓	✓
GDPR (General Data Protection Regulation)
Reference - IOM REST API - GDPR 2.9.4.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - GDPR 2.9.3.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - GDPR 2.9.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
RMA (Return Merchandise Authorization)
Reference - IOM REST API - RMA 2.10	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - RMA 2.9.4.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - RMA 2.9.3.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - RMA 2.9.0.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Transmissions
Reference - IOM REST API - Transmissions 1.1	✓	✓	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Transmissions 1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Monitoring (server status, cluster status)
Reference - IOM REST API - Health Service 1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓	✓
Job Schedules
Reference - IOM REST API - Schedules 1.0	✓	✓	✓	✓	✓

* This API is still available, but deprecated.

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.

Overview - Order Management REST API

Table of Contents

1 Introduction

1.1 Glossary

2 Version Matrix

Disclaimer