Connecting to Your Website

Overview

Websites in ShipperHQ control how your website, ecommerce platform, or other systems connect with ShipperHQ. For some platforms, Websites provides you with the credentials required to make the connection to ShipperHQ. For others, your Website will be automatically set up for you when you install the ShipperHQ app. In either case, Websites contain configuration options relating to how ShipperHQ interacts with your system.

Instructions by Ecommerce Platform

BigCommerce

When you install the ShipperHQ app in BigCommerce, your Website with be automatically set up in ShipperHQ. You can then configure the relevant items described in this doc if required or proceed directly to setting up your shipping requirements.

Magento 2.x and 1.x

The ShipperHQ Extension for Magento 2.x or Magento 1.x can be installed prior to or after setting up your Website in ShipperHQ. In order to connect your site to ShipperHQ, you will need to enter the API Key and Authentication Code provided on your Website in ShipperHQ while configuring the Magento 2.x or Magento 1.x ShipperHQ extension.

Note When you create a new ShipperHQ account, a default example Website will be created for you automatically. You can simply change the Website Name and Website URL to use this as your Website.

Shopify

When you install the ShipperHQ app for Shopify, your Website will be automatically set up in ShipperHQ. You can then configure the relevant items described in this doc if required or proceed directly to setting up your shipping requirements.

Zoey

The ShipperHQ Extension for Zoey can be installed prior to or after setting up your Website in ShipperHQ. In order to connect your site to ShipperHQ, you will need the API Key and Authentication Code provided on your Website in ShipperHQ.

Note When you create a new ShipperHQ account, a default example Website will be created for you automatically. You can simply change the Website Name and Website URL to use this as your Website.

WooCommerce

The ShipperHQ plugin for WooCommerce can be installed prior to or after setting up your Website in ShipperHQ. In order to connect your site to ShipperHQ, you will need the API Key and Authentication Code provided on your Website in ShipperHQ.

Note When you create a new ShipperHQ account, a default example Website will be created for you automatically. You can simply change the Website Name and Website URL to use this as your Website.

API Integrations

If you are using a custom-built integration with the ShipperHQ API it is useful to have a Website configured in your ShipperHQ account prior to starting development. The API Key and Authentication code provided on your Website in ShipperHQ will be required to connect to the ShipperHQ API.

Website Configuration

Basic Configuration

Field Name Description Example Supported On
Website URL The URL for this website. www.mytestsite.com All Platforms
Website Name Your internal name for this website. Company Website Name All Platforms
Internal Description A description of this website for your internal reference. Test website. All Platforms
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… Magento, Zoey, WooCommerce, API
Generate new 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.

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.
d79ef1e5b654ea3280e… Magento, Zoey, WooCommerce, API
Default Origin Your primary warehouse or ship-from location. California Warehouse All Platforms
Active Origins All ship-from locations that may be used for orders on this website. All Websites must have at least one Origin connected. May be used along with the Multi-Origin and Dropshipping Advanced Feature for multiple Origins. California Warehouse, New York Warehouse All Platforms

Optional Configuration

Field Name Description Example Supported On
All Products belong to All Assigned Origins If checked, all products are assumed to be available to ship from all Active Origins attached to this Website. Requires the Multi-Origin & Dropship Feature. Checked All Platforms

Advanced Configuration

Field Name Description Example Supported On
Use Parent for Attributes If checked, ShipperHQ will look at the parent product for configurable products, bundled products, or products with variants when checking for shipping-related attributes such as weight, dimensions, Shipping Group, Origin, etc. If unchecked, ShipperHQ will look at the child product for these attributes for any configurable products, bundled products, or products with variants. This setting does not impact simple products. Checked All Platforms
Ignore Virtual Products If checked, ShipperHQ will ignore virtual products (digital downloads, virtual gift cards, etc.). 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. Checked Magento, Zoey

Multiple Websites

For ShipperHQ accounts connected to Magento, Zoey, WooCommerce, or a Custom Integration you may configure multiple websites if on the ShipperHQ Standard plan or higher. This is useful for connecting a live website as well as a development or staging website to the same ShipperHQ account without the risk of impacting the connection to ShipperHQ by resetting the Authentication Code on the staging or development website.

Troubleshooting

If you’re seeing errors while connecting your store to ShipperHQ, check out our Troubleshooting doc for common problems.