[title] | test

Post Office Services 1.0.0

Get a list of nearby post offices with the Find a Post Office API or set up convenient post office delivery for your customers with Deliver to Post Office

To get access, create an account or sign in.

What it does

The Find a Post Office API returns a list of post offices near a given location. Each post office will indicate if you can deliver a package directly to that post office and its hours.

Within Find a Post Office is the Deliver to Post Office option. With this option, you can use Find a Post Office during checkout to give your online shoppers the ability to have purchases delivered directly to a participating post office of their choice near their home, office, or anywhere they choose. 

Please note: Deliver to Post Office is only available with Xpresspost™ and Expedited Parcel™ services.  

How it works

Find a Post Office 

The customer provides a location (a postal code, address, or intersection) and the API returns a list of nearby post offices in that area. This response also indicates if each location offers delivery directly to the post office for added flexibility. Once a specific post office is chosen by the customer, the API retrieves detailed information about that particular post office. 

To successfully offer the Deliver to Post Office option: 

  1. Display the post office information during checkout and allow shoppers to select a post office near them.   
  2. Capture the post office ID the shopper selected using the Get Nearest Post Office API.
  3. When you’re ready to ship your order, use the Create Shipments API to generate the Deliver to Post Office shipping label using the post office ID.
  4. When the package arrives at the post office, your shoppers will get an email. 

 

Latest updates in this version  

Find a Post Office workflow and calls

Find a Post Office can be called in any order but is generally called through the following two calls:

Find a Post Office workflow and calls
ServiceDescription
Get Nearest Post OfficeReturns a list of post offices near a given location. It also specifies which ones support direct delivery to the post office rather than to a recipient’s address. 
Get Post Office DetailProvides details of post offices returned in the Get Nearest Post Office call (for example, hours of operation). 

Deliver to Post Office

Deliver to Post Office benefits

  • Eliminate delays caused by unsuccessful delivery attempts
  • Increase customer satisfaction with faster, flexible delivery
  • Know your deliveries are safe in one of 6,000 secure, temperature-controlled Canada Post locations 

Deliver to Post Office workflow

A flowchart for Post office services – Deliver to post office. A text description of the flowchart is available on the page.

The Deliver to Post Office workflow is divided into three key stages. First, customers select a post office on an ecommerce site using Canada Post data, and the shipping information is sent to the retailer's shipping system. Second, a compliant shipping label is generated. Finally, the label is scanned at the post office, and the customer is notified that their package is ready for pickup. 

View larger image

Programming details

Programming details
Your processProgramming summary
Present shoppers with a map showing post offices near their ship-to address or let shoppers enter a postal code, address, or intersection near the pickup location

To find post offices that support Deliver to Post Office, send a request to the nearest post office and set the D2PO element to true.

The response will only include post offices that have the Deliver to Post Office feature.  

During checkout, shopper selects a post office for package delivery 

Along with the details of the order, you also save the following information: 

  • Shopper's name and home address
  • Phone number
  • Email address
  • The unique office identifier for the post office selected
The following steps describe how to produce shipping labels using web services 

When using Create Shipment to set up the order, you must include: 

  • name (under destination)
  • address-details (under destination)
  • client-voice-number (under destination)
  • email (under notification)
  • on-shipment (set to true or false)
  • on-exception (set to true or false)
  • on-delivery (set to true)
  • notification (email address)
  • option-qualifier-2 (office-id of the post office)
  • option-code= D2PO. Please note: The last character is the letter “O” not a zero

When you print the address label: 

  • The post office address will automatically appear in the “To” area of the shipping label
  • Deliver to Post Office will appear in the “Attention” section of the label
  • The label will contain the necessary encoding to ensure the shopper is properly notified 
When the post office scans the barcode, the shopper gets an email None. 
At the post office, the shopper shows their government-issued photo ID. The ID must have the address used to purchase the item. 

The following elements appear in the response to Get Shipment Details:

Destination: Contains the address of the post office where the shipment will be delivered.

Recipient: Contains the mail recipient’s address that you added in the Destination element. 

Start using the API

Get started

Consult our Developer guide for details about access tokens, authentication, rate limits, and more.

Developer guide

Get support

Get answers to common questions in our FAQs. If you can’t find your answers there, connect with our team.

FAQs

Contact us

Post Office Services

1.0.0

Get access to the Post Office Services API 1.0.0

To get access, create an account or sign in.