EzTrack Component

Properties   Methods   Events   Config Settings   Errors  

Retrieves tracking data for any package shipped from origin to delivery.

Syntax

TibxEzTrack

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 Codes 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:

After a successful TrackShipment call, the following fields will be populated:

The Canada Post URLS are:

Property List

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

Method List

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

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.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

AccountNumber Property (EzTrack Component)

The shipper's account number.

Syntax

__property String AccountNumber = { read=FAccountNumber, write=FSetAccountNumber };

Default Value

""

Remarks

The shipper's account number.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

Data Type

String

AuthorizationToken Property (EzTrack Component)

Authorization Token used to authenticate the request.

Syntax

__property String AuthorizationToken = { read=FAuthorizationToken, write=FSetAuthorizationToken };

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

Password Property (EzTrack Component)

Password for logging in to the Server .

Syntax

__property String Password = { read=FPassword, write=FSetPassword };

Default Value

""

Remarks

Password for logging in to the Server.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the login password for your Canada Post account.

Data Type

String

Server Property (EzTrack Component)

URL for the server where the requests are sent.

Syntax

__property String Server = { read=FServer, write=FSetServer };

Default Value

""

Remarks

URL for the server where the requests are sent.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

Data Type

String

UserId Property (EzTrack Component)

User Id for logging in to the Server .

Syntax

__property String UserId = { read=FUserId, write=FSetUserId };

Default Value

""

Remarks

User Id for logging in to the Server.

This property is not used by FedEx.

For Canada Post, this field should be set to the login username for your Canada Post account

Data Type

String

FirewallAutoDetect Property (EzTrack Component)

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Syntax

