Browse by Topic

ShipperHQ

We’ve integrated with ShipperHQ to provide you with advanced tools to control what shipping options to offer your customers during the checkout process. ShipperHQ enables you to do things like:

  • Per product per zone shipping options
  • Different shipping options based on customer groups
  • Different shipping options based on different shipping origin addresses; useful for those with warehouses in multiple locations and those using dropshippers
  • You can define what box sizes you ship with as well as how many products you can get into different boxes.
  • Support for Freight Carriers
  • and more...
 
 

How the Integration Works

When one of your customers goes through the checkout flow, BigCommerce will reach out to ShipperHQ via an API call and ask ShipperHQ what shipping rates to offer to your customers. ShipperHQ will return a set of values in the API response and BigCommerce will use those values to display them to your customers.

As a part of the API request to ShipperHQ, BigCommerce will include basic information about the order that ShipperHQ needs in order to determine what shipping rate to offer your customer. The information we send includes product information such as:

  • weight
  • dimensions
  • quantity
  • price
  • customer group (if any)
  • free shipping (on or off)
  • fixed shipping price (if assigned)

You can then set up shipping rules in ShipperHQ that offer specific shipping options to your customers based on this data.

 

Product Shipping Attributes

There are three new fields available for you to define on the product level in BigCommerce that are included in the information we send to ShipperHQ to determine what shipping options to show your customers. These fields are not available until after you install the ShipperHQ app.

The specific fields available for you to define in your BigCommerce product catalog are:

You can also define these fields using the Product Import/Export feature.

ShipperHQ Attributes

 

Shipping Groups

Shipping Groups allow you to offer different shipping options based on the product being purchased. Some examples would be perishable products which have restrictions around how long they can be in transit, bulky products which may need to be shipped via LTL freight, or situations where you're offering a special shipping promotion on certain products. Here is a ShipperHQ doc showing an example setup.

You'll need to set up your Shipping Groups in ShipperHQ, then assign them to your products here. Make sure the values entered here exactly match the Shipping Group names in ShipperHQ and use commas to separate multiple values.

 

Origin Locations

ShipperHQ will use the default shipping origin whenever a product doesn't have a specific Shipping Origin applied to it here. So if you ship everything from a single location, you don't need to enter in any shipping origins. If you ship the majority of your products from a primary shipping origin, then you only need to add a Shipping Origin to the products that ship from your secondary location.

Make sure the values entered here exactly match the Origin names in ShipperHQ and use commas to separate multiple values.

For more information see ShipperHQ's Origin Configuration doc.

 

Dimensional Rules

By setting up Dimensional Rules you can configure a different way of handling certain products when ShipperHQ is calculating order dimension information. For example, some of your products may always ship separately from the rest of your products and never get packed into a box with other products.

Once you've set up your Dimensional Rules in ShipperHQ, you can enter the Rule Name in this field. Only one Dimensional Rule can be applied per product. In most cases, you will only need to enter Dimensional Rules for a subset of your products which are packed differently from the rest of your products.

 

Customer Groups

In addition to the three product shipping attributes mentioned above, we also include the customer group that the customer checking out belongs to. This enables you to offer different shipping options to different customer groups by defining shipping rules for customer groups in ShipperHQ.

Customer Groups

 
 

Installing the ShipperHQ app

The ShipperHQ app is available for you to install in our App Store. Installing the ShipperHQ app will not have any immediate impact on your BigCommerce store’s checkout flow. This gives you time to configure your shipping settings.

Shipper HQ App

After you’ve configured all your settings you can turn on ShipperHQ from your BigCommerce Control Panel in the Shipping Manager. This will cause ShipperHQ to control what options are displayed to your shoppers during the checkout flow instead of the options you’ve configured in BigCommerce.

 
 

Turning on ShipperHQ

Once you are done configuring all of your shipping settings in ShipperHQ, and have applied the appropriate shipping attributes to your product catalog, you can turn on ShipperHQ so that it starts controlling what shipping options are shown to your customers during the checkout flow.

