UPS Integrator Rates Component : Rates OCX, Rates .NET Component, Rates Class, Rates Bean, Rates Object

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 ServiceType 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 ServiceType 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 up to the maximum amount allowed and disregard the rest. This is important since the resulting value could prevent a correct response.

To use this component, you must have a FedEx AccountNumber. You should also have already obtained a DeveloperKey, Password and a MeterNumber 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.


AccountNumber	Account number for logging in to the FedEx Server.
CODDetail	Identifies the COD details on shipment level.
DeveloperKey	Identifying part of the authentication key used for the sender's identity.
DropoffType	Identifies the method by which the package is to be tendered to FedEx.
Firewall	A set of properties related to firewall access.
HomeDeliveryDetail	Identifies the Home Delivery Premium details.
MeterNumber	Meter number to use for submitting requests to the FedEx Server.
Packages	Collection of packages contained in the shipment being rated.
PackagingType	Identifies the packaging used by the requester for the package.
Password	Secret part of authentication key used for the sender's identity.
Proxy	A set of properties related to proxy access.
RateType	Indicates the type of rates to be returned.
RecipientAddress	Identifies the recipient's address.
SenderAddress	Identifies the sender's address.
Server	URL for the FedEx Server where the requests are sent.
Services	Collection of available services returned for the shipment being rated.
ServiceType	Service type for which the shipping rate is requested.
ShipDate	The date on which the package will be shipped.
ShipmentSpecialServices	Contains the collection of special services offered by FedEx.
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.
TotalInsuredValue	The total amount of insurance requested for the shipment being rated.
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.


XPath	Used to retrieve data at any place within the response
FullRequest	Contains the full request sent to the FedEx Server
FullResponse	Contains the full response returned by the FedEx Server
Warning	Notification returned by the server upon successful request (if applicable)
WeightUnit	Weight unit
SizeUnit	The dimension unit
DryIceCount	Number of packages in this shipment which contain dry ice
DryIceWeight	Total weight of the dry ice for this 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
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)
UseWinInet	If set, the WinInet API is used for retrieving the URL
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet
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 (Windows/COM only)

|

About

|

Privacy Policy

|

Terms of Use

|