__property bool FirewallAutoDetect = { read=FFirewallAutoDetect, write=FSetFirewallAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (EzTrack Component)

This property determines the type of firewall to connect through.

Syntax

__property TibxEzTrackFirewallTypes FirewallType = { read=FFirewallType, write=FSetFirewallType };

enum TibxEzTrackFirewallTypes {
  fwNone=0,
  fwTunnel=1,
  fwSOCKS4=2,
  fwSOCKS5=3,
  fwSOCKS4A=10
};

Default Value

fwNone

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (EzTrack Component)

This property contains the name or IP address of firewall (optional).

Syntax

__property String FirewallHost = { read=FFirewallHost, write=FSetFirewallHost };

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a Host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the component raises an exception.

Data Type

String

FirewallPassword Property (EzTrack Component)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

__property String FirewallPassword = { read=FFirewallPassword, write=FSetFirewallPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password properties are used to connect and authenticate to the given firewall. If the authentication fails, the component raises an exception.

Data Type

String

FirewallPort Property (EzTrack Component)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

__property int FirewallPort = { read=FFirewallPort, write=FSetFirewallPort };

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (EzTrack Component)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

__property String FirewallUser = { read=FFirewallUser, write=FSetFirewallUser };

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this property and Password properties are used to connect and authenticate to the given Firewall. If the authentication fails, the component raises an exception.

Data Type

String

IdentifierType Property (EzTrack Component)

Type of shipment identifier by which the shipment is to be tracked.

Syntax

__property TibxEzTrackIdentifierTypes IdentifierType = { read=FIdentifierType, write=FSetIdentifierType };

enum TibxEzTrackIdentifierTypes {
  itFedExTrackingNumberOrDoorTag=0,
  itFedExBillOfLading=1,
  itFedExCODReturnTrackingNumber=2,
  itFedExCustomerAuthorizationNumber=3,
  itFedExCustomerReference=4,
  itFedExDepartment=5,
  itFedExFreeFormReference=6,
  itFedExGroundShipmentId=7,
  itFedExGroundMPS=8,
  itFedExInvoiceNumber=9,
  itFedExPartnerCarrierNumber=10,
  itFedExPartNumber=11,
  itFedExPONumber=12,
  itFedExRMANumber=13,
  itFedExTrackingControlNumber=14,
  itFedExShipperReference=15,
  itFedExStandardMPS=16
};

Default Value

itFedExTrackingNumberOrDoorTag

Remarks

This is required if the track request will be made for an identifier other than Tracking Number.

This property is not applicable to UPS or USPS.

Data Type

Integer

PackageCount Property (EzTrack Component)

The number of packages returned for a given tracking number or any other shipment identifier.

Syntax

__property int PackageCount = { read=FPackageCount };

Default Value

0

Remarks

This property contains the number of packages returned from the Server after calling the TrackShipment method.

Currently, USPS does not support multiple package shipments and this does not apply.

This property is read-only.

Data Type

Integer

PackageIndex Property (EzTrack Component)

The package index in a shipment being tracked.

Syntax

__property int PackageIndex = { read=FPackageIndex, write=FSetPackageIndex };

Default Value

0

Remarks

This property contains the index of a package contained in the shipment.

The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.

Currently, USPS does not support multiple package shipments and this does not apply.

Data Type

Integer

PackageReceivedBy Property (EzTrack Component)

The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .

Syntax

__property String PackageReceivedBy = { read=FPackageReceivedBy };

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered.

Note: This property is only used when the Provider is set to pFedEx or pUPS.

This property is read-only.

Data Type

String

PackageReferences Property (EzTrack Component)

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

__property String PackageReferences = { read=FPackageReferences };

Default Value

""

Remarks

This should be inspected after a call to the TrackShipment method.

For FedEx and UPS, when populated, it should be a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

A package can have 0 to many reference numbers assigned to it by the shipper when the shipping label was generated.

Currently, USPS does not support multiple package shipments and this does not apply.

This property is read-only.

Data Type

String

PackageSignedBy Property (EzTrack Component)

Signature of person who signed for package at PackageIndex .

Syntax

__property String PackageSignedBy = { read=FPackageSignedBy };

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered.

Since USPS does not currently support multiple packages, PackageIndex can be ignored, this property returns the name of the person who signed for the package.

This property is read-only.

Data Type

String

PackageTrackingNumber Property (EzTrack Component)

Package's tracking number corresponding to the PackageIndex .

Syntax

__property String PackageTrackingNumber = { read=FPackageTrackingNumber };

Default Value

""

Remarks

This is returned in the server's response when the TrackShipment method is called.

Currently, USPS does not support multiple package shipments and this does not apply.

This property is read-only.

Data Type

String

PackageWeight Property (EzTrack Component)

Weight of the package at PackageIndex .

Syntax

__property String PackageWeight = { read=FPackageWeight };

Default Value

""

Remarks

This corresponds to the package at PackageIndex position in the list of packages contained in the shipment.

Currently, USPS does not support multiple package shipments and this does not apply.

This property is read-only.

Data Type

String

Provider Property (EzTrack Component)

Which provider to use.

Syntax

__property TibxEzTrackProviders Provider = { read=FProvider, write=FSetProvider };

enum TibxEzTrackProviders {
  pFedEx=0,
  pUPS=1,
  pUSPS=2,
  pCanadaPost=3
};

Default Value

pFedEx

Remarks

The "Ez" components support FedEx, UPS, USPS, and Canada Post servers. This property tells the component which protocol to use.

NOTE: When this property is set, all properties of the component will be reset to their default values.

Data Type

Integer

ProxyAuthScheme Property (EzTrack Component)

This property is used to tell the component which type of authorization to perform when connecting to the proxy.

Syntax

__property TibxEzTrackProxyAuthSchemes ProxyAuthScheme = { read=FProxyAuthScheme, write=FSetProxyAuthScheme };

enum TibxEzTrackProxyAuthSchemes {
  authBasic=0,
  authDigest=1,
  authProprietary=2,
  authNone=3,
  authNtlm=4,
  authNegotiate=5
};

Default Value

authBasic

Remarks

This property is used to tell the component which type of authorization to perform when connecting to the proxy. This is used only when the User and Password properties are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.

If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the component. Look at the configuration file for the component being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of User and Password.

Data Type

Integer

ProxyAutoDetect Property (EzTrack Component)

This property tells the component whether or not to automatically detect and use proxy system settings, if available.

Syntax

__property bool ProxyAutoDetect = { read=FProxyAutoDetect, write=FSetProxyAutoDetect };

Default Value

False

Remarks

This property tells the component whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (EzTrack Component)

This property contains a password if authentication is to be used for the proxy.

Syntax

__property String ProxyPassword = { read=FProxyPassword, write=FSetProxyPassword };

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (EzTrack Component)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

__property int ProxyPort = { read=FProxyPort, write=FSetProxyPort };

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80). See the description of the Server property for details.

Data Type

Integer

ProxyServer Property (EzTrack Component)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

__property String ProxyServer = { read=FProxyServer, write=FSetProxyServer };

Default Value

""

Remarks

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the Server property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (EzTrack Component)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

__property TibxEzTrackProxySSLs ProxySSL = { read=FProxySSL, write=FSetProxySSL };

enum TibxEzTrackProxySSLs {
  psAutomatic=0,
  psAlways=1,
  psNever=2,
  psTunnel=3
};

Default Value

psAutomatic

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (EzTrack Component)

This property contains a username if authentication is to be used for the proxy.

Syntax

__property String ProxyUser = { read=FProxyUser, write=FSetProxyUser };

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (EzTrack Component)

Street name.

Syntax

__property String RecipientAddress1 = { read=FRecipientAddress1, write=FSetRecipientAddress1 };

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (EzTrack Component)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

__property String RecipientAddress2 = { read=FRecipientAddress2, write=FSetRecipientAddress2 };

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientCity Property (EzTrack Component)

Name of city, town, etc.

Syntax

__property String RecipientCity = { read=FRecipientCity, write=FSetRecipientCity };

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (EzTrack Component)

Country code.

Syntax

__property String RecipientCountryCode = { read=FRecipientCountryCode, write=FSetRecipientCountryCode };

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (EzTrack Component)

State or province code.

Syntax

__property String RecipientState = { read=FRecipientState, write=FSetRecipientState };

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (EzTrack Component)

Postal code.

Syntax

__property String RecipientZipCode = { read=FRecipientZipCode, write=FSetRecipientZipCode };

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

SenderAddress1 Property (EzTrack Component)

Street name.

Syntax

__property String SenderAddress1 = { read=FSenderAddress1 };

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderAddress2 Property (EzTrack Component)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

__property String SenderAddress2 = { read=FSenderAddress2 };

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderCity Property (EzTrack Component)

Name of city, town, etc.

Syntax

__property String SenderCity = { read=FSenderCity };

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

This property is read-only.

Data Type

String

SenderCountryCode Property (EzTrack Component)

Country code.

Syntax

__property String SenderCountryCode = { read=FSenderCountryCode };

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

This property is read-only.

Data Type

String

SenderState Property (EzTrack Component)

State or province code.

Syntax

__property String SenderState = { read=FSenderState };

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

This property is read-only.

Data Type

String

SenderZipCode Property (EzTrack Component)

Postal code.

Syntax

__property String SenderZipCode = { read=FSenderZipCode };

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

This property is read-only.

Data Type

String

ShipDate Property (EzTrack Component)

The date on which the package was tendered.

Syntax

__property String ShipDate = { read=FShipDate };

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only and not available at design time.

Data Type

String

ShipDateEnd Property (EzTrack Component)

End of ship date range used to narrow search.

Syntax

__property String ShipDateEnd = { read=FShipDateEnd, write=FSetShipDateEnd };

Default Value

""

Remarks

For FedEx, this property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateStart is required. Format: YYYY-MM-DD.

This property is not applicable to UPS or USPS requests.

Data Type

String

ShipDateStart Property (EzTrack Component)

Start of ship date range used to narrow search.

Syntax

__property String ShipDateStart = { read=FShipDateStart, write=FSetShipDateStart };

Default Value

""

Remarks

For FedEx, this property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required. Format: YYYY-MM-DD.

This property does not apply to UPS or USPS.

Data Type

String

ShipperAccountNumber Property (EzTrack Component)

Account number associated with shipment.

Syntax

__property String ShipperAccountNumber = { read=FShipperAccountNumber, write=FSetShipperAccountNumber };

Default Value

""

Remarks

This indicates the account number associated with shipment (as opposed to the AccountNumber, which is that of party sending the request).

For FedEx, when providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.

For UPS, this can be provided in a track request to narrow down the search results. It can also be returned in the server response when the TrackShipment method is called.

This is not used by the USPS component.

Data Type

String

SSLAcceptServerCertEncoded Property (EzTrack Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLAcceptServerCertEncoded = { read=FSSLAcceptServerCertEncoded, write=FSetSSLAcceptServerCertEncoded };
__property DynamicArray<Byte> SSLAcceptServerCertEncodedB = { read=FSSLAcceptServerCertEncodedB, write=FSetSSLAcceptServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertEncoded Property (EzTrack Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLCertEncoded = { read=FSSLCertEncoded, write=FSetSSLCertEncoded };
__property DynamicArray<Byte> SSLCertEncodedB = { read=FSSLCertEncodedB, write=FSetSSLCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This property is not available at design time.

Data Type

Byte Array

SSLCertStore Property (EzTrack Component)

This is the name of the certificate store for the client certificate.

Syntax

__property String SSLCertStore = { read=FSSLCertStore, write=FSetSSLCertStore };
__property DynamicArray<Byte> SSLCertStoreB = { read=FSSLCertStoreB, write=FSetSSLCertStoreB };

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject property to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Byte Array

SSLCertStorePassword Property (EzTrack Component)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

__property String SSLCertStorePassword = { read=FSSLCertStorePassword, write=FSetSSLCertStorePassword };

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (EzTrack Component)

This is the type of certificate store for this certificate.

Syntax

__property TibxEzTrackSSLCertStoreTypes SSLCertStoreType = { read=FSSLCertStoreType, write=FSetSSLCertStoreType };

enum TibxEzTrackSSLCertStoreTypes {
  cstUser=0,
  cstMachine=1,
  cstPFXFile=2,
  cstPFXBlob=3,
  cstJKSFile=4,
  cstJKSBlob=5,
  cstPEMKeyFile=6,
  cstPEMKeyBlob=7,
  cstPublicKeyFile=8,
  cstPublicKeyBlob=9,
  cstSSHPublicKeyBlob=10,
  cstP7BFile=11,
  cstP7BBlob=12,
  cstSSHPublicKeyFile=13,
  cstPPKFile=14,
  cstPPKBlob=15,
  cstXMLFile=16,
  cstXMLBlob=17,
  cstJWKFile=18,
  cstJWKBlob=19,
  cstSecurityKey=20,
  cstBCFKSFile=21,
  cstBCFKSBlob=22,
  cstPKCS11=23,
  cstAuto=99
};

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

The component supports both public and private keys in a variety of formats. When the cstAuto value is used, the component will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (EzTrack Component)

This is the subject of the certificate used for client authentication.

Syntax

__property String SSLCertSubject = { read=FSSLCertSubject, write=FSetSSLCertSubject };

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (EzTrack Component)

This specifies the SSL/TLS implementation to use.

Syntax

__property TibxEzTrackSSLProviders SSLProvider = { read=FSSLProvider, write=FSetSSLProvider };

enum TibxEzTrackSSLProviders {
  sslpAutomatic=0,
  sslpPlatform=1,
  sslpInternal=2
};

Default Value

sslpAutomatic

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the component will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The component will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (EzTrack Component)

This is the certificate (PEM/Base64 encoded).

Syntax

__property String SSLServerCertEncoded = { read=FSSLServerCertEncoded };
__property DynamicArray<Byte> SSLServerCertEncodedB = { read=FSSLServerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The Store and Subject properties also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Byte Array

Timeout Property (EzTrack Component)

A timeout for the component.

Syntax

__property int Timeout = { read=FTimeout, write=FSetTimeout };

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the component will wait for the operation to complete before returning control.

The component will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the component raises an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalWeight Property (EzTrack Component)

Total shipment weight.

Syntax

__property String TotalWeight = { read=FTotalWeight };

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This does not apply to USPS.

This property is read-only.

Data Type

String

TrackEventCount Property (EzTrack Component)

The number of records in the TrackEvent arrays.

Syntax

__property int TrackEventCount = { read=FTrackEventCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrackEventAddress1
• TrackEventAddress2
• TrackEventCity
• TrackEventCompany
• TrackEventCountryCode
• TrackEventDate
• TrackEventException
• TrackEventLocation
• TrackEventOther
• TrackEventState
• TrackEventStatus
• TrackEventTime
• TrackEventZipCode

The array indices start at 0 and end at TrackEventCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

TrackEventAddress1 Property (EzTrack Component)

Line 1 in the location address where a tracking event occurred (by package).

Syntax

__property String TrackEventAddress1[int TrackEventIdx] = { read=FTrackEventAddress1 };

Default Value

""

Remarks

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventAddress2 Property (EzTrack Component)

Line 2 in the location address where a tracking event occurred (by package).

Syntax

__property String TrackEventAddress2[int TrackEventIdx] = { read=FTrackEventAddress2 };

Default Value

""

Remarks

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCity Property (EzTrack Component)

Name of the city where the tracking event occurred.

Syntax

__property String TrackEventCity[int TrackEventIdx] = { read=FTrackEventCity };

Default Value

""

Remarks

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCompany Property (EzTrack Component)

Company name if delivered to a company for a given TrackingNumber .

Syntax

__property String TrackEventCompany[int TrackEventIdx] = { read=FTrackEventCompany };

Default Value

""

Remarks

Company name if delivered to a company for a given TrackingNumber.

This property is applicable only to USPS and is returned after a call to the TrackShipment method for each tracking event returned by the USPS Server.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCountryCode Property (EzTrack Component)

Country code where the tracking event happened.

Syntax

__property String TrackEventCountryCode[int TrackEventIdx] = { read=FTrackEventCountryCode };

Default Value

""

Remarks

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventDate Property (EzTrack Component)

Date the tracking event happened.

Syntax

__property String TrackEventDate[int TrackEventIdx] = { read=FTrackEventDate };

Default Value

""

Remarks

Date the tracking event happened.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventException Property (EzTrack Component)

The most recent status exception for the tracking event.

Syntax

__property String TrackEventException[int TrackEventIdx] = { read=FTrackEventException };

Default Value

""

Remarks

The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventLocation Property (EzTrack Component)

Location description where a tracking event occurred.

Syntax

__property String TrackEventLocation[int TrackEventIdx] = { read=FTrackEventLocation };

Default Value

""

Remarks

Location description where a tracking event occurred.

This is only applicable to UPS.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventOther Property (EzTrack Component)

Other information about the tracking event.

Syntax

__property String TrackEventOther[int TrackEventIdx] = { read=FTrackEventOther };

Default Value

""

Remarks

Other information about the tracking event.

This is only applicable to USPS and will be populated with any additional information in the tracking event that is not provided by the other properties. Examples of this are "AuthorizedAgent" and "Signer" (when there is a signer for that event).

The format of this property is a comma-separated "name=value" list.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventState Property (EzTrack Component)

State or province code where the tracking event occurred.

Syntax

__property String TrackEventState[int TrackEventIdx] = { read=FTrackEventState };

Default Value

""

Remarks

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventStatus Property (EzTrack Component)

Literal description of the tracking event.

Syntax

__property String TrackEventStatus[int TrackEventIdx] = { read=FTrackEventStatus };

Default Value

""

Remarks

Literal description of the tracking event.

For UPS, possible values are:

For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.

When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventTime Property (EzTrack Component)

Time the tracking event occurred.

Syntax

__property String TrackEventTime[int TrackEventIdx] = { read=FTrackEventTime };

Default Value

""

Remarks

Time the tracking event occurred.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventZipCode Property (EzTrack Component)

Postal code where the tracking event happened.

Syntax

__property String TrackEventZipCode[int TrackEventIdx] = { read=FTrackEventZipCode };

Default Value

""

Remarks

Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

Config Method (EzTrack Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Reset Method (EzTrack Component)

Resets the internal state of the component and all properties to their default values.

Syntax

void __fastcall Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

TrackShipment Method (EzTrack Component)

Returns tracking data for requested idValue of IdentifierType type.

Syntax

void __fastcall TrackShipment(String idValue);

Remarks

The idValue parameter identifies the shipment. This identifier can be of IdentifierType type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.

FedEx

FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.

When sending a tracking request to the FedEx Server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:

A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.

If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.

UPS

If the UPS system does not locate any data for the requested idValue, an error message will be returned. The full server reply will be saved to RawResponse.

Upon successful response, the server will return tracking events for each package included in the shipment, and other values tied to that package. For example, if a shipment contained four packages, the query response would show all four packages.

If there is a problem with a specific idValue within the request, the response will raise an error that pertains to the specific idValue.

USPS

For USPS, the IdentifierType property is not valid. Currently, the only way to track USPS packages is by the tracking number, which should be specified as the idValue parameter.

Error Event (EzTrack Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TibxEzTrackErrorEventParams;
typedef void __fastcall (__closure *TibxEzTrackErrorEvent)(System::TObject* Sender, TibxEzTrackErrorEventParams *e);
__property TibxEzTrackErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (EzTrack Component)

Notification returned by the server upon successful request (if applicable).

Syntax

typedef struct {
  String Message;
} TibxEzTrackNotificationEventParams;
typedef void __fastcall (__closure *TibxEzTrackNotificationEvent)(System::TObject* Sender, TibxEzTrackNotificationEventParams *e);
__property TibxEzTrackNotificationEvent OnNotification = { read=FOnNotification, write=FOnNotification };

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (EzTrack Component)

Fired after the server presents its certificate to the client.

Syntax

typedef struct {
  String CertEncoded;
  DynamicArray<Byte> CertEncodedB;
  String CertSubject;
  String CertIssuer;
  String Status;
  bool Accept;
} TibxEzTrackSSLServerAuthenticationEventParams;
typedef void __fastcall (__closure *TibxEzTrackSSLServerAuthenticationEvent)(System::TObject* Sender, TibxEzTrackSSLServerAuthenticationEventParams *e);
__property TibxEzTrackSSLServerAuthenticationEvent OnSSLServerAuthentication = { read=FOnSSLServerAuthentication, write=FOnSSLServerAuthentication };

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (EzTrack Component)

Fired when secure connection progress messages are available.

Syntax

typedef struct {
  String Message;
} TibxEzTrackSSLStatusEventParams;
typedef void __fastcall (__closure *TibxEzTrackSSLStatusEvent)(System::TObject* Sender, TibxEzTrackSSLStatusEventParams *e);
__property TibxEzTrackSSLStatusEvent OnSSLStatus = { read=FOnSSLStatus, write=FOnSSLStatus };

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (EzTrack Component)

EzTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (EzTrack Component)

EzTrack Errors

The component may also return one of the following error codes, which are inherited from other components.