# shipperhq/module-shipping-tracker

> Shipping Tracker - By the ShipperHQ Team

`composer require shipperhq/module-shipping-tracker`

Canonical URL: https://packagento.com/shipperhq/module-shipping-tracker

## At a glance

- **Vendor**: shipperhq (https://packagento.com/shipperhq.md)
- **Latest version**: 1.1.1 — released 2024-11-15
- **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/shipperhq/module-shipping-tracker 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 shipperhq/module-shipping-tracker:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

Shipping Tracker - By the ShipperHQ Team

## README

Facts
-----
- [extension on GitHub](https://github.com/shipperhq/module-shipping-tracker)

Description
-----------

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.

Compatibility
-------------
This module supports and is tested against the following Magento versions:

* 2.4.6
* 2.4.5-p1
* 2.4.5
* 2.4.4-p2
* 2.4.4-p1
* 2.4.4
* 2.4.3-p3
* 2.4.3-p2
* 2.4.3
* 2.4.2
* 2.4.1
* 2.4.0

per the [official Magento 2 requirements](https://experienceleague.adobe.com/docs/commerce-operations/installation-guide/system-requirements.html)

Supports both Magento Opensource (Community) and Magento Commerce (Enterprise)

Compatibility with earlier editions is possible but is not maintained.

Installation Instructions
-------------------------
Install using composer by adding to your composer file using commands:

1. composer require shipperhq/module-shipping-tracker
2. composer update
3. bin/magento setup:upgrade

For up-to-date installation instructions, along with troubleshooting steps, please see the documentation, below.

Configuration
-------------
The shipping tracker configuration can be found in the shipping methods section: Stores > Configuration > Sales > Shipping Methods > ShipperHQ Tracker 1...5

For further information on using Shipping Tracker, please refer to our [online documentation](http://support.webshopapps.com/shippingtracker)

Support
-------
If you have any issues with this extension, open an issue on [GitHub](https://github.com/shipperhq/module-shipping-tracker/issues).

Contribution
------------
Any contribution is highly appreciated. The best way to contribute code is to open a [pull request on GitHub](https://help.github.com/articles/using-pull-requests).

License
-------
Copyright (c) 2015 Zowta LLC & Zowta Ltd. See [license] for details.

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


[license]: LICENSE.txt
[magento]: https://github.com/magento/magento2/blob/2.4-develop/LICENSE.txt

Copyright
---------
Copyright (c) 2016 Zowta LLC & Zowta Ltd.

## Changelog

### [v1.1.1](https://github.com/shipperhq/module-shipping-tracker/tree/v1.1.1) (2024-11-15)
[Full Changelog](https://github.com/shipperhq/module-shipping-tracker/-/compare/v1.1.0...develop)

### [v1.1.0](https://github.com/shipperhq/module-shipping-tracker/tree/v1.1.0) (2024-08-22)
[Full Changelog](https://github.com/shipperhq/module-shipping-tracker/-/compare/v1.0.6...develop)

### [v1.0.6](https://github.com/shipperhq/module-shipping-tracker/tree/v1.0.6) (2023-06-16)
[Full Changelog](https://github.com/shipperhq/module-shipping-tracker/-/compare/v1.0.5...develop)
 - [MNB-3339](https://webshopapps.atlassian.net/browse/MNB-3339) Correction to phrasing in README [\#14](https://github.com/shipperhq/module-shipping-tracker/-/merge_requests/14) ([wsajason](https://gitlab.com/wsajason))

### [v1.0.5](https://github.com/shipperhq/module-shipping-tracker/tree/v1.0.5) (2022-06-20)
[Full Changelog](https://github.com/shipperhq/module-shipping-tracker/-/compare/v1.0.4...develop)

### [v1.0.5](https://github.com/shipperhq/module-shipping-tracker/tree/v1.0.5) (2022-06-20)
[Full Changelog](https://github.com/shipperhq/module-shipping-tracker/-/compare/v1.0.4...develop)
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

### [1.0.0] - 2018-02-23
#### Added
- Initial release

### [1.0.1] - 2018-03-01
#### Added
- M2-59 update to tracking email template

### [1.0.2] - 2019-03-19
#### Added
- SHQ18-1678 Update links to point to new support documentation

### [1.0.3] - 2019-05-28
#### Added
- SHQ18-1992 Fix for tracking links from wrong order showing in email template

### [1.0.3] - 2020-11-13
#### Added
- ISSUE-12 Updated version numbers to allow composer update

## Recent Versions

| Version | Released |
|---|---|
| 1.1.1 | 2024-11-15 |
| v1.0.5 | 2022-06-20 |
| 1.0.4 | 2020-11-17 |
| 1.0.1 | 2018-03-01 |
| 1.0.0 | 2018-02-23 |

## Quality

Latest release (1.1.1) 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 | – | – | not tested | 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 | 8 | 8 warnings (ruleset: Magento2) — 1 auto-fixable with phpcbf |
| PHPMD | Warning | 7 | 7 rule violations (UnusedLocalVariable:2, UnusedFormalParameter:2, MissingImport:2, IfStatementAssignment: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 | 13 | 13 | – | – |
| 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 | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### 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=["shipperhq/module-shipping-tracker"],
  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

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