How to Install the ShipperHQ Magento 2 Extension

Overview

Please follow these steps to install your extension. These installation instructions provide comprehensive installation guidance. If you do not follow these steps as indicated you may well see issues with your install, which may take some time to resolve. So please follow each step carefully and if the install fails re-check the steps.

Presumptions

We assume you understand Magento 2, and have it installed correctly.

It is highly recommended to backup your server files and database before installing this module. No responsibility can be taken for any adverse effects it may cause. It is also recommended you install on a test server initially to carry out your own testing.

Also make sure your [M2instanceRootDirectory]/vendor/ directory is writable or you will get a message stating module-shipper or module-logger “does not exist and could not be created.

Main Installation Processes

Clean Install

** These steps are optional if your site is in developer mode

  1. Enable Maintenance mode (php bin/magento maintenance:enable) **
  2. Run the following commands from your root Magento installation directory:
    • composer require shipperhq/module-shipper
    • php bin/magento module:enable --clear-static-content ShipperHQ_Common ShipperHQ_Logger ShipperHQ_Shipper
  3. php bin/magento cache:flush
  4. php bin/magento setup:upgrade
  5. php bin/magento setup:di:compile **
  6. php bin/magento setup:static-content:deploy **
  7. Disable Maintenance mode (php bin/magento maintenance:disable) **
  8. Now that you have ShipperHQ installed you can begin configuring your extension.

Updating Existing Installation

** These steps are optional if your site is in developer mode

  1. Enable Maintenance mode (php bin/magento maintenance:enable) **
  2. Run the following commands from your root Magento installation directory:
    • composer update shipperhq/*
    • php bin/magento cache:flush
    • php bin/magento setup:upgrade
  3. Remove generated file content by deleting contents of:
    var/view_preprocessed
    pub/static/frontend/
    pub/static/adminhtml/
    pub/static/_requirejs/
    var/generation
  4. If you’re not in developer mode run these commands:
    • php bin/magento setup:di:compile **
    • php bin/magento setup:static-content:deploy **
  5. Disable Maintenance mode (php bin/magento maintenance:disable) **
  6. This would also be a good time to Synchronize your ShipperHQ with M2 so go ahead and take care of that in Sales > Configuration > Shipping Methods  > Synchronize ShipperHQ near the top of the shipping method.
  7. Now that you have ShipperHQ installed you can begin configuring your extension.

Specify a Specific Version of ShipperHQ

To deploy a specific version of the shipperhq extension follow these directions:

  1. Enable Maintenance mode (php bin/magento maintenance:enable) – optional if site is in developer mode.
  2. Run from your root Magento directory:
    composer require shipperhq/module-shipper:20.18.10 --update-with-dependencies
    where 20.18.10 is the version of the module you want to install.
  3. If you are upgrading to the next major version, you will need to explicitly specify the version
    composer require shipperhq/module-calendar: ^22.0 --update-with-dependencies
    where 22 is the next major version number of the module you want to install.
  4. If you have a previously installed version of ShipperHQ also run:
    composer update shipperhq/module-shipper
  5. Continue by running the Clean Install or Update Existing Installation instructions ignoring their composer steps.

Other Installation Processes

Manual Installation

Please note that we recommend the use of Composer (as above), per Magento 2 standards.
  1. Download the latest release: https://github.com/shipperhq/module-shipper/releases
  2. Extract the archive you’ve just downloaded, within it you will find a folder called “ZIP” with a .zip archive.
    module-shopper
    ├── CHANGELOG-PUBLIC.md
    ├── CHANGELOG.MD
    ├── LICENSE.txt
    ├── LICENSE_AFL.txt
    ├── README.md
    ├── ZIP
    │   ├── ShipperHQ\ Standard\ M2-20.18.12.zip <-- This file
    ├── composer.json
    ├── composer.lock
    ├── grumphp.yml
    ├── src
    │   ├── (etc...)
    └── test
     └── Unit
  3. Extract the contents of the .zip archive to the root of your Magento directory. This will merge into the app directory. This is a raw install so any test files/directories must be removed if present.
  4. Enable the modules using: php bin/magento module:enable ShipperHQ_Shipper ShipperHQ_Logger ShipperHQ_Common
  5. Update Magento with: php bin/magento setup:upgrade
  6. Clear cache and re-compile
  7. Now that you have ShipperHQ installed you can begin configuring your extension.

Migrating the ShipperHQ Extension from Magento 1 to Magento 2

When migrating from the ShipperHQ Magento 1 extension to the Magento 2 extension there are some additional steps as the files are completely different. Please see this document for details.

Installing Magento 2 ShipperHQ Separate Modules

ShipperHQ provides additional functionality in separate modules. These are not required in order to use ShipperHQ on Magento 2, but they provide advanced capabilities.

Installation instructions for these modules are available here.

WebShopApps MatrixRate Installation

Please see the MatrixRate Installation guide.

Post-Installation Steps

In order to successfully connect your Magento eCommerce site to ShipperHQ you’ll need to configure your website in ShipperHQ. The final step is to configure the ShipperHQ Magento extension.

Troubleshooting Magento 2 Installations

Please see the troubleshooting guide for Magento 2.