Attachment (CI, Inbound)
- ser_hcskb_api
This DTO is used for attachment (file) upload on transport- and delivery level to the Transporeon Platform.
If an attachment is uploaded on transport level, the fields delivery_id and delivery_number must be set null / empty. Please do not fill them with 0.
If an attachment is set on delivery level, the fields delivery_id or delivery_number must be filled.
Provide transport_id in both cases.
For attachment qualifiers, see Attachment Qualifiers
File contents must be base64 encoded. See the field description for more details.
Field | Mandatory | Description |
|---|---|---|
transport_id | True | Unique Transporeon-ID. |
delivery_id | For attachments on delivery level | Unique Transporeon delivery ID – please provide either delivery_id or delivery_number. If both are provided, delivery_id has precedence. |
delivery_number | For attachments on delivery level | Identifies the delivery / order uniquely in the shipper's system. |
scheduler_email | False | E-mail address of the responsible scheduler. Transporeon will match the provided e-mail address with the schedulers registered and active for that company. In case no match can be found or no e-mail is given a system user will instead be shown as the responsible scheduler. |
qualifier | True | Identifies the type of the uploaded attachment. |
description | False | Description of the uploaded attachment |
filename | True | File name of the uploaded attachment. We allow to upload files with extensions bmp, jpeg, jpg, pdf, png, tif and tiff. |
data | True | File contents. Must be base64 encoded without line feeds. See RFC 4648 chapter 4. |
Â