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

Configure the ShipperHQ Adobe Commerce/Magento 2 Extension

Set up and connect ShipperHQ to Magento 2 for seamless shipping integration

Overview

Setting up your website in ShipperHQ gives you the credentials needed to connect your Magento ShipperHQ extension. This document guides you through the basic steps to connect with ShipperHQ and other available configuration options.

Table of Contents

Before You Begin

Connecting ShipperHQ Account to Magento

  1. Obtain your API Key and Authentication Code from ShipperHQ by logging into your account and navigating to Websites. Edit the website configured for this store and go to eCommerce Configuration.

    Connect ShipperHQ with your eCommerce site - API key and authorization code.

  2. Enter the API Key and Authentication code into the associated fields in the extension settings within your Store Configuration options in the Magento 2 admin. These options are found at Stores > Configuration > Sales > Shipping Methods > ShipperHQ.
  3. Ensure the Environment Scope dropdown matches your ShipperHQ environment scope setting with the Scope used for your API and Authentication codes.
  4. Set the Enabled dropdown to "Yes" and disable all other shipping methods in Magento to prevent unexpected results at checkout.
  5. Save the store configuration settings.

If you have multiple websites running different ShipperHQ configurations, create each website in ShipperHQ and collect the API Key and Authentication code. Then, within the Shipping Methods > ShipperHQ website settings, uncheck the "default" setting and override the API Key and Authentication code for each of your websites.

Configuring Extension Settings

💡 Please note: Unless directly advised by ShipperHQ, the Sandbox mode must be set to "No." Enabling Sandbox mode will show that SHQ is not contactable.

ShipperHQ Configuration Options

  • Main Shipping Carrier Title: Carrier title displayed when no other title is returned from ShipperHQ
  • Environment Scope: Match the environment scope configured in the ShipperHQ dashboard
  • API Key: Unique identifier in ShipperHQ for your website
  • Authentication Code: Unique code to authenticate this website with ShipperHQ
  • Backup Carrier/Method: Select a standard Magento shipping carrier to act as a backup in case ShipperHQ is not responding

Advanced Settings Panel

  • Custom Shipping Rates in Admin: Allow admin users to set a custom shipping rate when placing orders via the admin panel
  • Hide Carrier Notifications At Checkout: Hide notifications if carriers include additional information with rates
  • Display Transaction ID: Enable this setting for debugging if advised by ShipperHQ support
  • Require Meaningful Address to Request Rates: Request shipping rates only if a zipcode is entered at checkout, reducing API requests
  • Enable Caching of ShipperHQ Rates: Allow ShipperHQ to cache shipping rate requests to minimize API requests
  • Timeout (seconds): Set the timeout period in seconds before calling the backup carrier
  • Sandbox URL: DO NOT EDIT - URL for connecting to the sandbox or test environment
  • Secure URL: DO NOT EDIT - URL for securely connecting to the live ShipperHQ environment
  • Sandbox Mode: Select "Yes" to use the sandbox or test environment

Standard Shipping Panel

  • Calculate Handling Fee: Handling fee type
  • Handling Fee: Enter fee or leave blank for no fee
  • Ship to Applicable Countries: Limit ShipperHQ to selected or all countries
  • Ship to Specific Countries: Select applicable countries for ShipperHQ carrier
  • Show Method if Not Applicable: Display notification from ShipperHQ if no rates are returned
  • Sort Order: Determine the order of ShipperHQ rates in Magento
  • Displayed Error Message: Text shown if ShipperHQ does not return a response
  • Debug: Enable additional logging and frontend display to assist in debugging