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 | Default | Example | Description |
---|---|---|---|---|---|
in query | creationDate[gte] | string date-time | Required | The earliest creation date of a transmission. | ||
in query | creationDate[lte] | string date-time | Required | The latest creation date of a transmission. | ||
in query | transmissionTypes | array | |||
in query | transmissionSubtypes | array | |||
in query | transmissionStatuses | array | |||
in query | transmissionResponseStatuses | array | |||
in query | receiverTypes | array | |||
in query | shopIds | array | 1 | ||
in query | supplierIds | array | 1 | ||
in query | limit | integer | 1000 | The number of items to return. If not set the limit is 1000. | |
in query | offset | integer | 0 | The number of items to skip before starting to collect the result set. | |
in query | orderBy | ||||
in query | sortDirection |
200 - OK The response for a transmission collection request.
400 - Bad Request - Generic or business logic validation error.
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}
Returns a transmission for the given id.
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | transmissionId | string | ORDERTRANSMISSION-10000 | Required | The transmission identifier. |
200 - OK The response for one transmission request.
400 - Bad Request - Generic or business logic validation error.
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.
/transmission-updates
Bulk create processes to update statuses of transmissions.
A process will be created for each transmission, which will be processed asynchronously.
207 - Multi-Status Contains multiple responses for different requests, that was done within one single request.
400 - Bad Request - Generic or business logic validation error.
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.
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
| Example: 2018-02-27T07:15:37.562Z
date-time
| Example: 2018-02-27T07:15:40.562Z
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
| Example: 2018-02-28T07:15:40.562Z
date-time
| Example: 2018-02-28T07:45:40.562Z
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
| Example: 2018-02-27T07:15:37.562Z
date-time
| Example: 2018-02-27T07:15:40.562Z
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
| Example: 2018-02-28T07:15:40.562Z
date-time
| Example: 2018-02-28T07:45:40.562Z
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