This is done in your BigCommerce Shipping Manager. Navigate to Store SetupShipping. In the Checkout Shipping Options section you’ll see a toggle to enable Advanced shipping rules. Once enabled, ShipperHQ will immediately start powering your checkout shipping options.

Advanced shipping settings switch being toggled to on

Upon enabling ShipperHQ, all of your previous settings for Default shipping rules will be saved, but they will have no impact on your checkout shipping options. If you go back to Default shipping rules all of your previous settings will immediately go into effect and ShipperHQ will have no impact on your checkout shipping options. This allows you to go back and forth between the two systems as needed while you conduct testing to make sure you have everything working properly.

 

Preview Advanced Shipping

By enabling Preview Advanced Shipping, the shipping rates and quotes generated by ShipperHQ at checkout can be previewed by store users logged into the control panel before enabling them live for your shoppers. This is useful for confirming your settings at ShipperHQ have been configured correctly before publicly surfacing them to your shoppers.

Preview Advanced Shipping box checked

Your shoppers will not be impacted by this preview — they will continue to see the Default shipping rules previously configured. Once you are satisfied with the quotes being generated, you are ready to use ShipperHQ. To activate ShipperHQ, click the toggle to enable Advanced Shipping Rules (see Turning on ShipperHQ).

Preview Advanced Shipping is only available if ShipperHQ is already installed and is not currently powering checkout.

 

Fallback Shipping Methods

To provide extra peace of mind, you can set up Fallback Shipping Methods which will only trigger if there is an issue communicating with ShipperHQ. This means that customers will always see shipping options during checkout. Created shipping zones are listed under the Fallback Shipping Method section. Click the Configure button and set up the shipping methods that should be used as a fallback option. 

Fallback Shipping methods

 
 

ShipperHQ Supported Carriers

Small package carriersLTL freight carriers
  • UPS
  • UPS SurePost
  • USPS
  • FedEx
  • FedEx SmartPost
  • GSO
  • Australia Post
  • StarTrack
  • DHL
  • DHL Express via ILS
  • Fastway
  • Canada Post
  • Cerasis
  • Echo Global Logistics
  • ReTrans Freight
  • Primus / GLB
 
 

Getting Help

The ShipperHQ support team is available if you need any help figuring out how to set up your shipping rates with ShipperHQ. To contact the ShipperHQ team:

ShipperHQ carrier and packing details are included in your Store Logs. This information can be useful when first configuring your ShipperHQ settings. See ShipperHQ documentation for more information on how to configure ShipperHQ.

ShipperHQ details in the Store Logs section of the control panel

 
 

Applying Attributes to Products via CSV Import/Export

If you're using ShipperHQ, you can save time by applying Shipping Groups, Shipping Origins, and/or Dimensional Rules to multiple products at the same time. You can do this by using our Import/Export feature to add this information via spreadsheet and importing it into your store.

 

New to our Import/Export feature? Brush up on importing products and exporting products. For a quick overview on updating products with this feature, see Updating Products Using Import/Export.

 

Creating a Shipping Export Template

Since the shipping attributes are not included in the default or bulk edit export templates, you'll need to create a custom export template in order to export and re-import these details. The steps below will cover creating a customized export template that includes the shipping attribute fields.

1. Go to Advanced SettingsExport Templates.

2. In the Action drop-down next to Bulk Edit, select Choose an ActionCreate a Copy.

Copy the Bulk Edit template

3. Rename your custom template (we used "Shipping"), then click on the Products tab.

4. You will be brought to a list of product attributes. Click the checkbox next to Export this field to deselect all fields, then reselect the following fields.

  • Product Name
  • Category String
  • Shipping Groups
  • Origin Locations
  • Dimensional Rules

If you prefer, you can keep the other fields selected; they will just make it slightly more difficult to locate the shipping attributes in the spreadsheet.

