Overview - Intershop Order Management REST API

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.

Glossary

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

Version Matrix

IOM Version REST Version	5.0	4.7	4.6	4.5	4.4	4.3	4.2	4.1	4.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	✓	✓	✓	✓	✓	✓	✓	✓	✓
GDPR (General Data Protection Regulation)
Reference - IOM REST API - GDPR 2.10	✓
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	✓	✓	✓	✓	✓	✓	✓	✓	✓
Inventory Service / ATP
Reference - IOM REST API - Inventory Service 2.0	✓	✓	✓	✓	✓	✓	✓	✓	✓
Job Schedules
Reference - IOM REST API - Schedules 1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓
Monitoring (server status, cluster status)
Reference - IOM REST API - Health Service 1.0	✓	✓	✓	✓	✓	✓	✓	✓	✓
Order Service
Reference - IOM REST API - Order 2.4	✓	✓	✓
Reference - IOM REST API - Order 2.3	✓	✓	✓	✓
Reference - IOM REST API - Order 2.2	✓	✓	✓	✓	✓	✓	✓	✓	✓
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 (d)	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*	✓*
Reservation Service
Reference - IOM REST API - Reservation	✓	✓	✓	✓	✓	✓	✓	✓	✓
RMA (Return Merchandise Authorization)
Reference - IOM REST API - RMA 2.12	✓
Reference - IOM REST API - RMA 2.11	✓	✓	✓	✓	✓
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 2.0	✓	✓	✓	✓	✓	✓	✓
Reference - IOM REST API - Transmissions 1.1 (r)	-		-	-	-	-	-	✓	✓
Reference - IOM REST API - Transmissions 1.0 (r)	-		-	-	-	-	-	-	✓

(d) * deprecated.

(r) - removed

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.

Table of Contents

Introduction

Glossary

Version Matrix