Skip to content
Visit ShipperHQ.com
  • There are no suggestions because the search field is empty.

Installing Magento 2 ShipperHQ Separate Modules

Install and configure ShipperHQ modules for enhanced Magento 2 checkout features

Table of Contents

Overview

ShipperHQ provides additional functionality through separate modules. These are optional for using ShipperHQ on Magento 2/Adobe Commerce, but they offer enhanced capabilities. For example, the 'module-calendar' adds a delivery date selector to the checkout. These modules are available in a private composer repository.

Access Credentials
To access this private repository, you need to contact us with your ShipperHQ login email before proceeding with the steps below.

Assumptions

For a successful installation and use of ShipperHQ separate modules, we assume:

  • You understand Magento 2/Adobe Commerce and have it properly installed
  • Your base ShipperHQ extension is up to date. If not, download the latest version from our public repo or perform a Composer update. See our Installation doc
  • You have access to our private repository
  • You have backed up your server and database before proceeding. We are not responsible for any adverse effects. It's best to test on a development server first

These modules do not support multi-address checkouts; only basic rates are visible in such instances.

Third-Party Checkout Compatibility
These separate modules are designed for Magento/Adobe Commerce native checkout and may not be compatible with third-party checkouts. Consult your checkout's developer for compatibility needs.

Modules details & functionality

Each module provides specific features or may be necessary for certain ShipperHQ capabilities.

shipperhq/module-option

Enables:

shipperhq/module-calendar

Displays the Date & Time calendar at checkout under carrier date/time settings.

shipperhq/module-pickup

Shows In-Store Pickup locations, and optionally a map. It's recommended to use with the calendar module for showing pickup order calendars.

shipperhq/module-orderview

Displays Shipping Insight shipment info on order details within Magento/Adobe Commerce Admin. Full Shipping Insights functionality requires this module.

Adding modules from our Private Repository

When prompted for credentials during setup, enter the credentials supplied by ShipperHQ Support.

  • Use your preferred text editor to add the following repository to the composer.json file in your Magento root directory:

    "repositories": [
{
"type": "composer",
"url": "https://repo.magento.com/"
},
{
"type": "composer",
"url": "https://packages.shipperhq.com"
}
]

  • Add the modules via command line:

    composer require <shipperhq/module-name>
composer update
php bin/magento module:enable ShipperHQ_ModuleName

    For example:

    composer require shipperhq/module-calendar
composer update
php bin/magento module:enable ShipperHQ_Calendar

Module names include:

  • shipperhq/module-option: ShipperHQ_Option
  • shipperhq/module-calendar: ShipperHQ_Calendar
  • shipperhq/module-pickup: ShipperHQ_Pickup
  • shipperhq/module-orderview: ShipperHQ_OrderView

Requires Prior Installation of ShipperHQ Extension
Ensure the ShipperHQ extension is installed. Follow our installation and upgrade instructions if needed.

Check for new versions of installed modules

To verify you're using the latest module version, use this Composer command. It shows the current and latest available versions:

composer show --latest shipperhq/module-name

Disabling Modules

To disable modules from the command line:

php bin/magento module:disable --clear-static-content ShipperHQPickup ShipperHQOption ShipperHQ_Calendar

Then run the following cleanup commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento indexer:reindex
php bin/magento cache:clean