RequestedShipment Elements

Element Required Description
ShipTimestamp Required Identifies the date and time the package is tendered to FedEx. Both the date and time portions of the string are expected to be used. The date should not be a past date or a date more than 10 days in the future. The time is the local time of the shipment based on the shipper's time zone.

The date format must be YYYY-MM-DDTHH:MM:SS-xx:xx. The time must be in the format: HH:MM:SS using a 24-hour clock. The date and time are separated by the letter T (e.g., 2009-06-26T17:00:00). The UTC offset indicates the number of hours/minutes (e.g. xx:xx) from UTC (e.g 2009-06-26T17:00:00-04:00 is defined as June 26, 2009 5:00 p.m. Eastern Time).

See Time Zones for more information about time zones.

DropoffType Optional Identifies the method by which the package is to be tendered to FedEx. This element does not dispatch a courier for package pickup. See DropoffType for list of valid enumerated values.
ServiceType Required Identifies the FedEx service to use in shipping the package. See ServiceType for list of valid enumerated values.
PackagingType Required Identifies the packaging used by the requestor for the package. See PackagingType for list of valid enumerated values.
TotalWeight Optional Identifies the total weight of the shipment being conveyed to FedEx. This is only applicable to International shipments and should only be used on the first package of a multiple-package shipment.
TotalInsuredValue Optional Total declared value amount. FedEx does not provide insurance of any kind.
PreferredCurrency Optional Indicates the currency the caller requests to have used in all returned monetary values (when a choice is possible).
TotalDimensions Optional The total dimensions of the package.
Shipper Required Descriptive data identifying the party responsible for shipping the package. Shipper and Origin should have the same address.
Recipient Required Descriptive data identifying the party receiving the package.
RecipientLocationNumber Optional A unique identifier for a recipient location.
Origin Optional Identifies the shipment’s physical starting address if different from the shipper.
ShippingChargesPayment Required Descriptive data indicating the method and means of payment to FedEx for providing shipping services.
SpecialServicesRequested Required Descriptive data regarding special services requested by the shipper for this shipment. If the shipper is requesting a special service which requires additional data, such as C.O.D., the special service type must be present in the ShipmentSpecialServicesRequested/ SpecialServiceTypes collection, and the supporting detail must be provided in the appropriate sub-object. For example, to request C.O.D., "COD" must be included in the SpecialServiceTypes collection and the CodDetail object must contain the required data.
ExpressFreightDetail Optional Details specific to a FedEx Freight® shipment.
FreightShipmentDetail Optional Details applicable to shipments using FEDEX_FREIGHT and FEDEX_NATIONAL_FREIGHT services.
FreightShipmentDetail Optional Data applicable to shipments using FEDEX_FREIGHT PRIORITY and FEDEX_FREIGHT ECONOMY services.
DeliveryInstructions Optional Used with FedEx Home Delivery® and FedEx Freight.
VariableHandlingChargeDetail Optional Details about how to calculate variable handling charges at the shipment level.
CustomsClearanceDetail Optional Information about this package that only applies to an international (export) shipment.
PickupDetail Optional For use in “process tag” transaction.
SmartPostDetail Optional Details specific to FedEx SmartPost shipments.
BlockInsightVisibility Optional If true, only the shipper/payor will have visibility of this shipment.
ErrorLabelBehavior Optional Specifies the client-requested response in the event of errors within shipment.
LabelSpecification Required Details about the image format and printer type for the returned label.
ShippingDocumentSpecification Optional Details such as the label, shipping document types, NAFTA information, CI information, and GAA information.
RateRequestTypes Optional Indicates the type of rates to be returned.
CustomerSelectedActualRateType Optional Specifies the type of rate the customer wishes to have used as the actual rate type.
EdtRequestType Optional Specifies whether the customer wishes to have Estimated Duties and Taxes provided with the rate quotation on this shipment. Only applies with shipments moving under international services.
MasterTrackingId Optional Used when requesting child pieces in a multiple-package shipment (MPS). The master tracking information will be returned in reply from the first package requested for a multiple-package shipment. That master tracking information is then inserted into the requests for each additional package requested for that multiple-package shipment.
MasterTrackingId/TrackingIdType Package Valid values are:
  • EXPRESS
  • FREIGHT
  • GROUND
  • USPS
  • FEDEX
CodReturnTrackingId Optional Only used with C.O.D. MPS sent in multiple transactions. Required on last transaction only.
PackageCount Required For an MPS, this is the total number of packages in the shipment.
ShipmentOnlyFields Optional Specifies which package-level data values are provided at the shipment-level only. The package-level data values types specified here will not be provided at the package-level.
RequestedPackageLineItems Optional One or more package-attribute descriptions, each of which describes an individual package, a group of identical packages, or (for the total-piece-total-weight case) common characteristics of packages in the shipment.