UPSAddress Class

Properties Methods Events Configuration Settings Errors

Checks either a general validation of a city, state, and zip code, or a validation and classification of a specific, street-level address, and suggests alternates if an error is discovered.

Syntax

inship.upsaddress()

Remarks

Using the UPS guidelines, this class allows a merchant to access:

the accuracy of a City, State, and ZipCode combination;
the accuracy of a street address, and also use to determine if an address is a commercial or residential address;

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 class, you must register with the UPS OnLine Tools service. For more information, please visit http://www.ee.ups.com/.

Address validation for a non-street-level validation is only supported for addresses within the US, but is available for use in 47 origin countries.

Address validation for a street-level validation is only supported for addresses within the US and Puerto Rico.

Through the ValidateAddress method, this class communicates with the UPS UPSServer and verifies that the:

City, State, and ZipCode combination are a valid US address (for a non-street-level validation)
Address1, Address2, City, State, and ZipCode combination are a valid US or PR address (for a street-level validation)

To use the component for a non-street-level address validation, first set the properties of one of the following input combinations, and call the ValidateAddress:

To use the component for a street-level address validation, the Address1 is required to be set along with setting the rest of address properties (as listed above), and call the ValidateAddress method. If address classification (whether an address is a residence or a commercial location) is wanted while validating an address, then the RequestType has to be set to 2 (Address Validation and Classification). For address classification requests, it is important that the client include all information available about the address. Such information is important for accurate results, as many locations include both commercial and residential entities (such as a deli on the ground floor of an apartment building).

In cases where no combinations are found, the class fails with an error.

Once the request has been successfully submitted and combinations are found, the class 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 intended address (for a non-street-level validation);
50 valid street address/city/state/zip/country combinations that closely match the intended address (for a street-level validation), along with the address classification of each candidate (if this requested);

If no matches were found, the class fails with an error.

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

If your U.S. customer enters an incorrect address while placing their online order, this class 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.

For a street-level address validation and classification, the UPSAccountNumber is required to be sent in the request. Also, you might need access UPS website (https://www.ups.com/upsdeveloperkit/updateaccesskeys?loc=en_US) to update your UPSAccessKey in order to access a certain UPS Online tool (in this case: 'Address Validation - Street Level').

NOTE:UPS assumes no liability for the information provided by the address validation functionality.

Property List

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


Address1	Street name.
Address2	A specific detail on the address (such as building, suite, apartment, floor number etc.
City	Name of city, town, etc.
CountryCode	Country code.
State	State or province code.
ZipCode	Postal code.
Aggregate	String representing the list of address candidates (if any).
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
MatchCount	The number of records in the Match arrays.
MatchAddress1	Address line 1 of an address candidate in the list of matches (if any).
MatchAddress2	Address line 2 of an address candidate in the list of matches (if any).
MatchCity	City name of an address candidate in the list of matches (if any).
MatchCompany	Name of the company that resides at an address candidate in the list of matches (if any).
MatchCountryCode	Country code of an address candidate in the list of matches (if any).
MatchQuality	Quality factor an address candidate in the list of matches (if any).
MatchResidentialStatus	Residential status of an address candidate in the list of matches (if any).
MatchState	State or province code of an address candidate in the list of matches (if any).
MatchZipCode	Postal Code of an address candidate in the list of matches (if any).
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
UPSAccessKey	An identifier required to connect to a UPS server.
UPSAccountNumber	The shipper's UPS account number.
UPSPassword	Password to use for logging in to a UPS Server .
UPSServer	URL for the UPS server where the requests are sent.
UPSUserId	User Id for logging in to UPS.

Method List

The following is the full list of the methods of the class 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.
ValidateAddress	Returns corrected and standardized address information.

Event List

The following is the full list of the events fired by the class 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 class 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.
Warning	Warning message returned by the server.
UseSOAP	Whether or not to use UPS' webservices.
RequestType	Identifies the optional processing to be performed during address validation on street-level.
MatchAggregate[i]	String representing the address candidate in the list of matches (if any, at index i).
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.