Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

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

inship.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.

CODTotalAmountThe total amount to be collected on delivery.
CODTypeCOD type.
CommodityCountThe number of records in the Commodity arrays.
CommodityDescriptionComplete and accurate description of this commodity line item.
CommodityFreightClassIndicates the freight class of the commodity.
CommodityFreightPackagingTypeIdentifies the Commodity item's packaging type.
CommodityHandlingUnitsNumber of individual handling units to which this commodity applies.
CommodityHarmonizedCodeUnique code representing this commodity line item (for imports only).
CommodityHazardousMaterialsOptionsIndicates the kind of hazardous material content in this commodity.
CommodityHeightThe height of the commodity.
CommodityLengthThe width of the commodity.
CommodityManufacturerCountry code where the contents of this commodity line were produced, manufactured or grown in their final form.
CommodityNmfcCodeNMFC Code for commodity.
CommodityNumberOfPiecesThe total number of packages, cartons, or containers for the commodity line item.
CommodityPONumberThe PO Number for printed reference per commodity.
CommodityQuantityNumber of units contained in this commodity line item measured in units specified by the QuantityUnit .
CommodityQuantityUnitUnit of measure used to express the Quantity of this commodity line item.
CommodityUnitPriceValue of each QuantityUnit in Quantity of this commodity line item.
CommodityValueThe value of an individual item being shipped.
CommodityVolumeThis should contain the volume of the freight item.
CommodityWeightThe shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.
CommodityWidthThe width of the commodity.
DropoffTypeIdentifies the method by which the package is to be tendered to FedEx.
FedExAccountNumberAccount number for logging in to the FedEx Server .
FedExCSPProductIdIdentifies the CSP product.
FedExCSPProductVersionIdentifies the CSP product version.
FedExCSPUserKeyCSP end user key.
FedExCSPUserPasswordCSP end user password.
FedExDeveloperKeyIdentifying part of the authentication key used for the sender's identity.
FedExMeterNumberMeter number to use for submitting requests to the FedEx Server .
FedExPasswordSecret part of authentication key used for the sender's identity.
FedExServerURL for the FedEx Server where the requests are sent.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FreightGuaranteeDateThe date the freight shipment is guaranteed for.
FreightGuaranteeTypeSpecifies what type of freight guarantee is requested.
InsuredValueThe total amount of insurance requested for the shipment being rated.
PackageCountThe number of records in the Package arrays.
PackageHeightThe height of the package to be shipped.
PackageInsuredValueAmount of insurance requested for this package.
PackageLengthThe length of the package to be shipped.
PackageTypeThe packaging type of the package being rated and/or shipped.
PackageSignatureTypeSpecifies one of the Delivery Signature Options requested for this package.
PackageSpecialServicesContains the collection of special services offered on the package level.
PackageWeightWeight of this package.
PackageWidthThe width of the package to be shipped.
PayorAccountNumberThe account number of the party responsible for payment (shipping charges, or duties and taxes).
PayorAddress1Street name.
PayorAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
PayorCityName of city, town, etc.
PayorCountryCodeThe country code for the payor of the shipment, or duties and taxes.
PayorNameIdentifies the payor's name.
PayorTypeMethod of payment for shipment, or duties and taxes.
PayorStateState or province code.
PayorZipCodePayor's postal code (if applicable).
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RateTypeIndicates the type of rates to be returned.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlagsVarious flags that denote information about the address.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientStateState or province code.
RecipientZipCodePostal code.
RequestedServiceService type for which the shipping rate is requested.
SenderAddress1Street name.
SenderAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderAddressFlagsVarious flags that denote information about the address.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderStateState or province code.
SenderZipCodePostal code.
ServiceCountThe number of records in the Service arrays.
ServiceAccountBaseChargeTransportation charges before surcharges and discounts applied to a ServiceType .
ServiceAccountNetChargeNet charge amount applied to a ServiceType .
ServiceAccountTotalDiscountTotal discount amount applied to the shipment for a ServiceType .
ServiceAccountTotalSurchargeTotal surcharge amount for all additional services applied to a ServiceType .
ServiceAggregateAggregate of details and rates for the ServiceType in the list of available services.
ServiceDeliveryDateThis indicates the shipment delivery date for the ServiceType .
ServiceDeliveryDayIndicates the day of the week the shipment can be delivered when using the ServiceType .
ServiceEffectiveNetDiscountIndicates the net discount applied to a ServiceType .
ServiceListBaseChargeTransportation charges before surcharges and discounts applied to a ServiceType .
ServiceListNetChargeNet charge amount applied to a ServiceType .
ServiceListTotalDiscountTotal discount amount applied to a ServiceType .
ServiceListTotalSurchargeTotal surcharge amount for all additional services applied to a ServiceType .
ServiceRateScaleApplicable rate scale for the ServiceType .
ServiceRateZoneApplicable rate zone for the ServiceType .
ServiceTypeIndicates the service type in the list of available services returned.
ServiceTypeDescriptionIndicates the textual description of a service type in the list of available services returned.
ServiceSignatureTypeIndicates the textual description of the delivery signature services option required by FedEx for the ServiceType .
ServiceTransitTimeExpected number of days in transit from pickup to delivery for the ServiceType .
ShipDateThe date on which the package will be shipped.
ShipmentInfoAccountNumberThis is the account number to be used with a freight shipment.
ShipmentInfoAlternateBillingAccountNumberThis should be set to the alternate account number to be billed.
ShipmentInfoAlternateBillingCityThis should be set to the city associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingCompanyNameThis should be set to the name of the company associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingCountryCodeThis should be set to the country code associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingPersonNameThis should be set to the name of the person associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingStateThis should be set to the state associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingStreetAddressThis should be set to the street address associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoAlternateBillingZipCodeThis should be set to the zip code associated with the account number set in FreightAlternateBillingAccountNumber .
ShipmentInfoBillingAddress1This should be set to the first address line listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingAddress2This should be set to the second address line listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingCityThis should be set to the city listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingCompanyNameThis should be set to the name of the company listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingCountryCodeThis should be set to the country code listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingEmailThis should be set to the email address listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingFaxThis should be set to the fax number listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingPersonNameThis should be set to the name of the person listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingPhoneThis should be set to the phone number listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingStateThis should be set to the state listed on the account associated with the FreightAccountNumber .
ShipmentInfoBillingZipCodeThis should be set to the zip code listed on the account associated with the FreightAccountNumber .
ShipmentInfoClientDiscountPercentThe estimated client discount rate for a freight shipment.
ShipmentInfoCollectTermsTypeThis sets the terms for how to collect payment for this freight shipment.
ShipmentInfoCommentsThe description for this freight shipment.
ShipmentInfoCouponsThis contains a semicolon delimited list of identifiers for promotional discounts offered to customers.
ShipmentInfoDeclaredValueThe total declared value per unit for this freight shipment.
ShipmentInfoDeclaredValueUnitsIdentifies the declared value units corresponding to the above defined declared value.
ShipmentInfoEmergencyContactPhoneThe phone number for the emergency contact.
ShipmentInfoHazardousMaterialsOfferorIf this shipment contains hazardous materials, this should contain the offeror of the hazardous materials.
ShipmentInfoLiabilityCoverageAmountThis should be set to the total value of the liability coverage.
ShipmentInfoLiabilityCoverageTypeThis should be set to the type of liability coverage offered.
ShipmentInfoPalletWeightThis should contain the total weight of all pallets used in this freight shipment.
ShipmentInfoRoleThis indicates the role of the party is submitting the transaction for this freight shipment.
ShipmentInfoTotalHandlingUnitsTotal number of individual handling units in the entire shipment (for unit pricing).
ShipmentInfoTotalLengthThis should be set to the total length of the shipment.
ShipmentInfoTotalWidthThis should be set to the total width of the shipment.
ShipmentInfoTotalHeightThis should be set to the total height of the shipment.
ShipmentSpecialServicesContains the collection of special services offered by FedEx.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
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 class 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 class 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 class 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 retrieve data at any place within the response.
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.
CODReferenceIndicatorThe reference information to be added to the COD return label.
DryIceCountThe number of packages which contain dry ice.
PackageDryIceWeight[i]The weight of the dry ice for each package.
SizeUnitThe dimension unit.
WeightUnitWeight unit.
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.
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.
FreightAccountNumberAccount number used with the FedEx Freight service.
FreightBillingPersonNameThe name of the person to be billed.
FreightBillingCompanyNameThe name of the company to be billed.
FreightBillingPhoneThe phone number of the party to be billed.
FreightBillingFaxThe fax number of the party to be billed.
FreightBillingEmailThe email of the party to be billed.
FreightBillingAddress1The first address line of the party to be billed.
FreightBillingAddress2The second address line of the party to be billed.
FreightBillingCityThe city of the party to be billed.
FreightBillingStateThe state of the party to be billed.
FreightBillingCountryCodeThe country code of the party to be billed.
FreightBillingZipCodeThe zip code of the party to be billed.
FreightAlternateBillingAccountNumberThe alternate account number to be billed.
FreightAlternateBillingPersonNameThe name of the person to be billed.
FreightAlternateBillingCompanyNameThe name of the company to be billed.
FreightAlternateBillingStreetAddressThe street address line of the party to be billed.
FreightAlternateBillingCityThe city of the party to be billed.
FreightAlternateBillingStateThe state of the party to be billed.
FreightAlternateBillingCountryCodeThe country code of the party to be billed.
FreightAlternateBillingZipCodeThe zip code of the party to be billed.
FreightClientDiscountPercentEstimated discount rate provided by client for unsecured rate quote.
FreightCollectTermsTypeThe terms of the collect payment for a Freight Shipment.
FreightCommentDescription for the shipment.
FreightDeclaredValueThe declared value for the shipment.
FreightDeclaredValueUnitsThe declared value units.
FreightHazardousMaterialsOfferorThe offeror of the hazardous materials.
FreightLiabilityCoverageAmountThe total amount of liability coverage.
FreightLiabilityCoverageTypeThe type of liability coverage offered.
FreightPalletWeightTotal weight of pallets used in shipment.
FreightRoleIndicates the role of the party submitting the transaction.
FreightShipmentLengthThe overall length of the shipment.
FreightShipmentWidthThe overall width of the shipment.
FreightShipmentHeightThe overall height of the shipment.
FreightTotalHandlingUnitsThe total handling units for the shipment.
FreightItemCountThe 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.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0