- Menu
- Sitemap
Reference - IOM REST API - Communication 2.9.0.0
Download Specification
This API specification is available for download as an Open API 2.0 YAML file:
API Specification
Introduction
Dispatch API
/dispatches
POST: Create a order dispatch message
Description
Persist a dispatch message and triggers the processing
Request Body
Request Parameters
| Location | Name | Format | Description |
|---|
Response
201 - Created
| Response Header | Description |
|---|---|
Location | The path to the newly created resource | Format: url |
400 - Bad Request
ErrorReport application/json
401 - Unauthorized
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error
Response API
/responses
POST: Create a order response message
Description
Persist a order response message and triggers the processing
Request Body
Request Parameters
| Location | Name | Format | Description |
|---|
Response
201 - Created
| Response Header | Description |
|---|---|
Location | The path to the newly created resource | Format: url |
400 - Bad Request
ErrorReport application/json
401 - Unauthorized
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error
Return API
/returns
POST: Create a order return message
Description
Persist a return message and triggers the processing
Request Body
Request Parameters
| Location | Name | Format | Description |
|---|
Response
201 - Created
| Response Header | Description |
|---|---|
Location | The path to the newly created resource | Format: url |
400 - Bad Request
ErrorReport application/json
401 - Unauthorized
403 - Forbidden
415 - Unsupported Media Type
500 - Internal Server Error
Request and Response Object Schemata
ErrorReport application/json
{- "status":integerThe HTTP status code applicable to this problem, expressed as a string value | Format:
int32| Example:400 - "errors":arrayAn array of
Errorobjects.[]Error:
{- "code":stringRequired | Exception / Error code | Example:
VALIDATION_EXCEPTION - "message":stringRequired | Exception / Error message | Example:
Attribute XYZ is mandatory - "value":objectValue 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.