# dhl/module-unified-tracking

> Integrate the DPDHL Group tracking web service into Magento® 2 carrier modules.

`composer require dhl/module-unified-tracking`

Canonical URL: https://packagento.com/dhl/module-unified-tracking

## At a glance

- **Vendor**: dhl (https://packagento.com/dhl.md)
- **Latest version**: 2.4.0 — released 2026-06-03
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/dhl/module-unified-tracking and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require dhl/module-unified-tracking:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Integrate the DPDHL Group tracking web service into Magento® 2 carrier modules.

## README

The DHL Unified Tracking extension offers an integration of the [Shipment Tracking - Unified
API](https://developer.dhl/api-reference/shipment-tracking) into the Magento® 2 platform. 

### Description

This extension enables integrators to request tracking details for a given
DHL shipment. The extension does not display tracking status and tracking history
on its own. It accepts a tracking number and will return the tracking details in a
format suitable for use in Magento® 2. The UI integration needs to be realized within
a carrier module or similar.

### Requirements

* PHP >= 8.3
* PHP Internationalization extension

### Compatibility

* Magento 2.4.8+

### Installation Instructions

Install sources:

    composer require dhl/module-unified-tracking

Enable module:

    ./bin/magento module:enable Dhl_UnifiedTracking
    ./bin/magento setup:upgrade

Flush cache and compile:

    ./bin/magento cache:flush
    ./bin/magento setup:di:compile

### Uninstallation

To unregister the tracking module from the application, run the following command:

    ./bin/magento module:uninstall Dhl_UnifiedTracking
    composer update

### Usage

Tracking details can be obtained from the web service by either enabling the carrier
plugin or using the tracking service directly.
 
The web service allows to filter results by DHL divisions.

#### Carrier Plugin

The tracking extension comes with a plugin that can be enabled to replace a carrier's
original `\Magento\Shipping\Model\Carrier\AbstractCarrierOnline::getTrackingInfo` method.

```xml
<type name="Vendor\Module\Model\Carrier">
    <plugin name="dhlgw_get_tracking_info" type="Dhl\UnifiedTracking\Plugin\Carrier\GetTrackingDetails"/>
</type>
```

The request for tracking info will then be picked up by the tracking extension and
return a result object ready to be processed by the `Magento_Shipping` core module.

#### Tracking Service

The tracking extension offers an integration point that can be used to request
tracking details from the web service: `\Dhl\UnifiedTracking\Api\TrackingInfoProviderInterface::getTrackingDetails`.

Using the tracking service directly can be useful if the result needs to be modified
before passing it to the `Magento_Shipping` core module.

```php
// \Vendor\Module\Model\Carrier::getTrackingInfo

public function getTrackingInfo($tracking)
{
    $result = $this->trackingInfoProvider->getTrackingDetails($tracking, $this->getCarrierCode());
    
    if ($result instanceof \Magento\Shipping\Model\Tracking\Result\Error) {
        // create link to portal if web service returned an error
        $statusData = [
            'tracking' => $tracking,
            'url' => 'https://trackntrace.carrier.com/?track=' . $tracking,
        ];
        $result = $this->_trackStatusFactory->create(['data' => $statusData]);
    }

    return $result;
}
```

#### Limit Web Service Results

The tracking web service is able to return results from across DHL divisions.
If the integration is only meant to request tracking details from a certain carrier
(e.g. DHL Paket), then the web service results should be filtered by providing
a tracking configuration object via DI configuration:

```xml
<type name="Dhl\UnifiedTracking\Model\Pipeline\Stage\SendRequestStage">
    <arguments>
        <argument name="configurations" xsi:type="array">
            <item name="fooCarrierCode" xsi:type="object">Vendor\Foo\Model\TrackingConfiguration</item>
            <item name="barCarrierCode" xsi:type="object">Vendor\Bar\Model\TrackingConfiguration</item>
        </argument>
    </arguments>
</type>
```

The carrier code is the identifier of the Magento® carrier that the tracking number
belongs to. Compare

* `\Magento\Sales\Api\Data\TrackInterface::getTrackNumber`
* `\Magento\Sales\Api\Data\TrackInterface::getCarrierCode`

See [API docs](https://developer.dhl/api-reference/shipment-tracking#/default/get_shipments)
for a list of available service names.

### Support

In case of questions or problems, please have a look at the
[Support Portal (FAQ)](http://dhl.support.netresearch.de/) first.

If the issue cannot be resolved, you can contact the support team via the
[Support Portal](http://dhl.support.netresearch.de/) or by sending an email
to <dhl.support@netresearch.de>.

### License

[OSL - Open Software Licence 3.0](http://opensource.org/licenses/osl-3.0.php)

### Copyright

(c) 2021 DPDHL Group

## Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### 2.4.0

Magento 2.4.9 compatibility release

#### Added

- Support for Magento 2.4.9
- Support for PHP 8.5

### 2.3.0

Magento 2.4.8 and PHP 8.4 compatibility release

#### Added

- Support for Magento 2.4.8
- Support for PHP 8.4
- Code quality tools (PHPStan, Rector)

#### Changed

- Updated SDK dependency to ^2.4.0
- Modernized test infrastructure with PHPUnit 10

#### Removed

- Support for PHP 8.2

### 2.2.0 

Magento 2.4.7 compatibility release

#### Added

- Support for Magento 2.4.7

#### Removed

- Support for PHP 7.x
- Support for PHP 8.1

### 2.1.0

Magento 2.4.4 compatibility release

#### Added

- Support for Magento 2.4.4

#### Removed

- Support for PHP 7.1

### 2.0.1

#### Fixed

- Update version constraint for the `netresearch/module-shipping-core` package.

### 2.0.0

#### Changed

- Replace shipping core package dependency

### 1.2.0

#### Added

- Possibility to track Deutsche Post shipments

### 1.1.0

Magento 2.4 compatibility release

#### Added

- Support for Magento 2.4

#### Removed

- Support for Magento 2.2

### 1.0.0

Initial release

## Recent Versions

| Version | Released |
|---|---|
| 2.4.0 | 2026-06-03 |
| 2.3.0 | 2025-06-24 |
| 2.2.0 | 2024-05-27 |
| 2.1.0 | 2022-04-29 |
| 2.0.1 | 2021-04-28 |
| 2.0.0 | 2021-03-18 |
| 1.2.0 | 2021-01-26 |
| 1.1.0 | 2020-09-09 |
| 1.0.0 | 2019-12-17 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| dhl/sdk-api-unified-tracking | ^2.4.0 |
| ext-intl | * |
| magento/framework | ^103.0.8 |
| magento/module-sales | ^103.0.8 |
| magento/module-shipping | ^100.4.8 |
| magento/module-store | ^101.1.8 |
| netresearch/module-shipping-core | ^4.0.0 |
| php | ~8.3.0\|\|~8.4.0\|\|~8.5.0 |

### Require (dev)

| Package | Constraint |
|---|---|
| phpunit/phpunit | ^10.5.0 |

## Quality

Latest release (2.4.0) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | not tested | not tested | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Warning | 4 | 4 warnings (ruleset: Magento2) |
| PHPMD | Warning | 13 | 13 rule violations (UnusedFormalParameter:7, MissingImport:5, ExcessiveParameterList:1) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | Error | – | – |
| 2.4.8 | – | 13 | 13 | – |
| 2.4.9 | – | – | 13 | 13 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | Error | – | – |
| 2.4.8 | – | 3 | 3 | – |
| 2.4.9 | – | – | 3 | 3 |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["dhl/module-unified-tracking"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

dhl is a Magento 2 vendor on Packagento. See https://packagento.com/dhl.md for their full catalogue.