Technical Descriptions
- ser_hcskb_api
- Faruk Mercan
Data Transfer Objects
The interface uses data transfer objects (DTOs) for defining 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
OpenApi
Use these descriptions if you are using our OpenApi for Shippers and Partners in PUSH (inbound) and / or PULL (outbound) setup.
Version 2 (latest):
Documentation: API for Shippers and Partners v2
Description: https://xch.transporeon.com/openapi/v2/swagger.json
Version 1 (deprecated):
Documentation: API for Shippers and Partners
Description: https://xch.transporeon.com/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 Shippers (Push Notifications)
Description: https://xch.transporeon.com/openapi/v2/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.
SOAP
The following WSDL specifies our SOAP webservice in PUSH (inbound) and PULL (outbound) setup.
https://xch.transporeon.com/soap/2.1/?WSDL
XSD
Use the following description for these scenarios:
Receiving push messages from us
Pushing data to us with other protocols (e.g., SFTP, AS/2, plain HTTPS POST)
https://xch.transporeon.com/openapi/v2/schema.xsd
TP Essentials Template
You can download the Excel template for TPE (Transporeon Essentials) uploads at the following link: