Shipping Integrator FedExRates Component : FedExRates OCX, FedExRates .NET Component, FedExRates Class, FedExRates Bean, FedExRates Object

Available in: SHIPPING

FedExRates Component [Shipping Integrator V4]

Properties Methods Events Configuration Settings

Provides access to pre-ship rate information for a single package per your established FedEx account rates.

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

When providing origin, destination information, weight, and service, this component allows a user to obtain rate quote for a specific service, or a list of available FedEx Express services with the respective rate quotes.

You can send a rate request to FedEx by calling the GetRates method for:

a specific FedEx service (when RequestedService is specified). In this case, the component will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.
all available FedEx services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination. This option is available for all shipping types and destinations.

Discount rates are available for all services and origin/destination pairs. List rates are available for Express and Ground U.S. shipments only. To have list rates returned with your discount rates, you must set the RateType to 0 (rtList). This way, you will receive both discount and list rates.

When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.

Rating for Multiple Package Shipment (MPS) is available for: Express U.S. Domestic and International multiple package shipments, Ground US Domestic and International multiple-package shipments, Express Domestic C.O.D. and International C.O.D. multiple-package shipments and Ground Domestic C.O.D. and International C.O.D. multiple-package shipments.

Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.

With the Rates Component, you can:

ensure service availability (after you provide the carrier code, service type, origination & destination postal codes, packaging type, drop-off type, and estimated weight);
retrieve the rate required for that shipment.

The restrictions on the allowed property values are listed separately under each control property description. If the user enters more than the allowed number of characters, an error will not be generated. The control will simply pass in the characters provided and the server may disregard the extra characters. This is important since the resulting value could prevent a correct response.

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.

Property List

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


CODTotalAmount	The total amount to be collected.
CODType	COD type.
DropoffType	Identifies the method by which the package is to be tendered to FedEx.
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.
HomeDeliveryDate	Date for Ground Home Delivery service.
HomeDeliveryPhone	The phone number of the delivery location.
HomeDeliveryType	The type of Home Delivery Premium service being requested.
InsuredValue	The total amount of insurance requested for the shipment being rated.
PackageCount	The number of records in the Package arrays.
PackageCODAmount	The COD monetary value for the package.
PackageHeight	The height of the package to be shipped.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageType	The packaging type of the package being rated and/or shipped.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageSpecialServices	Contains the collection of special services offered on the package level.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
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.
RateType	Indicates the type of rates to be returned.
RecipientAddress1	Street name.
RecipientAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlags	Various flags that denote information about the address.
RecipientCity	Name of city, town, etc.
RecipientCountryCode	Country code.
RecipientState	State or province code.
RecipientZipCode	Postal code.
RequestedService	Service type for which the shipping rate is requested.
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderAddressFlags	Various flags that denote information about the address.
SenderCity	Name of city, town, etc.
SenderCountryCode	Country code.
SenderState	State or province code.
SenderZipCode	Postal code.
ServiceCount	The number of records in the Service arrays.
ServiceAccountBaseCharge	Transportation charges before surcharges and discounts applied to a ServiceType .
ServiceAccountNetCharge	Net charge amount applied to a ServiceType .
ServiceAccountTotalDiscount	Total discount amount applied to the shipment for a ServiceType .
ServiceAccountTotalSurcharge	Total surcharge amount for all additional services applied to a ServiceType .
ServiceAggregate	Aggregate of details and rates for the ServiceType in the list of available services.
ServiceDeliveryDate	This indicates the shipment delivery date for the ServiceType .
ServiceDeliveryDay	Indicates the day of the week the shipment can be delivered when using the ServiceType .
ServiceEffectiveNetDiscount	Indicates the net discount applied to a ServiceType .
ServiceListBaseCharge	Transportation charges before surcharges and discounts applied to a ServiceType .
ServiceListNetCharge	Net charge amount applied to a ServiceType .
ServiceListTotalDiscount	Total discount amount applied to a ServiceType .
ServiceListTotalSurcharge	Total surcharge amount for all additional services applied to a ServiceType .
ServiceRateScale	Applicable rate scale for the ServiceType .
ServiceRateZone	Applicable rate zone for the ServiceType .
ServiceType	Indicates the service type in the list of available services returned.
ServiceTypeDescription	Indicates the textual description of a service type in the list of available services returned.
ServiceSignatureType	Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType .
ServiceTransitTime	Expected number of days in transit from pickup to delivery for the ServiceType .
ShipDate	The date on which the package will be shipped.
ShipmentSpecialServices	Contains the collection of special services offered by FedEx.
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.
TotalWeight	The total weight of all the pieces in this shipment.

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.
GetRates	Returns rate information for a specified or all available FedEx services.
Reset	Resets the internal state of the component and all properties to their default values.

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.
CODReferenceIndicator	The reference information to be added to the COD return label.
DryIceCount	Number of packages in this shipment which contain dry ice.
DryIceWeight	Total weight of the dry ice for this shipment.
SizeUnit	The dimension unit.
WeightUnit	Weight unit.
CurrencyCode	The currency code associated with the monetary values present in the request.
FreightGuaranteeDate	The date of greight guarantee.
FreightGuaranteeTime	The time of greight guarantee.
FreightGuaranteeType	The type of greight guarantee.
AccountFromCurrency[i]	The currency from which the value was converted.
AccountIntoCurrency[i]	The currency to which the value was converted.
AccountExchangeRate[i]	The exchange rate use when converting currency.
ListFromCurrency[i]	The currency from which the value was converted.
ListIntoCurrency[i]	The currency to which the value was converted.
ListExchangeRate[i]	The exchange rate use when converting currency.
SmartPostAncillaryEndorsement	The endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestId	The Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubId	The HubId used to send FedEx SmartPost shipments.
SmartPostIndicia	The Indicia type used for a FedEx SmartPost shipment.
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.