How to create a Deliver to Post Office shipping label using web services

Here’s how to use a web service-based shipping system to create Deliver to Post Office shipping labels.

How to identify a Deliver to Post Office shipment in your Create Shipment request

The web service called Create Shipment is where you specify all the details about your shopper’s parcel, including identifying it as a Deliver to Post Office shipment. If you use non-contract shipping, use the Create Non-Contract Shipment web service instead.

Create Shipment includes request elements specifically related to Deliver to Post Office, which are listed and described in detail below. For the full list of fields required for a Create Shipment request, refer to Contract Shipping or Non-Contract Shipping documentation.

See the full Create Shipment XML diagram: REST | SOAP.

Destination request elements

Requirement Deliver to Post Office-related request element Description Why we need this information
Under destination:

name,
client-voice-number,
address-details,
address-line-1,
city,
prov-state,
country-code,
postal-zip-code		 Your shopper’s contact information. The address-details structure must contain the shopper’s address.

Do NOT use the address-details structure to provide the address of the selected post office.		 To verify shoppers’ identity when they pick up their parcel. Their name and address must match their government-issued ID.

If shoppers do not pick up their parcel after 5 days, they will receive a voice message reminder.

Notification request elements

Requirement Deliver to Post Office-related request element Description Why we need this information

Under notification:

  • email
  • on-shipment
  • on-exception
  • on-delivery
  • Enter the shopper’s email address in the email field
  • Set on-delivery to true
  • Set on-shipment and on-exception to true or false
 A barcode scan at the destination post office triggers an email to shoppers indicating that their item is ready for pickup.

Option request elements

Requirement Deliver to Post Office-related request element Description Why we need this information

Under option:

  • option-qualifier-2
  • option-code

In option-qualifier-2 enter the office-id of the destination post office. E.g., 0000102978

Note:
  • leading zeroes are significant and must be included. In option-code enter D2PO
  • the last character is the letter ‘O’ not a zero.

We use the office-id of the post office to look up the address and include it on the shipping label. There is no need for you to provide the address of the post office.

The option-code D2PO identifies the parcel as a Deliver to Post Office item. It is necessary to produce the correct shipping label.

Print your shipping label

Follow the standard procedure to print your shipping label:

  1. Submit your Create Shipment request.
  2. Make a call to Get Artifact to retrieve and print your shipping label.

Deliver to Post Office shipping label

After you print your shipping label, perform a Transmit Shipments web service call followed by calls to Get Manifest and Get Artifact to retrieve and print your manifest to provide to Canada Post at pickup or drop-off time.

By correctly including the elements listed above in your Create Shipment request, you are playing a crucial role in ensuring that parcels are successfully delivered.