Release notes

Canada Post APIs often change and evolve over time. For example, new services or options can be added, old products can be retired, and bugs can be fixed. These modifications necessitate a change in the version number of the API. In some cases, upgrading to the new version is optional, whereas other APIs require a mandatory upgrade. We’ll provide you with advance notice by email of any new features and versions. Old versions of our APIs will be supported as long as possible. We’ll give ample notice if a version must be retired.

API categories

A diagram illustrating API product versioning. The diagram shows the API product version name for the Shipping API, with explanations for each part of the version number.

Our APIs are grouped into categories known as ‘API products’ (for example, Rating, Tracking, Shipping, and so on). API product versions are indicated by a unique version name for all API product groups (for example, Rating 4.0.0 or Rating 3.1.0). Each API product has been assigned an initial version (1.0.0) to start, and each API product is versioned independently. Your applications should use the same version of each Canada Post API when they call an API from within the same group (for example, all your applications should call Rating 4.0.0 if that’s the version you’ve chosen).

REST versioning

Version information is dynamically passed to our APIs in the HTTP header variables Content-Type or Accept (see HTTP header variables). Version information is dynamically returned from our APIs in the media-type attribute of link elements. For example:

Rating API header values
HTTP header variable	Header value
Accept	application/vnd.cpc.ship.rate-v4+xml
Content-Type	application/vnd.cpc.ship.rate-v4+xml

Important

If, in the past, your REST requests to our APIs used */* in place of the Accept header, we no longer support these requests (as of Sept. 21, 2013). You must identify a value for your Accept and Content-Type in your HTTP header.

Version status, history, and release notes

Rating

Rating
Version	Release notes
4.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Shipping

Shipping
Version	Release notes
8.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Tracking

Tracking
Version	Release notes
2.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Post Office Services

Post Office Services
Version	Release notes
1.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Pickup

Pickup
Version	Release notes
1.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Returns

Returns
Version	Release notes
2.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Service Information

Service Information
Version	Release notes
2.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.

Customer Information Services

Customer Information Services
Version	Release notes
2.0.0 Supported	April 30, 2026 New feature JSON standardization All API endpoints now utilize the JSON format for requests and responses, providing complete feature parity with previous formats. This ensures consistency and simplifies integration. Protocol simplification (REST only) We’ve streamlined our protocol support, making REST the sole available option. XML is no longer supported SOAP is no longer supported Expanded language support We’ve significantly expanded our support for the following languages: Python Ruby cURL PHP Java Node.js Go Swift C C# YAML configuration files available We now offer YAML files for easier setup and deployment of API clients. This is especially ideal for automated deployments. Please note: If your existing integration used XML or SOAP, you’ll need to migrate to the JSON/REST format to access the latest versions of our APIs. Please consult our updated API documentation for migration guides and new code examples. Security update Mandatory OAuth 2.0 Bearer tokens Every API request must now include a valid OAuth 2.0 Bearer access token in the authorization header. This enhances security and ensures compliance with modern standards. Refer to our updated documentation for details and implementation guides. Important change Merchant Registration has been decommissioned as an API endpoint. If your application integrated directly with the Merchant Registration API, you must now use the designated alternative method for registering merchants.