Authentication

Basic Authentication

Please configure your clients to use this authentication method to submit user name and password.

Bearer Token Authentication

To generate a valid JSON Web Token (JWT), just log into the OMT, inspect the browser cookies and use the value of the cookie called 'OMS_IDENTITY' as JWT. Within a UI-client (e.g., Postman) choose Bearer Token and just type in a valid JWT.

Authorization

The following permissions must be assigned to a shop:

The permission Create order is required to create an order.
The permission View order is required to view an order.
The permission Order status web service is required to view an order report/ order states for one or more orders.
The permission Change orders is required to create change requests for an order.
The permission View order changes is required to view change requests for an order.

API Specification

Introduction

OpenAPI Version: 3.0.1

IOM Order API Version: 2.3

The IOM Order API allows to create orders, view orders, create change requests and view change requests for an order.
Furthermore, it is possible to search for order states.

Changelog

Version 2.3

Added optional search filter emails to retrieve order-states.

Version 2.2
Added operation getOrder.
- Added operations createChangeRequest, getChangeRequest and getChangeRequestViewList.
- Added undocumented constraints to Price, ListPrice, UnitPrice. net must not be greater than gross, amountDiscounted must not be greater than amount.
Added undocumented constraint to OrderPosition. Optional number must not be negative.
Added undocumented attributes to OrderPositionReturned. Added OrderPositionReturnedQuantities and OrderPositionReturnedUnits.

Version 2.1
Extended Tax. An unknown type can be submitted when adding rate and location.
Added undocumented constraint to Tax. type has max length of 512 characters.
Added undocumented constraint. In a list of Tax (taxes) each type is allowed once only.
Exceeded length of attributes in Promotion. id has max length of 512 characters. name, descriptorId, code and budgetSourceId have max length of characters.

Open ReDoc-rendered Open API documentation in separate window.

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.