Canada Post API Reference
CarrierID=158
Move to: Functions, Carrier Services, Special Services, Package Types, Documents, Labels
Go to: Carrier Components List
About
Canada Post is the primary postal operator in Canada that handles domestic, business and international shipments. For more details, visit the Canada Post website.
Setup
Setup My System (onboarding wizard) is supported for this carrier, However, the key detail for this carrier is:
- Requirements:
- An Access Token (Generated automatically in Wizard) Click HERE for details.
- Signup on Canada Post Website (link in Wizard)
- Refund Email Address
- The admin user will be asked to state whether their contract allows for regular pickups of Canada Post shipments. If the client does not have regular pickups, they must either drop off their parcels at a Canada Post facility by using the Drop At Carrier Facility and Carrier Drop Facility Identifier.Click HERE for details.
- Billing Account
Functions
| Function | ID |
|---|---|
| Rate | 1 |
| Ship* | 2 |
| Void | 3 |
| Return | 4 |
| End of Day | 5 |
| Pickup | 15 |
| Pickup Cancel | 16 |
| Pickup Rate | 30 |
| Carrier Location Search** | 73 |
*Future ship not supported by Canada Post API – if utilized, will cause manifest errors and shipment rejections.
**Used when selecting “Deliver to Post Office” from Special Service is selected.
Carrier Services
| Carrier Service | ID |
|---|---|
| Expeditied Parcel | 10342 |
| Epedited Parcel USA | 10347 |
| Expedited Post | 10343 |
| Express Post Certified | 10344 |
| International Parcel Surface | 10357 |
| Library Materials | 10346 |
| Priority | 10345 |
| Small Packet Intenational Air | 10361 |
| Small Packet International Surface | 10362 |
| Small Packet USA Air | 10351 |
| Tracked Packet International | 10363 |
| Tracked Packet USA | 10352 |
| Xpresspost International | 10355 |
| Xpresspost USA | 10354 |
Special Services
| Special Service | ID |
|---|---|
| Carrier Drop Facility Identifier | 625 |
| COD - Amount | 77 |
| COD - Any | 55 |
| Coverage | 61 |
| Coverage Value | 78 |
| Delivery Confirmation - Proof of Age 18 | 621 |
| Delivery Confirmation - Proof of Age 19 | 622 |
| Delivery Confirmation - Signature Required | 39 |
| Disposition Method - Leave At Door | 123 |
| Disposition Method - Return | 116 |
| Disposition Method - Return at Senders Expense | 172 |
| Drop At Carrier Facility | 169 |
| Email Notification Addresses | 184 |
| Exception Email Notidication | 186 |
| Promotion Code | 626 |
| Shipment Email Notification | 183 |
| Transmit Shipment* | 164 |
*Important Note from Canada Post: If you use traditional contract shipping and manifest processes (e.g. you ship more than 50 parcels per day from a central warehouse), Transmit Shipment is not for you. You must continue to use the regular manifest (End Of Day) process. Failure to do so will result in refusal of your shipment until you produce the required manifests.
Package Types
| Package Type | ID |
|---|---|
| Customer Package | 10162 |
| Tube | 10163 |
| Unpackaged | 10164 |
Documents
| Output Type | ID | Generate From | Format | Printer | Stock |
|---|---|---|---|---|---|
| Manifest | 10 | Carrier | PDF Raw | Client/Response/Windows |
Labels
| Output Type | ID | Generate From | Format | Printer | Stock |
|---|---|---|---|---|---|
| Label | 1 | Carrier | ZPL, PDF Raw | Windows/Client/Response | Thermal 4x6 |
| Return Label | 1 | Carrier | ZPL, PDF Raw | Windows/Client/Response | Thermal 4x6 |
Related Content
- Carriers lists supported carriers and gives links to their reference topics.
