Properties   Methods   Events   Configuration Settings  

Provides the length of time needed to transport a shipment from the origin to the destination, using any of the applicable UPS Services.

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

Using of this component makes possible comparing the speed of different UPS delivery services to everywhere UPS delivers around the world (available in 47 countries) by providing UPS delivery options based on the origin and destination addresses, and a desired delivery date.

The properties that must be submitted in the request are:

• SenderAddress
• RecipientAddress
• Date shipment is picked up from the origin (ShipDate)
• Shipment Weight for shipments outside the US and non-document shipments inside the US (TotalWeight);
• Unit of Measure for weight when the TotalWeight is provided (WeightUnit);
• Shipment Bill Type (document or non-document) for shipments outside the US (Documents);
• Shipment Contents Value for Document shipments when the origin or destination is Canada or non-document shipments outside the US (TotalValue);
• Currency Code for the package contents value when TotalValue is provided (CurrencyCode);

The following information is optional:

• Town name for the origin and/or destination (SenderTown, RecipientTown applicable to non-US addresses);
• Indicator that specifies if the Shipment Bill Type is a document or non-document for shipments outside the US (represented by Documents config setting, which defaults to False, i.e. non-document);

The request is sent to UPS Server by calling GetShippingTime method. If error conditions were found in the request, you will receive an error.

Note: All characters beyond the maximum length allowed for all input values will be truncated and no error will be returned.

If the address information provided in the request is inaccurate or does not perfectly match the address information returned, a candidate list of addresses will be returned.

Note: A candidate list may be returned for either origin (stored in SenderCandidateAggregate) or destination (stored in RecipientCandidateAggregate) addresses inside the US only. To read an address, set the Aggregate property of an ADDRESSINFO component to this value, and read the values of the desired fields for each candidate from 0 to ADDRESSINFO's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.

When the information provided in the request is adequate, the server response will contain various services available and the corresponding transit information, such as: the scheduled delivery date and time as well as the number of days in transit.

The server response will consist of the requester's information as well as a service summary stored in the Services collection, potentially a Disclaimer text, and the DutyType (applicable to international addresses only).

If the origin and destination are one of the combinations that creates a disclaimer, the services returned will be conditionally guaranteed based on the Disclaimer text.

The information provided in the server response gives the users the ability to choose the service that best fits their needs.

By using this component, you can:

• Improve customer service by providing consistent, up-to-date shipping information based on the origin and destination addresses and the date the shipment is needed;
• Plan and manage inventory levels by controlling when your company receives merchandise;
• Review delivery options when placing an online order;
• Synchronize the arrival of multiple packages with different points of origin.

Property List

---

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

AccessKey	An identifier required to connect to UPS.
Disclaimer	Disclaimer text.
DutyType	Auto duty type applicable for requests outside the US.
Firewall	A set of properties related to firewall access.
Password	Password to use for logging in to a UPS Server.
Proxy	A set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientCandidateAggregate	String representing the list of destination address candidates (if any).
SenderAddress	Identifies the sender's address from which the shipment is originating.
SenderCandidateAggregate	String representing the list of origin address candidates (if any).
Server	URL for the UPS server where the time-in-transit requests are sent to.
Services	Collection of available services returned.
ShipDate	The date the user requests UPS to pickup the package from the origin.
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.
TotalValue	Monetary value of shipment contents.
TotalWeight	Total shipment's weight.
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 further details.

Config	Sets or retrieves a configuration setting.
GetShippingTime	Provides the average estimated time to ship a package from an origin to a destination address.
Reset	Reset the internal state of the component and all properties to their default values.

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.
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.

XPath	Used to retrieve data at any place within the response
FullRequest	Contains the full request sent to UPS
FullResponse	Contains the full response returned by UPS
Warning	Warning message returned by the server
Documents	Whether this shipment contains only documents
MaxRecords	Maximum number of candidates the user wishes to receive in the response
WeightUnit	Weight unit
SenderTown	Town name from which the shipment is originating (applicable to non-US addresses only)
RecipientTown	Town name to where the shipment is destined (applicable to non-US addresses only)
SenderCountryName	Country name from which the shipment is originating
RecipientCountryName	Country name to which the shipment is destined
CurrencyCode	The unit of currency used for the package value (when this is provided)
AcceptEncoding	Used to tell the server which types of content encodings the client supports
AllowHTTPCompression	This property enables HTTP compression for receiving data
Authorization	The Authorization string to be sent to the server
EncodeURL	If set to true the URL will be encoded by the component
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
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
UsePlatformHTTPClient	Whether or not to use the platform HTTP client
UserAgent	Information about the user agent (browser)
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
UseIPv6	Whether or not to use IPv6
MaxLineLength	The maximum amount of data to accumulate when no EOL is found
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)
FirewallListener	If true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall
FirewallPort	The TCP port for the FirewallHost;
FirewallUser	A user name if authentication is to be used connecting through a firewall
FirewallType	Determines the type of firewall to connect through
TcpNoDelay	Whether or not to delay when sending packets
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 (Windows/COM only)