Skip to main content
All CollectionsAPI & Integrations
Canada Post Integration
Canada Post Integration

Learn how to set up your Canada Post integration for label generation.

Andrej Janev avatar
Written by Andrej Janev
Updated over a month ago

To start generating labels with Canada Post, we just need to follow a few simple and easy steps. Let's go:

  1. From your Rich Returns dashboard, go to Configuration -> Returns -> Return Methods -> Configure Pre-Paid Labels -> Setup. It looks like a lot of work but it's not. You'll be there before you blink. See my screenshot. If I'm doing it, you can do it too, trust me.


  2. Next stop - Canada Post. Let's choose our desired carrier from the dropdown menu.

  3. To bring this integration to life, we need your information. First piece: Customer Number. Let's find it out:

    1. Head over to the Canada Post page to log in.


    2. Once you're logged in, choose the Business Settings from your Account dropdown menu.

    3. Once there, the Customer Number will magically appear in front of you. Copy, paste and populate into your Rich Returns settings.



  4. We need the second piece - and that's our API key. Let's first find our username and password in the Canada Post dashboard.

    1. Let's visit the Canada Post Developer Program page. Make sure you're logged in. You will know that's the case by looking at the Welcome message and the Company field being populated.


    2. Head over to the API Keys section, as shown in the screenshot.


      You will see a pair of values, separated by a colon (:). You can see on the screenshot above (1):(2). You will need to copy and paste these values. Then you need to paste them in the exact same format in your Rich Returns window.


      So, for example, if my username was 1234 and my password was 5678, we'd have the following value in the field: 1234:5678.

    3. Once we've made sure that the field is populated, press the Generate API Key button. I promise, this is the last step.


      You will see an API key appear. And that's all folks! Now you can save your settings.

  5. In this last step, you just need to make sure that you have the correct options in place to start generating labels:

    1. Service: choose the service that you want to use for all prepaid labels generated through Canada Post.

    2. Canada Post Option: this option is required if your return address is outside Canada.

    3. Canada Post currency: this option is also required if your return address is outside Canada. It can be USD or CAD.

    4. Canada Post Conversion: set up the conversion rate. If you used USD in the field above, and if $1.00 CAD = $0.85 USD, then the conversion rate here would be 0.85.


      Make sure that you also have your Package Dimensions and Empty Box Weight populated. No label can be created without them!

  6. That's it! Ensure that you have the Automatic Prepaid Label option active for your customers and you're all set.

Have questions? Need assistance? Feel free to reach out and we'll guide you along the way.

Did this answer your question?