Upload (PDF only)
Using this method, only the document in '.pdf.' format 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.
Example filename: 201903151242_dispatchOrder_1.0_12345_deliveryNote_filename.pdf
Filename format:
<creationDate>_<messageType>_<messageTypeVersion>_<reference>_<documentTypeCode>_<filename>.<fileExtension>>
| Property | Type | Length | Mandatory | Description |
|---|---|---|---|---|
<creationDate> | String | 12 | M | Creation date and time |
<messageType> | String | 20 | M | Valid message types: items, receiptAviso, receiptOrder, dispatchOrder |
<messageTypeVersion> | String | 3 | M | Will be provided by our IT contact (default 1.0) |
<reference> | String | 35 | M | Reference used in the related message type (e.g. for dispatchOrder use customerReference1) |
<documentTypeCode> | String | 20 | M | Type which document is uploaded. Valid types: deliveryNote, invoice, label |
<filename> | String | 35 | M | Filename of upload document, can be any filename chosen by customer. |
<fileExtension> | String | 5 | M | Fileextension. E.g.: .pdf |
In case of Labels/Parcels, it's important do be sure that correct data format has been choosen. Allowed document formats are: PDF Allowed size of single document/file is 5 MB max.
Upload (metadata file)
This method allows to use multiple reference types.
This upload version allows 2 options:
1. Upload document + metadata file
Example document name: dispatchOrder_12345.pdf
Example metadata name: dispatchOrder_12345.xml
In this upload version a document file and a metadata file is uploaded. It is recommended to give the metadata file the same name as the document. The optional file element of the metadata file is not used in this case.
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.
2. Upload metadata file including Base64 encoded document
In this upload version only a metadata file is uploaded. The document itself is uploaded Base64 encoded in the optional file element of the metadata file.
In case of Labels/Parcels, it's important do be sure that correct data format has been choosen. Allowed document formats are: PDF, ZPL. Please remember that in cace of processing of documents as metadata file, they have to be Base64 encoded. Allowed size of single document/file is 5 MB max.
MetadataDocument
{
"filename" : "dispatchOrder_12345.pdf",
"file":"...",
"location" : "TES",
"operative" : "TESTICC",
"messageType" : "dispatchOrder",
"messageVersion": "1.0",
"documentType" : "deliveryNote",
"references":[{...}]
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| filename | String | M | Filename of upload document, can be any filename chosen by customer. |
| file | String | O | Base 64 encoded file. |
| location | String | M | Location code of warehouse, announced by IT contact. |
| operative | String | M | Operative (customer) code in warehouse, announced by IT contact. |
| messageType | String | M | Valid message types: items, receiptAviso, receiptOrder, dispatchOrder |
| messageVersion | String | M | Will be provided by our IT contact (default 1.0) |
| documentType | String | M | The document type, e.g. deliveryNote, invoice, label, itemlabel. |
| references | Array[DocumentUploadReferences] | M | Array of references used to find the order. |
LogisticsDocumentUploadReferences
"...": {
"type": "customerReference1",
"value": "30001486"
}| Property | Type | Mandatory | Description |
|---|---|---|---|
| type | String | M | Type of reference. Valid values: customerReference1, customerReference2, orderNumber, invoiceNumber, deliveryNoteNumber |
| value | String | M | Reference value. |
LogisticsDocumentUploadDetails
Please be adviced that besides Labels and Parcels, Invoices and Delivery notes could be also uploaded using options mentioned and described above - In case of such documents to be uploaded to us, please be sure that all the rules stated are followed and format for Invoices and Delivery notes is set for A4. In case of need for more details on this topic, please contact us.