Download OpenAPI specification:Download
The transmission REST API supports tasks to view and manage transmissions of the IOM.
Returns all transmissions for selected search criterias.
creationDate[gte] required | string <date-time> The earliest creation date of a transmission. |
creationDate[lte] required | string <date-time> The latest creation date of a transmission. |
transmissionTypes | Array of strings (TransmissionType) Items Enum: "ORDERTRANSMISSION" "DISPATCHTRANSMISSION" "RETURNTRANSMISSION" "PAYMENTTRANSMISSION" "MAILTRANSMISSION" "RESPONSETRANSMISSION" "INVOICETRANSMISSION" "DOCUMENTTRANSMISSION" "RETURNANNOUNCEMENTTRANSMISSION" Example: transmissionTypes=ORDERTRANSMISSION |
transmissionSubtypes | Array of strings (TransmissionSubtype) Items Enum: "ORDER_CHECKED" "ORDER_ANNOUNCEMENT" "ORDER_BACKLOG" "ORDER_RECALL" "ORDER_CONFIRMATION" "ORDER_RECALL_REQUEST" "ORDER_BACKLOG_REQUEST" "ORDER_APPROVAL" "ORDER_RESEND" "DISPATCH_SEND" "DISPATCH_REQUEST_NEW" "RETURN_SEND" "RETURN_CONFIRMATION" "RETURN_REJECT" "RETURN_REQUEST_NEW" "PAYMENT_SEND" "MAIL_ORDER" "MAIL_ORDER_MERGE" "MAIL_READY_FOR_PICKUP" "MAIL_ORDER_COMMISSIONED" "MAIL_TEMPORARY_RESPONSE" "MAIL_INITIAL_RESPONSE" "MAIL_COUNTINUOUS_RESPONSE" "MAIL_DISPATCH" "MAIL_DISPATCH_IMMATERIAL" "MAIL_RETURN_CAN" "MAIL_RETURN_RCL" "MAIL_RETURN_INV" "MAIL_RETURN_RET" "MAIL_RETURN_DEF" "MAIL_PAYMENT_REMINDER" "MAIL_DELIVERY_DELAY" "MAIL_INVOICE" "MAIL_CEDIT_NOTE" "MAIL_RETURN_RCL010" "MAIL_RETURN_RCL020" "MAIL_RETURN_RCL021" "MAIL_RETURN_RCL045" "MAIL_RETURN_RCL980" "MAIL_RETURN_REJECTED" "MAIL_DISPATCH_INVOICE" "MAIL_RETURN_CREDIT_NOTE" "MAIL_RETURN_CAN_CREDIT_NOTE" "MAIL_RETURN_RCL_CREDIT_NOTE" "MAIL_RETURN_INV_CREDIT_NOTE" "MAIL_RETURN_RET_CREDIT_NOTE" "MAIL_RETURN_DEF_CREDIT_NOTE" "MAIL_RETURN_RCL010_CREDIT_NOTE" "MAIL_RETURN_RCL020_CREDIT_NOTE" "MAIL_RETURN_RCL045_CREDIT_NOTE" "MAIL_RETURN_REFUNDED" "MAIL_RETURN_RCL980_CREDIT_NOTE" "MAIL_RETURN_RCL021_CREDIT_NOTE" "MAIL_RETURN_LABEL" "MAIL_RETURN_ANNOUNCEMENT" "MAIL_RETURN_ANNOUNCEMENT_TRANSMISSION" "RESPONSE_SEND" "RESPONSE_CONFIRMATION" "RESPONSE_REQUEST_NEW" "RESPONSE_TEMPORARY" "RESPONSE_INITIAL" "RESPONSE_CONTINUOUS" "INVOICE_CREATE_DOCUMENT" "INVOICE_DEBITOR_SEND" "INVOICE_OPEN_ITEM_SEND" "DOCUMENT_SUPPLIER_DELIVERY_NOTE_SEND" "DOCUMENT_SUPPLIER_RETURN_SLIP_SEND" "DOCUMENT_SUPPLIER_ORDER_RETURN_LABEL_SEND" "DOCUMENT_SHOP_DELIVERY_NOTE_SEND" "DOCUMENT_SHOP_RETURN_SLIP_SEND" "DOCUMENT_SHOP_ORDER_RETURN_LABEL_SEND" "DOCUMENT_SHOP_INVOICE_CREDIT_NOTE" "RETURN_ANNOUNCEMENT_SEND" "OTHERS" Example: transmissionSubtypes=MAIL_ORDER |
transmissionStatuses | Array of strings (TransmissionStatus) Items Enum: "INITIAL" "DO_PULL" "PULLED" "DO_PUSH" "PUSHED" "DO_MANUAL_CHECK" "CHECKED" "DO_CANCEL" "CANCELED" "TRANSMISSIONED" "CONFIRMED" Example: transmissionStatuses=CONFIRMED |
transmissionResponseStatuses | Array of strings (TransmissionResponseStatus) Items Enum: "OK" "INVALID" "REJECTED" "EXTERNAL_ERROR" "INTERNAL_ERROR" "NOT_AVAILABLE" Example: transmissionResponseStatuses=REJECTED |
receiverTypes | Array of strings (ReceiverType) Items Enum: "OMS" "SHOP" "SUPPLIER" "CUSTOMER" "PAYMENTPROVIDER" "FINANCECONTROLLER" Example: receiverTypes=SHOP |
shopIds | Array of integers <int64> Example: shopIds=1 |
supplierIds | Array of integers <int64> Example: supplierIds=1 |
limit | integer Default: 1000 Example: limit=50 The number of items to return. |
offset | integer Default: 0 Example: offset=0 The number of items to skip before starting to collect the result set. |
orderBy | string (SortableTransmissionAttribute) Default: "id" Enum: "id" "transmissionType" "transmissionSubtype" "status" "responseStatus" "creationDate" "modificationDate" "shopOrderNumber" "orderId" "shopId" "shopName" "supplierId" "supplierName" "receiverType" "retryCount" "retryDate" "nextRetryDate" "errorText" Example: orderBy=creationDate The attribute on which should be sorted. |
sortDirection | string (SortDirection) Default: "ASC" Enum: "ASC" "DESC" Example: sortDirection=ASC The sort direction the attribute should be sorted with. |
The response for a transmission collection request.
Bad request - Generic or business logic validation error.
Unauthorized - Authentication information is missing or invalid.
Forbidden - the user is not authorized to use this resource.
Not Acceptable - A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.
Internal Server Error - An unexpected error occured.
The production API server.
{- "meta": {
- "totalCount": 10000
}, - "data": [
- {
- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "id": "ORDERTRANSMISSION-10000",
- "transmissionType": "ORDERTRANSMISSION",
- "transmissionSubtype": "MAIL_ORDER",
- "status": "CONFIRMED",
- "responseStatus": "REJECTED",
- "creationDate": "2020-04-16T16:12:29Z",
- "modificationDate": "2020-04-16T16:12:29Z",
- "orderId": 10026,
- "shopOrderNumber": 20180303123,
- "shopId": 1000,
- "shopName": "Test Shop US DE",
- "supplierId": 1000,
- "supplierName": "Test Supplier US DE",
- "receiverType": "SHOP",
- "retryCount": 2,
- "retryDate": "2020-04-16T16:12:29Z",
- "nextRetryDate": "2020-04-16T16:12:29Z",
- "errorText": "This was no error, because the status was set OK."
}
]
}
Returns a transmission for the given id.
transmissionId required | string Example: ORDERTRANSMISSION-10000 The transmission identifier. |
The response for one transmission request.
Bad request - Generic or business logic validation error.
Unauthorized - Authentication information is missing or invalid.
Forbidden - the user is not authorized to use this resource.
Not Acceptable - A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.
Internal Server Error - An unexpected error occured.
The production API server.
{- "links": [
- {
- "href": "string",
- "rel": "string"
}
], - "id": "ORDERTRANSMISSION-10000",
- "transmissionType": "ORDERTRANSMISSION",
- "transmissionSubtype": "MAIL_ORDER",
- "status": "CONFIRMED",
- "responseStatus": "REJECTED",
- "creationDate": "2020-04-16T16:12:30Z",
- "modificationDate": "2020-04-16T16:12:30Z",
- "orderId": 10026,
- "shopOrderNumber": 20180303123,
- "shopId": 1000,
- "shopName": "Test Shop US DE",
- "supplierId": 1000,
- "supplierName": "Test Supplier US DE",
- "receiverType": "SHOP",
- "retryCount": 2,
- "retryDate": "2020-04-16T16:12:30Z",
- "nextRetryDate": "2020-04-16T16:12:30Z",
- "errorText": "This was no error, because the status was set OK."
}
Bulk create processes to update statuses of transmissions.
A process will be created for each transmission, which will be processed asynchronously.
id | string The transmission identifier. |
updateType | string (TransmissionUpdateType) Enum: "RESEND" "CANCEL" "SENT" The type of process to create on a transmission, e.g. to resend a transmission. |
Created - The entity was created successfully.
Contains multiple responses for different requests, that was done within one single request.
Bad request - Generic or business logic validation error.
Unauthorized - Authentication information is missing or invalid.
Forbidden - the user is not authorized to use this resource.
Not Acceptable - A representation of the response in the media type that was requested in the ACCEPT header cannot be provided.
Unsupported Media Type - The media type of the sent body is not supported.
The production API server.
[- {
- "id": "ORDERTRANSMISSION-10000",
- "updateType": "RESEND"
}
]
{- "meta": {
- "successCount": 100,
- "failureCount": 5
}, - "data": [
- {
- "link": {
- "href": "string",
- "rel": "string"
}, - "status": 400,
- "errors": [
- {
- "code": "VALIDATION_EXCEPTION",
- "message": "Attribute XYZ is mandatory",
- "value": { }
}
]
}
]
}