[title] | test

Pickup 1.0.0

Convenient One-Time On-Demand package pickup

To get access, create an account or sign in.

What it does

Integrate our One-Time On-Demand Pickup API and request a package pickup right from your online platform. You can request a One-Time On-Demand pickup at your business location. If your contract specifies a third-party pickup, you can also request a pickup at that location. 

How it works

Follow these steps to request a pickup:

  1. Determine if pickup is available at your location and find cut-off times.
  2. Request a pickup using the Create Pickup Request web service. Among other elements, your request will include the following:
    • Pickup location: Specify whether pickup is at the business address we have on file or at a third-party location (note that third-party pickups are still billed to you).
    • Pickup date: Request a pickup the day you need it. You can schedule up to 30 days in advance if you have a package agreement or up to 5 days in advance if you don’t.
    • Pickup time: Choose a Ready for Pickup Time between noon and 4 p.m. For same-day pickups, you must submit the request at least one hour before your desired pickup time. Your closing time must be at least an hour after your preferred time.

See the full list of request elements in the Create Pickup Request web service.

Once you’ve submitted a successful pickup request, you’ll receive a request ID number and status (pending). If you request a same-day pickup after the cut-off times for that day, you’ll receive an error.

 

Latest updates in this version  

Pickup workflow

A flowchart for the Pickup API. A text description of the flowchart is available on the page.

The Pickup workflow begins by optionally checking for Canada Post pickup availability and pricing at a specific location. Once confirmed, a pickup request can be created. After creation, the system can optionally retrieve all pickup requests, get details about a specific request, modify an existing request, or cancel a scheduled pickup. 

View larger image

Pickup calls

Pickup service functionality is provided through the following calls:

Pickup calls
ServiceDescription
Get Pickup AvailabilityRetrieves pickup availability and cut-off times based on pickup location (postal code entered). 
Get Pickup PriceReturns price for a pickup request.
Create On-demand PickupCreates a request for a One-Time On-Demand pickup and returns pickup request ID and links (URLs included in the API response). 
Get Pickup DetailsUses the request ID returned from the Create Pickup request and returns an information summary about a specific pickup. 

Modify On-demand Pickup

Modifies the details of an existing pickup request, such as contact details or pickup time.

Please note: If you need to change your pickup location or your payment information, cancel your pickup request and create a new one. 

Cancel Pickup Request

Cancels an existing pickup request.

Please note: If you cancel a request at your default business address, you won’t be able to recreate another request in that same timeslot. Use Update Pickup Request or request a different time.  

Get All On-demand PickupsRetrieves all open pickup requests and the status of each.

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