# shipperhq/module-common

> ShipperHQ Common

`composer require shipperhq/module-common`

Canonical URL: https://packagento.com/shipperhq/module-common

## At a glance

- **Vendor**: shipperhq (https://packagento.com/shipperhq.md)
- **Latest version**: 20.10.1 — released 2026-05-29
- **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-common 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-common:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

ShipperHQ Common

## README

ShipperHQ Common is a shared library module that provides the core models, interfaces, and utilities used across ShipperHQ's suite of Magento 2 modules. It is a required dependency of other ShipperHQ modules and is not intended to be used standalone.

---

### Features

- **Shared Models**: Common data models for pickup, calendar, and shipping option features shared across ShipperHQ modules.
- **Configuration Interfaces**: Abstract configuration classes and interfaces that provide a consistent configuration contract across the ShipperHQ module suite.
- **Checkout Integration**: Plugin support for Magento's shipping method management to enable ShipperHQ's extended checkout capabilities.
- **Service Abstractions**: Shared service classes consumed by ShipperHQ feature modules to avoid duplication and ensure consistency.

---

### Installation

This module is installed automatically as a dependency when you install any ShipperHQ module that requires it. You do not need to install it directly.

Full installation instructions for the ShipperHQ extension are available in the [ShipperHQ documentation](https://docs.shipperhq.com/installing-magento-2-shipperhq-extension/).

---

### Requirements

- Magento 2.4.4+
  - Compatibility with earlier editions is possible but not maintained
  - Supports both Magento Opensource (Community) and Magento Commerce (Enterprise)
- A valid ShipperHQ account. [Sign up here](https://shipperhq.com/) for your 15-day free trial!

---

### Configuration

This module has no configuration of its own. All ShipperHQ configuration is managed through the main ShipperHQ module under `Stores > Configuration > Sales > Shipping Methods > ShipperHQ`.

You can find full configuration instructions in the [ShipperHQ documentation](https://docs.shipperhq.com/).

---

### Frequently Asked Questions

#### 1. Do I need to install this module manually?
No. This module is pulled in automatically as a composer dependency when you install any ShipperHQ module that requires it.

#### 2. Is there a free trial available for ShipperHQ?
Yes, ShipperHQ offers a free trial for new users. You can sign up for the trial on the [ShipperHQ website](https://shipperhq.com/) and explore the platform's features before committing to a subscription.

#### 3. How do I troubleshoot issues related to this module?
- Verify that all ShipperHQ modules are on compatible versions by checking the `require` constraints in each module's `composer.json`.
- Check our extensive [documentation](https://docs.shipperhq.com/category/troubleshooting/) for troubleshooting tips.

#### 4. Can I use this module without installing the main ShipperHQ module?
No, this library is not intended for standalone use. It is designed to be consumed by other ShipperHQ modules that provide the actual shipping features.

---

### Support

For assistance, please visit our [Help Center](https://docs.shipperhq.com/) or contact ShipperHQ support at [support@shipperhq.com](mailto:support@shipperhq.com).

For alternative contact methods, please visit our [Contact Us](https://shipperhq.com/contact/) page.

---

### Contributing

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

See license files

---

### Copyright
Copyright (c) 2015 Zowta LLC (http://www.ShipperHQ.com)

## Changelog

### 20.7.0 (2018-06-25)
SHQ18-277 retain existing selectiosn on checkout selections object


### 20.8.0 (2019-03-14)
SHQ18-1651 Update dependencies in composer.json


### 20.9.0 (2019-11-20)
SHQ18-2869 Process rate response as array


### 20.9.1 (2021-01-07)
INFRA-208 updated composer json from uppercase to lowercase


### 20.9.2 (2021-02-23)
MNB-1003 Fix for rate shopped accessorials on LTL methods


### 20.9.3 (2021-04-22)
MNB-1204 Fix issue around date select requesting rates for all carriers and errors showing when shouldnt


### 20.9.4 (2021-11-02)
MNB-1797 Fix unit tests to work with Magento 2.3+


### 20.10.0 (2022-05-13)
MNB-2430 M2.4.4 compatibility


### 20.10.1 (2026-05-29)
ENG26-26 Modernising copyrights and docs

## Recent Versions

| Version | Released |
|---|---|
| 20.10.1 | 2026-05-29 |
| 20.10.0 | 2022-05-13 |
| 20.9.4 | 2021-11-02 |
| 20.9.3 | 2021-04-22 |
| 20.9.2 | 2021-02-23 |
| 20.9.1 | 2021-01-07 |
| 20.9.0 | 2019-11-20 |
| 20.8.0 | 2019-03-14 |
| 20.7.0 | 2018-06-25 |
| 20.6.5 | 2018-05-18 |

Showing 10 of 40 versions. Full release history on https://packagento.com/shipperhq/module-common.

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | >=100.0 |
| magento/module-store | >=100.0 |
| shipperhq/library-shipper | ^20.12 |
| shipperhq/library-ws | ^20.4 |

### Require (dev)

| Package | Constraint |
|---|---|
| fooman/magento2-phpunit-bridge | ^0.9.0 |
| friendsofphp/php-cs-fixer | ~2.1.1 |
| jakub-onderka/php-console-highlighter | ^0.3.2 |
| jakub-onderka/php-parallel-lint | ^0.9.2 |
| lusitanian/oauth | ~0.8.10 |
| mikey179/vfsstream | ^1.6 |
| pdepend/pdepend | ^2.5 |
| phploc/phploc | ^4.0 |
| phpmd/phpmd | @stable |
| phpro/grumphp | ^0.12.1 |
| phpunit/phpunit | ~5.3.0 |
| sebastian/phpcpd | 2.0.4 |
| squizlabs/php_codesniffer | ^3.2 |
| symfony/dependency-injection | >3.4.26 |
| theseer/phpdox | ^0.10.1 |

## Quality

Latest release (20.10.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 | 1 | 1 | – | – |
| 2.4.8 | – | 1 | 1 | – |
| 2.4.9 | – | – | 1 | 1 |


### 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 | 53 | 53 warnings (ruleset: Magento2) — 23 auto-fixable with phpcbf |
| PHPMD | Warning | 4 | 4 rule violations (MissingImport:2, UndefinedVariable:2) |
| Cpd | Pass | 0 |  |
| Composer validate | Info | 3 | valid; 3 advisory notes (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 | 19 | 19 | – | – |
| 2.4.8 | – | 19 | 19 | – |
| 2.4.9 | – | – | 19 | 19 |


### 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 | Fail | 4 | 4 advisories (medium:1, high:3); 3 high+, 1 medium/unknown, 0 low |

## 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-common"],
  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.