ShipperHQ attributes under the Products tab when creating a new export template

5. Click Save & Exit.

 

Exporting Your Products

 

Make a sample! Before exporting your products, edit a product and add the shipping attributes. (They can be found in the Details tab under Shipping.) This way you'll have a live example of how these fields are formatted in the spreadsheet, making it easier to apply them to the rest of your products.

1. Go to ProductsExport.

2. Under Template, select the shipping template that you created.

The newly created export template selected in the Export Products screen

3. Click Continue and follow the prompts to download your CSV file. Open the spreadsheet using your spreadsheet editor of choice.

4. Add your shipping attributes to the Shipping Groups, Origin Locations, and Dimensional Rules columns.

Sample CSV with shipping fields highlighted

5. Save your spreadsheet when done. Do not change the file type from CSV, since only CSV files can be re-imported.

6. Re-import your spreadsheet. Double-check some of your updated products to make sure the data was imported accurately.

 
 

Adding the 'City' Field to the Cart Page (Blueprint Themes)

 

This only applies to our Legacy Blueprint Themes. These instructions may not be compatible with third-party developed themes, or themes based on our new Stencil themes.

If you use ShipperHQ, and use YRC Freight and/or FedEx LTL to provide real-time freight shipping quotes to your shoppers, it requires the city value to properly return freight shipping quotes, and the Estimate Shipping & Tax button on the cart page will not return quotes for these services unless the City field is included.

Before making any changes, back up your theme customizations.

 

Adding the HTML to Panels/CartContent.html

1. Go to Storefront › Design Options, then click Edit HTML/CSS.

2. In the list of Other Template Files on the left, locate and click CartContent.html under Panels.

Use Ctrl F or Command F to quickly locate template files in the list.

3. Add the following two lines of code between the State and Zip/Postcode fields. Please note that the class may require some theme-specific customisation, and should be made to match the surrounding fields in style.

<dt>%%LNG_City%%:</dt>
<dd><input type="text" class="Textbox" name="shippingZoneCity" id="shippingZoneCity" value="%%GLOBAL_ShippingCity%%" /></dd>

Before:

Template HTML editor showing where to add the city field code (before)

After:

Template HTML editor showing where to add the city field code (after)

4. Save your changes.

 

Adding the HTML to cart.html

If your store was created before February 8, 2016, use the following instructions to add the required HTML to your template. If your store was created after this date, the required code is already included, and you can skip this section.

1. In the list of Other Template Files on the left, locate and click cart.html.

Use Ctrl F or Command F to quickly locate template files in the list.

2. On or around line 3, replace %%GLOBAL_TPL_PATH%%/js/cart.js with the following:

%%ASSET_js/cart.js%%

Before:

Template HTML editor showing where to add the reference to your custom cart.js file (before)

After:

Template HTML editor showing where to add the reference to your custom cart.js file (after)

3. Save your changes.

 

Adding the Javascript to js/cart.js

If your store was created before February 8, 2016, use the following instructions to add the required HTML to your template. If your store was created after this date, the required code is already included, and you can skip this section.

1. Connect to your store using a WebDAV client, like CyberDuck.

2. Navigate to the template folder, then open the js folder.

3. Download cart.js to your computer, then open it in a text editor like Notepad or TextEdit.

4. Locate w: 'getShippingQuotes', and paste the following code on the line immediately after it.

city: $('#shippingZoneCity').val(),

Before:

Editing cart.js to include the city variable (before)

After:

Editing cart.js to include the city variable (after)

5. Save the file, then re-upload it back to the template/js folder in your store.

 

Confirming Installation

If completed correctly, you should now be able to see the optional City field on your store’s cart page. To test that it is working correctly, enter some test State, City and Zip/Postcode credentials, then click the Estimate Shipping & Tax button to confirm you are receiving freight quotes via ShipperHQ.

Note that your freight shipping rules must already be configured in your ShipperHQ account.

Was this article helpful?