Installing Magento 2 ShipperHQ Separate Modules

Overview

ShipperHQ provides additional functionality in separate modules. These are not required in order to use ShipperHQ on Magento 2/Adobe Commerce, but they provide advanced capabilities. An example is ‘module-calendar’ which will display a delivery date selector on the checkout. These modules are held in a private composer repository.

Assumptions

In order to successfully install and use the ShipperHQ separate modules, we make a few assumptions in the following instructions.

• We assume you understand Magento 2/Adobe Commerce, and have it installed correctly
• We assume your base ShipperHQ extension is the latest version. If not, you can get the latest version from our public repo or via Composer update. Instructions to update can be found in our Installation doc
• We assume you have been granted access to our private repository
• We assume you’ve appropriately backed up your server files and database before proceeding. We cannot take responsibility for any adverse effects related to installation or use of these modules. We recommend installing on a test server initially to carry out your own testing

These modules do not support multi-address checkouts — you will only be able to see basic rates in these instances.

Modules details & functionality

Each module offers or enables specific functionality when installed or may be required to use certain ShipperHQ capabilities.

shipperhq/module-option

This module enables support for:

• Accessorial UI elements for LTL Freight carriers allowing customers to choose accessorials at checkout
• Showing tooltips on shipping methods
• Displaying input fields for Customer Account Custom Carriers

shipperhq/module-calendar

Used to display the Date & Time calendar on the checkout when you choose to display the calendar under the desired carrier date/time settings.

shipperhq/module-pickup

Used to display the details of In-Store Pickup locations along with a map if you chose to display it. We highly recommend using this module in addition to the calendar module with In-Store Pickup so that you can show a calendar on the checkout pickup orders.

shipperhq/module-orderview

Used to enable display of Shipping Insight shipment info on order details in the Magento/Adobe Commerce Admin. You will not have access to full Shipping Insights functionality without this module.

Adding modules from our Private Repository

At any point during set up if it asks you to enter credentials,  you will need to enter the credentials requested and sent to from ShipperHQ Support team.

• Using your preferred text editor, you’ll need to add the https://packages.shipperhq.com repository under the repositories section of the composer.json file located in your Magento root directory. Here’s an example of what it would look like when added to a native M2 composer.json file:

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

• You can then add the modules via command line with the commands below:

  composer require <shipperhq/module-name>
  composer update
  php bin/magento module:enable ShipperHQ_ModuleName

  for example:

  composer require shipperhq/module-calendar
  composer update
  php bin/magento module:enable ShipperHQ_Calendar

  Module names are:

  • shipperhq/module-option: ShipperHQ_Option
  • shipperhq/module-calendar: ShipperHQ_Calendar
  • shipperhq/module-pickup: ShipperHQ_Pickup
  • shipperhq/module-orderview: ShipperHQ_OrderView

Check for new versions of installed modules

If you’re ever unsure about whether you’re using the latest version of a particular module, you can use the following Composer command to check this. Composer’s output will include the current version and the latest available version:

composer show --latest shipperhq/module-name

Disabling Modules

From the command line you can disable these separate modules via:

php bin magento module:disable --clear-static-content ShipperHQ_Pickup ShipperHQ_Option ShipperHQ_Calendar

Lastly, run the standard cleanup commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento indexer:reindex
php bin/magento cache:clean