How to Set Up Canada Post

Overview

This document will cover how to create a Canada Post API Username and Password. The instructions below will tell you where to go and how to get them.

Create a new Canada Post Carrier

When setting up your Canada Post carrier in ShipperHQ, you’ll need certain credentials that will allow ShipperHQ to connect to the Canada Post servers and obtain a rate quote. Follow these directions to obtain/set-up the necessary credentials.

Adding Canada Post carrier from the Marketplace page

  1. Navigate to the Marketplace page from the ShipperHQ Dashboard (left sidebar)
  2. Search for the Canada Post Carrier under ‘Small Package Carriers’
    • You can filter by carrier type or by installation status using the dropdown menus near the search bar
    • Being to install and validate a selected carrier by clicking the “install” button directly on the listing or click anywhere else on the listing to view a detailed page with more information about the carrier including information required for validating the carrier.
  3. Proceed to the “Register for Canada Post API Credentials” instructions below and enter the required account information for validation.
  4. Note: Successful installation depends on the accurate entry of the account information required by each carrier. If you do not have the correct information you will not be able to validate your carrier or receive live rates. 
  5. Once validation is successful, you will be presented with the option to enable your carrier right away or configure it further. Selecting configure will take you to the carrier’s details page.

Register for Canada Post API credentials

  1. You’ll need to go to the Canada Post Developer Program website. Click either “Sign in” or “Join NOW”.
  2. You need to have a Canada Post account to pull live rates with ShipperHQ. If you do not have one, you can register by clicking “Sign up” (this is 100% free).
  3. If this is your first time to access the Developer Program website, you might see a License Agreement. Please read over, then click the green button that says “Agree and Continue.”
  4. Canada Post will then prompt you through the steps required to get the credentials.
  5. Click on the blue button labeled “Developer program” on top of the left hand column, you’ll then see your “API keys”
  6. You will then copy and paste these into your Canada Post Carrier set in ShipperHQ. Proceed to “Add Credentials to Canada Post Carrier” below.

Canada_Post_-_Web_Services_and_APIs_for_eCommerce_Merchants_and_Developers

Add Credentials to Canada Post Carrier

  1. Go to the carriers page in the ShipperHQ dashboard
  2. Since you have already created the carrier, you will now need to edit it
  3. Click on the “Update Credentials” link on the top. That will bring you to the Validation screen.
  4. Click “Begin Validation” under the Canada Post install screen and enter the Canada Post API information obtained from before.
  5. ShipperHQ will indicate if validation is successful. You can enable the carrier to start rating by toggling the switch from Disabled to Enabled.
  6. Click “Configure This Carrier” to select your methods and set your Canada Post settings.