4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

FedExRates Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DShipping.Fedexrates

Remarks

When providing origin, destination information, weight, and service, this component allows a user to obtain a 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 a 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 FedExRates 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 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.

CODTotalAmountThe total amount to be collected on delivery.
CODTypeCOD type.
DropoffTypeIdentifies the method by which the package is to be tendered to FedEx.
FedExAccountLogin information for FedEx.
FirewallA set of properties related to firewall access.
FreightGuaranteeIdentifies the freight guarantee details.
HomeDeliveryDateDate for Ground Home Delivery service.
HomeDeliveryPhoneThe phone number of the delivery location.
HomeDeliveryTypeThe type of Home Delivery Premium service being requested.
InsuredValueThe total amount of insurance requested for the shipment being rated.
PackagesA collection of packages contained in the shipment.
ProxyA set of properties related to proxy access.
RateTypeIndicates the type of rates to be returned.
RecipientAddressIdentifies the recipient's address.
RequestedServiceService type for which the shipping rate is requested.
SenderAddressIdentifies the sender's address.
ServicesCollection of available services returned for the shipment being rated.
ShipDateThe date on which the package will be shipped.
ShipmentSpecialServicesContains the collection of special services offered by FedEx.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TotalWeightThe 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.

ConfigSets or retrieves a configuration setting .
GetRatesReturns rate information for a specified or all available FedEx services.
ResetResets 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.

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 component 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 set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
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.
EstimateDeliveryDetermines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
DryIceCountThe number of packages which contain dry ice.
PackageDryIceWeight[i]The weight of the dry ice for each package.
SizeUnitThe dimension unit.
WeightUnitWeight unit.
CODReferenceIndicatorThe reference information to be added to the COD return label.
CurrencyCodeThe currency code associated with the monetary values present in the request.
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.
IncludePackageRatesWhether to parse package rates from the FedEx response.
PackageRateDetails[i].CountTotal package rate details count returned for each RequestedService.
PackageRateDetails[i].IndexPackage rate details for each package.
PackageRateDetails[i].RateTypeReturns the package rate type for each available rate.
PackageRateDetails[i].PackageIndexReturns the package index for each rate.
PackageRateDetails[i].NetChargeReturns the net charge for each package and rate type.
PackageRateDetails[i].BaseChargeReturns the base charge for each package and rate type.
PackageRateDetails[i].TotalSurchargesReturns the total surcharges for each package and rate type.
PackageRateDetails[i].TotalDiscountReturns the total discount for each package and rate type.
GroupPackageCount[i]Count of packages within a group of identical packages.
PayorAccountNumberThe account number of the party responsible for payment.
PayorNameThe payor's name.
PayorAddress1Street name of the Payor's address.
PayorAddress2A specific detail on the address.
PayorCityName of city, town, etc.
PayorStateState or province code.
PayorZipCodePayor's postal code (if applicable).
PayorCountryCodeThe country code for the payor of the shipment.
RateModeTypeSpecifies which values to return when there are multiple entries for the same RateType.
SmartPostAncillaryEndorsementThe endorsement type used for a FedEx SmartPost shipment.
SmartPostCustomerManifestIdThe Customer Manifest Id used to group FedEx SmartPost packages.
SmartPostHubIdThe HubId used to send FedEx SmartPost shipments.
SmartPostIndiciaThe Indicia type used for a FedEx SmartPost shipment.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
TransferredDataThe contents of the last response from the server.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
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).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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 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.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]