Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

FedExAddress Class

Properties   Methods   Events   Configuration Settings   Errors  

Allows you to validate or complete recipient addresses.

Syntax

FedExAddress

Remarks

Via this class you can perform the following:

  • Confirm the validity and completeness of US, Puerto Rico and Canadian recipient addresses.
  • Complete incomplete recipient addresses.
  • Correct invalid recipient addresses.
  • Determine whether an address is business or residential to increase the accuracy of courtesy rate quotes. This applies to US addresses only.
  • Find information on the nearest FedEx location(s).

Having correct addresses on the shipping labels will eliminate delivery delays and additional service fees (occurring when a shipment is re-routed).

For address verification, use the ValidateAddress method. This provides street level matches, but it does not currently verify suite or apartment numbers. It checks if the street exists in the city and state/province or postal code entered, and if the street number is within a valid range for the street entered. Upon successful reply, it either provides an exact match or possible alternatives (multiple address results) when an exact match cannot be found based on the input values, or informs you if no possible alternatives can be found.

The following information is the minimum required to check an address:

  • Street Address
  • City and State/Province or Postal Code

To search for the nearest FedEx location(s), use the FindLocations method. You can search by address or telephone number.

To narrow down the search, you can specify what type of locations are you looking for (such as FedEx Staffed, Self-Service and/or Authorized Ship Center) and any special service those locations offer (such as Saturday service, packaging supplies, packing services, latest Express drop-off, etc.).

If the request completes successfully, FedEx server will return a set of matches that satisfies the search criteria. You will be able to retrieve FedEx location Ids, addresses, available services they offer, operations hours on weekdays and/or weekends.

The set of locations retrieved is limited to a maximum of ten locations returned within a 50-mile radius.

To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a FedExDeveloperKey, FedExPassword and a FedExMeterNumber uniquely assigned to your account by FedEx after registration for Web Services.

FedEx allows this service to be used in production environment only (i.e., after passing the certification). Customers need to be certified first in order to have the Advanced (such as Address Validation) services activated. After the certification is granted, you will receive the production credentials (FedExDeveloperKey, FedExPassword and FedExMeterNumber) uniquely assigned to your FedExAccountNumber by FedEx after being certified for FedEx Web Services. Once they move to production, Address Validation is a feature that has to be activated upon the customer's request.

Property List


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

