How to install ShipperHQ on Magento 2

Table of Contents

Overview
Presumptions
Latest Version
Main Installation Processes
Clean Install
Moving From Magento Marketplace Installation
Updating Existing Installation
Other Installation Processes
Migrating the ShipperHQ Extension from Magento 1 to Magento 2
Installing Magento 2 ShipperHQ Separate Modules
WebShopApps MatrixRate Installation
Post-Installation Steps
Troubleshooting Magento 2 Installations

Overview

Follow these steps to install your ShipperHQ extension on Magento 2. This guidance will help you achieve a smooth installation. Make sure you follow each step carefully to avoid any issues. If the installation fails, double-check the steps before proceeding again.

Assumptions

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

You understand Magento 2/Adobe Commerce and have it properly installed
Your /vendor/ directory is writable to prevent issues like the module not existing or not being created
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

⚠️ Note: Consider installing on a test server initially to perform your testing.

Latest Version

Keep up with the latest versions of the extension by watching the public repository at github.com/shipperhq/module-shipper/releases. Check out the published changelog here.

Main Installation Processes

Clean Install

Enable Maintenance mode: php bin/magento maintenance:enable
Run these commands from your root Magento directory:
- composer require shipperhq/module-shipper
- php bin/magento module:enable --clear-static-content ShipperHQ_Common ShipperHQ_Logger ShipperHQ_Shipper
- php bin/magento cache:flush
- php bin/magento setup:upgrade
- php bin/magento setup:di:compile
- php bin/magento setup:static-content:deploy
Disable Maintenance mode: php bin/magento maintenance:disable

Now that ShipperHQ is installed, you can begin configuring your extension.

💡 Optional: Some steps can be skipped if your site is in developer mode.

Moving From Magento Marketplace Installation

To switch from modules installed via the Magento Marketplace to using Composer, run:

composer require shipperhq/module-shipper:^20.35

Then follow steps 5 onward from the "Clean Install" section above.

Updating Existing Installation

Enable Maintenance mode: php bin/magento maintenance:enable
Optional: If you require a specific version of the modules use one of the following commands. Please note that this is typically not required so you can skip this step unless advised otherwise:
- composer require shipperhq/module-shipper:20.18.10 --update-with-dependencies for a specific version
- composer require shipperhq/module-calendar: ^22.0 --update-with-dependencies for the next major version
Run these commands from your root Magento directory:
- composer update shipperhq/*
- php bin/magento cache:flush
- php bin/magento setup:upgrade
Remove generated file content from:
- var/view_preprocessed
- pub/static/frontend/
- pub/static/adminhtml/
- pub/static/_requirejs/
- generation/ (use var/generation for older M2 versions)
Run: php bin/magento setup:di:compile
Deploy static content: php bin/magento setup:static-content:deploy
Disable Maintenance mode: php bin/magento maintenance:disable

This is an excellent time to synchronize your Magento 2 site with ShipperHQ.

💡 Optional: Some steps can be skipped if your site is in developer mode.

Other Installation Processes

Migrating the ShipperHQ Extension from Magento 1 to Magento 2

For detailed steps on migrating from the ShipperHQ Magento 1 extension to Magento 2, refer to Managing ShipperHQ on Magento 1.

Installing Magento 2 ShipperHQ Separate Modules

ShipperHQ offers additional functionality through separate modules. While not required, they provide advanced capabilities. Find installation instructions at Installing Magento 2 ShipperHQ Separate Modules.