XX (Development)

ct.soa-gw.canadapost.ca

XX (Production)

soa-gw.canadapost.ca

{pin number}

the parcel PIN

{dnc number}

the delivery notice card number

Accept

application/vnd.cpc.track-v2+xml (Note: */* in place of the header value will return an error)

Authorization

Basic {Base64 encoding of userid:password}

Accept-language

en-CA or fr-CA

{pin number}

The PIN (Parcel Identification Number) assigned by Canada Post on creation of the shipping label and used for tracking purposes.

(12, 13 or 16 characters)

When executing a request by PIN, this is mandatory and is the only parameter necessary.

The {pin number} is embedded into the URI as follows:

XX/vis/track/pin/{pin number}/detail

dnc

The Delivery Notice Card (DNC) number – The number on the card left by delivery personnel when no one is home to receive the delivery.

(15 numeric characters)

When executing a request by DNC number, this is mandatory and is the only parameter necessary.

The {dnc number} is embedded into the URI as follows:

XX/vis/track/dnc/{dnc number}/detail

pin

The PIN that can be used for other tracking calls

active-exists

1 | 0

"1" Indicates that the tracking information is contained in the active data repository.

archive-exists

1 | 0

"1" Indicates that the tracking information is contained in the archive data repository.

destination-postal-id

First 3 digits of the destination Postal Code for parcels to be delivered in Canada.

^[ABCEGHJKLMNPRSTVXY]{1}\d{1}[A-Z]{1}

For international parcels this is the Postal Identifier of the destination country (e.g. ZIP code for parcels with U.S. destination) or an identifier of the destination country

expected-delivery-date

yyyy-mm-dd

The date the item is expected to reach the destination address for addresses in Canada.

If the item has been mailed from or to an international location this date may be blank.

changed-expected-date

yyyy-mm-dd

Indicates a new expected delivery date.

changed-expected-delivery-reason

Text description of reason for change to expected delivery date.

mailed-by-customer-number

Customer number of the mailing customer.

mailed-on-behalf-of-customer-number

Customer number of the mailed-on-behalf-of customer if applicable.

original-pin

In the situation where a parcel is being returned and the original parcel was created with an anticipated return, this field will contain the original PIN when the return PIN is queried.

service-name

Canada Post service name in the language specified by the request. (The service-name will default to English if language is not specified).

For inbound international parcels, service type is empty or contains the service name from its shipper of origin if available.

service-name-2

Canada Post service name in the other Canadian official language. For inbound international parcels, service name is empty or contains the service name from its shipper of origin.

customer-ref-1

The value supplied by the shipper as customer-ref-1 when the shipment was first created with Canada Post. French character set is supported through this interface.

customer-ref-2

The value supplied by the shipper as customer reference 2 when the shipment was first created with Canada Post.

Special characters should be avoided when entering customer reference numbers.

return-pin

In the situation where a parcel is being sent with an anticipated return, this field will contain the return PIN when the original PIN is queried.

signature-image-exists

true | false

True indicates that Get Signature Image will return a signature image. If false, there is no need to call Get Signature Image because it will return “not found”.

suppress-signature

true | false

Indicates whether a signature image collected by Canada Post for domestic parcels has been requested to be suppressed for viewing by the recipient of a parcel.

delivery-options

The set of delivery options requested for this parcel.

delivery-option

The string representing the delivery-option.

delivery-option-description

The description of the delivery option.

significant-events

The list of events associated with this parcel.

occurrence

The parent element of one set of significant event details.

event-identifier

Event identifier used to identify event types.

event-date

yyyy-mm-dd - date of a tracking event

event-time

hh:mm:ss - time of a tracking event

event-time-zone

Time zone associated with an event. May not be populated for international tracking events.

event-description

A brief description of the event.

signatory-name

If the event presented is a signature capture event, the text of this field will represent the name of the signature.

Note: For enhanced privacy and security, the signatory name will now always be empty. It may be removed in a future release.

event-site

Site information provided by the parcel handler.

event-province

For domestic events, this contains the province that the event occurred in.

event-retail-location-id

Contains the office-id where a parcel is being/was retained.

event-retail-name

Retail name of the location where a parcel is/was held.

cod-remit-info

Information associating a COD parcel with the remittance tracking event or vice versa.

pin

This instance of the PIN specifies the PIN of the COD remittance or the original parcel depending on the value of type.

type

Has the value COD_PIN or REMIT_PIN and indicates what PIN is contained in the PIN value immediately above.

id

 Code associated with the failure of a query.

description

Text message associated with a code.

004

No PIN History

002

Duplicate PIN