Address1Street name.
Address2A specific detail on the address (such as building, suite, apartment, floor number etc.
AddressFlagsVarious flags that denote information about the address.
CityName of city, town, etc.
CountryCodeCountry code.
StateState or province code.
ZipCodePostal code.
CompanyName of the company that resides at the address to be validated.
ConstraintExpressDropoffTimeThis should contain the time you would like to dropoff an express package.
ConstraintFiltersThe following flags are defined (specified in hexadecimal notation).
ConstraintLocationAttributesThis indicates the services you would like to search for at a particular location.
ConstraintLocationContentOptionsThis sets what content you would like to have returned with the location data.
ConstraintLocationTypeFlagsThis indicates the type(s) of FedEx location you would like to search for.
ConstraintResultsRequestedThe number of results requested.
ConstraintResultsToSkipThe number of results to skip.
ConstraintSearchRadiusThis contains the search radius to be used when FindLocations is called.
ConstraintSupportedRedirectToHoldServiceIndicates which redirect to hold services you are searching for.
FedExAccountNumberAccount number for logging in to the FedEx Server .
FedExCSPProductIdIdentifies the CSP product.
FedExCSPProductVersionIdentifies the CSP product version.
FedExCSPUserKeyCSP end user key.
FedExCSPUserPasswordCSP end user password.
FedExDeveloperKeyIdentifying part of the authentication key used for the sender's identity.
FedExMeterNumberMeter number to use for submitting requests to the FedEx Server .
FedExPasswordSecret part of authentication key used for the sender's identity.
FedExServerURL for the FedEx Server where the requests are sent.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
GeographicCoordinatesSpecifies the geographic coordinates by which nearby FedEx locations are to be found.
LocationCountThe number of records in the Location arrays.
LocationAcceptedCurrencyThe currency that is accepted at this FedEx location.
LocationAttributesThis specifies what type of services this FedEx location provides.
LocationCarrierCountThis contains the number of Carriers returned for the current location.
LocationCarrierEffectiveLatestDropoffCountThis contains the total number of effective latest dropoff times that were returned for the carrier specified by CarrierIndex .
LocationCarrierEffectiveLatestDropoffDayOfWeekThis contains the day of the week for the current effective latest dropoff.
LocationCarrierEffectiveLatestDropoffIndexThis specifies the index for the effective latest dropoff time for the carrier specified by CarrierIndex .
LocationCarrierEffectiveLatestDropoffTimeThis contains the current carrier's effective dropoff time for the specified day.
LocationCarrierExceptionalLatestDropoffCountThis contains the total number of exceptional latest dropoff times that were returned for the carrier specified by CarrierIndex .
LocationCarrierExceptionalLatestDropoffDayOfWeekThis contains the day of the week for the current exceptional latest dropoff.
LocationCarrierExceptionalLatestDropoffIndexThis specifies the index for the exceptional latest dropoff time for the carrier specified by CarrierIndex .
LocationCarrierExceptionalLatestDropoffTimeThis contains the current carrier's exceptional dropoff time for the specified day.
LocationCarrierIndexThis contains the current index for the array of carriers that were returned for the current location.
LocationCarrierNormalLatestDropoffCountThis contains the total number of normal latest dropoff times that were returned for the carrier specified by CarrierIndex .
LocationCarrierNormalLatestDropoffDayOfWeekThis contains the day of the week for the current normal latest dropoff.
LocationCarrierNormalLatestDropoffIndexThis specifies the index for the normal latest dropoff time for the carrier specified by CarrierIndex .
LocationCarrierNormalLatestDropoffTimeThis contains the current carrier's normal dropoff time for the specified day.
LocationCarrierTypeThis contains the type of carrier the current carrier is.
LocationCarrierTypeDescriptionThe textual description of the rfCarrierType;.
LocationCityName of the city that the current location is in.
LocationCompanyNameThe name of the business at this FedEx location.
LocationCountryCodeThis contains the country code for the current location.
LocationEffectiveHoursCountThis contains the number of effective hours that were returned for the current location.
LocationEffectiveHoursDayOfWeekThis contains the day of the week for which the effective hours are being specified.
LocationEffectiveHoursDescriptionThis contains the description for the effective hours, specified by EffectiveHoursIndex , for the current location.
LocationEffectiveHoursIndexThis specifies the current index for the array containing the current location's effective hours.
LocationEffectiveHoursOperationalHoursThis contains the time range for the effective hours, specified by EffectiveHoursIndex , that the current location is open.
LocationEmailThe email address provided for the current location.
LocationEntityIdThe entity ID for the current location.
LocationExceptionalHoursCountThis contains the number of exceptional hours that were returned for the current location.
LocationExceptionalHoursDayOfWeekThis contains the day of the week for which the exceptional hours are being specified.
LocationExceptionalHoursDescriptionThis contains the description for the exceptional hours, specified by ExceptionalHoursIndex , for the current location.
LocationExceptionalHoursIndexThis specifies the current index for the array containing the current location's exceptional hours.
LocationExceptionalHoursOperationalHoursThis contains the time range for the exceptional hours, specified by ExceptionalHoursIndex , that the current location is open.
LocationFaxThis contains the fax number for the current location.
LocationGeographicCoordinatesThis contains the geographic coordinates of the current location.
LocationHolidayCountThis contains the number of holidays that the current FedEx location observes.
LocationHolidayDateThis is the date of the holiday specified by HolidayIndex .
LocationHolidayIndexThis contains the index of the current holiday the FedEx location observes.
LocationHolidayNameThis contains the name of the holiday specified by HolidayIndex .
LocationIdBusiness identifier that can be used by IRV attendant to look directions to this FedEx location.
LocationMapURLThis contains the URL to the google map showing the location.
LocationNormalHoursCountThis contains the number of normal hours that were returned for the current location.
LocationNormalHoursDayOfWeekThis contains the day of the week for which the normal hours are being specified.
LocationNormalHoursDescriptionThis contains the description for the normal hours, specified by NormalHoursIndex , that the current location is open.
LocationNormalHoursIndexThis specifies the current index for the array containing the current location's normal hours.
LocationNormalHoursOperationalHoursThis contains the time range for the normal hours, specified by NormalHoursIndex , that the current location is open.
LocationPersonNameThe name of the person listed as the contact for the current location.
LocationPhoneThe phone number for the current location.
LocationSpecialInstructionsThis contains any special instructions provided for the current location.
LocationStateState or province code of the current location.
LocationStoreNumberThe store number for the current location.
LocationStreetAddressStreet address or intersection of this FedEx location.
LocationTypeThe type of this FedEx location.
LocationZipCodeThe postal code for the current location.
MatchCountThe number of records in the Match arrays.
MatchAddress1Address line 1 of an address candidate in the list of matches (if any).
MatchAddress2Address line 2 of an address candidate in the list of matches (if any).
MatchChangeTypeChanges made to the Address (during validation process) compared to this address candidate.
MatchCityCity name of an address candidate in the list of matches (if any).
MatchCompanyName of the company that resides at an address candidate in the list of matches (if any).
MatchCountryCodeCountry code of an address candidate in the list of matches (if any).
MatchQualityQuality factor an address candidate in the list of matches (if any).
MatchResidentialStatusResidential status of an address candidate in the list of matches (if any).
MatchStateState or province code of an address candidate in the list of matches (if any).
MatchZipCodePostal Code of an address candidate in the list of matches (if any).
PhonePhone number for which nearby FedEx locations are to be found.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
SearchCriteriaThe criteria to be used to find FedEx Locations.
SortCriteriaThe criteria to be used to sort the results.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TotalLocationsFoundSpecifies the total number of locations found.

Method List


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

ConfigSets or retrieves a configuration setting .
FindLocationsFinds FedEx location(s) based on the input data.
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 class 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 class 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 retrieve data at any place within the response.
WarningWarning message returned by the server.
CSPUserKeyCSP end user key.
CSPUserPasswordCSP end user password.
CSPProductIdIdentifies the CSP product.
CSPProductVersionIdentifies the CSP product version.
UseSOAPDetermines if the FedEx SOAP web services are used instead of the FedEx XML web services.
CustomContentDefines any custom content to print on the label.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
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.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0