Prerequisites
- A subscribed Deliveo API connection.
- Permission to install the add-on.
- Permission to use the add-on.
Installation and access
The add-on can be installed on the DispatcherThe Dispatcher member of the Courier Service team. Manages customers and dispatches couriers. He/she uses the Deliveo dispatcherThe Dispatcher member of the Courier Service team. Manages customers and dispatches couriers. He/she uses the Deliveo dispatcher (admin) portal. (admin) portal. Portal under the ‘Add-ons’ menu item. After installation, it can be accessed via the ‘Add-ons / Status Import’ menu item. Only users with the appropriate authorisation may carry out the installation and use the add-on.
Uploading files
The add-on supports the following file formats:
- CSV
- XLSX
- XLS
The maximum file size for upload is 10 MB. The file must contain a header row. The system uses the column names in the header to match the file’s columns with the Deliveo fields.
To upload the file:
- Open the ‘Add-ons / Status Import’ menu item.
- Drag the file into the upload area, or click to browse.
- Select the file to be processed.
- Click the Upload button.
Once the upload is complete, the field mapping interface and a preview of the file’s contents will appear.
Field mapping
To process the file, you must map its columns to the corresponding fields in Deliveo.
Mandatory fields
Consignment ID
Select the file column that contains the consignment ID.
ShipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units., even if it consists of several Packing Units. ID type
The following ID types can be used:
- DeliveoIDUnique primary identifier for shipments in the Deliveo system.
- ESID (External ShipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units., even if it consists of several Packing Units. ID, ID received from a partner)
The selected ID type must match the type of IDs contained in the file.
Additional fields that can be matched
Recipient’s name
The name of the person receiving the consignment.
Date of delivery
The date and time of successful delivery.
The time entered cannot be earlier than the time of the shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units.’s most recent status change.
Payment method
Accepted values:
CASH– cash paymentCARD– payment by bank card
Failed status ID
The status ID associated with a failed delivery. This ID is found in the first column of the table under the Settings / Bounce menu item.
Failure date and time
The date and time of the failed delivery event. It is not necessary to map all optional fields. Only map those fields that appear in the uploaded file and that you wish to import.
Saving the mapping template
The configured field mapping can be saved using the ‘Save Template’ button. If you later upload a file with the same column headers, the system will automatically apply the previously saved mapping. This speeds up processing for status files that are regularly received in the same format. The current mapping can be reset using the ‘Reset’ button.
Processing statuses
After mapping the fields, click the ‘Process statuses’ button. The system will, line by line:
- searches for the consignment based on the specified identifier;
- checks the imported data;
- applies the appropriate status change;
- display the result of the processing.
Processing result
Once processing is complete, the system displays a summary:
- number of rows processed;
- number of rows processed successfully;
- number of faulty rows;
- progress of the processing;
- detailed error messages for the faulty rows.
In the event of an error, the system displays:
- the number of the faulty line;
- the consignment ID;
- the cause of the error.
For example, processing may fail if the delivery time specified in the file is earlier than the time of the shipmentSend to An identifier that groups together packages sent from a Sender to a Recipient by a Customer at the same time. In practice, this is understood to mean the entire shipment, even if it consists of several Packing Units.’s most recent status change. The error only prevents the affected line from being processed. The other rows containing valid data can be processed.
Common errors
The consignment cannot be found
Please check:
- the consignment ID;
- the selected ID type;
- whether the file contains a DeliveoIDUnique primary identifier for shipments in the Deliveo system. or ESID;
- whether the identifier contains any unnecessary spaces.
The date is earlier than the date of the most recent status change
The status date cannot be earlier than the date of the consignment’s most recent status.
Please correct the date and time in the file, then upload the file again.
The payment method is not accepted
Please use only the following values in the payment method field:
CASHCARD
The file columns are not displayed
Please check that:
- the file contains a header row;
- the header fields are not empty;
- the file is in CSV, XLSX or XLS format;
- the file size does not exceed 10 MB.
An incorrect field has been mapped
Click the ‘Reset’ button, then reconfigure the field mappings. If you previously saved an incorrect template, save the correct settings again.