Search: 
Available in: FEDEX
Rates Component [IBiz FedEx Integrator V1]

Properties   Methods   Events   Configuration Settings  

Provides courtesy rate(s) applicable to your FedEx account for a single package.

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

This component allows a user to request shipping rate(s) by calling the GetRates method for a specific FedEx service (when ServiceType is specified) or all available services (when ServiceType is set to UNSPECIFIED, which is the default) and a specified destination. This is available for a single package.

With the Rates component, you can:

ensure service availability (after you provide the carrier code, service type, origination & destination postal codes, packaging type, dropoff type, and estimated weight);

retrieves 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 account number (AccountNumber) and a meter number (MeterNumber) uniquely assigned to your account by FedEx.

Property List


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

AccountNumber Account number for logging in to the FedEx ServerURL.
CarrierCode Carrier code used to ship the package.
DestinationCountry Country code to which the shipment is destined.
DestinationPostalCode Postal code to which the shipment is destined.
DestinationState State or province code to which the shipment is destined.
DropoffType Dropoff type.
FromCountry Name of the country from which the shipment will be originating.
FromPostalCode Postal code from which the shipment will be originating.
FromState State or province code from which the shipment will be originating.
MeterNumber Meter number to use for submitting requests to the FedEx ServerURL.
PackageHeight The height of the package to be shipped.
PackageLength The length of the package to be shipped.
PackageWidth The width of the package to be shipped.
PackagingType Packaging type for the shipment the rate is requested.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of the server certificate for the last established connection.
ServerURL URL for the FedEx server where the requests are sent.
ServiceCount Number of available FedEx services returned for a shipment rate request.
ServiceDeliveryDate Delivery date for a ServiceType in the list of available services.
ServiceDeliveryDay Delivery day for a ServiceType in the list of available services.
ServiceDiscBaseCharge Discounted base rate amount for the shipment.
ServiceDiscNetCharge Discounted net charge amount for the shipment.
ServiceDiscTotalDiscount Total discount amount applied to the shipment.
ServiceDiscTotalSurcharge Total surcharge amount for the shipment.
ServiceEffectiveNetDiscount Effective net discount applied.
ServiceIndex Index of a FedEx service in the list of all available FedEx services.
ServiceRateScale Rate scale used to rate package to be shipped via a ServiceType.
ServiceRateZone Zone used for rate (if zone applies) for a ServiceType.
ServiceType Service type for which the shipping rate is requested.
ServiceTypeDescription Description for a ServiceType.
ShipDate The date on which the package will be shipped.
SizeUnit The dimension unit of the package.
Timeout A timeout for the component.
Value The declared value of package contents.
Weight Weight for a shipment the rate is requested.
WeightUnit Weight type for a shipment the rate is requested.

Method List


The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.

Config Sets or retrieves a component configuration setting.
GetRates Returns rate information for a specified or all available FedEx ServiceType.
Reset Reset 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 complete descriptions.

Error Information about errors during data delivery.
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 complete descriptions.

AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
Alcohol Whether the shipment contains alcohol.
COD Whether COD is selected.
CODAmount COD Collection Amount.
CODType COD Collection Type.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
DiscountedSurchargeAggregate Aggregate of surcharges (according to discounted rates).
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
FullRequest Contains the full request sent to the FedEx server.
FullResponse Contains the full response returned by the FedEx server.
HTTPVersion The version of HTTP used by the component
HoldAtLocation Whether Hold At Location special service is selected.
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
ListRate Whether a list rate courtesy quotes should be included in the server response.
ListSurchargeAggregate Aggregate of surcharges (according to list rates).
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
ResidentialDelivery Whether the shipment is to be delivered to a residential site.
ResidentialPickup Whether the shipment is to be picked up at a residential site.
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
SaturdayDelivery Whether the shipment will be scheduled for Saturday delivery.
SaturdayPickup Whether the shipment will be scheduled for Saturday pickup.
ServiceListBaseCharge Base charge (list rate).
ServiceListNetCharge Net charge (list rate).
ServiceListTotalDiscount Total discount applied (list rate).
ServiceListTotalSurcharge Total surcharge applied (list rate).
ServiceTimeInTransit Estimated time in transit.
SignatureOption Specifies one of the Delivery Signature Options requested for the shipment to be rated.
SocketHandle The handle of the main socket used by the component.
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
UserAgent Information about the user agent (browser).
Warning Information on a Soft Error (if applicable).
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)
XPath Used to retrieve data at any place within the response.

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.