Personal Library

Kbid	P29405
Last Modified	09-Jun-2020
Added to KB	08-May-2020
Public Access	Everyone
Status	Online
Doc Type	References
Product	IOM 2.15 IOM 2.16 IOM 2.17 IOM 3.0

Reference - IOM REST API - Transmissions 1.1

https://support.intershop.com/kb/P29405

Share this document

Product Version	2.17
Product To Version
Status	final

Download Specification

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

intershop-order-management-transmission-1.1.yaml

API Specification

Introduction

OpenAPI Version: 3.0.0

IOM Transmission REST API Version: 1.1

The transmission REST API supports tasks to view and manage transmissions of the IOM.

transmission API

Transmission related operations exposed by this service.

/transmissions

GET: Get transmissions by search criterias.

Description

Returns all transmissions for selected search criterias.

Request Body

Request Parameters

Location	Name	Format	Description
in query	creationDate[gte]	string	Required \| The earliest creation date of a transmission. \| Format: `date-time`
in query	creationDate[lte]	string	Required \| The latest creation date of a transmission. \| Format: `date-time`
in query	transmissionTypes	array
in query	transmissionSubtypes	array
in query	transmissionStatuses	array
in query	transmissionResponseStatuses	array
in query	receiverTypes	array
in query	shopIds	array	Example: `1`
in query	supplierIds	array	Example: `1`
in query	limit	integer	The number of items to return. If not set the limit is 1000. \| Default: `1000`
in query	offset	integer	The number of items to skip before starting to collect the result set. \| Default: `0`
in query	orderBy	--
in query	sortDirection	--

Response

200 - OK

The response for a transmission collection request.

TransmissionCollectionContainer application/json

400 - Bad Request

- Generic or business logic validation error.

ErrorReport application/json

401 - Unauthorized

- Authentication information is missing or invalid.

Response Header	Description
`WWW-Authenticate`

403 - Forbidden

- the user is not authorized to use this resource.

406 - Not Acceptable

- A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.

500 - Internal Server Error

- An unexpected error occured.

/transmissions/{transmissionId}

GET: Get a transmission by id.

Description

Returns a transmission for the given id.

Request Body

Request Parameters

Location	Name	Format	Description
in path	transmissionId	string	Required \| The transmission identifier. \| Example: `ORDERTRANSMISSION-10000`

Response

200 - OK

The response for one transmission request.

Transmission application/json

400 - Bad Request

- Generic or business logic validation error.

ErrorReport application/json

401 - Unauthorized

- Authentication information is missing or invalid.

Response Header	Description
`WWW-Authenticate`

403 - Forbidden

- the user is not authorized to use this resource.

406 - Not Acceptable

- A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.

500 - Internal Server Error

- An unexpected error occured.

transmissionUpdate API

/transmission-updates

POST: Bulk create processes to update statuses of transmissions.

Description

Bulk create processes to update statuses of transmissions.
A process will be created for each transmission, which will be processed asynchronously.

Request Body

Array of TransmissionUpdate application/json

Request Parameters

Response

201 - Created

- The entity was created successfully.

207 - Multi-Status

Contains multiple responses for different requests, that was done within one single request.

MultiStatusCollectionContainer application/json

400 - Bad Request

- Generic or business logic validation error.

ErrorReport application/json

401 - Unauthorized

- Authentication information is missing or invalid.

Response Header	Description
`WWW-Authenticate`

403 - Forbidden

- the user is not authorized to use this resource.

406 - Not Acceptable

- A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.

415 - Unsupported Media Type

- The media type of the sent body is not supported.

Request and Response Object Schemata

ErrorReport application/json

{

"status":
integer
The HTTP status code. | 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.
}
]

}

MultiStatusCollectionContainer application/json

