This API specification is available for download as an Open API 3.0 YAML file:
Transmission related operations exposed by this service.
/transmissions
Returns all transmissions for selected search criterias.
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 | -- |
200 - OK
400 - Bad Request
401 - Unauthorized
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
406 - Not Acceptable
500 - Internal Server Error
/transmissions/{transmissionId}
Returns a transmission for the given id.
Location | Name | Format | Description |
---|---|---|---|
in path | transmissionId | string | Required | The transmission identifier. | Example: ORDERTRANSMISSION-10000 |
200 - OK
400 - Bad Request
401 - Unauthorized
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
406 - Not Acceptable
500 - Internal Server Error
/transmission-updates
Bulk create processes to update statuses of transmissions.
A process will be created for each transmission, which will be processed asynchronously.
201 - Created
207 - Multi-Status
400 - Bad Request
401 - Unauthorized
Response Header | Description |
---|---|
WWW-Authenticate |
403 - Forbidden
406 - Not Acceptable
415 - Unsupported Media Type
int32
| Example: 400
Error
objects.Error
: VALIDATION_EXCEPTION
Attribute XYZ is mandatory
MultiStatusCollectionMetaData
object. The meta data of a multi-status collection.int64
| Example: 100
int64
| Example: 5
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.int32
| Example: 400
Error
objects.Error
: VALIDATION_EXCEPTION
Attribute XYZ is mandatory
Link
objects.Link
: ORDERTRANSMISSION-10000
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_
.OTHERS
for subtypes that are not listed, e.g. custom ones.ORDERTRANSMISSION
| Possible Values: ORDERTRANSMISSION
DISPATCHTRANSMISSION
RETURNTRANSMISSION
PAYMENTTRANSMISSION
MAILTRANSMISSION
RESPONSETRANSMISSION
INVOICETRANSMISSION
DOCUMENTTRANSMISSION
RETURNANNOUNCEMENTTRANSMISSION
TransmissionType
and unknown subtypes, e.g. custom ones. | Example: MAIL_ORDER
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: INITIAL
DO_PULL
PULLED
DO_PUSH
PUSHED
DO_MANUAL_CHECK
CHECKED
DO_CANCEL
CANCELED
TRANSMISSIONED
CONFIRMED
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: OK
INVALID
REJECTED
EXTERNAL_ERROR
INTERNAL_ERROR
NOT_AVAILABLE
date-time
date-time
int64
| Example: 10026
20180303123
int64
| Example: 1000
Test Shop US DE
int64
| Example: 1000
Test Supplier US DE
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: OMS
SHOP
SUPPLIER
CUSTOMER
PAYMENTPROVIDER
FINANCECONTROLLER
2
date-time
date-time
This was no error, because the status was set OK.
CollectionMetaData
object. The meta data of the collection.int64
| Example: 10000
Transmission
objects. The core data of the transmission collection.Transmission
: Link
objects.Link
: ORDERTRANSMISSION-10000
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_
.OTHERS
for subtypes that are not listed, e.g. custom ones.ORDERTRANSMISSION
| Possible Values: ORDERTRANSMISSION
DISPATCHTRANSMISSION
RETURNTRANSMISSION
PAYMENTTRANSMISSION
MAILTRANSMISSION
RESPONSETRANSMISSION
INVOICETRANSMISSION
DOCUMENTTRANSMISSION
RETURNANNOUNCEMENTTRANSMISSION
TransmissionType
and unknown subtypes, e.g. custom ones. | Example: MAIL_ORDER
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: INITIAL
DO_PULL
PULLED
DO_PUSH
PUSHED
DO_MANUAL_CHECK
CHECKED
DO_CANCEL
CANCELED
TRANSMISSIONED
CONFIRMED
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: OK
INVALID
REJECTED
EXTERNAL_ERROR
INTERNAL_ERROR
NOT_AVAILABLE
date-time
date-time
int64
| Example: 10026
20180303123
int64
| Example: 1000
Test Shop US DE
int64
| Example: 1000
Test Supplier US DE
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: OMS
SHOP
SUPPLIER
CUSTOMER
PAYMENTPROVIDER
FINANCECONTROLLER
2
date-time
date-time
This was no error, because the status was set OK.
TransmissionUpdate
: A transmission id and the process that should be done on this transmission.ORDERTRANSMISSION-10000
RESEND
- Resend the transmission.CANCEL
- Cancel the transmission.SENT
- Set the transmission as already sent.RESEND
| Possible Values: RESEND
CANCEL
SENT
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.