Reference - IOM REST API - Communication 2.9.0.0

Document View

Download Specification

This API specification is available for download as an Open API 2.0 YAML file:

oms.rest.communication-swagger-2.9.0.0.yaml

API Specification

Introduction

OpenAPI Version: none

IOM REST Communication API Version: 2.9.0.0

The IOM REST Communication API supports dispatch, order response and return message transmission to the IOM.

Dispatch API

/dispatches

POST: Create a order dispatch message

Description

Persist a dispatch message and triggers the processing

Request Body

Request Parameters

Response

201 - Created

Response Header	Description
`Location`	The path to the newly created resource \| Format: `url`

400 - Bad Request

ErrorReport application/json

401 - Unauthorized Authentication information is missing or invalid

403 - Forbidden

415 - Unsupported Media Type

500 - Internal Server Error An unexpected error occured

Response API

/responses

POST: Create a order response message

Description

Persist a order response message and triggers the processing

Request Body

Request Parameters

Response

201 - Created

Response Header	Description
`Location`	The path to the newly created resource \| Format: `url`

400 - Bad Request

ErrorReport application/json

401 - Unauthorized Authentication information is missing or invalid

403 - Forbidden

415 - Unsupported Media Type

500 - Internal Server Error An unexpected error occured

Return API

/returns

POST: Create a order return message

Description

Persist a return message and triggers the processing

Request Body

Request Parameters

Response

201 - Created

Response Header	Description
`Location`	The path to the newly created resource \| Format: `url`

400 - Bad Request

ErrorReport application/json

401 - Unauthorized Authentication information is missing or invalid

403 - Forbidden

415 - Unsupported Media Type

500 - Internal Server Error An unexpected error occured

Request and Response Object Schemata

ErrorReport application/json

{

"status":
integer
The HTTP status code applicable to this problem, expressed as a string value | Format: int32 | Example: 400
"errors":
array
An array of Error objects.
[
Error
{
- "code":
  string
  Required | Exception / Error code | Example: VALIDATION_EXCEPTION
- "message":
  string
  Required | Exception / Error message | Example: Attribute XYZ is mandatory
- "value":
  object
  Value which caused the exception / error
}
]

}

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.