Code Samples for Pickup:  REST  |  SOAP

Pickup

Request on-demand and scheduled parcel pickups

number

Read Getting Started to find out how to sign up, get your API keys and more.

number

For essential information common to all our web services, read the Fundamentals of Canada Post Web Services:  REST  |  SOAP

Service Summary

Use pickup web services to perform the following:

  • Determine parcel pickup availability – find out if Canada Post offers parcel pickup service at your location.
  • Request one or more of the following types of pickup:
    • on-demand pickup – a one-time pickup request.
    • third-party pickup – an on-demand pickup at a third-party location, but billed to your account (for commercial customers who have this option specified in their contract).
Pickup Workflow

Pickup

Pickup functionality is provided through the following calls.

  1. Get Pickup Availability
    REST   |    SOAP
    This call identifies if pickup services are available for a given postal code. It also provides information related to the type of pickup available and the cut-off times for pickup service requests. It provides the same functionality as Determine Parcel Pickup Availability.
  2. Create Pickup Request
    REST   |    SOAP
    Request a one-time on-demand pickup.
  3. Get Pickup Request Details
    REST   |    SOAP
    Retrieve information about a specific pickup request.
  4. Update Pickup Request
    REST   |    SOAP
    Modify an existing pickup request, such as contact details or pickup times.
  5. Cancel Pickup Request
    REST   |    SOAP
    Cancel a pickup request.
  6. Get Pickup Requests
    REST   |    SOAP
    Retrieve all of your open pickup requests and their statuses.