Installing the ShipperHQ Magento 2 Enhanced Checkout

Overview

Please follow these steps to install the ShipperHQ enhanced checkout. You should not install the standard ShipperHQ module for Magento 2. 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.

Compatibility

ShipperHQ Enhanced Checkout is an enterprise only feature. It’s currently supported on Magento 2.2 and 2.3 only.

Presumptions

You will need to request access to this satis repository by emailing support@shipperhq.com and include your ShipperHQ login email address before attempting to access them using the steps below.

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.

Main Installation Processes

Edit composer.json

You will need to add the packages.shipperhq repository to your composer.json file

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

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-shq-client
  4. composer require shipperhq/module-orderview
  5. php bin/magento module:enable --clear-static-content ShipperHQ_Logger ShipperHQ_Client ShipperHQ_Server ShipperHQ_Orderview
  6. php bin/magento cache:flush
  7. php bin/magento setup:upgrade
  8. php bin/magento setup:di:compile **
  9. php bin/magento setup:static-content:deploy **
  10. Disable Maintenance mode (php bin/magento maintenance:disable) **
  11. 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-shq-client:1.0.0 --update-with-dependencies where 1.0.00 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-shq-client: ^2.0 --update-with-dependencies where 2.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/
    • 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

Was this doc helpful?