Support

Frequently asked questions

How do I see my API usage?

Your application page displays the number of API requests your application has made.

To see your API usage:

1. Select Apps in the main menu.
2. Select your application.
3. In the API products table, you’ll see all the products your application has access to.

For each API you have access to, you can compare the usage to the rate limit.

How do I test an API?

Once you have access to an API product, you can try it out in your browser without any additional setup. All you have to do is select the endpoint you want, and then select Try it.

To try an API:

1. Under the Try it tab, select the API credential you generated for an app in the dropdown. This will automatically populate the API Key field (only one credential will be displayed if you didn’t create multiple credentials). You can also enter your API Key manually in the API Key field.

Please note: The portal won’t give you an API Secret. You must have saved it when creating an app. You can reset your API Key and API Secret in the Apps settings, if necessary.

2. Enter the associated API Secret.
3. Under Scopes, check the Merchant box.
4. Press Get token to ensure correct access.
5. Select and modify your parameters.
6. Press Send and see the response given by the server.

How do I create an application?

Developers can create apps inside the portal. These apps allow you to request credentials to the available APIs. An app can have one or more APIs, depending on the use case.

First-time users should visit the Apps page to create their first app.

Existing users can go directly to the Apps section to use an existing app or to create a new app. You can add as many apps as needed.

After creating an app, you’ll get new credentials consisting of a unique API Key and an API Secret.

Please note:

• The API Secret will only be displayed once. Make sure you take note of it and keep it for your records.
• You must be logged in to see the Apps menu option in the top navigation.

To create a new app:

1. Select Apps in the top navigation menu.
2. Choose Create new app.
3. Select an app type: Test or Production¹. Please note: You can’t change the app type after creation.
4. Enter a meaningful app name.
5. Add a description explaining the app's purpose (optional).
6. Select Create.

Tip: You can customize your app by adding an image or icon after the initial setup.

¹ Test apps use static/stubbed data and don’t trigger billing, making them ideal for integration testing. Production apps use live data and generate real-world keys.

When you’re finished creating your app, you’ll be brought to the app’s API product section to begin adding APIs.

Please note: You can edit or delete an app at any time if it’s not in use.

Notes about API credentials

• To edit or reset your credentials or API Secret, select the three dots under Credentials in the API products section and make your changes.
• Any app can have multiple credentials.

For more information about the types of credentials supported by Canada Post, consult the Authentication guide.

What’s the difference between a Test app and a Production app? What are the limitations?

Test apps use static/stubbed data and don’t trigger billing, making them ideal for integration testing. Production apps use live data and generate real-world keys.

How do I reset my application’s API Secret?

Your API Secret is encrypted, so we can’t retrieve it if you forget it. You can, however, reset it. The stored value will be updated and the new value will be returned to you.

To reset your API Secret:

1. Select Apps in the main menu.
2. Select the application in question.
3. Select the Reset API Secret link in the Credentials section menu (next to the Add credential button).
4. Select Reset in the popup modal.

How do I integrate Canada Post shipping into my website?

The Canada Post Developer Portal provides a set of APIs for developers to connect to our shipping system. Sign in and get comprehensive documentation, code samples, and keys to integrate our APIs into your existing platform.

You can also connect with approved third-party solution providers who have already integrated Canada Post technologies. They can help simplify the purchase process for you and your online shoppers.

I have questions or problems with a shipping plugin or modules. What do I do?

Canada Post relies on third parties to create solutions that interface with our system. We don’t have visibility into these solutions, and we can’t provide direct support for them.

We recommend you contact the specific application’s support team for any questions you may have. They should be your first contact if an issue arises that requires troubleshooting.

If it’s determined that the problem originates from our system, we’ll provide help as needed.

Why is the label showing a different weight than the one I submitted for the shipment?

The weight on most of our labels is represented as "KG VE/EV", where "VE" means volumetric equivalent. This is the volumetric (cubic) weight of the package calculated from the weight and dimensions in your request.

Why does my manifest created in the development environment only show a single item?

Some data in the test environment is stubbed or faked, and this is therefore expected behaviour.