4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

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.




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:

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.

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.
ProxyA set of properties related to proxy access.
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.
UPSAccountLogin 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.

ConfigSets or retrieves a configuration setting .
ResetResets 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.
NotificationNotification returned by the server upon successful request (if applicable).
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.

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe 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.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
WarningWarning message returned by the server.
AlternateDeliveryAddressUsed to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.
IncludeNegotiatedRatesWhether to include the NegotiatedRatesIndicator in the request.
ShipmentIndicationTypeWhether shipment is Hold For Pickup or Delivery at UPS Access Points.
NotificationLanguageUsed to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationDialectUsed to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
ItemizedChargesCountThe count of itemized charges.
ItemizedChargesCode[i]The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCurrencyCode[i]The currency used for the charge.
ItemizedChargesMonetaryValue[i]The amount being charged.
ItemizedChargesSubType[i]The subtype of the itemized charge.
SubVersionUPS SubVersion.
TaxInformationIndicatorControls whether to send a TaxInformationIndicator.
UseSOAPWhether or not to use UPS' webservices.
RequestTypeIdentifies 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).
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
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.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
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.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
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;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]