Receive (metadata file)
Example filename: 201903151242_shipment_1.0_12345_T103_filename.pdf
- Receive metadata file including
base64
encoded document
Filename format: <creationDate>_<messageType>_<messageTypeVersion>_<reference>_<documentTypeCode>_<filename>.<fileExtension>
{
"messageHeader":{...},
"document":{...}
}
Property | Type | Mandatory | Description |
---|---|---|---|
messageHeader | MessageHeader | M | Message Header information. |
document | document | M | metadata and payload |
Document
{
"trackingId": "123456789",
"documentNumber": "T103",
"documentName": "T103 - Proof of Delivery (hardcopy)",
"filename": "585986_1709212002936.pdf",
"documentId": "PR1450317393",
"fileSize": 104715,
"mimeType": "application/pdf",
"uploadedAt": 1709212307736,
"file": "base64 encoded document"
}
Property | Type | Mandatory | Description |
---|---|---|---|
filename | string | M | Original filename as in SPOT system. |
file | string | M | the file it self in base64 encoding |
documentTypeCode | string | M | SPOT 4-letter document code. (Document type code list) |
documentName | string | M | name of document type |
documentId | string | M | documentId |
fileSize | intiger | M | filesize in bytes |
mimeType | string | M | mimeType |
uploadedAt | string | M | timestamp of upload |
Receive (document only)
Example filename: 201903151242_shipment_1.0_12345_T103_filename.pdf
- Using this method you will receive only the document itself in *.pdf format without addtional metadata file.
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: shipment |
<messageTypeVersion> | String | M | Will be provided by our IT contact (default 1.0) |
<reference> | String | M | trackingID |
<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 |