How to Connect your Website in ShipperHQ

Overview

Setting up a Website in ShipperHQ gives you the credentials you’ll need to connect your eCommerce store to ShipperHQ. Depending on the eCommerce platform you’re using, website configuration may be different. This document walks you through the configuration options available for Websites in ShipperHQ.

Configuration

Listed below are the

Website Overview Panel
Field Name Description Example Required?
Website Name Your internal name for this website. Test
Website URL The URL for this website. www.test.com
Internal Description A description of this website for your internal reference. Test website.
API Key The API Key used to validate communications between your website and ShipperHQ. This is generated by ShipperHQ when you save the website and is shown on the Websites index. 12309ddccdb362d…
Generate Authentication Code/Reset Authentication Code Click this button to generate an Authentication Code used to validate communications between your website and ShipperHQ. This will be automatically generated and shown to you once, but won’t be visible after that point for security reasons. You should record this Authentication Code somewhere safe. d79ef1e5b654ea3280e…
Active Origins The origins that are associated with the website. All locations where items are shipping from. California Warehouse
Default Origin The main origin or warehouse. California Warehouse
  1. The first step will be to create a new site or edit the default site by going to the Websites section in the navbar of your account.
    Copy_API_Key
  2. A new authentication code can then be generated. This code in conjunction with your API key will allow ShipperHQ to connect and sync with your Magento, Zoey, or WooCommerce accounts. For more instruction on how to use these credentials to connect SHQ to your platform, please visit the following pages:
    1. Magento 1 Extension Configuration
    2. Magento 2 Extension Configuration
    3. WooCommerce Extension Configuration
In order to successfully connect your eCommerce site to ShipperHQ, you’ll first need to install it on your site as well as set up a new website as shown here.

Generate_Key_Popup

Auth_Code_Generated

If you change the Authentication Code after having set up your connection to your site, you’ll need to update your site with the new Authentication Code as it will take effect immediately.
Advanced Options Panel
Field Name Description Example
Use Parent for Attributes When handling bundles/configurables check this box to use Attributes such as Location, Shipping Group defined on these, disabled to use child simple products When you have parent/child products, and product dimensions as well as other attributes are only on parent product, in this instance option need to be ticked.
Ignore Virtual products Specify whether virtual products are used in the shipping rate calculation. This is to be used with downloadable products or products that has no weight nor dimensions and needed to be ignored from rate calculations when  request is triggered from the platform.

Trouble Shooting

You may receive an error that looks something like this when trying to configure your site within Magento:
megento_error

 

The most usual reason behind this is that SandBox Mode is enabled. So make sure that it is set to ‘No’ unless specifically instructed to do so. Some other trouble shooting methods would be to make sure that the environment scope matches the same one set within ShipperHQ. Also, double check that the API Key and Authentication code were input properly.

If nothing happens after clicking “Generate New Authentication Code” (3, above) this is likely a new website. In this scenario, at the bottom, select the drop-down arrow to the right of the “Save” button and click “Save and Edit”. When successfully saved, click the Generate button again. This should then show you the authentication code.