In order to establish the Canada Post API connection you will need to enter the login credentials at the very top of the plugin configuration screen:
As you can see they consist of:
- Username
- Password
- Customer Number
Once your login credentials were entered and Save changes button hit, the API Connection Status should change to OK and turn green.
Obtaining the credentials will require creating a Canada Post account, which you will find described step-by-step below.
Creating a new Canada Post account
First of all, start with visiting the Canada Post site at https://www.canadapost-postescanada.ca/cpotools/apps/drc/home.
Click Sign up button:
You should be redirected to the login page. You can use your existing Canada Post account or register a new account. If you already have a Canada Post account, fill in your login details and click Sign In button.
If you want to create a new account, click Register now button.
To get Canada Post API login credentials you need to create your Canada Post business profile.
Sign up using your existing customer number or click Sing up for customer number button if you don’t have one yet.
Create your Canada Post business profile by filling in the necessary information.
After successful verification you can go back to https://www.canadapost-postescanada.ca/cpotools/apps/drc/home and after logging in, join the Developer Program.
After joining the Developer Program, the next screen will include:
- Customer Number (1)
- API Keys (2)
- Username
- Password
Enter them on the Canada Post Live Rates plugin configuraton screen at WooCommerce → Settings → Shipping → Canada Post Live Rates and hit the Save changes button at the bottom.
Using already existing Canada Post account
If you already have existing Canada Post account, you can simply join the Development Program. In order to do that log in to your Canada Post account and click Join NOW button and access the Developer Program here.
The next screen will include:
- Customer Number (1)
- API Keys (2)
- Username
- Password
Enter them on the Canada Post Live Rates plugin configuration screen at WooCommerce → Settings → Shipping → Canada Post Live Rates and hit the Save changes button at the bottom.
API Connection Status
Once your login credentials were entered and Save changes button hit, the API Connection Status should change to OK and turn green.
Canada Post API Access: Legacy Developer Program vs. New Developer Portal (OAuth 2.0)
Canada Post now operates two separate developer systems for accessing their shipping APIs. If you’re setting up Canada Post Live Rates, it’s important to understand which system you’re using, since the two are not compatible with each other.
Legacy Developer Program (API keys)
This is the original system, based on a development key and a production key. It’s the system our Canada Post Live Rates plugin currently supports.
New Developer Portal (OAuth 2.0)
Canada Post has introduced a modern Developer Portal built on OAuth 2.0 authentication (using client_id / client_secret credentials instead of static API keys). Canada Post is actively promoting this as the recommended path for new integrations, with modern JSON endpoints and faster onboarding.
For our plugin: Canada Post Live Rates currently works with legacy API credentials (development/production keys). New OAuth 2.0 credentials from the new Developer Portal will not work with the plugin at this time.
How to get legacy Developer Program credentials (as a new user)
Previously, new users could register for the legacy Developer Program directly through a self-service online form. This is no longer the case. As of now, Canada Post requires new legacy accounts to be set up through their support team:
- Call Canada Post technical support at 1-877-376-1212.
- Ask them to open a ticket for legacy Developer Program access.
- Be ready to provide your Canada Post customer number — this is used to verify your identity.
- Canada Post support will issue your development and production API keys once your identity and account are verified.