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

How to install ShipperHQ on Magento 2

Install and update ShipperHQ to enhance Magento 2 shipping capabilities

Table of Contents

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

Presumptions

We assume you have a working knowledge of Magento 2 and have it installed correctly. Ensure your /vendor/ directory is writable to prevent issues like the module not existing or not being created. 💡

⚠️ Note: It's highly recommended to back up your server files and database before installing this module. We cannot take responsibility for any adverse effects. 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

  1. Enable Maintenance mode: php bin/magento maintenance:enable
  2. 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
  3. 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

  1. Enable Maintenance mode: php bin/magento maintenance:enable
  2. Specify a ShipperHQ version:
    • 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
  3. Run these commands from your root Magento directory:
    • composer update shipperhq/*
    • php bin/magento cache:flush
    • php bin/magento setup:upgrade
  4. 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)
  5. Run: php bin/magento setup:di:compile
  6. Deploy static content: php bin/magento setup:static-content:deploy
  7. 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 this document.

Installing Magento 2 ShipperHQ Separate Modules

ShipperHQ offers additional functionality through separate modules. While not required, they provide advanced capabilities. Find installation instructions here.

WebShopApps MatrixRate Installation

Refer to the MatrixRate Installation guide.

Post-Installation Steps

To connect your Magento eCommerce site to ShipperHQ, configure your website in ShipperHQ. Finally, configure the ShipperHQ Magento extension.

Troubleshooting Magento 2 Installations

For assistance, check out the troubleshooting guide for Magento 2.