{

"meta":
object
A MultiStatusCollectionMetaData object. The meta data of a multi-status collection.
{
- "successCount":
  integer
  The number of successful operations. | Format: int64 | Example: 100
- "failureCount":
  integer
  The number of failed operations. | Format: int64 | Example: 5
}
"data":
array
An array of MultiStatus objects. The core data of the multi-status collection.
[
MultiStatus: Contains multiple responses `MultiStatusResponse` for different requests, that was done within one single request.
{
- "link":
  object
  Required | A Link object.
  {
  "href":
  string
  The link to the resource.
  "rel":
  string
  The relation of the link to the resource, i.e. self.
  }
- "status":
  integer
  Required | The HTTP status code. | 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.
  }
  ]
}
]

}

Transmission application/json

{

"links":
array
An array of Link objects.
[
Link:
{
- "href":
  string
  The link to the resource.
- "rel":
  string
  The relation of the link to the resource, i.e. self.
}
]
"id":
string
The transmission identifier. | Example: ORDERTRANSMISSION-10000
"transmissionType":
string
The type of the transmission.

ORDERTRANSMISSION - Transmissions that are used for order processing messages, e.g. to announce an order entry. Subtypes of this type start with ORDER_.
DISPATCHTRANSMISSION - Transmissions that are used for dispatch messages, e.g. a delivery that was made. Subtypes of this type start with DISPATCH_.
RETURNTRANSMISSION - Transmissions that are used for return messages, e.g. a received return. Subtypes of this type start with RETURN_.
PAYMENTTRANSMISSION - Transmissions that are used for payment notification messages, e.g. a received payment. Subtypes of this type start with PAYMENT_.
MAILTRANSMISSION - Transmissions that are used for emails, e.g. to send a delivery email to the customer. Subtypes of this type start with MAIL_.
RESPONSETRANSMISSION - Transmissions that are used for response messages, e.g. to respond to a delivery request. Subtypes of this type start with RESPONSE_.
INVOICETRANSMISSION - Transmissions that are used for invoice processing messages. Subtypes of this type start with INVOICE_.
DOCUMENTTRANSMISSION - Transmissions that are used for document processing messages. Subtypes of this type start with DOCUMENT_.
RETURNANNOUNCEMENTTRANSMISSION - Transmissions that are used for return announcements messages. Subtypes of this type start with RETURNANNOUNCEMENT_.

For any type use OTHERS for subtypes that are not listed, e.g. custom ones.
| Example: ORDERTRANSMISSION | Possible Values: ORDERTRANSMISSIONDISPATCHTRANSMISSIONRETURNTRANSMISSIONPAYMENTTRANSMISSIONMAILTRANSMISSIONRESPONSETRANSMISSIONINVOICETRANSMISSIONDOCUMENTTRANSMISSIONRETURNANNOUNCEMENTTRANSMISSION
"transmissionSubtype":
string
The subtype of the transmission.
Please note the string representation to support subtypes from schema TransmissionType and unknown subtypes, e.g. custom ones. | Example: MAIL_ORDER
"status":
string
The processing status of the transmission.

INITIAL - Transmission is initially stored.
DO_PULL - Transmission will be pulled.
PULLED - Transmission was received (pulled) from the sender.
DO_PUSH - Transmission can be sent (pushed) to the receiver.
PUSHED - Transmission was sent (pushed) to the receiver.
DO_MANUAL_CHECK - The processing of transmission was canceled because of errors. The transmission has to be checked manually.
CHECKED - Transmission was checked manually and is ready to process.
DO_CANCEL - Transmission will be canceled.
CANCELED - Transmission can be canceled because processing is not required any longer.
TRANSMISSIONED - Transmission was submitted.
CONFIRMED - Transmission was confirmed from the receiver. | Example: CONFIRMED | Possible Values: INITIALDO_PULLPULLEDDO_PUSHPUSHEDDO_MANUAL_CHECKCHECKEDDO_CANCELCANCELEDTRANSMISSIONEDCONFIRMED
"responseStatus":
string
The status of the response of the transmission.

OK - The transmission was successfully received.
INVALID - An error occurred during validation check at the receiver.
REJECTED - The operation was rejected by the receiver.
EXTERNAL_ERROR - An unexpected error occurred at the receiver.
INTERNAL_ERROR - Internal unexpected error has occurred.
NOT_AVAILABLE - The response status is not set. | Example: REJECTED | Possible Values: OKINVALIDREJECTEDEXTERNAL_ERRORINTERNAL_ERRORNOT_AVAILABLE
"creationDate":
string
The date when the transmission was created. | Format: date-time
"modificationDate":
string
The date when the transmission was modified. | Format: date-time
"orderId":
integer
The id of the order. | Format: int64 | Example: 10026
"shopOrderNumber":
string
The order number as used by the shop. | Example: 20180303123
"shopId":
integer
The id of the shop. | Format: int64 | Example: 1000
"shopName":
string
The name of the shop. | Example: Test Shop US DE
"supplierId":
integer
The id of the supplier. | Format: int64 | Example: 1000
"supplierName":
string
The name of the supplier. | Example: Test Supplier US DE
"receiverType":
string
The type of the receiver of a transmission.

OMS - The OMS-application itself.
SHOP - The shop is the receiver of the transmission.
SUPPLIER - The supplier is the receiver of the transmission, e.g. of a delivery request.
CUSTOMER - The customer is the receiver of the transmission, e.g. an email to confirm an order.
PAYMENTPROVIDER - A payment provider is the receiver of the transmission, e.g. to note a received payment to.
FINANCECONTROLLER - A finance contoller is the receiver of the transmission, e.g. a debitor management system that receives open amounts. | Example: SHOP | Possible Values: OMSSHOPSUPPLIERCUSTOMERPAYMENTPROVIDERFINANCECONTROLLER
"retryCount":
integer
Number of sending attempts. | Example: 2
"retryDate":
string
The date of the last attempt to send the transmission. | Format: date-time
"nextRetryDate":
string
The next date to send the transmission. | Format: date-time
"errorText":
string
The error text, if the transmission failed. | Example: This was no error, because the status was set OK.

}

