FedExAddress Component [Shipping Integrator V4]
Properties
Methods
Events
Configuration Settings
Allows you to validate or complete recipient addresses.
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
Via this component 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 component, you must have a FedEx FedExAccount. You should also have already obtained a
FedExAccount, FedExAccount and a FedExAccount 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 (FedExAccount,
FedExAccount and FedExAccount) uniquely assigned to your FedExAccount
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 component 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. |
| AddressFlags | Various flags that denote information about the address. |
| City | Name of city, town, etc. |
| CountryCode | Country code. |
| State | State or province code. |
| ZipCode | Postal code. |
| Company | Name of the company that resides at the address to be validated. |
| FedExAccountNumber | Account number for logging in to the FedEx Server . |
| FedExCSPProductId | Identifies the CSP product. |
| FedExCSPProductVersion | Identifies the CSP product version. |
| FedExCSPUserKey | CSP end user key. |
| FedExCSPUserPassword | CSP end user password. |
| FedExDeveloperKey | Identifying part of the authentication key used for the sender's identity. |
| FedExMeterNumber | Meter number to use for submitting requests to the FedEx Server . |
| FedExPassword | Secret part of authentication key used for the sender's identity. |
| FedExServer | URL for the FedEx Server where the requests are sent. |
| 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. |
| LocationCount | The number of records in the Location arrays. |
| LocationCity | City name of a FedEx location. |
| LocationDescription | A textual description of the type of business at this FedEx location. |
| LocationDistance | Distance of this FedEx location from the point indicated by the search criteria. |
| LocationHoursSaturday | Saturday hours of operation for this FedEx location. |
| LocationHoursWeekday | Weekday hours of operation for this FedEx location. |
| LocationId | Business identifier that can be used by IRV attendant to look directions to this FedEx location. |
| LocationLastExpressSaturday | The time of day on Saturdays by which FedEx Express packages must be dropped off at this location for shipment that day. |
| LocationLastExpressWeekday | The time of day on weekdays by which FedEx Express packages must be dropped off at this location for shipment that day. |
| LocationLastGroundSaturday | The time of day on Saturdays by which FedEx Ground packages must be dropped off at this location for shipment that day. |
| LocationLastGroundWeekday | The time of day on weekdays by which FedEx Ground packages must be dropped off at this location for shipment that day. |
| LocationName | The name of the business at this FedEx location. |
| LocationServiceFlags | This specifies what type of services this FedEx location provides. |
| LocationState | State or province code of this FedEx location. |
| LocationStreetAddress | Street address or intersection of this FedEx location. |
| LocationZipCode | Postal Code of this FedEx location. |
| 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). |
| MatchChangeType | Changes made to the Address (during validation process) compared to this address candidate. |
| 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). |
| Phone | Phone number for which nearby FedEx locations are to be found. |
| 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. |
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. |
| FindLocations | Finds FedEx location(s) based on the input data. |
| 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.
| |
| 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. |
| CSPUserKey | CSP end user key. |
| CSPUserPassword | CSP end user password. |
| CSPProductId | Identifies the CSP product. |
| CSPProductVersion | Identifies the CSP product version. |
| LocationType | Contains the collection drop-off service identifiers to search for. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| 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. |
| 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. |
| 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. |
| 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. |
| UsePlatformHTTPClient | Whether or not to use the platform HTTP client. |
| UserAgent | Information about the user agent (browser). |
| KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
| UseIPv6 | Whether or not to use IPv6. |
| MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
| 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;. |
| FirewallUser | A user name if authentication is to be used connecting through a firewall. |
| FirewallType | Determines the type of firewall to connect through. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| 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. |
