FedExFreightRates Class
Properties Methods Events Configuration Settings Errors
Provides access to pre-ship rate information for a freight shipment per your established FedEx account rates.
Syntax
FedExFreightRates
Remarks
When providing origin, destination information, weight, and service, this class 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). The class 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.
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 FedExFreightRates Class, 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 class, you must have a FedEx FedExAccountNumber. You should also have already obtained a FedExDeveloperKey, FedExPassword and a FedExMeterNumber 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 class with short descriptions. Click on the links for further details.
CODTotalAmount | The total amount to be collected on delivery. |
CODType | COD type. |
CommodityCount | The number of records in the Commodity arrays. |
CommodityDescription | Complete and accurate description of this commodity line item. |
CommodityFreightClass | Indicates the freight class of the commodity. |
CommodityFreightPackagingType | Identifies the Commodity item's packaging type. |
CommodityHandlingUnits | Number of individual handling units to which this commodity applies. |
CommodityHarmonizedCode | Unique code representing this commodity line item (for imports only). |
CommodityHazardousMaterialsOptions | Indicates the kind of hazardous material content in this commodity. |
CommodityHeight | The height of the commodity. |
CommodityLength | The width of the commodity. |
CommodityManufacturer | Country code where the contents of this commodity line were produced, manufactured or grown in their final form. |
CommodityNmfcCode | NMFC Code for commodity. |
CommodityNumberOfPieces | The total number of packages, cartons, or containers for the commodity line item. |
CommodityPONumber | The PO Number for printed reference per commodity. |
CommodityQuantity | Number of units contained in this commodity line item measured in units specified by the QuantityUnit . |
CommodityQuantityUnit | Unit of measure used to express the Quantity of this commodity line item. |
CommodityUnitPrice | Value of each QuantityUnit in Quantity of this commodity line item. |
CommodityValue | The value of an individual item being shipped. |
CommodityVolume | This should contain the volume of the freight item. |
CommodityWeight | The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. |
CommodityWidth | The width of the commodity. |
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. |
FreightGuaranteeDate | The date the freight shipment is guaranteed for. |
FreightGuaranteeType | Specifies what type of freight guarantee is requested. |
InsuredValue | The total amount of insurance requested for the shipment being rated. |
PackageCount | The number of records in the Package arrays. |
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. |
PayorAccountNumber | The account number of the party responsible for payment (shipping charges, or duties and taxes). |
PayorAddress1 | Street name. |
PayorAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
PayorCity | Name of city, town, etc. |
PayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
PayorName | Identifies the payor's name. |
PayorType | Method of payment for shipment, or duties and taxes. |
PayorState | State or province code. |
PayorZipCode | Payor's postal code (if applicable). |
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. |
ShipmentInfoAccountNumber | This is the account number to be used with a freight shipment. |
ShipmentInfoAlternateBillingAccountNumber | This should be set to the alternate account number to be billed. |
ShipmentInfoAlternateBillingCity | This should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingCompanyName | This should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingCountryCode | This should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingPersonName | This should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingState | This should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingStreetAddress | This should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoAlternateBillingZipCode | This should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber . |
ShipmentInfoBillingAddress1 | This should be set to the first address line listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingAddress2 | This should be set to the second address line listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingCity | This should be set to the city listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingCompanyName | This should be set to the name of the company listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingCountryCode | This should be set to the country code listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingEmail | This should be set to the email address listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingFax | This should be set to the fax number listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingPersonName | This should be set to the name of the person listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingPhone | This should be set to the phone number listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingState | This should be set to the state listed on the account associated with the FreightAccountNumber . |
ShipmentInfoBillingZipCode | This should be set to the zip code listed on the account associated with the FreightAccountNumber . |
ShipmentInfoClientDiscountPercent | The estimated client discount rate for a freight shipment. |
ShipmentInfoCollectTermsType | This sets the terms for how to collect payment for this freight shipment. |
ShipmentInfoComments | The description for this freight shipment. |
ShipmentInfoCoupons | This contains a semicolon delimited list of identifiers for promotional discounts offered to customers. |
ShipmentInfoDeclaredValue | The total declared value per unit for this freight shipment. |
ShipmentInfoDeclaredValueUnits | Identifies the declared value units corresponding to the above defined declared value. |
ShipmentInfoEmergencyContactPhone | The phone number for the emergency contact. |
ShipmentInfoHazardousMaterialsOfferor | If this shipment contains hazardous materials, this should contain the offeror of the hazardous materials. |
ShipmentInfoLiabilityCoverageAmount | This should be set to the total value of the liability coverage. |
ShipmentInfoLiabilityCoverageType | This should be set to the type of liability coverage offered. |
ShipmentInfoPalletWeight | This should contain the total weight of all pallets used in this freight shipment. |
ShipmentInfoRole | This indicates the role of the party is submitting the transaction for this freight shipment. |
ShipmentInfoTotalHandlingUnits | Total number of individual handling units in the entire shipment (for unit pricing). |
ShipmentInfoTotalLength | This should be set to the total length of the shipment. |
ShipmentInfoTotalWidth | This should be set to the total width of the shipment. |
ShipmentInfoTotalHeight | This should be set to the total height of the shipment. |
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 class 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 class 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 class 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. |
UseSOAP | Determines if the FedEx SOAP web services are used instead of the FedEx XML web services. |
CustomContent | Defines any custom content to print on the label. |
CODReferenceIndicator | The reference information to be added to the COD return label. |
DryIceCount | The number of packages which contain dry ice. |
PackageDryIceWeight[i] | The weight of the dry ice for each package. |
SizeUnit | The dimension unit. |
WeightUnit | Weight unit. |
CurrencyCode | The 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. |
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. |
FreightAccountNumber | Account number used with the FedEx Freight service. |
FreightBillingPersonName | The name of the person to be billed. |
FreightBillingCompanyName | The name of the company to be billed. |
FreightBillingPhone | The phone number of the party to be billed. |
FreightBillingFax | The fax number of the party to be billed. |
FreightBillingEmail | The email of the party to be billed. |
FreightBillingAddress1 | The first address line of the party to be billed. |
FreightBillingAddress2 | The second address line of the party to be billed. |
FreightBillingCity | The city of the party to be billed. |
FreightBillingState | The state of the party to be billed. |
FreightBillingCountryCode | The country code of the party to be billed. |
FreightBillingZipCode | The zip code of the party to be billed. |
FreightAlternateBillingAccountNumber | The alternate account number to be billed. |
FreightAlternateBillingPersonName | The name of the person to be billed. |
FreightAlternateBillingCompanyName | The name of the company to be billed. |
FreightAlternateBillingStreetAddress | The street address line of the party to be billed. |
FreightAlternateBillingCity | The city of the party to be billed. |
FreightAlternateBillingState | The state of the party to be billed. |
FreightAlternateBillingCountryCode | The country code of the party to be billed. |
FreightAlternateBillingZipCode | The zip code of the party to be billed. |
FreightClientDiscountPercent | Estimated discount rate provided by client for unsecured rate quote. |
FreightCollectTermsType | The terms of the collect payment for a Freight Shipment. |
FreightComment | Description for the shipment. |
FreightDeclaredValue | The declared value for the shipment. |
FreightDeclaredValueUnits | The declared value units. |
FreightHazardousMaterialsOfferor | The offeror of the hazardous materials. |
FreightLiabilityCoverageAmount | The total amount of liability coverage. |
FreightLiabilityCoverageType | The type of liability coverage offered. |
FreightPalletWeight | Total weight of pallets used in shipment. |
FreightRole | Indicates the role of the party submitting the transaction. |
FreightShipmentLength | The overall length of the shipment. |
FreightShipmentWidth | The overall width of the shipment. |
FreightShipmentHeight | The overall height of the shipment. |
FreightTotalHandlingUnits | The total handling units for the shipment. |
FreightItemCount | The number of freight items. |
FreightItemClass[i] | The class of the freight item. |
FreightItemPackagingType[i] | The packaging type for the specified freight item. |
FreightItemDescription[i] | The description for the specified freight item. |
FreightItemWeight[i] | The weight of the specified freight item. |
FreightItemLength[i] | The length of the specified freight item. |
FreightItemHeight[i] | The height of the specified freight item. |
FreightItemWidth[i] | The width of the specified freight item. |
FreightItemVolume[i] | Volume of the specified freight item. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
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. |
FollowRedirects | Determines what happens when the server issues a redirect. |
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. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
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. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
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). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
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. |