Data Transfer Objects

The interface uses data transfer objects (DTOs) to define data to be transferred between Transporeon and the customer’s system. They are used in inbound direction to feed our backends and outbound messages to send corresponding data.

The DTOs are defined independently of the transport protocol in use.

Technical descriptions

To maximize flexibility, you have the option to integrate with our platform in several ways.

OpenApi

Use these descriptions if you are using our OpenApi for Carriers and you want to push data to our servers (inbound) and / or pull data from our servers (outbound).

• Documentation: API for Carriers

• Description: https://xch.transporeon.com/carrier_interface/openapi/v1/swagger.json

OpenApi Push Notifications

Use these descriptions if you want to receive push notifications from our servers (outbound). For this scenario, it is required that you provide REST endpoints according to the following OpenApi specification:

• Documentation: API for Carriers (Push Notifications)

• Description: https://xch.transporeon.com/carrier_interface/openapi/v1/swagger-push.json

If it is not feasible to implement a REST API based on the specification, an alternative approach would be to send messages to your system in XML format to a single endpoint using either POST or PUT methods. For further details, please consult the XSD section provided below.

XSD

Use the following description for these scenarios:

• Receiving PUSH messages from us

• Pushing data to us

This applies to all file-based protocols, e.g. SFTP, AS/2, and plain HTTPS POST / PUT.

Schemas

• Attachment (Customer -> Transporeon)

• Attachment (Transporeon -> Customer)

• place_offer

• withdraw_offer

• change_request

• delete_change_request

• delivery_item_update

• accept_transport

• decline_transport

• parameter_update

• process_status

• change_request_accepted

• change_request_declined

• price_items

• transport / tour

• tsmBooking2Carrier

SOAP

The following WSDLs specify our SOAP webservice for PUSH (inbound) messages.

SOAP services are deprecated. Please consider other protocols for new integrations.

• https://xch.transporeon.com/carrier_interface/best_carrier?WSDL

• https://xch.transporeon.com/carrier_interface/no-touch_order?WSDL

• https://xch.transporeon.com/carrier_interface/parameter?WSDL

• https://xch.transporeon.com/carrier_interface/transportvisibility/soap?WSDL

• https://xch.transporeon.com/carrier_interface/attachment?wsdl