Assigned Transports Interface

Transports

Transport data are exported

• After assignment (Best Carrier)

• After acceptance (No-Touch Order)

• On any relevant change¹ after the transport has been assigned or accepted

¹ Relevant change is defined as a change of any field mapped in the export format, except system timestamps and fields associated with control flow logic not representing changes of actual contents.

In addition to the Transporeon standard data formats and API servers, we also support exporting data in Soloplan format.

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Attachments

The Assigned Transports Interface also includes the export of attachments (files). Usually we only export metadata, but also the export of the actual files can be enabled.

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Attachment Upload Interface

The Attachment upload interfaces includes attachments (files) upload on transport level and delivery level to the Transporeon Platform.

Booked Time Slots Interface

An export is generated by Transporeon whenever one of the below listed events for a booking occurs. A qualifier that specifies the event is included in the Transporeon standard XML export file. See DTO description for further details.

Events:

• A booking has been created by the carrier (booking.created)

• A booking has been updated by the shipper or carrier (booking.modified)

• A booking has been cancelled by the shipper or carrier (booking.cancelled)

• A reservation has been created

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Booking number}_#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Attachments

The Booked Time Slots Interface also includes the export of attachments (files). Usually we only export metadata, but also the export of the actual files can be enabled.

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Event Management Interface

Event Management Interface includes sending event management data on transport level and delivery level to the Transporeon Platform.

Loading Commission Printout Interface

This interface provides exports of the loading commission of assigned transports from Transporeon-Web for carriers in PDF format.

An export file is generated by Transporeon whenever one of the below listed events occurs.

Events:

• A transport has been assigned to the carrier by the shipper

• A transport has been accepted by the carrier

• A transport has been modified by the shipper

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Customer Number of Shipper}_#{Sequence Number}.pdf}

Offer Placement and Transport Acceptance Interface

Transports

You receive transports for the following purposes:

• Best-Carrier transports for offer placement

• No-Touch-Order transports for acceptance

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Offer Placement

Offer placement includes the following processes:

• Placing offers

• Withdrawing offers

• Declining offers

• Placing a change request

• Cancelling a change request

• Getting change request acceptance

• Getting change request decline

Transport Acceptance

Transport acceptance includes the following processes:

• Accepting no-touch order transports

• Declining no-touch order transports

Change Requests

With this DTO you can request certain changes for transports or deliveries / orders.

The shipper can then either accept or decline your change requests.

Afterwards you will receive feedback about their decision.

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Transport Number of Shipper}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Creation of Shipments

This interface provides the possibility to create shipments for a shipper. Depending on individual business processes, the shipper can accept or decline such shipments.

Surcharge Interface

Surcharge interface provides the following functionalities:

• Request surcharges

• Receive data for surcharge requests that have been accepted or declined by the shipper.

File name pattern for outbound files:

^{#{yyyyMMddHHmmss}_#{Customer Number}_[#{Shipper Id}_]#{Transporeon Id}_#{Event Qualifier}_#{Sequence Number}.xml}

Note, the {Shipper Id} part is optional. It can be enabled on request.

Transport Data Editing Interface

This interface provides

• Editing transport, delivery / order  and delivery / order item parameters, which are allowed and requested to edit by shipper

The parameters which can be updated are defined by the shipper. Editable parameters are marked accordingly within the Assigned Transports interface. For more details please refer to Assigned transports interface documentation.

Settlements

Settlements includes the following processes:

• Accepting an existing settlement

• Declining an existing settlement

• Displaying a list of settlements

See also

• Communication

• Technical Descriptions (CI)