Upload (document only)
Example filename: 201903151242_shipment_1.0_12345_T103_filename.pdf
Using this method, only the document itself is needed but the filename must strictly follow the below described format, as the for the upload necessary metadata will be parsed from the filename.
Filename format: <creationDate>_<messageType>_<messageTypeVersion>_<reference>_<documentTypeCode>_<filename>.<fileExtension>
| Property | Type | Mandatory | Description |
|---|---|---|---|
<creationDate> | String | M | Creation date and time |
<messageType> | String | M | Valid message types: clientTransportOrder, shipment |
<messageTypeVersion> | String | M | Will be provided by our IT contact (default 1.0) |
<reference> | String | M | Reference used in the related message type (e.g. for shipment use trackingID). Needs to be aligned with IT contact. |
<documentTypeCode> | String | M | SPOT 4-letter document code. (Document type code list) |
<filename> | String | M | Filename of upload document, can be any filename chosen by customer. |
<fileExtension> | String | M | Fileextension. E.g.: .pdf |
Upload (Document + metadata)
Example document name: hardcopyPOD_12345.pdf Example metadata name: hardcopyPOD_12345.xml
For the second method an additional metadata file is needed. This allows for the use of multiple and additional reference types. It is recommended to give the metadata file the same name as the document.
FTP folder: /in/transport/document
Both files (document and metadata) need to be provided in a 30 minute time window to each other. If this is not the case they will be discarded.
DocumentMetadata
{
"filename": "testdocument.pdf",
"file": "...",
"accountNumber" : "926989",
"partyId" : "2496735",
"messageType" : "shipment",
"messageVersion": "1.0",
"documentType" : "T103",
"references": [{...}]
}| Property | Type | EDI Mandatory | API Mandatory | Description |
|---|---|---|---|---|
| filename | String | M | M | Filename of document |
| file | String | O | Base 64 encoded file. | |
| accountNumber | String | C | SPOT Address book account number | |
| partyId | String | C | SPOT Address book Party number | |
| messageType | String | M | Valid message types: clientTransportOrder, shipment | |
| messageVersion | String | M | Will be provided by our IT contact (default 1.0) | |
| documentType | String | M | M | SPOT 4-letter document code. (Document type code list) |
| references | Array[DocumentUploadReferences] | M | M | Array of references used to find shipment. |
TransportDocumentUploadReferences
"...": {
"type": "TRACKING_ID",
"value": "100149780",
"key": "string"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| type | String | M | Type of reference. Valid values: TRACKING_ID, MAWB, HAWB, MBL, HBL, JOBFILE_UWK_POSITION |
| value | String | M | Reference value. |
| key | String | O | Key for referenceNumber assignment (For example EDI-Partner reference type). |