File (CI, Outbound)
This DTO is used to export files to your system. It is mainly in use for the Loading Commission Printout Interface, not to be confused with Attachments on Transporeon Platform.
Please note this DTO is only in use for API calls. We put the PDF files directly on the SFTP server or provide it as AS/2 message if you choose these protocols. You might be still interested in the filename convention described below.
Field Description
Field | Description | Type | Mandatory | Remarks |
---|---|---|---|---|
transportId | Unique Transporeon Transport ID | Long (64 bit) | True | |
transportNumber | Shipper's transport number | C | True | |
name | Filename | C | True | See paragraph below about filename convention |
content | Payload | C | True | Data are base64 encoded |
Filename convention
The file name is structured as follows:
timestamp_transportId_transportNumber_eventQualifier_shipperId_randomSeqNumber.pdf
Examples
Transport has been assigned or accepted:
20200928164243_699999999_33333000_transport.assigned_228168_969.pdf
Shipper has modified the assigned transport:
20200928164243_699999999_33333000_transport.assigned.modified_228168_969.pdf