Installing 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. Also make sure your [Magento Root Directory]/vendor/ directory is writable or you will get a message stating module-shipper or module-logger “does not exist and could not be created.”

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

Latest Version

To follow the latest versions of the extension, you can watch the public repo at github.com/shipperhq/module-shipper/releases

See the published changelog here.

Main Installation Processes

Clean Install

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

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

Updating Existing Installation

  1. Enable Maintenance mode (php bin/magento maintenance:enable) **
  2. To specify a specific version of ShipperHQ run one of the following from your root Magento installation directory, or skip this step if you wish to upgrade to the latest release of the current major version:
    • 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.
    • 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.0 is the major version you want to install
  3. Run the following commands from your root Magento installation directory
  4. composer update shipperhq/*
  5. php bin/magento cache:flush
  6. php bin/magento setup:upgrade
  7. Remove generated file content by deleting contents of:
    • var/view_preprocessed
    • pub/static/frontend/
    • pub/static/adminhtml/
    • pub/static/_requirejs/
    • generation/ (with older versions of M2 this was: var/generation )
  8. From your root Magento installation directory run php bin/magento setup:di:compile **
  9. Deploy static content php bin/magento setup:static-content:deploy **
  10. Disable Maintenance mode (php bin/magento maintenance:disable) **
  11. This would also be a good time to Synchronize your Magento 2 site with ShipperHQ

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

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 of all modules:
      1. https://github.com/shipperhq/module-shipper/releases
      2. https://github.com/shipperhq/library-shipper/releases
      3. https://github.com/shipperhq/library-ws/releases
      4. https://github.com/shipperhq/module-common/releases
      5. https://github.com/shipperhq/module-logger/releases
  2. Extract the archive you’ve just downloaded to your Magento directory. Within it you will need to create the respective sub-directories within the “app” directory. The subdirectory name can be found in the “psr-4” section of composer.json (E.g.: "ShipperHQ\\Shipper\\": "src/" would become app/code/ShipperHQ/Shipper)
  3. Extract the contents of the .zip archive to newly-created 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.

Was this doc helpful?