Properties   Methods   Events   Configuration Settings  

Provides up-to-the-minute status reports of shipments, domestic and international, from origin to delivery.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

For a given UPS 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. Track 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.

This component provides several levels of information depending on the request:

• When tracking a package using a UPS tracking number as the request parameter, this component returns information such as current delivery status, including the time and location of the latest transit scan.
• When tracking a package using a reference number, this component returns information appropriate to the request. The request parameters are the reference number plus at least one of the following optional qualifiers: shipper number, pickup date range, destination postal code and/or destination country.

This component can return several kinds of initial responses:

• Multi-Piece summary - When multiple packages from a single shipment match the request, the delivered response contains the UPS tracking number, pickup date, delivery date and time (for delivery packages only), location where each package was left if the consignee was not available, UPS shipping service and total shipment weight.
• Package Detail - When a single package matches the request, the response contains the package weight, consignee city, state and country, the date, time and location of the latest scan while in transit, current delivery status and the name of the person who signed for the package.
• Package Progress - Lists the date, time, location, and status of each scan of the package during transit, from the point of origin to the current location.

A combination of the multi-piece and package detail responses can be returned in the candidate list.

You can request the multi-piece or package detail response as well as package progress information after you receive the initial response.

Multi-piece summary and package progress requests use the information in a package detail response to retrieve additional information about the package. For example, the component returns information regarding the shipment from a multi-piece summary request. It would also return the date, time, and status of every scan for the package from a package progress request.

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.

This component limits the data requested to ten (10) packages per transaction.

Property List

---

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

AccessKey	An identifier required to connect to UPS.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	A password if authentication is to be used when connecting through the firewall.
FirewallPort	Port of the firewall to connect to.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FromAddressLine1	Shipper's address line 1.
FromAddressLine2	Shipper's address line 2.
FromCity	Shipper's city.
FromCountryCode	UPS billing code for the shipper's country.
FromState	Shipper's state or province code.
FromZipCode	Shipper's zip or postal code.
PackageCount	The number of packages returned for a given shipment id or reference number.
PackageIndex	The package index in a shipment returned for a given shipment id or reference number.
PackageMessage	Message describing the shipping status in more details corresponding to the PackageIndex.
PackageRefNumber	Value of a reference number assigned to a package (if any) corresponding to the PackageIndex.
PackageRefNumberCount	Number of reference numbers assigned to a package (if any).
PackageTrackingNumber	Package's tracking number corresponding to the PackageIndex.
PackageWeight	Package's weight corresponding to the PackageIndex.
PackageWeightUnit	Package's weight unit of measurement code corresponding to the PackageIndex.
Password	Password to use for logging in to a UPS Server.
ProxyAuthorization	Similar to the Authorization property, but for proxy authorization.
ProxyPassword	A password if Basic authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxySSL	Determines when to use SSL for the connection to the proxy.
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if Basic authentication is to be used for the proxy.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded	The SSL certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	The password for the certificate store (if any).
SSLCertStoreType	The type of certificate store for the client certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCert	The server certificate for the last established connection.
SSLServerCertStatus	The verification status of the server certificate for the last established connection.
ScheduledDeliveryDate	Date shipment was originally scheduled for delivery.
ScheduledDeliveryTime	Time shipment was originally scheduled for delivery.
Server	URL for the UPS server where the tracking requests are sent to.
ServiceTypeDescription	Description of a UPS service used to ship the package or shipment being tracked.
ShipDate	The date on which the package was tendered to UPS.
ShipDateEnd	End of pickup date range used to narrow a reference number search.
ShipDateStart	Start of pickup date range used to narrow reference number search.
ShipmentId	UPS-assigned tracking number used to track a shipment.
ShipmentRefNumber	Customer-defined number (that may or may not be unique) used to identify a shipment.
ShipmentWeight	Shipment's total weight.
ShipmentWeightUnit	Shipment's weight unit of measurement code.
ShipperNumber	The shipper's UPS account number.
Timeout	A timeout for the component.
ToAddressLine1	Line 1 in ship to address.
ToAddressLine2	Line 2 in ship to address.
ToCity	City name in ship to address.
ToCountryCode	Country code in ship to address.
ToState	State or province code in ship to address.
ToZipCode	Zip code (United States) or postal code (international destination) in ship to address.
TrackAddressLine1	Line 1 in the location address where a tracking event occurred (by package).
TrackAddressLine2	Line 2 in the location address where a tracking event occurred (by package).
TrackCity	City where a tracking event occurred (by package).
TrackCount	Number of tracking events (by package).
TrackCountryCode	Country code where a tracking event occurred (by package).
TrackDate	Date of a tracking event.
TrackLocation	Location description where a tracking event occurred.
TrackSigner	Name of the person signing for package delivery (by package and if applicable).
TrackState	State or province code where a tracking event occurred (by package).
TrackStatus	Status code description for a tracking event (by package).
TrackTime	Time of a tracking event (by package).
TrackZipCode	Zip or postal code where a tracking event occurred (by package).
UserId	User ID for logging in to UPS.

Method List

---

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

Config	Sets or retrieves a component configuration setting.
Reset	Reset the internal state of the component and all properties to their default values.
TrackShipment	Returns tracking data for requested identifier of type idType.

Event List

---

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.

Error	Information about errors during data delivery.
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 complete descriptions.

AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only).
FromAddressLine3	The line 3 in ship from address.
FullRequest	Contains the full request sent to UPS.
FullResponse	Contains the full response returned by UPS.
HTTPVersion	The version of HTTP used by the component
IfModifiedSince	A date determining the maximum age of the desired document.
InBufferSize	The size in bytes of the incoming queue of the socket.
KeepAlive	Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData	The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize	The size in bytes of the outgoing queue of the socket.
PackageRescheduledDeliveryDate	Date when the delivery is re-scheduled to (if applicable).
PackageRescheduledDeliveryTime	Time when the delivery is re-scheduled to (if applicable).
PackageReturnAddressLine1	Line 1 in return to sender's address (if applicable).
PackageReturnAddressLine2	Line 2 in return to sender's address (if applicable).
PackageReturnAddressLine3	Line 3 in return to sender's address (if applicable).
PackageReturnCity	City in return to sender's address (if applicable).
PackageReturnCountryCode	Country code in return to sender's address (if applicable).
PackageReturnState	State or province code in return to sender's address (if applicable).
PackageReturnZipCode	Zip or postal code in return to sender's address (if applicable).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyPassword	A password if Basic 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 Basic authentication is to be used for the proxy.
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
SocketHandle	The handle of the main socket used by the component.
ToAddressLine3	The line 3 in ship to address.
TrackAddressLine3	Line 3 in the location address where the tracking event occurred (if any).
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making http requests through WinInet
UserAgent	Information about the user agent (browser).
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)
XPath	Used to retrieve data at any place within the response.