This article explains how to set up the integration, configure mail order shipping options, understand delivery notifications, and migrate from ShipStation if applicable.
Setting up the integration
To connect Breadstack with Canada Post, you’ll need to retrieve your Canada Post credentials and enter them in Breadstack.
Step 1: Find your Canada Post credentials
Before configuring the integration, gather the following information from your Canada Post account: your Customer Number, API Key Username, API Key Password, and (if applicable) your Contract ID. Here's where to find each one:
Customer Number
You can find your Customer Number in the Canada Post dashboard.
Insert screenshot: Canada Post dashboard showing Customer Number
API Key Username and API Key Password
These credentials are generated through the Canada Post Developer Portal.
-
Sign in to the Canada Post Developer Portal
-
Generate or locate your production API credentials.
-
Copy the API Key Username and API Key Password.
Contract ID (optional)
If you have a Canada Post contract, your Contract ID can also be found in the Developer Portal.
This determines how shipping fees are charged when a waybill is created, based on your agreement with Canada Post.
Step 2: Configure Canada Post in Breadstack
⚠️ Important note for ShipStation users
Enabling the Canada Post integration automatically disables the ShipStation integration. Only one can be active at a time.
Read our recommended migration steps before continuing.
Once you have your credentials:
-
In Breadstack, go to Settings → Integrations → Canada Post.
-
Enable the Canada Post integration.
-
Enter the following details:
-
API Key Username
-
API Key Password
-
Customer Number
-
Contract ID (optional)
-
-
Save your changes.
Mail order shipping options
By default, Breadstack supports two mail order shipping options when using Canada Post:
-
Flat rate shipping
-
Free shipping
These options:
-
Ship orders via Canada Post
-
Do not require any Canada Post plugin or extension on your storefront
-
Only require the Canada Post integration to be enabled in Breadstack
Using additional Canada Post shipping options
If you use additional shipping options provided by Canada Post (for example, via a Canada Post storefront plugin), customers can select those options at checkout.
Orders placed with these shipping methods can still be fulfilled in Breadstack in the same way as Flat rate or Free shipping orders.
Delivery notifications and tracking
Once Canada Post receives the shipment details:
-
The customer receives a confirmation email containing tracking information.
-
The Track for updates link in the email directs the customer to a Canada Post tracking page with real-time delivery status.
Canada Post also offers free automatic tracking notifications. For more information, see Canada Post’s documentation: Get delivery notifications about your shipped packages
Migrating from ShipStation to a direct Canada Post integration
If you are switching from ShipStation to the direct Canada Post integration:
-
Waybills created using ShipStation cannot be voided through the Canada Post integration.
-
Waybills created using Canada Post cannot be voided through ShipStation.
Recommended migration steps
Before enabling the Canada Post integration:
-
Complete or void any existing mail orders created through ShipStation.
-
Then enable the Canada Post integration in Breadstack.
All existing Breadstack mail order workflows are fully supported after migration, with no additional configuration required.