Document Properties
Kbid
2728F6
Last Modified
07-Mar-2022
Added to KB
13-Nov-2015
Public Access
Everyone
Status
Online
Doc Type
Concepts
Product
  • IOM 3.0
  • IOM 3.1
  • IOM 3.2
  • IOM 3.3
  • IOM 3.4
  • IOM 3.5
  • IOM 3.6
  • IOM 3.7
  • IOM 4.0
  • IOM 4.1
  • IOM 4.2
  • IOM 4.3
  • IOM 4.4
  • IOM 4.5
  • IOM 4.6
  • IOM 4.7
Concept - IOM REST Web Services

Introduction

Intershop Order Management (IOM) uses Representational State Transfer (REST). The present concept gives some basic information about the IOM's REST service handling.

This concept is primarily intended for all developers implementing a project or working with the core product of IOM.

References

General

Authorization

IOM supports basic http authentication only. Please configure your clients to use this authentication method. A very simple method to send REST requests on the command line can be realized using wget. The example also shows, how to configure this client to use basic http authentication (--auth-no-challenge).

wget -q -O- --auth-no-challenge  --http-user=<user> --http-password='<password>' \
http://<hostname>/<REST URL>

Allowed HTTP Requests

The following requests show the general existing HTTP requests. Not all requests are required for each service.

  • POST- Creates or updates a resource

  • PUT- Updates a resource

  • GET- Retrieves a resource or list of resources

  • DELETE- Delete a resource

Typical Server Responses

  • 200 OK - The request was successful.

  • 201 Created - The request was successful and a resource was created.

  • 204 No Content - The request was successful but there is no representation to return (that is, the response is empty).

  • 400 Bad Request - The request could not be understood or was missing required parameters.

  • 401 Unauthorized - Authentication failed or user does not have permissions for the requested operation.

  • 403 Forbidden - Access denied.

  • 404 Not Found - Resource was not found.

  • 405 Method Not Allowed - Requested method is not supported for the specified resource.

  • 503 Service Unavailable - The service is temporary unavailable (e.g., due to scheduled platform maintenance). Try again later.

Response Examples

Response Envelope Example

All API responses will be returned by the following JSON envelope. Errors, and exceptions are only present if they occur:

200 OK
{
        "data": {
            "validUntil": "2014-12-19 11:25:00",
            "resvId": "sdfdk43ß445lksld0394",
            "items": [
                {
                    "id": "BDJs-3432",
                    "qty": 2,
                    "state": "reserved"
                },
                {
                    "id": "AFEz-5562",
                    "qty": 1,
                    "state": "reserved"
                }
            ]
        },
        "errors": [],
        "exceptions": []
    }

Data

The data section contains the resource object for a success, typically a status code 200.

Errors and Exceptions

The errors section contains validation errors when a request fails. On a success, this data is empty.

Error messages
"errors": [
    {
        "message": "The value must be an integer",
        "sourceField": "qty"
    },
    {
        "message": "The reservation type is invalid",
        "sourceField": "type"
    },
    {
        "message": "required",
        "sourceField": "shop"
    },
]

The exceptions section contains exceptions that are thrown when a request fails due to an invalid request or code error. On a success, this data is empty.

Exceptions
"exceptions": [
    {
        "code": "20001",
        "message": "The requested id BDJs-3432 was not found "
    },
    {
        "code": "20002",
        "message": "The requested shop 1 was not found "
    }
]
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.
The Intershop Knowledge Portal uses only technically necessary cookies. We do not track visitors or have visitors tracked by 3rd parties. Please find further information on privacy in the Intershop Privacy Policy and Legal Notice.
Home
Knowledge Base
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.