CanadaPostTrack Class
Properties Methods Events Configuration Settings Errors
Provides tracking information and SPOD for a given tracking number or other shipment identifier.
Syntax
inship.canadaposttrack()
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.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| CanadaPostAccountNumber | The shipper's account number. |
| CanadaPostContractId | This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract. |
| CanadaPostPassword | Password for logging in to the Server . |
| CanadaPostServer | URL for the server where the requests are sent. |
| CanadaPostUserId | User Id for logging in to the Server . |
| EndDate | The end date for the date range to be searched. |
| ExpectedDeliveryDate | The package's expected delivery date. |
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| IdentifierType | The identifier type to be used to track a package. |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RecipientPostalCode | Identifies the recipient's postal code. |
| ShipDate | The date on which the package was tendered. |
| ShipperAccountNumber | Customer number associated with shipment. |
| SignedBy | Name of person who signed for the package. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| StartDate | The end date for the date range to be searched. |
| Timeout | A timeout for the component. |
| TrackEventCount | The number of records in the TrackEvent arrays. |
| TrackEventCity | Name of the city where the tracking event occurred. |
| TrackEventDate | Date the tracking event happened. |
| TrackEventDescription | This will contain the description of the current tracking event. |
| TrackEventLocation | Location description where a tracking event occurred. |
| TrackEventLocationId | Office ID of the location where a tracking event occurred. |
| TrackEventLocationName | Name of the location where a tracking event occurred. |
| TrackEventProvince | Province or state code where the tracking event occurred. |
| TrackEventTime | Time the tracking event occurred. |
| TrackEventTimeZone | Timezone of the Time . |
| TrackingNumber | The package's tracking number. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
| Config | Sets or retrieves a configuration setting . |
| Reset | Resets the internal state of the component and all properties to their default values. |
| SaveProofOfDelivery | Saves the proof of delivery to the specified file. |
| TrackShipment | Returns tracking data for requested idValue of IdentifierType type. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
| Error | Information about errors during data delivery. |
| Notification | Notification returned by the server upon successful request (if applicable). |
| SSLServerAuthentication | Fired after the server presents its certificate to the client. |
| SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| XPath | Used to retrieve data at any place within the response. |
| GetTrackingSummary | Indicates to get the tracking summary. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| Append | Whether to append data to LocalFile. |
| Authorization | The Authorization string to be sent to the server. |
| BytesTransferred | Contains the number of bytes transferred in the response data. |
| EncodeURL | If set to true the URL will be encoded by the component. |
| FollowRedirects | Determines what happens when the server issues a redirect. |
| GetOn302Redirect | If set to true the component will perform a GET on the new location. |
| HTTPVersion | The version of HTTP used by the component. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| OtherHeaders | Other headers as determined by the user (optional). |
| ProxyAuthorization | The authorization string to be sent to the proxy server. |
| ProxyAuthScheme | The authorization scheme to be used for the proxy. |
| ProxyPassword | A password if authentication is to be used for the proxy. |
| ProxyPort | Port for the proxy server (default 80). |
| ProxyServer | Name or IP address of a proxy server (optional). |
| ProxyUser | A user name if authentication is to be used for the proxy. |
| TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
| TransferredHeaders | The full set of headers as received from the server. |
| UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
| ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
| FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallHost | Name or IP address of firewall (optional). |
| FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
| FirewallPort | The TCP port for the FirewallHost;. |
| FirewallType | Determines the type of firewall to connect through. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| Linger | When set to True, connections are terminated gracefully. |
| LingerTime | Time in seconds to have the connection linger. |
| LocalHost | The name of the local host through which connections are initiated or accepted. |
| LocalPort | The TCP port in the local host where the component binds. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| MaxTransferRate | The transfer rate limit in bytes per second. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| FirewallData | Used to send extra data to the firewall. |
| InBufferSize | The size in bytes of the incoming queue of the socket. |
| OutBufferSize | The size in bytes of the outgoing queue of the socket. |
| CodePage | The system code page used for Unicode to Multibyte translations. |