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

Installing the ShipperHQ Magento 2 Enhanced Checkout

Install and Update ShipperHQ Enhanced Checkout Module for Magento 2 Integration

Overview

Please follow these steps to install the ShipperHQ enhanced checkout. You should not install the standard ShipperHQ module for Magento 2. These instructions provide comprehensive guidance. If you do not follow these steps carefully, you may encounter issues with your installation. Please follow each step closely, and if the installation fails, review the steps again. 😊

Requirements

  • Compatible with Magento 2/Adobe Commerce native checkout
    • Note: Unlike the standard ShipperHQ extension, which does not modify checkout, the Enhanced Checkout module may be incompatible with third-party checkouts. Contact your checkout developer for custom compatibility.
  • Available only on the ShipperHQ Enterprise plan. Connect with a shipping expert if you need to switch plans at sales@shipperhq.com.
  • Requires Magento 2/Adobe Commerce version 2.3.4 or higher.

Table of Contents

Presumptions

Before proceeding, request access to the satis repository by emailing support@shipperhq.com and include your ShipperHQ login email address. We assume you understand Magento 2 and have it installed correctly. Ensure your /vendor/ directory is writable to avoid messages stating module-shipper or module-logger "does not exist and could not be created." 💡

⚠️ Note: It's highly recommended to back up your server files and database before installing this module. No responsibility is taken for any adverse effects. Installing on a test server initially for your testing is advisable.

Main Installation Process

If you've previously installed the standard ShipperHQ extension, please uninstall those modules before proceeding.

Edit composer.json

Add the packages.shipperhq repository to your composer.json file:

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

Clean Install

  1. Enable Maintenance mode using php bin/magento maintenance:enable **
  2. Run the following commands from your root Magento installation directory:

    • composer require shipperhq/module-shq-client
    • composer require shipperhq/module-orderview
    • php bin/magento module:enable --clear-static-content ShipperHQ_Logger ShipperHQ_Client ShipperHQ_Server ShipperHQ_Orderview
    • 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 using php bin/magento maintenance:disable **

  4. Now that ShipperHQ is 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 using php bin/magento maintenance:enable **
  2. To update to the latest release of the current major version, continue to step 3.

Other Options: To update to a specific version or a higher major version of ShipperHQ, run the following before continuing:

  • To upgrade to a specific version: run composer require shipperhq/module-shq-client:1.0.0 --update-with-dependencies where "1.0.0" is the version you want to install.
  • To upgrade to the next major version: run composer require shipperhq/module-shq-client: ^2.0 --update-with-dependencies where "2.0" is the major version you want to install.
  1. Run the following commands from your root Magento installation directory:

    • composer update shipperhq/*
    • php bin/magento cache:flush
    • php bin/magento setup:upgrade

  2. Remove generated file content by deleting the contents of:

    • var/view_preprocessed
    • pub/static/frontend/
    • pub/static/adminhtml/
    • pub/static/_requirejs/
    • var/generation

  3. From your root Magento installation directory, run php bin/magento setup:di:compile **

  4. Deploy static content using php bin/magento setup:static-content:deploy **
  5. Disable Maintenance mode using php bin/magento maintenance:disable **
  6. Take this opportunity to synchronize your Magento 2 site with ShipperHQ.

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

😊 Happy Shipping with ShipperHQ!