Installing the ShipperHQ Magento 2 Enhanced Checkout

Overview

This guide walks you through installing the ShipperHQ Enhanced Checkout for Magento 2. Enhanced Checkout adds advanced delivery options to your store’s checkout process, including real-time carrier rates, delivery date selection, time slots, and in-store pickup.

You’ll learn how to:

• Install the necessary modules
• Enable Enhanced Checkout features in your ShipperHQ account
• Configure settings within Magento
• Validate the setup with test scenarios

This article is aimed at developers and store administrators responsible for setting up shipping functionality. Before you begin, make sure you have a Magento 2 site and a ShipperHQ account with Enhanced Checkout enabled.

💡 For help with specific features like delivery dates or pickup options, see Using Enhanced Checkout Features or visit our Support Centre.

Requirements

To install the Enhanced Checkout, ensure you meet the following requirements:

• Magento Open Source or Adobe Commerce version 2.4.4 or newer
• Composer installed on your server
• SSH access to your server
• Admin access to your Magento installation
• Satis credentials - contact support@shipperhq.com if you don’t have access to packages.shipperhq.com
• Permissions to run commands such as php, composer, and bin/magento
• A ShipperHQ account with Enhanced Checkout enabled
• At least one active carrier configured in ShipperHQ
• API credentials (see: Connecting ShipperHQ Account to Magento)

🔍 Not sure if your plan includes Enhanced Checkout? Log in to ShipperHQ to check your dashboard or contact support.

⚠️ We recommend backing up your server files and database before starting installation. Consider using a staging or test environment.

Main Installation Process

If you’ve previously installed the standard ShipperHQ extension, uninstall it before continuing.

Edit composer.json

Add the ShipperHQ package repository to your composer.json file:

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

Clean Install

This section is for first-time installations. If you’re upgrading an existing installation, click here

Step 1: Check if Developer Mode is Enabled

In your Magento root directory, run:

php bin/magento deploy:mode:show

You’ll see one of the following:

• Current application mode: developer
• Current application mode: production

Learn more about Magento deployment modes

Step 2: Install Based on Your Mode

✅ If Developer Mode is enabled:

composer require shipperhq/module-shq-client shipperhq/module-orderview
php bin/magento module:enable ShipperHQ_Logger ShipperHQ_Client ShipperHQ_Server ShipperHQ_Orderview
php bin/magento cache:flush
php bin/magento setup:upgrade

✅ If Developer Mode is disabled (Production Mode):

php bin/magento maintenance:enable
composer require shipperhq/module-shq-client 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
php bin/magento maintenance:disable

Once complete, you can begin configuring the Enhanced Checkout settings in ShipperHQ.

Updating Existing Installation

Use this section to upgrade to the latest version of Enhanced Checkout.

1. Enable maintenance mode (unless you’re on a development server):

php bin/magento maintenance:enable

2. From your Magento root directory, run:

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

3. If Developer Mode is disabled, continue with:

php bin/magento setup:di:compile
php bin/magento setup:static-content:deploy

4. Disable maintenance mode:

php bin/magento maintenance:disable

Once updated, take this opportunity to synchronize Magento with ShipperHQ.

😊 Happy Shipping with ShipperHQ!