Freight Elements

Table 89. Freight Request Elements
Element   Description
RequestedShipment/ServiceType Required Identifies the FedEx service to use in shipping the package. See ServiceType for list of valid enumerated values. Use one of the following enumerated values:
  • FEDEX_FREIGHT_PRIORITY
  • FEDEX_FREIGHT_ECONOMY
RequestedShipment/ShippingChargesPayment Payment Optional Descriptive data indicating the method and means of payment to FedEx for providing shipping services. Enter the party responsible for the transportation charges: SENDER or RECIPIENT. THIRD-PARTY is not supported for FedEx Freight Priority or FedEx Freight Economy.
RequestedShipment/ShippingChargesPayment Payment/Payor/ResponsibleParty Party/AccountNumber Optional Identifies the FedEx account number assigned to the customer. If the shipment is a Bill Sender transaction, enter the shipper's FedEx 9 digit Enterprise account number or the 8 or 9 digit Freight account number. If the shipment is Bill Recipient and the payor's FedEx account number is known, enter the payor's FedEx account number.
RequestedShipment/SpecialServicesRequested ShipmentSpecialServicesRequested/FreightGuaranteeDetail/Type FreightGuaranteeType Optional The type of guarantee.

Valid values are:

  • GUARANTEED_DATE
  • GUARANTEED_MORNING
Note: The Guaranteed delivery options are available for both the Freight Priority service and the Freight Economy service for an additional charge.
RequestedShipment/SpecialServicesRequested ShipmentSpecialServicesRequested/FreightGuaranteeDetail/Date Optional Date for all Freight guarantee types.
RequestedShipment/FreightShipmentDetail Optional Data applicable to shipments using FedEx LTL Freight services.
RequestedShipment/FreightShipmentDetail/FedExFreightAccountNumber Required Account number used with FEDEX_FREIGHT services. If the shipper is responsible for the transportation charges, enter the SAME account number in the FedExFreightAccountNumber that is entered in the ShippingChargesPayment/Payor/ResponsibleParty/Account number. If the shipper is not responsible for the transportation charges, enter a valid FedEx Freight 8- or 9-digit account number.
RequestedShipment/FreightShipmentDetail/FedExFreightBillingContactAndAddress Required Enter the Billing Address information in FedExFreightBillingContactAndAddress fields for the above FedExFreightAccountNumber. Entries in FedExFreightAccountNumber and FedExFreightBillingContactAndAddress are required for security purposes.
RequestedShipment/FreightShipmentDetail/PrintedReferences Optional Identification values to be printed during creation of a Freight Bill of Lading.
RequestedShipment/FreightShipmentDetail/Role FreightShipmentRoleType Required Indicates the role of the party submitting the transaction. CONSIGNEE is the equivalent of Collect and SHIPPER is the equivalent of Prepaid.

Valid values are:

  • CONSIGNEE
  • SHIPPER
  • THIRD_PARTY
RequestedShipment/FreightShipmentDetail/CollectTermsType FreightCollectTermsType Optional Designates the terms of the “collect” payment for a Freight Shipment.

Valid values are:

  • SECTION_7_SIGNED
  • STANDARD
RequestedShipment/FreightShipmentDetail/DeclaredValuePerUnit Money Optional Identifies the declared value for the shipment.
RequestedShipment/FreightShipmentDetail/DeclaredValueUnits Optional Identifies the declared value units corresponding to the above defined declared value.
RequestedShipment/FreightShipmentDetail/LiabilityCoverageDetail Optional Identifies the Liability Coverage Amount. For January 2011, this value represents coverage amount per pound
RequestedShipment/FreightShipmentDetail/Coupons Optional Identifiers for promotional discounts offered to customers.
RequestedShipment/FreightShipmentDetail/TotalHandlingUnits nonNegativeInteger Required Total number of individual handling units in the entire shipment (for unit pricing).
RequestedShipment/FreightShipmentDetail/ClientDiscountPercent decimal Optional Estimated discount rate provided by client for unsecured rate quote.
RequestedShipment/FreightShipmentDetail/PalletWeight Weight Optional Total weight of pallets used in shipment.
RequestedShipment/FreightShipmentDetail/ShipmentDimensions Dimensions Optional Overall shipment dimensions.
RequestedShipment/FreightShipmentDetail/Comment Optional Description for the shipment.
FreightShipmentDetail/SpecialServicePayments FreightSpecialServicePayment Optional Specifies which party will pay surcharges for any special services which support split billing.
RequestedShipment/FreightShipmentDetail/SpecialServicePayments FreightSpecialServicePayment/SpecialService Optional Identifies the special service.
RequestedShipment/FreightShipmentDetail/SpecialServicePayments FreightSpecialServicePayment/PaymentType Optional Indicates who will pay for the special services.
RequestedShipment/FreightShipmentDetail/HazardousMaterialsEmergencyContactNumber Optional Must be populated if any line items contain hazardous materials.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem Optional Details of the commodities in the shipment.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/FreightClass Required Freight class for this line item.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/HandlingUnits Optional Number of individual handling units to which this line applies.
Note: Total of line-item-level handling units may not balance to shipment-level total handling units.)
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Packaging Required Specification of handling-unit packaging for this commodity or class line.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Pieces Required Number of pieces for this commodity or class line.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/NmfcCode Optional NMFC Code for commodity.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/HazardousMaterials Optional Indicates the kind of hazardous material content in this line item.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/PurchaseOrderNumber Optional For printed reference per line item.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Description Required Customer-provided description for this commodity or class line.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Weight Required Weight for this commodity or class line.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Weight/Units WeightUnits Identifies the unit of measure associated with a weight value. See the list of enumerated types for valid values.

