This API specification is available for download as an Open API 3.0 YAML file:
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
Open ReDoc-rendered Open API documentation in separate window.
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.