Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

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.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

CanadaPostAccountNumberThe shipper's account number.
CanadaPostContractIdThis property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.
CanadaPostPasswordPassword for logging in to the Server .
CanadaPostServerURL for the server where the requests are sent.
CanadaPostUserIdUser Id for logging in to the Server .
EndDateThe end date for the date range to be searched.
ExpectedDeliveryDateThe package's expected delivery date.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdentifierTypeThe identifier type to be used to track a package.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RecipientPostalCodeIdentifies the recipient's postal code.
ShipDateThe date on which the package was tendered.
ShipperAccountNumberCustomer number associated with shipment.
SignedByName of person who signed for the package.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StartDateThe end date for the date range to be searched.
TimeoutA timeout for the component.
TrackEventCountThe number of records in the TrackEvent arrays.
TrackEventCityName of the city where the tracking event occurred.
TrackEventDateDate the tracking event happened.
TrackEventDescriptionThis will contain the description of the current tracking event.
TrackEventLocationLocation description where a tracking event occurred.
TrackEventLocationIdOffice ID of the location where a tracking event occurred.
TrackEventLocationNameName of the location where a tracking event occurred.
TrackEventProvinceProvince or state code where the tracking event occurred.
TrackEventTimeTime the tracking event occurred.
TrackEventTimeZoneTimezone of the Time .
TrackingNumberThe 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.

ConfigSets or retrieves a configuration setting .
ResetResets the internal state of the component and all properties to their default values.
SaveProofOfDeliverySaves the proof of delivery to the specified file.
TrackShipmentReturns 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.

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to retrieve data at any place within the response.
GetTrackingSummaryIndicates to get the tracking summary.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0