EzTrack Component
Properties Methods Events Configuration Settings Errors
Retrieves tracking data for any package shipped from origin to delivery.
Syntax
nsoftware.InShip.Eztrack
Remarks
The EzTrack component provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the component that is specific to the carrier.
For a given tracking or reference number, this tool identifies the package(s) and provides detailed information about each package, including the current shipping status and the time and location of each scan while in transit. The EzTrack component supports tracking by tracking number, shipment identification number, or reference number. Using this component, you can find out up-to-the-minute specific details on shipping status, including the time and location of each scan as the package moves toward its final destination. And, this tracking information can be displayed in a customized format.
FedEx and UPS both support multiple package shipment tracking, but USPS does not.
When the TrackShipment method call of this component returns a response, it will either return a successful response document or an error document. An error may be returned at the top (response) level if there is a problem with the syntax of the request, or if a system error occurs.
In any of the above scenarios, if there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific identifier.
For more details on errors codes and descriptions, please refer to the Error Messages section.
To use this component, you must set the appropriate Account settings for the specified Provider.
Canada Post Setup and Required Properties
When retrieving tracking information via Canada Post, the following fields are required:
| UserId | The login username for your Canada Post account. |
| Password | The login password for you Canada Post account. |
After a successful TrackShipment call, the following fields will be populated:
| Date | Date of a tracking event (yyyy-mm-dd). |
| Time | Time of a tracking event (hh:mm:ss). |
| Status | A brief description of the event. |
| City | Site information provided by the parcel handler. |
| State | For domestic events, this contains the province that the event occurred in. |
The Canada Post URLS are:
| Test (Development) | https://ct.soa-gw.canadapost.ca |
| Production | https://soa-gw.canadapost.ca |
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
| Account | Login information for the specified Provider . |
| Firewall | A set of properties related to firewall access. |
| IdentifierType | Type of shipment identifier by which the shipment is to be tracked. |
| PackageCount | The number of packages returned for a given tracking number or any other shipment identifier. |
| PackageIndex | The package index in a shipment being tracked. |
| PackageReferences | References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer. |
| PackageSignedBy | Signature of person who signed for package at PackageIndex . |
| PackageTrackingNumber | Package's tracking number corresponding to the PackageIndex . |
| PackageWeight | Weight of the package at PackageIndex . |
| Provider | Which provider to use. |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address to which the shipment is destined. |
| SenderAddress | Identifies the sender's address from which the shipment is originating. |
| ShipDate | The date on which the package was tendered. |
| ShipDateEnd | End of ship date range used to narrow search. |
| ShipDateStart | Start of ship date range used to narrow search. |
| ShipperAccountNumber | Account number associated with shipment. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to be used during SSL negotiation. |
| SSLServerCert | The server certificate for the last established connection. |
| Timeout | A timeout for the component. |
| TotalWeight | Total shipment weight. |
| TrackEvents | Collection of tracking details for all scanning events that occur during the shipping process of the package at PackageIndex . |
Method List
The following is the full list of the methods of the component 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. |
| TrackShipment | Returns tracking data for requested idValue of IdentifierType type. |
Event List
The following is the full list of the events fired by the component 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 component 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. |
| 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. |