The Deliveo Website Plugin (DWP) is a Deliveo module that can be integrated into a website, enabling website visitors or customers to post parcels directly, check the status of their existing parcels and, depending on the authorised functions, carry out additional actions.
The DWP connects to the system via the Deliveo API, so an active Deliveo subscription and API access are required to use it.
The module can be integrated into your own website, making it particularly useful for courierThe person who delivers Shipments to the recipient. services that want their customers to be able to book or track parcels without having to register separately or use the Deliveo Customer Portal.
Key features
Among other things, the DWP provides the following functions:
-
creating a new consignment;
-
selecting a delivery option;
-
selecting a collection point;
-
managing cash on delivery;
-
using reference numbers and tracking codes;
-
Managing custom fields OP1–OP3;
-
Calculating postage;
-
calculating volumetric weight;
-
Online payment via Barion;
-
Tracking a consignment;
-
displaying tracking information;
-
downloading labels;
-
downloading the signature sheet;
-
modifying or cancelling a consignment where permitted;
-
initiating the return of a delivered consignment.
Some of the available functions can be enabled or disabled in the settings.
Sending a consignment
One of the main functions of DWP is the creation of new consignments. On the consignment submission interface, the user can enter the details required for the consignment’s delivery, after which DWP forwards these to the Deliveo system.
Sender’s details
Under ‘Sender details’, the information required for the collection point and contact person can be entered. This may include, for example:
-
name;
-
company name;
-
country;
-
postcode;
-
town;
-
address;
-
telephone number;
-
email address.
The fields that actually appear may depend on the version and configuration of DWP.
Recipient’s details
For the recipient’s details, you must provide the information required for delivery. As with the sender, you can enter the recipient’s contact and address details here.
Use of a Parcel Point
DWP is capable of displaying active ‘Parcel Point’ locations created in Deliveo. A Parcel Point can be selected separately:
-
on the collection page;
-
on the delivery side.
This means that a consignment can be dispatched from a parcel point, delivered to a parcel point, or – depending on the options provided by the courierThe person who delivers Shipments to the recipient. service – a parcel point can be used on both sides. DWP imports parcel points directly from the Deliveo system; therefore, they are managed not in DWP but within the relevant master data in Deliveo.
Managing the invoice payer
DWP can be used in two ways, depending on whether all online postings relate to the same Customer.
Using a fixed Customer
A fixed Customer ID can be specified in the configuration. In this case:
-
every 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. created via DWP is assigned to this Customer;
-
no separate ‘Billing Contact’ block is displayed to the visitor;
-
the billing relationship is determined by the Customer specified in the configuration.
This can be used for websites where the DWP is provided for a single contracted Customer.
Creating a Customer from the specified details
If no fixed Customer is set up, the visitor can enter the bill payer’s details. Based on these, the DWP checks whether the relevant Customer already exists in the Deliveo system.
If one is found, the existing clientThe Customer (bill payer) pays the Courier Service for the delivery of parcels. You can also be the sender / recipient of the shipment. He/she uses the Deliveo customer interface. is used. If no matching clientThe Customer (bill payer) pays the Courier Service for the delivery of parcels. You can also be the sender / recipient of the shipment. He/she uses the Deliveo customer interface. is found, the DWP creates one based on the details provided and then links the new consignment to that clientThe Customer (bill payer) pays the Courier Service for the delivery of parcels. You can also be the sender / recipient of the shipment. He/she uses the Deliveo customer interface..
Consignment contents and ColliPackaging unit. Shows how many pieces are included in a given shipment.s
A consignment may consist of one or more physical parcels, i.e. ColliPackaging unit. Shows how many pieces are included in a given shipment.s. In the DWP, multiple ColliPackaging unit. Shows how many pieces are included in a given shipment.s can be added to the same consignment. The following details, amongst others, can be specified for each ColliPackaging unit. Shows how many pieces are included in a given shipment.:
-
weight;
-
length;
-
width;
-
height;
-
unique identifier.
The DWP determines the aggregate details of the consignment from the data for each ColliPackaging unit. Shows how many pieces are included in a given shipment.k.
Total weight and total volume
Where multiple parcels are used, the system aggregates their weight and volume. Based on the parcel dimensions provided, the DWP also automatically calculates the volumetric weight.
Volume weight ensures that large but relatively light parcels are also taken into account correctly when calculating the charge.
Delivery options
You can select a Delivery Option created in Deliveo for the consignment. DWP retrieves the available Delivery Options from the Deliveo system; therefore, these are created and managed via 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.
Using the Delivery Option, the courierThe person who delivers Shipments to the recipient. service can offer various service types, for example with different delivery or collection conditions.
Cash on Delivery
The DWP supports the recording of cash-on-delivery consignments. If a consignment is subject to cash on delivery, the amount due and the associated details can be specified. Cash on delivery is managed in Deliveo in accordance with the standard cash-on-delivery process.
Reference number and tracking code
The following can be specified for the consignment:
-
Reference number;
-
Tracking code.
These can be used to link external systems, online shops or customer-side processes’ own identifiers to the Deliveo consignment.
OP1–OP3 custom fields
The DWP supports Deliveo’s OP1, OP2 and OP3 fields. These are custom data fields that can be used to request additional information required for the courierThe person who delivers Shipments to the recipient. service’s own operations. The displayed names of these fields can be modified in the configuration, so the visitor does not need to see the technical designations OP1, OP2 or OP3.
Fee calculation
The DWP is able to request a charge from the Deliveo system based on the parcel’s details. The following, amongst other factors, can be taken into account during charge calculation:
-
collection and delivery addressesAddresses The geographical addresses where the CourierThe person who delivers Shipments to the recipient. will pick up or deliver the parcel. An Address can be both a shipping address and a receiving address, the system does not distinguish between the two.;
-
delivery option;
-
number of parcels;
-
weight;
-
volume;
-
volumetric weight;
-
cash on delivery;
-
the pricing conditions configured in Deliveo.
The actual charge is always determined by the pricing set in Deliveo.
Online payment via Barion
DWP can also be used with Barion online payment. If Barion integration is enabled and Deliveo’s fee calculation returns an amount due, the visitor can pay the service fee online as part of the parcel dispatch process.
The process in this case is as follows:
-
The visitor fills in the parcel details.
-
DWP retrieves the delivery fee.
-
The visitor makes the payment via the Barion interface.
-
Once payment has been successfully completed, the DWP creates the parcel in Deliveo.
This ensures that the system avoids creating an unpaid parcel in the event of a failed or abandoned payment.
Tracking a consignment
DWP also features a dedicated parcel enquiry function. This function can be enabled or disabled separately in the configuration. To enquire about a parcel, the visitor must provide:
-
the DeliveoIDUnique primary identifier for shipments in the Deliveo system.;
-
the recipient’s postcode.
The combined use of these two pieces of information prevents anyone from viewing the parcel’s details simply by knowing the DeliveoIDUnique primary identifier for shipments in the Deliveo system..
Data displayed upon enquiry
Following successful authentication, the DWP may display the information relating to the consignment.
This may include:
-
the current status of the consignment;
-
the consignment’s log;
-
the contents of the parcel;
-
the sender’s details;
-
the recipient’s details;
-
tracking information;
-
the consignment label;
-
the signature sheet.
The display of the sender’s and recipient’s details can be configured separately.
Downloading the label
The label for the queried consignment can be downloaded from the DWP, provided that this function is available. This is useful, for example, if the sender wishes to print and affix the parcel label themselves.
Signature sheet
The display or download of the signature sheet relating to the delivery can also be enabled. If the function is active and the relevant document is available for the consignment, it can be accessed via the DWP enquiry interface.
Modifying and deleting a consignment
In the DWP, you can enable the modification and deletion of previously created consignments. This feature can only be used if it has been enabled in the DWP configuration. In addition, the consignment must also meet the following conditions:
-
the courierThe person who delivers Shipments to the recipient. has not yet collected it;
-
it has not yet been delivered;
-
it has not been paid for.
If any of these conditions have already been met, you cannot amend or cancel the consignment via the DWP.
Returns
The DWP also supports the initiation of returns for delivered consignments. This function can be enabled separately. If a return is available for a delivered consignment, the DWP prepares the new dispatch form using the details from the original consignment.
In doing so, the original:
-
the sender’s details become those of the return recipient;
-
the recipient’s details become those of the sender of the return
.
This means the user does not have to re-enter the full address details. A return technically involves creating a new consignment.
Customising the appearance
The DWP’s appearance is partially configurable. Among other things, you can set:
-
your own logo;
-
theme colour;
-
displayed functions;
-
the names of individual fields;
-
the displayed names of the OP1–OP3 fields;
-
data displayed on the tracking page.
This allows the DWP’s appearance to be customised to match the courierThe person who delivers Shipments to the recipient. service’s website.
Multilingual support
The DWP can be used in multiple languages. With the appropriate language files, the same installation can be used on websites or for customer groups in several different languages.
Installation
DWP can be installed on your own web server. To install it, copy the programme files to the appropriate web directory, then create and configure the configuration file. The configuration must include, amongst other things:
-
the Deliveo API connection details;
-
the functions you wish to use;
-
any fixed Customer ID;
-
display settings;
-
the data required for online payment;
-
other operational parameters.
The specific configuration variables required for installation and operation are contained in the .env.example file.
Download: https://gitlab.com/mav-it/deliveo-website-plugin
Demo: https://dwp.deliveo.eu/
Server requirements
DWP is a PHP-based application. It is always recommended to use a version of PHP that is still officially supported.
Deliveo is developed and bug-fixed for supported PHP versions. We do not undertake to fix compatibility or operational errors arising from the use of unsupported, obsolete PHP versions. The web server must also have the PHP extensions required for DWP to function, as well as the capability for external HTTPS connections.
Updates
After installing a new version, it is advisable to compare the current .env.example file with the previous configuration, as new configuration variables may be introduced when new features are added.
The plugin can update itself from the https://gitlab.com/mav-it/deliveo-website-plugin website. To run the update, add /update to the end of the installation URL
E.g.: dwp.example.com/update
Important information
DWP is built on Deliveo’s API, so any data created or queried within DWP comes directly from the Deliveo system. DWP is not a separate courierThe person who delivers Shipments to the recipient. service database in its own right, but rather a web-based add-on interface for Deliveo.
A significant proportion of the available services, delivery options, collection points, charges and other business rules must therefore be configured not in DWP, but on the Deliveo 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.