CanadaPostTrack Class

Properties   Methods   Events   Configuration Settings   Errors  

Provides tracking information and SPOD for a given tracking number or other shipment identifier.

Class Name

InShip_CanadaPostTrack

Procedural Interface

 inship_canadaposttrack_open();
 inship_canadaposttrack_close($res);
 inship_canadaposttrack_register_callback($res, $id, $function);
 inship_canadaposttrack_get_last_error($res);
 inship_canadaposttrack_get_last_error_code($res);
 inship_canadaposttrack_set($res, $id, $index, $value);
 inship_canadaposttrack_get($res, $id, $index);
 inship_canadaposttrack_do_config($res, $configurationstring);
 inship_canadaposttrack_do_reset($res);
 inship_canadaposttrack_do_saveproofofdelivery($res, $trackingnumber, $filename);
 inship_canadaposttrack_do_trackshipment($res, $idvalue);

Remarks

This class provides Tracking and Signature Proof of Delivery (SPOD) services:

• Tracking Service: to obtain real-time tracking information for Canada Post shipments.
• Signature Proof of Delivery (SPOD): to request a proof of delivery letter that includes a graphic image of your recipient's signature after your shipment has been delivered.

The available options for Tracking service are:

Track by Tracking Number

You can use a package's tracking number, or PIN, when calling TrackShipment by providing the tracking number in the idValue parameter. No extra qualifiers (ie. date range, etc.) will be used in this instance.

Track by other identifier

Possible identifiers are:

• Reference Number - You can track using a reference number that is printed on the shipping label. In order to do this, you must also supply a date range using the StartDate and EndDate properties.
• Delivery Notice Card (DNC) - You can track using the DNC number, which will be on the card that is left on the recipient's door if the package could not be delivered. No extra qualifiers (ie. date range, etc.) will be used in this instance.

To track by identifiers other than tracking number, the TrackShipment method should be called by providing an idValue and setting the IdentifierType property.

Upon successful request, the user will receive the current shipment status with a detailed tracking activity.

To confirm a shipment has been received and signed for you can call the SaveProofOfDelivery method. With this feature, you can request a letter that includes a graphic of the recipient's signature for Canada Post shipments. Note that you must supply the package's tracking number, or PIN, to retrieve the proof of delivery certificate.

In order to use this class you will need to have a CanadaPost CanadaPostAccountNumber, which is your customer number. You will also need to have signed up for the Developer Program and obtained a CanadaPostUserId and CanadaPostPassword.