PHPackages                             shipperhq/module-common - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. shipperhq/module-common

ActiveMagento2-module[Utility & Helpers](/categories/utility)

shipperhq/module-common
=======================

ShipperHQ Common

20.10.1(1mo ago)21.1M↓48.9%21OSL-3.0PHPCI failing

Since May 3Pushed 1mo ago10 watchersCompare

[ Source](https://github.com/shipperhq/module-common)[ Packagist](https://packagist.org/packages/shipperhq/module-common)[ RSS](/packages/shipperhq-module-common/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (10)Dependencies (38)Versions (40)Used By (1)

ShipperHQ Common for Magento 2
==============================

[](#shipperhq-common-for-magento-2)

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
--------

[](#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
------------

[](#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
------------

[](#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
-------------

[](#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
--------------------------

[](#frequently-asked-questions)

### 1. Do I need to install this module manually?

[](#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?

[](#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?

[](#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?

[](#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
-------

[](#support)

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

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

---

Contributing
------------

[](#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
-------

[](#license)

See license files

---

Copyright
---------

[](#copyright)

Copyright (c) 2015 Zowta LLC ()

###  Health Score

61

—

FairBetter than 98% of packages

Maintenance93

Actively maintained with recent releases

Popularity41

Moderate usage in the ecosystem

Community21

Small or concentrated contributor base

Maturity75

Established project with proven stability

 Bus Factor1

Top contributor holds 72.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~99 days

Recently: every ~480 days

Total

38

Last Release

35d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/9913303e58b27013c39ad677c9161a0600e00d3181733d8fbf4059c532a611b0?d=identicon)[shipperhq](/maintainers/shipperhq)

---

Top Contributors

[![wsagen](https://avatars.githubusercontent.com/u/4350893?v=4)](https://github.com/wsagen "wsagen (29 commits)")[![wsajosh](https://avatars.githubusercontent.com/u/1335244?v=4)](https://github.com/wsajosh "wsajosh (6 commits)")[![wsajason](https://avatars.githubusercontent.com/u/3204631?v=4)](https://github.com/wsajason "wsajason (4 commits)")[![wsaDemo](https://avatars.githubusercontent.com/u/4519867?v=4)](https://github.com/wsaDemo "wsaDemo (1 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/shipperhq-module-common/health.svg)

```
[![Health](https://phpackages.com/badges/shipperhq-module-common/health.svg)](https://phpackages.com/packages/shipperhq-module-common)
```

###  Alternatives

[shipperhq/module-shipper

Magento Shipping integration with ShipperHQ

201.0M2](/packages/shipperhq-module-shipper)[fastly/magento2

Fastly CDN Module for Magento 2.4.x

1564.4M1](/packages/fastly-magento2)[loki/magento2-components

Core module for defining Alpine.js components with advanced AJAX features

1011.8k26](/packages/loki-magento2-components)[fishpig/magento2-wordpress-integration

Securely integrate WordPress and Magento 2.

83369.2k7](/packages/fishpig-magento2-wordpress-integration)[run-as-root/magento2-prometheus-exporter

Magento2 Prometheus Exporter

68357.9k](/packages/run-as-root-magento2-prometheus-exporter)[zwernemann/module-withdrawal

Magento 2 EU Withdrawal Button Module - Adds a withdrawal/revocation button for orders in compliance with EU Directive (EU) 2023/2673

244.9k2](/packages/zwernemann-module-withdrawal)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)