README

A simple extension which allows you to enter custom shipment tracking URLs. This will enable your customers to have a clickable shipping tracking link in the new shipment email and when viewing their order in Magento.

Features

Custom Tracking URLs: Define generic tracking URL patterns for your shipments.
Multiple Trackers: Configure up to five independent trackers (Tracker 1…5).
Email and Account Links: Adds clickable tracking links to shipment emails and the order view in My Account.
Carrier-Agnostic: Works with any carrier that provides a public tracking URL.
Per-Store Configuration: Scope settings at website/store view for multi-store setups.
Magento 2 Compatible: Tested with Magento 2.4.4+.

Installation

Install using composer by adding to your composer file using commands:

composer require shipperhq/module-shipping-tracker
composer update
bin/magento setup:upgrade

For up-to-date installation instructions, use the composer commands above.

Requirements

Magento 2.4.4+
- Compatibility with earlier editions is possible but not maintained
- Supports both Magento Opensource (Community) and Magento Commerce (Enterprise)

Configuration

The shipping tracker configuration can be found under: Stores > Configuration > Sales > Shipping Methods > ShipperHQ Tracker 1...5

Enable one of the trackers (Tracker 1…5).
Set a descriptive Title (shown to customers).
Choose a Predefined Carrier (Pre URL) or select "Use Manual Url" to provide your own.
If using Manual Url, enter a Tracking URL pattern using the placeholders below.

Placeholders supported in the Tracking URL pattern:

#TRACKNUM#: Replaced with the package tracking number. Include this exactly where the carrier expects the tracking value.
#POSTCODE#: Replaced with the destination postcode when available. Only include if required by the carrier’s tracking page. If the postcode is not available, the token will not be replaced.
#SPECIAL#: Add this token when you need to link to a generic tracking page without auto-inserting a tracking number. When present, the module removes #SPECIAL# and also strips any #TRACKNUM# token from the URL, resulting in a general tracking page link.

Examples (Manual Url):

Tracking number only: https://carrier.example/track?num=#TRACKNUM#
Tracking number + postcode: https://carrier.example/track?num=#TRACKNUM#&postcode=#POSTCODE#
Generic tracking page (no auto-insert): https://carrier.example/track#SPECIAL#

Support

If you have any issues with this extension, open an issue on GitHub.

Contribution

Any contribution is highly appreciated. The best way to contribute code is to open a pull request on GitHub.

License

We also dutifully respect the Magento OSL license, which is included in this codebase.

shipperhq / module-shipping-tracker

Maintainers

Details