UPSAddress Component

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

DPayments.DShippingSDK.Upsaddress

Remarks

Using the UPS guidelines, this component 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 component, 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 component communicates with the UPS Server 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 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 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 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 address 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.

For a street-level address validation and classification, the AccountNumber 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 AccessKey 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 component with short descriptions. Click on the links for further details.


Address	Identifies the address to be validated.
Aggregate	String representing the list of address candidates (if any).
Firewall	A set of properties related to firewall access.
Matches	Collection of address candidates that meet the search criteria.
Proxy	A set of properties related to proxy access.
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.
UPSAccount	Login information for 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.
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 component 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 component with short descriptions. Click on the links for further details.


AlternateDeliveryAddress	Used to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.
HasXPath	Determines whether a specific element exists in the document.
IncludeNegotiatedRates	Whether to include the NegotiatedRatesIndicator in the request.
ItemizedChargesCode[i]	The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCount	The count of itemized charges.
ItemizedChargesCurrencyCode[i]	The currency used for the charge.
ItemizedChargesMonetaryValue[i]	The amount being charged.
ItemizedChargesSubType[i]	The subtype of the itemized charge.
MatchAggregate[i]	String representing the address candidate in the list of matches (if any, at index i).
NotificationDialect	Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationLanguage	Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
RequestType	Identifies the optional processing to be performed during address validation on street-level.
ShipmentIndicationType	Whether shipment is Hold For Pickup or Delivery at UPS Access Points.
SubVersion	UPS SubVersion.
TaxInformationIndicator	Controls whether to send a TaxInformationIndicator.
UseSOAP	Whether or not to use UPS' webservices.
Warning	Warning message returned by the server.
XAttrCount	The number of records in the XAttr arrays.
XAttrName[i]	The name of the indexed attribute.
XAttrValue[i]	The value of the indexed attribute.
XChildCount	The number of records in the XChild arrays.
XChildElement[i]	The name of the indexed child element.
XChildText[i]	The text of the indexed child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Used to set the XPath within the response from the server.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
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.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
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.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
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.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
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.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
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.
SentHeaders	The full set of headers as sent by the client.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the component will close the upload or download stream after the transfer.
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).
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;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
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 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.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
UseNTLMv2	Whether to use NTLM V2.
CACertFilePaths	The paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLNegotiatedCipher	Returns the negotiated ciphersuite.
SSLNegotiatedCipherStrength	Returns the negotiated ciphersuite strength.
SSLNegotiatedCipherSuite	Returns the negotiated ciphersuite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
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.
BuildInfo	Information about the product's build.
GUIAvailable	Tells the component whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.