Canada Post Corporation (CPC)
Overview
Canada Post Corporation (CPC) is a national postal service provider in Canada. It deals with shipping and mailing services, and the major products and services have been divided into three categories:
- Transaction Mail
- Parcels
- Direct marketing
We, PB-SendTech Solution, trade with Parcels services only.
Onboarding of a Canada Post Carrier Account
To onboard a CPC carrier account, the user needs to possess the following pre-requisites:
- Payment Method
- Location ID
For onboarding the carrier, an API request call is made, that covers all the essentials. Below is the Sample Request to onboard CPC carrier:
CPC Sample Request
{
"carrierID": "CPC",
"description": "CPC",
"carrierAccountType": "Shipping",
"provisioningType": "API",
"parameters": {
"paymentMethod": "CARRIER",
"locationID": "04vkZJPqo1Y"
}
}
If the request to onboard the CPC carrier account is successful, the response will have all the details as indicated in the below Sample Response.
CPC Sample Response
{
"carrierAccountID": "xxxx1xxxx4dn",
"description": "CPC",
"carrierID": "CPC",
"accountNumber": "xxxxxxxx",
"parameters": {
"accountType": "ENTERPRISE",
"customerNumber": "xxxxxxxx",
"email": "xxxx@xxx.xx",
"paymentMethod": "CARRIER",
"shipToBpn": "xxxxxxx",
"username": "xxxxcccbb611xxx"
},
"carrierAccountType": "Shipping",
"provisioningType": "Web"
}
API Operations for Shipping with CPC
The APIs integrate with CPC through the following operations:
Operations | Method | Resource Path |
---|---|---|
Add a Carrier Account | POST | /api/v1/carrierAccounts |
Rate a Parcel | POST | /api/v1/rates |
Create a Shipping Label | POST | /api/v1/shipments |
Reprint a Label | GET | /api/v1/shipments/{{shipmentId}}/reprint |
Void a Label | PUT | /api/v1/shipments/{{shipmentId}}/cancel |
Get Tracking Information | GET | /api/v1/tracking/{{trackingNumber}} |
Canada Post also supports
shipmentByRateShop
operations:Operations | Method | Resource Path |
---|---|---|
Create a Shipping Label | POST | /api/v2/shipments |
Reprint a Label | POST | /api/v2/shipments/reprint |
Void a Label | POST | /api/v2/shipments/cancel |
Metadata
Metadata provides information about CPC carrier services, including origin and destination countries, supported carrier services, supported package types, and supported special services. Users can select specific origin and destination countries from the provided dropdown menu to dynamically view relevant metadata specific to those countries.