IntershopIOM - 1.1 - Transmission

IOM Transmission REST API (1.1)

Download OpenAPI specification:Download

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

Authentication

bearerAuth

JWT Bearer token

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

basicAuth

Basic Authentication

Security Scheme Type HTTP
HTTP Authorization Scheme basic

transmission

Transmission related operations exposed by this service.

Get transmissions by search criterias.

Returns all transmissions for selected search criterias.

Authorizations:
query Parameters
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.
If not set the limit is 1000.

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.

id - Sort by the identifier in scope of it's type.
transmissionSubtype - Sort by the subtype of the transmission.
status - Sort by the processing status.
responseStatus - Sort by the response status.
creationDate - Sort by the creation date.
modificationDate - Sort by the modification date.
orderId - Sort by the id of the order.
shopOrderNumber - Sort by the shop order number.
shopId - Sort by the id of the shop.
shopName - Sort by the name of the shop.
supplierId - Sort by the id of the supplier.
supplierName - Sort by the name of the supplier.
receiver - Sort by the receiver of the transmission.
retryCount - Sort by the number of sending attempts.
retryDate - Sort by the date of the last attempt to send.
nextRetryDate - Sort by the next date to send.
errorText - Sort by the possible error message of the transmission.

sortDirection
string (SortDirection)
Default: "ASC"
Enum: "ASC" "DESC"
Example: sortDirection=ASC

The sort direction the attribute should be sorted with.

ASC - Sort by the attribute ascending.
DESC - Sort by the attribute descending.

Responses

200

The response for a transmission collection request.

400

Bad request - Generic or business logic validation error.

401

Unauthorized - Authentication information is missing or invalid.

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.

get /transmissions

The production API server.

{protocol}://{domain}:{port}/rest/transmissions

Response samples

Content type
application/vnd.intershop.transmission.v1+json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "data":
    [
    ]
}

Get a transmission by id.

Returns a transmission for the given id.

Authorizations:
path Parameters
transmissionId
required
string
Example: ORDERTRANSMISSION-10000

The transmission identifier.

Responses

200

The response for one transmission request.

400

Bad request - Generic or business logic validation error.

401

Unauthorized - Authentication information is missing or invalid.

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.

get /transmissions/{transmissionId}

The production API server.

{protocol}://{domain}:{port}/rest/transmissions/{transmissionId}

Response samples

Content type
application/vnd.intershop.transmission.v1+json
Copy
Expand all Collapse all
{
  • "links":
    [
    ],
  • "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."
}

transmissionUpdate

Bulk create processes to update statuses of transmissions.

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

Authorizations:
Request Body schema: application/vnd.intershop.transmission.v1+json
Array
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.

RESEND - Resend the transmission.
CANCEL - Cancel the transmission.
SENT - Set the transmission as already sent.

Responses

201

Created - The entity was created successfully.

207

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.

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.

post /transmission-updates

The production API server.

{protocol}://{domain}:{port}/rest/transmission-updates

Request samples

Content type
application/vnd.intershop.transmission.v1+json
Copy
Expand all Collapse all
[
  • {
    }
]

Response samples

Content type
application/vnd.intershop.transmission.v1+json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "data":
    [
    ]
}