Tracking

Code Samples for Tracking: Java (.zip) | PHP (.zip) | C# (.zip)

Get Delivery Confirmation Certificate – SOAP

Summary

Name:	Get Delivery Confirmation Certificate
Reason to Call:	To retrieve the image of the delivery confirmation certificate (which is a document showing proof of delivery with details) for a given parcel.
Input:	PIN
Output:	PDF document
Error Examples:	PIN not found, signature not available
Typical Prior Calls:	Get Tracking Summary, Get Tracking Details
Typical Next Call:	No directly related calls
Version history:	Release notes

Call Details

WSDL:	track.wsdl
Endpoint (Development):	https://ct.soa-gw.canadapost.ca/vis/soap/track
Endpoint (Production):	https://soa-gw.canadapost.ca/vis/soap/track
Namespace:	http://www.canadapost.ca/ws/soap/track
Operation:	GetDeliveryConfirmationCertificate

SOAP Body

This section describes the XML input elements to this service. For the hierarchical structure, see the XML diagram.

Get Delivery Confirmation Certificate – Request Elements
Element Name	Type	Required / Optional	Description
get-delivery-confirmation-certificate-request	complex	required	The top level XML element for the request input information.
locale	simple	optional	Indicates your language preference for receiving error messages. EN = English FR = French If no value is provided, the default language is English.
pin	simple	required	The Parcel Identification Number (PIN) assigned by Canada Post on creation of the shipping label and used for tracking purposes. (12, 13 or 16 characters)

Request – XML Diagram

Get Delivery Confirmation Certificate – Structure of the XML Request

Response Details

Response – Elements

The following table describes the XML elements in the response to Get Delivery Confirmation Certificate. For the hierarchy of the response, see the XML diagram.

Get Delivery Confirmation Certificate – Response Elements
Element Name	Type	Description
get-delivery-confirmation-certificate-response	complex	The top level XML element for the response information. It will either contain the results of a successful completion or the error message structure.
delivery-confirmation-certificate	complex	This structure contains the results of a successful completion of the service.
filename	simple	Represents the filename of the image file.
image	simple	64-bit encoded content of the file.
mime-type	simple	Represents the MIME type of the file (type/subtype).

Response – XML Diagram

Get Delivery Confirmation Certificate – Structure of the XML Response

Response – Possible Error Responses

The response to error conditions for this web service follows the standard SOAP error response approach used for all Canada Post web services. For more information, see SOAP Fundamentals of Canada Post Web Services.

Possible error messages for this service include the following:

Code	Message
007	No Delivery Information Available

Examples

Sample SOAP XML Request – Get Delivery Confirmation Certificate

<get-delivery-confirmation-certificate-request>

</get-delivery-confirmation-certificate-request>

Sample SOAP XML Response – Get Delivery Confirmation Certificate


  

		<get-delivery-confirmation-certificate-response>
	
		<delivery-confirmation-certificate>
	
		<filename>1371134583769923.pdf</filename>

		<image>JVBERi0xLjQKJeLjz(etc...base64 encoded PDF)</image>

		<mime-type>application/pdf</mime-type>

	
		</delivery-confirmation-certificate>

	
		</get-delivery-confirmation-certificate-response>

Sign in

Resources