You can reach the plugin settings by choosing the WooCommerce → Settings → Shipping → Canada Post Live Rates from the sidebar.
API Settings
Go to WooCommerce → Settings → Shipping → Canada Post Live Rates to configure the Canada Post connection. These settings apply to all Canada Post Live Rates shipping methods in your store.
API Type
Choose the connection matching your credentials:
| API Type | Credentials | Where to obtain them |
|---|---|---|
| REST API | API Key and API Secret | Your application in the new Canada Post Developer Portal. |
| Legacy API | API Key Username, API Key Password, and Customer Number | The legacy Canada Post Developer Program. |
The plugin supports both connection types. Existing settings continue to use Legacy API until you select REST API and save the new credentials. Credentials for one connection type cannot be used with the other.
For the new connection, follow How to get the REST API Key and API Secret? (materiał 01 na tej karcie). To switch an existing store, see Migrating from Legacy API to REST API (materiał 03 na tej karcie).
API Key and API Secret — REST API
Enter the API Key and matching API Secret from your Production application with access to the Rating API product. These identify your application; they are not your Canada Post website login or your Octolize subscription key.
The plugin handles OAuth access tokens automatically. There is no token field or REST test environment selector in the plugin.
API Key Username and API Key Password — Legacy API
Enter the credentials issued for the legacy Developer Program. These fields appear when Legacy API is selected. See How to create an account? for the distinction between the two systems.
Customer Number
For Legacy API, enter your Canada Post customer number.
For REST API, enter your customer number when using Quote Type → Commercial. For regular retail rates, select Quote Type → Counter in each relevant shipping method. REST Counter requests omit the customer number and contract ID, even if those values are saved globally.
Leaving this field empty does not automatically change a method’s Quote Type to Counter. Commercial methods still need a customer number.
Contract ID — REST API
If you have a commercial Canada Post contract, enter its contract number to request the associated Commercial rates. Solutions for Small Business members and general business users without a commercial contract should leave this field empty. Canada Post distinguishes these cases in the Rating API specification.
Customer Number and Contract ID are separate values. Preserve any leading zeroes and use the numbers assigned by Canada Post.
Quote Type is configured per shipping method
Open WooCommerce → Settings → Shipping → Shipping zones, edit the appropriate Canada Post Live Rates method, and review Rates Adjustments → Quote Type:
- Commercial requests discounted account rates and requires the customer number, plus a contract ID for contract customers.
- Counter requests regular retail rates.
See Shipping method configuration.
API Connection Status
After entering your credentials, select Save changes and check API Connection Status. A green OK status indicates a successful connection check.
For REST API, the check requests a sample Counter quote. It confirms that the application can access Rating, but it does not validate Commercial account details or guarantee that a service is available for your customers’ parcels. Check a real cart after configuring the connection.
If an error appears, follow REST API troubleshooting.
Origin Settings
The Canada Post plugin uses the shop’s origin entered in the WooCommerce settings at WooCommerce → Settings → General → Store Address by default. However, if you want the live rates to be calculated for the different shipper’s address than your shop’s because e.g. you ship your products not from the shop but directly from the warehouse located somewhere else, you can define the Custom Origin using the fields below:
Custom Origin is fully optional for WooCommerce 3.2 and later releases. If, for some reason, your shop still uses the WooCommerce pre-3.2 version, defining the Custom Origin in the plugin settings above is mandatory.
Please be advised that each shipping method that uses Canada Post plugin can have its own Custom Origin. To learn more about Multiple Custom Origins feature – read this article →