Development Documents
09-Feb-2024
Overview - Intershop Order Management REST API
Document Properties
Kbid
2G9423
Added to KB
05-Jun-2020
Status
online
Product
  • IOM 2.9
  • IOM 2.12
  • IOM 2.14
  • IOM 2.16
  • IOM 3.0
  • IOM 3.2
  • IOM 3.4
  • IOM 3.6
  • IOM 4.0
  • IOM 4.2
  • IOM 4.4
  • IOM 4.6
Last Modified
09-Feb-2024
Public Access
everyone
Doc Type
Overviews
Product
  • IOM 2.11
  • IOM 2.13
  • IOM 2.15
  • IOM 2.17
  • IOM 3.1
  • IOM 3.3
  • IOM 3.5
  • IOM 3.7
  • IOM 4.1
  • IOM 4.3
  • IOM 4.5
Document Link
https://knowledge.intershop.com/kb/2G9423


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 3rd 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 Website, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Home
Knowledge Base
User Manuals
Product Releases
Log on to continue
This Knowledge Base document is reserved for registered customers.
Log on with your Intershop Entra ID to continue.
Write an email to supportadmin@intershop.de if you experience login issues,
or if you want to register as customer.