Valid values are:

  • KG
  • LB
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Weight/ValueDecimal Required Identifies the weight value of a package/shipment.
RequestedShipment/FreightShipmentDetail/LineItems FreightShipmentLineItem/Volume Optional Volume (cubic measure) for this commodity or class line.
RequestedShipment/ShippingDocumentSpecification Required Indicates the types of shipping documents produced for the shipper by FedEx
RequestedShipment/ShippingDocumentSpecification/ShippingDocumentTypes Required Indicates the types of shipping documents requested by the shipper
RequestedShipment/ShippingDocumentSpecification/FreightAddressLabelDetail/DocTabContent Optional If omitted, no doc-tab will be produced (i.e. default - former NONE type).
Table 90. Optional Pickup Request Elements
Element   Description
CreatePickupRequest/AssociatedAccountNumber Optional The number associated with the FedEx Account.
CreatePickupRequest/OriginDetail Optional Descriptive data about the origin of the shipment being picked up by FedEx.
CreatePickupRequest/FreightPickupDetail Optional Descriptive data for a freight shipment being picked up by FedEx. This element is only required when requesting a freight service pickup and should not be used for other types of pickups including FedEx Freight pickups
CreatePickupRequest/CarrierCode Optional Identifies the FedEx service that is being sent the package pickup request.
CreatePickupRequest/Remarks Optional Identifies any remarks or comments to be passed to the FedEx courier picking up the shipment.
Table 91. Freight Reply Elements
Element   Description
CompletedShipmentDetail/ShipmentRating/ActualRateType Optional The rate type identifies which entry in the following array is considered ad presenting the "actual" rates for the shipment.
CompletedShipmentDetail/ShipmentRating/EffectiveNetDiscount Optional The "list" total net charges minus "actual" total net charges.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails Optional Each element of this field provides shipment-level rate totals for a specific rate type.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/RateType Optional Type used for this specific set of rate data.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/RateScale Optional Indicates the rate scale used.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/RateZone Optional Indicates the rate zone used (based on origin and destination).
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/PricingCode Optional Identifies the type of pricing used for this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/RatedWeightMethod Optional Indicates which weight was used.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/CurrencyExchangeRate Optional Specifies the currency exchange performed on financial amounts for this rate.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/SpecialRatingApplied Optional Indicates which special rating cases applied to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/DimDivisor Optional The value used to calculate the weight based on the dimensions.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FuelSurchargePercent Optional Specifies a fuel surcharge percentage.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalBillingWeight Optional The weight used to calculate these rates.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalDimWeight Optional Sum of dimensional weights for all packages.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalBaseCharge Optional The total freight charge that was calculated for this package before surcharges, discounts and taxes.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalFreightDiscounts Optional The total discounts used in the rate calculation.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalNetFreight Optional The freight charge minus discounts.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalSurcharges Optional The total amount of all surcharges applied to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalNetFedExCharge Optional This shipment's totalNetFreight + totalSurchages (not including totalTaxes).
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalTaxes Optional Total of the transportation-based taxes.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalNetCharge Optional The net charge after applying all discounts and surcharges.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalRebates Optional The total sum of all rebates applied to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalDutiesAndTaxes Optional Total of all values under this shipment's dutesAndTaxes;only provided if estimated duties and taxes were calculated for this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalNetChargeWithDutiesAndTaxes Optional This shipment's totalNetCharge + totalDutiesAndTaxes; only provided if estimated duties and taxes were calculated for this shipment AND duties, taxes and transportation charges are all paid by the same sender's account.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail Optional Rate data specific to FedEx Freight and FedEx National Freight services.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/QuoteNumber Optional A unique identifier for a specific rate quotation.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseChargeCalculation Optional Specifies how total base charge is determined.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge Optional Individual charge which contributes to the total base charge for the shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/FreightClass FreightClassType Optional Freight class type. These values represent the industry-standard freight classes used for FedEx Freight Priority and FedEx Freight Economy shipment description.
Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms.
Valid values are:
  • CLASS_050
  • CLASS_055
  • CLASS_060
  • CLASS_065
  • CLASS_070
  • CLASS_077_5
  • CLASS_085
  • CLASS_092_5
  • CLASS_100
  • CLASS_110
  • CLASS_125
  • CLASS_150
  • CLASS_175
  • CLASS_200
  • CLASS_250
  • CLASS_300
  • CLASS_400
  • CLASS_500
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/RatedAsClass Optional Effective freight class used for rating this line item.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/NmfcCode Optional NMFC Code for commodity.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/Description Optional Customer-provided description for this commodity or class line.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/Weight Optional Weight for this commodity or class line.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/ChargeRate Optional Rate or factor applied to this line item.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/ChargeBasis Optional Identifies the manner in which the chargeRate for this line item was applied.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/BaseCharges FreightBaseCharge/ExtendedAmount Optional The net or extended charge for this line item.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/Notations Optional Human-readable descriptions of additional information on this shipment rating.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/Notations/Code Optional Unique identifier for notation.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightRateDetail/Notations/Description Optional Human-readable explanation of notation.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/FreightDiscounts Optional All rate discounts that apply to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/Rebates Optional All rebates that apply to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/Surcharges Optional All surcharges that apply to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/Taxes Optional All transportation-based taxes applicable to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/DutiesAndTaxes Optional All commodity-based duties and taxes applicable to this shipment.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/VariableHandlingCharges Optional The "order level" variable handling charges.
CompletedShipmentDetail/ShipmentRating/ShipmentRateDetails ShipmentRateDetail/TotalVariableHandlingCharges Optional The total of all variable handling charges at both shipment (order) and package level.