TransmissionCollectionContainer application/json

{

"meta":
object
A CollectionMetaData object. The meta data of the collection.
{
- "totalCount":
  integer
  The total number of objects in the collection (without offset and limit). | Format: int64 | Example: 10000
}
"data":
array
An array of Transmission objects. The core data of the transmission collection.
[
Transmission:
{
- "links":
  array
  An array of Link objects.
  [
  Link:
  {
  "href":
  string
  The link to the resource.
  "rel":
  string
  The relation of the link to the resource, i.e. self.
  }
  ]
- "id":
  string
  The transmission identifier. | Example: ORDERTRANSMISSION-10000
- "transmissionType":
  string
  The type of the transmission.
  
  ORDERTRANSMISSION - Transmissions that are used for order processing messages, e.g. to announce an order entry. Subtypes of this type start with ORDER_.
  DISPATCHTRANSMISSION - Transmissions that are used for dispatch messages, e.g. a delivery that was made. Subtypes of this type start with DISPATCH_.
  RETURNTRANSMISSION - Transmissions that are used for return messages, e.g. a received return. Subtypes of this type start with RETURN_.
  PAYMENTTRANSMISSION - Transmissions that are used for payment notification messages, e.g. a received payment. Subtypes of this type start with PAYMENT_.
  MAILTRANSMISSION - Transmissions that are used for emails, e.g. to send a delivery email to the customer. Subtypes of this type start with MAIL_.
  RESPONSETRANSMISSION - Transmissions that are used for response messages, e.g. to respond to a delivery request. Subtypes of this type start with RESPONSE_.
  INVOICETRANSMISSION - Transmissions that are used for invoice processing messages. Subtypes of this type start with INVOICE_.
  DOCUMENTTRANSMISSION - Transmissions that are used for document processing messages. Subtypes of this type start with DOCUMENT_.
  RETURNANNOUNCEMENTTRANSMISSION - Transmissions that are used for return announcements messages. Subtypes of this type start with RETURNANNOUNCEMENT_.
  
  For any type use OTHERS for subtypes that are not listed, e.g. custom ones.
  | Example: ORDERTRANSMISSION | Possible Values: ORDERTRANSMISSIONDISPATCHTRANSMISSIONRETURNTRANSMISSIONPAYMENTTRANSMISSIONMAILTRANSMISSIONRESPONSETRANSMISSIONINVOICETRANSMISSIONDOCUMENTTRANSMISSIONRETURNANNOUNCEMENTTRANSMISSION
- "transmissionSubtype":
  string
  The subtype of the transmission.
  Please note the string representation to support subtypes from schema TransmissionType and unknown subtypes, e.g. custom ones. | Example: MAIL_ORDER
- "status":
  string
  The processing status of the transmission.
  
  INITIAL - Transmission is initially stored.
  DO_PULL - Transmission will be pulled.
  PULLED - Transmission was received (pulled) from the sender.
  DO_PUSH - Transmission can be sent (pushed) to the receiver.
  PUSHED - Transmission was sent (pushed) to the receiver.
  DO_MANUAL_CHECK - The processing of transmission was canceled because of errors. The transmission has to be checked manually.
  CHECKED - Transmission was checked manually and is ready to process.
  DO_CANCEL - Transmission will be canceled.
  CANCELED - Transmission can be canceled because processing is not required any longer.
  TRANSMISSIONED - Transmission was submitted.
  CONFIRMED - Transmission was confirmed from the receiver. | Example: CONFIRMED | Possible Values: INITIALDO_PULLPULLEDDO_PUSHPUSHEDDO_MANUAL_CHECKCHECKEDDO_CANCELCANCELEDTRANSMISSIONEDCONFIRMED
- "responseStatus":
  string
  The status of the response of the transmission.
  
  OK - The transmission was successfully received.
  INVALID - An error occurred during validation check at the receiver.
  REJECTED - The operation was rejected by the receiver.
  EXTERNAL_ERROR - An unexpected error occurred at the receiver.
  INTERNAL_ERROR - Internal unexpected error has occurred.
  NOT_AVAILABLE - The response status is not set. | Example: REJECTED | Possible Values: OKINVALIDREJECTEDEXTERNAL_ERRORINTERNAL_ERRORNOT_AVAILABLE
- "creationDate":
  string
  The date when the transmission was created. | Format: date-time
- "modificationDate":
  string
  The date when the transmission was modified. | Format: date-time
- "orderId":
  integer
  The id of the order. | Format: int64 | Example: 10026
- "shopOrderNumber":
  string
  The order number as used by the shop. | Example: 20180303123
- "shopId":
  integer
  The id of the shop. | Format: int64 | Example: 1000
- "shopName":
  string
  The name of the shop. | Example: Test Shop US DE
- "supplierId":
  integer
  The id of the supplier. | Format: int64 | Example: 1000
- "supplierName":
  string
  The name of the supplier. | Example: Test Supplier US DE
- "receiverType":
  string
  The type of the receiver of a transmission.
  
  OMS - The OMS-application itself.
  SHOP - The shop is the receiver of the transmission.
  SUPPLIER - The supplier is the receiver of the transmission, e.g. of a delivery request.
  CUSTOMER - The customer is the receiver of the transmission, e.g. an email to confirm an order.
  PAYMENTPROVIDER - A payment provider is the receiver of the transmission, e.g. to note a received payment to.
  FINANCECONTROLLER - A finance contoller is the receiver of the transmission, e.g. a debitor management system that receives open amounts. | Example: SHOP | Possible Values: OMSSHOPSUPPLIERCUSTOMERPAYMENTPROVIDERFINANCECONTROLLER
- "retryCount":
  integer
  Number of sending attempts. | Example: 2
- "retryDate":
  string
  The date of the last attempt to send the transmission. | Format: date-time
- "nextRetryDate":
  string
  The next date to send the transmission. | Format: date-time
- "errorText":
  string
  The error text, if the transmission failed. | Example: This was no error, because the status was set OK.
}
]

}

TransmissionUpdate application/json

[

TransmissionUpdate: A transmission id and the process that should be done on this transmission.
{

"id":
string
The transmission identifier. | Example: ORDERTRANSMISSION-10000
"updateType":
string
The type of process to create on a transmission, e.g. to resend a transmission.

RESEND - Resend the transmission.
CANCEL - Cancel the transmission.
SENT - Set the transmission as already sent.
| Example: RESEND | Possible Values: RESENDCANCELSENT

}

]

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.