Search: 
Available in: FEDEX | S3 | USPS
AddressInfo Component [UPS Integrator V2]

Properties   Methods   Events   Configuration Settings  

Checks U.S. shipping addresses (city, state, and zip code) and suggests alternates if an error is discovered.

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 the UPS guidelines, this component allows a merchant to access the accuracy of a Address, Address, and Address combination. This will improve customer service by assisting shoppers when they place orders and also reduce operating costs by streamlining your shipping process. To use this component, you must register with the UPS OnLine Tools service. For more information, please visit http://www.ee.ups.com/.

Address validation is only supported for addresses within the United States, but is available for use in 47 origin countries.

Through the ValidateAddress method, this component communicates with the UPS Server and verifies that the Address, Address, and Address combination are a valid United States address.

To use the component, first set the properties of one of the following input combinations, and call ValidateAddress:

In cases where no combinations are found, the component throws an exception.

Once the request has been successfully submitted and combinations are found, the component returns the Aggregate (which contains the list of all matches), and the Matches collection that contains a list of up to 10 valid city/state/zip combinations that closely match the address.

If no matches were found, the component throws an exception.

Here are two ways you can use this component to provide better customer service and cut costs:

If your U.S. customer enters an incorrect zip code while placing their online order, this component allows you to provide suggested alternatives allowing the errors to be corrected at the point of entry long before orders leave the shipping dock. This may help reduce costly returns. This will also enable your customer service representatives to validate addresses when they are speaking with a customer instead of after an error is discovered.

NOTE:UPS assumes no liability for the information provided by the address validation functionality. The address validation functionality does not support the identification or verification of occupants at an address.

Property List


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

AccessKeyAn identifier required to connect to UPS.
AddressIdentifies the address to be validated.
AggregateString representing the list of address candidates (if any).
FirewallA set of properties related to firewall access.
MatchesCollection of address candidates that meet the search criteria.
PasswordPassword to use for logging in to a UPS Server.
ProxyA set of properties related to proxy access.
ServerURL for the UPS server where the address validation requests are sent.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
UserIdUser 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.

ConfigSets or retrieves a configuration setting.
ResetReset the internal state of the component and all properties to their default values.
ValidateAddressReturns corrected and standardized address information.

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.

ErrorInformation about errors during data delivery.
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 component with short descriptions. Click on the links for further details.

XPathUsed to retrieve data at any place within the response
FullRequestContains the full request sent to UPS
FullResponseContains the full response returned by UPS
WarningWarning message returned by the server
AcceptEncodingUsed to tell the server which types of content encodings the client supports
AllowHTTPCompressionThis property enables HTTP compression for receiving data
AuthorizationThe Authorization string to be sent to the server
EncodeURLIf set to true the URL will be encoded by the component
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
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired
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
UsePlatformHTTPClientWhether or not to use the platform HTTP client
UserAgentInformation about the user agent (browser)
UseWinInetIf set, the WinInet API is used for retrieving the URL
UseWinInetCookiesControls whether to send and accept cookies when making HTTP requests through WinInet
UseIPv6Whether or not to use IPv6
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available
FirewallHostName or IP address of firewall (optional)
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only)
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall
FirewallPortThe TCP port for the FirewallHost;
FirewallUserA user name if authentication is to be used connecting through a firewall
FirewallTypeDetermines the type of firewall to connect through
TcpNoDelayWhether or not to delay when sending packets
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 (Windows/COM only)

| About | Privacy Policy | Terms of Use |
© Copyright 2010 /n software inc.