DPD Shipping

Ship with DPD Germany from Magento: DPD Pickup parcel shops at checkout, PDF and ZPL labels for one or many parcels, tracking with delivery dates and DPD return labels. This package is a carrier for Shipping Connect (softaware/module-shipping-core, free), which provides the checkout methods, the pickup point map, label printing, tracking and the API log.

• Admin demo (all Shipping Connect carriers): https://demo.softawarecommerce.com/try-admin/shipping
• Changelog: Release notes · Questions: FAQ

The demo connections have no credentials and are switched off, so the demo shows the admin screens and example labels but does not contact DPD.

1. Requirements

A DPD business account is required for live use. The Delis ID and its web service password come from DPD Germany: ask your DPD sales contact to activate web service access for your customer account. For testing you can use DPD's public stage system without a contract (see section 4).

2. Installation

With Composer. Use the Composer keys from your account on softawarecommerce.com (see https://softawarecommerce.com/shop/composer-access/):

composer config repositories.softaware composer https://repo.softawarecommerce.com
composer config --auth http-basic.repo.softawarecommerce.com PUBLIC_KEY PRIVATE_KEY
composer require softaware/module-shipping-dpd
bin/magento setup:upgrade
bin/magento setup:di:compile            # production mode only
bin/magento setup:static-content:deploy # production mode only
bin/magento cache:flush

Shipping Core is installed with it. To update later: composer update softaware/module-shipping-dpd, then the same bin/magento commands.

3. Quick start

1. Stores > Configuration > Softaware > Shipping Connect > General > Enabled = Yes.
2. Softaware > Shipping Connect > Carrier Connections > Add Carrier Connection, choose DPD Germany.
3. Enter a Name (for you), switch Enabled on, choose the Website.
4. Under Credentials enter the Delis ID and Password, then click Test Connection. The answer shows the system (stage or live), the Delis ID and the depot DPD returned.
5. Under Checkout Methods add for example "Home delivery" and "Pickup point / locker" with a price.
6. Fill in the Sender Address and Parcel Defaults and click Save.

The methods now appear at checkout for addresses in the allowed countries.

4. The DPD connection in detail

General

You can create several DPD connections, for example one per website or one for stage tests and one for live.

Credentials

Credentials are stored encrypted and are never shown again; leave ****** in the password field to keep the saved value. Test Connection uses the values in the form (including the sandbox switch) without saving them. The DPD login token is cached for 12 hours and renewed automatically.

Carrier Settings

Checkout Methods

Each row is a shipping method at checkout:

• On, Title (what the customer sees) and Sort.
• Delivery: Home delivery, or Pickup point / locker (DPD Pickup parcel shops).
• Carrier Product: one of the DPD products below. Parcel shop delivery uses DPD CLASSIC.
• Price: flat; by weight or by subtotal with a price table such as 2:4.95, 5:6.95, 31.5:9.95 (up to 2 kg costs 4.95 and so on; above the last limit the method is not offered). DPD Germany has no price API in this package, so live carrier prices are not available for DPD.
• Free From Subtotal and Countries (ISO codes) (comma separated, empty = all).

Prices are in the base currency. Cart rules with free shipping make every method free.

DPD products: DPD CLASSIC (CL), DPD 8:30 (E830), DPD 12:00 (E12), DPD 18:00 (E18), DPD Express International (IE2), DPD PARCELLetter (PL) and DPD MAX (MAX). Which products you may book depends on your DPD contract.

Sender Address and Parcel Defaults

The sender address is printed on the label; it can also come from an MSI inventory source (Use Address of Inventory Source). Parcel defaults (weight in kg, length, width and height in cm) pre-fill the label form when the order has no better data. Dimensions are sent to DPD as the parcel volume.

5. Parcel shops at checkout

When the customer selects a "Pickup point / locker" method, a Choose pickup point button appears under the shipping methods. The customer searches by postcode or town; the module asks DPD's parcel shop finder and shows the parcel shops in a list (name, address, distance, type, opening hours) next to an OpenStreetMap map. Collect here selects a shop.

• The point is required before the payment step and checked again when the order is placed (also for REST and GraphQL checkouts). Points must come from the search the server cached, not from the browser.
• The chosen point is stored with the order and shown in the admin order view, the customer's order view (Luma and Hyvä), order e-mails and invoice and shipment PDFs.
• The label is booked with DPD parcel shop delivery to that shop; DPD sends the parcel shop notification to the customer's e-mail address.
• Searches are rate limited per visitor and for the whole shop. Settings: Stores > Configuration > Softaware > Shipping Connect > Pickup Points at Checkout (points per search, searches per minute, map tile URL).

6. Creating labels

One order: open the order and click Create Shipment and Label. Several orders: select them in the order grid and choose Create Shipments and Labels (up to 50 orders at a time).

Per order you check the connection, the DPD product, the number of parcels, the weight per parcel, the dimensions, the insured value and whether the customer gets the shipment e-mail. Then click Create Shipments and Labels.

• DPD returns one tracking number per parcel; the module creates the Magento shipment for the items still to ship with all tracking numbers, or adds the label to an existing shipment ("Label for Shipment #").
• An insured value is booked as DPD higher insurance on the first parcel.
• Print All Labels gives one merged PDF. The order grid action Print Shipping Connect Labels prints the labels of the selected orders. PDF labels are also stored on the Magento shipment.
• A label is never created twice by accident: the order is locked while the label is created, and a request that may have reached DPD is not repeated.
• DPD has no cancel call: a label that is never scanned is not charged, so just do not use it.
• Cash on delivery is not offered: DPD removed it from the shipment web service version this package uses.

7. Tracking

A cron job every 15 minutes checks open DPD parcels (more often while they move, less often when they are older) and stores DPD's events, the current status and the delivery date. Tracking stops after delivery or after the number of days you set.

• Softaware > Shipping Connect > Shipments and Labels lists every label with status, last event and delivery date; the label page shows all events with time and location.
• Update Tracking checks now. The customer's tracking link opens the DPD tracking page (German or English).
• Settings under Stores > Configuration > Softaware > Shipping Connect > Tracking: Track Parcels Automatically, Parcels per Cron Run, Stop Tracking After (Days), Order Status When Delivered, E-mail Customer When, Tracking E-mail Template and Sender.

8. Return labels

In the order view click Create Return Label. The module asks DPD for a return parcel label for the order's address; it is stored like any label and can be downloaded. The label page has a signed download link (30 days) you can send to the customer. Softaware Returns can create the same DPD return labels from its return page.

9. Command line

bin/magento softaware:shipping:adapters                       # installed carriers and what they support
bin/magento softaware:shipping:test-connection [connection id] # test credentials
bin/magento softaware:shipping:create-label <order number> [-c connection] [-s CL] [-p parcels] [-w kg] [--return] [--no-email]
bin/magento softaware:shipping:track [--order number] [--label id] [--limit n]

10. Permissions (ACL)

Under Softaware > Shipping Connect: View Shipments and Labels, Create Shipments and Labels, Cancel Labels, Create Return Labels, Manage Carrier Connections, View API Log, Settings. Creating labels also creates the Magento shipment, so the role needs Sales > Operations > Orders > Actions > Ship as well.

11. Data sent to DPD

Recipient name, company, address, phone and e-mail (Predict or parcel shop notification), parcel weights and sizes, and the order number as reference. Parcel shop searches send only the postcode or town and the country. Every request is written to Softaware > Shipping Connect > API Log with passwords and tokens masked; set the retention in the API Log settings.

12. Troubleshooting

13. Uninstall

bin/magento module:disable Softaware_ShippingDpd
composer remove softaware/module-shipping-dpd
bin/magento setup:upgrade

Existing labels and tracking history stay in Shipping Core's tables; DPD connections can no longer be used until the package is installed again.