Specifies additional labels to be produced. All required labels for shipments will
be produced without the need to request additional labels. These are only available as thermal
labels.
The type of additional labels to return.The number of this type label to returnIdentifies the type of additional labels.Descriptive data for a physical location. May be used as an actual physical
address (place to which one could go), or as a container of "address parts" which should be
handled as a unit (such as a city-state-ZIP combination within the US).
Combination of number, street name, etc. At least one line is required for
a valid physical address; empty lines should not be included.
Name of city, town, etc.Identifying abbreviation for US state, Canada province, etc. Format and
presence of this field will vary, depending on country.
Identification of a region (usually small) for mail/package delivery.
Format and presence of this field will vary, depending on country.
Relevant only to addresses in Puerto Rico.The two-letter code used to identify a country.The fully spelt out name of a country.Indicates whether this address residential (as opposed to commercial).
Specifies which filing option is being exercised by the customer.
Required for non-document shipments originating in Canada destined for any country other than
Canada, the United States, Puerto Rico or the U.S. Virgin Islands.
Identification of the type of barcode (symbology) used on FedEx documents and
labels.
Identification of a FedEx operating company (transportation).The instructions indicating how to print the Certificate of Origin ( e.g. whether
or not to include the instructions, image type, etc ...)
Specifies characteristics of a shipping document to be produced.
Specifies the usage and identification of customer supplied images to be
used on this document.
Specifies the type of brokerage to be applied to a shipment.Descriptive data for the client submitting a transaction.The FedEx account number associated with this transaction.
This number is assigned by FedEx and identifies the unique device from
which the request is originating
Only used in transactions which require identification of the Fed Ex
Office integrator.
Indicates the region from which the transaction is submitted.
The language to be used for human-readable Notification.localizedMessages
in responses to the request containing this ClientDetail object. Different requests from
the same client may contain different Localization data. (Contrast with
TransactionDetail.localization, which governs data payload language/translation.)
Select the type of rate from which the element is to be selected.
Identifies the type of funds FedEx should collect upon shipment delivery.
Descriptive data required for a FedEx COD (Collect-On-Delivery) shipment.
Specifies the details of the charges are to be added to the COD collect
amount.
Identifies the type of funds FedEx should collect upon package delivery
For Express this is the descriptive data that is used for the recipient of
the FedEx Letter containing the COD payment. For Ground this is the descriptive data for
the party to receive the payment that prints the COD receipt.
When the FedEx COD payment type is not CASH, indicates the contact and
address of the financial institution used to service the payment of the COD.
Specifies the name of person or company receiving the secured/unsecured
funds payment
Indicates which type of reference information to include on the COD return
shipping label.
Only used with multi-piece COD shipments sent in multiple transactions.
Required on last transaction only.
Indicates which type of reference information to include on the COD return
shipping label.
CommercialInvoice element is required for electronic upload of CI data. It will
serve to create/transmit an Electronic Commercial Invoice through the FedEx Systems. Customers
are responsible for printing their own Commercial Invoice.If you would likeFedEx to generate a
Commercial Invoice and transmit it to Customs. for clearance purposes, you need to specify that
in the ShippingDocumentSpecification element. If you would like a copy of the Commercial Invoice
that FedEx generated returned to you in reply it needs to be specified in the
ETDDetail/RequestedDocumentCopies element. Commercial Invoice support consists of maximum of 99
commodity line items.
Any comments that need to be communicated about this shipment.
Any freight charges that are associated with this shipment.
Any taxes or miscellaneous charges(other than Freight charges or Insurance
charges) that are associated with this shipment.
Specifies which kind of charge is being recorded in the preceding field.
Any packing costs that are associated with this shipment.
Any handling costs that are associated with this shipment.
Free-form text.Free-form text.Free-form text.The reason for the shipment. Note: SOLD is not a valid purpose for a
Proforma Invoice.
Name of the International Expert that completed the Commercial Invoice
different from Sender.
Required for dutiable international Express or Ground shipment. This field
is not applicable to an international PIB(document) or a non-document which does not
require a Commercial Invoice
The instructions indicating how to print the Commercial Invoice( e.g. image type)
Specifies characteristics of a shipping document to be produced.
Specifies the usage and identification of a customer supplied image to be
used on this document.
Information about the transit time and delivery commitment date and time.
The Commodity applicable to this commitment.The FedEx service type applicable to this commitment.Shows the specific combination of service options combined with the
service type that produced this committment in the set returned to the caller.
Supporting detail for applied options identified in preceding field.
THe delivery commitment date/time. Express Only.The delivery commitment day of the week.The number of transit days; applies to Ground and LTL Freight; indicates
minimum transit time for SmartPost.
Maximum number of transit days, for SmartPost shipments.
The service area code for the destination of this shipment. Express
only.
The address of the broker to be used for this shipment.The FedEx location identifier for the broker.The delivery commitment date/time the shipment will arrive at the
border.
The delivery commitment day of the week the shipment will arrive at the
border.
The number of days it will take for the shipment to make it from broker to
destination
The delivery commitment date for shipment served by GSP (Global Service
Provider)
The delivery commitment day of the week for the shipment served by GSP
(Global Service Provider)
Messages concerning the ability to provide an accurate delivery commitment
on an International commit quote. These could be messages providing information about
why a commitment could not be returned or a successful message such as "REQUEST
COMPLETED"
Messages concerning the delivery commitment on an International commit
quote such as "0:00 A.M. IF NO CUSTOMS DELAY"
Information about why a shipment delivery is delayed and at what level
(country/service etc.).
Required documentation for this shipment.Freight origin and destination city center information and total distance
between origin and destination city centers.
The type of delay this shipment will encounter.
For international multiple piece shipments, commodity information must be passed in the Master
and on each child transaction.
If this shipment cotains more than four commodities line items, the four highest valued should
be included in the first 4 occurances for this request.
This field is used for enterprise transactions.Contains only additional quantitative information other than weight and
quantity to calculate duties and taxes.
Defines additional characteristic of commodity used to calculate duties
and taxes
All data required for this commodity in NAFTA Certificate of Origin.
Defines additional data to print in the Configurable portion of the label, this
allows you to print the same type information on the label that can also be printed on the doc
tab.
The descriptive data for a point-of-contact person.Client provided identifier corresponding to this contact information.
Identifies the contact person's name.Identifies the contact person's title.Identifies the company this contact is associated with.Identifies the phone number associated with this contact.
Identifies the phone extension associated with this contact.
Identifies a toll free number, if any, associated with this contact.
Identifies the pager number associated with this contact.
Identifies the fax number associated with this contact.Identifies the email address associated with this contact.
Specifies the currency exchange performed on financial amounts for this rate.
The currency code for the original (converted FROM) currency.
The currency code for the final (converted INTO) currency.
Multiplier used to convert fromCurrency units to intoCurrency units.
Indicates the type of custom delivery being requested.Time by which delivery is requested.Range of dates for custom delivery request; only used if type is
BETWEEN.
Date for custom delivery request; only used for types of ON, BETWEEN, or
AFTER.
Data required to produce a custom-specified document, either at shipment or
package level.
Common information controlling document production.Applicable only to documents produced on thermal printers with roll
stock.
Applicable only to documents produced on thermal printers with roll
stock.
Identifies the formatting specification used to construct this custom
document.
Constructed string, based on format and zero or more data fields, printed in
specified barcode symbology.
Width of thinnest bar/space element in the barcode.Solid (filled) rectangular area on label.Image to be included from printer's memory, or from a local file for offline
clients.
Printer-specific index of graphic image to be printed.Fully-qualified path and file name for graphic image to be printed.
Horizontal position, relative to left edge of custom area.
Vertical position, relative to top edge of custom area.Constructed string, based on format and zero or more data fields, printed in
specified printer font (for thermal labels) or generic font/size (for plain paper labels).
Printer-specific font name for use with thermal printer labels.
Generic font name for use with plain paper labels.Generic font size for use with plain paper labels.Reference information to be associated with this package.Allows customer-specified control of label content.If omitted, no doc tab will be produced (i.e. default is former NONE
type).
Controls which data/sections will be suppressed.For customers producing their own Ground labels, this field specifies
which secondary barcode will be printed on the label; so that the primary barcode
produced by FedEx has the correct SCNC.
Controls the number of additional copies of supplemental labels.
This value reduces the default quantity of destination/consignee air
waybill labels. A value of zero indicates no change to default. A minimum of one copy
will always be produced.
Interacts both with properties of the shipment and contractual
relationship with the shipper.
Specifies how the recipient is identified for customs purposes; the
requirements on this information vary with destination country.
Identifies responsibilities with respect to loss, damage, etc.
Documents amount paid to third party for coverage of shipment content.
For international multiple piece shipments, commodity information must be passed in the
Master and on each child transaction.
If this shipment cotains more than four commodities line items, the four highest valued
should be included in the first 4 occurances for this request.
Specifies additional description about customs options. This is a required
field when the customs options type is "OTHER".
Identifies whether or not the products being shipped are required to be accessible
during delivery.
Describes an approved container used to package dangerous goods commodities. This
does not describe any individual inner receptacles that may be within this container.
Indicates whether there are additional inner receptacles within this
container.
Indicates the type of this dangerous goods container, as specified by the
IATA packing instructions. For example, steel cylinder, fiberboard box, plastic jerrican
and steel drum.
Indicates the packaging type of the container used to package the
radioactive materials.
Indicates the number of occurrences of this container with identical
dangerous goods configuration.
Documents the kinds and quantities of all hazardous commodities in the
current container.
The descriptive data required for a FedEx shipment containing dangerous goods
(hazardous materials).
Shipment is packaged/documented for movement ONLY on cargo aircraft.
Indicates which kinds of hazardous content are in the current package.
Indicates whether there is additional customer provided packaging
enclosing the approved dangerous goods containers.
Identifies the configuration of this dangerous goods package. The common
configuration is represented at the shipment level.
Indicates one or more containers used to pack dangerous goods
commodities.
Description of the packaging of this commodity, suitable for use on OP-900
and OP-950 forms.
Name, title and place of the signatory for this shipment.
Telephone number to use for contact in the event of an emergency.
Offeror's name or contract number, per DOT regulation.Specifies the contact of the party responsible for handling the infectious
substances, if any, in the dangerous goods shipment.
Specifies additional handling information for the current package.
Specifies the radioactivity detail for the current package, if the package
contains radioactive materials.
The instructions indicating how to print the 1421c form for dangerous goods
shipment.
Specifies characteristics of a shipping document to be produced.
Specifies the usage and identification of customer supplied images to be
used on this document.
Specifies that name, title and place of the signatory responsible for the
dangerous goods shipment.
Indicates the place where the form is signed.Information about why a shipment delivery is delayed and at what level(
country/service etc.).
The date of the delayThe attribute of the shipment that caused the delay(e.g. Country, City,
LocationId, Zip, service area, special handling )
The point where the delay is occurring (e.g. Origin, Destination, Broker
location)
The reason for the delay (e.g. holiday, weekend, etc.).The name of the holiday in that country that is causing the delay.
The attribute of the shipment that caused the delay(e.g. Country, City,
LocationId, Zip, service area, special handling )
The point where the delay is occurring ( e.g. Origin, Destination, Broker
location).
Specifies the tracking id for the return, if preassigned.
Data required to complete the Destionation Control Statement for US exports.
Comma-separated list of up to four country codes, required for
DEPARTMENT_OF_STATE statement.
Name of end user, required for DEPARTMENT_OF_STATE statement.
Used to indicate whether the Destination Control Statement is of type Department
of Commerce, Department of State or both.
The dimensions of this package and the unit type used for the measurements.
Driving or other transportation distances, distinct from dimension measurements.
Identifies the distance quantity.Identifies the unit of measure for the distance value.Identifies the method by which the package is to be tendered to FedEx. This
element does not dispatch a courier for package pickup.
Specific information about the delivery of the email and options for the
shipment.
Email address to send the URL to.Information describing email notifications that will be sent in relation to events
that occur during package movement
A message that will be included in the email notifications
Information describing the destination of the email, format of the email
and events to be notified on
The format of the emailThe descriptive data for a FedEx email notification recipient.Identifies the relationship this email recipient has to the shipment.
The email address to send the notification toThe types of email notifications being requested for this recipient.
The format of the email notification.The language/locale to be used in this email notification.
Identifies the set of valid email notification recipient types. For SHIPPER,
RECIPIENT and BROKER the email address asssociated with their definitions will be used, any
email address sent with the email notification for these three email notification recipient
types will be ignored.
Customer-declared value, with data type and legal values depending on
excise condition, used in defining the taxable value of the item.
Specifies the types of Estimated Duties and Taxes to be included in a rate
quotation for an international shipment.
Electronic Trade document references used with the ETD special service.
Indicates the types of shipping documents produced for the shipper by
FedEx (see ShippingDocumentSpecification) which should be copied back to the shipper in
the shipment result data.
Country specific details of an International shipment.General field for exporting-country-specific export data (e.g. B13A for
CA, FTSR Exemption or AES Citation for US).
Details specific to an Express freight shipment.Currently not supported. Delivery contact information for an Express freight
shipment.
Indicates a FedEx Express operating region.Identifies a kind of FedEx facility.Specifies the optional features/characteristics requested for a Freight shipment
utilizing a flatbed trailer.
Individual charge which contributes to the total base charge for the shipment.
Freight class for this line item.Effective freight class used for rating this line item.NMFC Code for commodity.Customer-provided description for this commodity or class line.
Weight for this commodity or class line.Rate or factor applied to this line item.Identifies the manner in which the chargeRate for this line item was
applied.
The net or extended charge for this line item.Specifies the way in which base charges for a Freight shipment or shipment leg are
calculated.
These values represent the industry-standard freight classes used for FedEx
Freight and FedEx National Freight shipment description. (Note: The alphabetic prefixes are
required to distinguish these values from decimal numbers on some client platforms.)
Information about the Freight Service Centers associated with this shipment.
Information about the origin Freight Service Center.Information about the destination Freight Service Center.
The distance between the origin and destination FreightService Centers
Date for all Freight guarantee types.Identifies responsibilities with respect to loss, damage, etc.Rate data specific to FedEx Freight or FedEx National Freight services.
A unique identifier for a specific rate quotation.Specifies whether the rate quote was automated or manual.
Specifies how total base charge is determined.Freight charges which accumulate to the total base charge for the
shipment.
Human-readable descriptions of additional information on this shipment
rating.
Additional non-monetary data returned with Freight rates.Unique identifier for notation.Human-readable explanation of notation.Specifies the type of rate quoteThis class describes the relationship between a customer-specified address and the
FedEx Freight / FedEx National Freight Service Center that supports that address.
Freight Industry standard non-FedEx carrier identification
The name of the Interline carrier.Additional time it might take at the origin or destination to pickup or
deliver the freight. This is usually due to the remoteness of the location. This time is
included in the total transit time.
Service branding which may be used for local pickup or delivery, distinct
from service used for line-haul of customer's shipment.
Distance between customer address (pickup or delivery) and the supporting
Freight / National Freight service center.
Time to travel between customer address (pickup or delivery) and the
supporting Freight / National Freight service center.
Specifies when/how the customer can arrange for pickup or delivery.
Specifies days of operation if localServiceScheduling is LIMITED.
Freight service center that is a gateway on the border of Canada or
Mexico.
Alphabetical code identifying a Freight Service CenterFreight service center Contact and AddressSpecifies the type of service scheduling offered from a Freight or National
Freight Service Center to a customer-supplied address.
Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and
FEDEX_FREIGHT_PRIORITY services.
Account number used with FEDEX_FREIGHT service.Used for validating FedEx Freight account number and (optionally)
identifying third party payment on the bill of lading.
Used in connection with "Send Bill To" (SBT) identification of customer's
account used for billing.
Indicates the role of the party submitting the transaction.
Designates the terms of the "collect" payment for a Freight Shipment.
Identifies the declared value for the shipmentIdentifies the declared value units corresponding to the above defined
declared value
Identifiers for promotional discounts offered to customers.
Total number of individual handling units in the entire shipment (for unit
pricing).
Estimated discount rate provided by client for unsecured rate quote.
Total weight of pallets used in shipment.Overall shipment dimensions.Description for the shipment.Specifies which party will pay surcharges for any special services which
support split billing.
Details of the commodities in the shipment.Description of an individual commodity or class of content in a shipment.
Freight class for this line item.Specification of handling-unit packaging for this commodity or class
line.
Customer-provided description for this commodity or class line.
Weight for this commodity or class line.Volume (cubic measure) for this commodity or class line.
Indicates the role of the party submitting the transaction.Specifies which party will be responsible for payment of any surcharges for
Freight special services for which split billing is allowed.
Identifies the special service.Indicates who will pay for the special service.Data required to produce a General Agency Agreement document. Remaining content
(business data) to be defined once requirements have been completed.
Documents the kind and quantity of an individual hazardous commodity in a
package.
Identifies and describes an individual hazardous commodity.
Specifies the amount of the commodity in alternate units.
Customer-provided specifications for handling individual commodities.
Specifies the details of any radio active materials within the
commodity.
Identifies and describes an individual hazardous commodity.Regulatory identifier for a commodity (e.g. "UN ID" value).
In conjunction with the regulatory identifier, this field uniquely
identifies a specific hazardous materials commodity.
Indicates any special processing options to be applied to the description
of the dangerous goods commodity.
Information related to quantity limitations and operator or state
variations as may be applicable to the dangerous goods commodity.
Specifies any special processing to be applied to the dangerous goods commodity
description validation.
Specifies how the commodity is to be labeled.Customer-provided specifications for handling individual commodities.
Specifies how the customer wishes the label text to be handled for this
commodity in this package.
Text used in labeling the commodity under control of the labelTextOption
field.
Indicates which kind of hazardous content (as defined by DOT) is being reported.
Identifies number and type of packaging units for hazardous commodities.
Number of units of the type below.Units in which the hazardous commodity is packaged.Specifies documentation and limits for validation of an individual packing
group/category.
Coded specification for how commodity is to be packed.Identifies DOT packing group for a hazardous commodity.Identifies amount and units for quantity of hazardous commodities.
Number of units of the type below.Units by which the hazardous commodity is measured. For IATA commodity,
the units values are restricted based on regulation type.
Specifies which measure of quantity is to be validated.Specifies the measure of quantity to be validated against a prescribed limit.
Descriptive data required for a FedEx shipment that is to be held at the
destination FedEx location for pickup by the recipient.
Contact phone number for recipient of shipment.Contact and address of FedEx facility at which shipment is to be held.
Type of facility at which package/shipment is to be held.
Location identification (for facilities identified by an alphanumeric
location code).
Location identification (for facilities identified by an numeric location
code).
The descriptive data required by FedEx for home delivery services.
The type of International shipment.Specifies the type of label to be returned.Names for data elements / areas which may be suppressed from printing on labels.
This indicates if the top or bottom of the label comes out of the printer first.
Relative to normal orientation for the printer.Description of shipping label to be returned in the replyFor thermal printer labels this indicates the size of the label and the location
of the doc tab if present.
Identifies the Liability Coverage Amount. For Jan 2010 this value
represents coverage amount per pound
Represents a one-dimensional measurement in small units (e.g. suitable for
measuring a package or document), contrasted with Distance, which represents a large
one-dimensional measurement (e.g. distance between cities).
The numerical quantity of this measurement.The units for this measurement.CM = centimeters, IN = inchesIdentifies the representation of human-readable text.Two-letter code for language (e.g. EN, FR, etc.)Two-letter code for the region (e.g. us, ca, etc..).Internal FedEx use only.Data required to produce a Certificate of Origin document. Remaining content
(business data) to be defined once requirements have been completed.
Indicates which Party (if any) from the shipment is to be used as the
source of importer data on the NAFTA COO form.
Contact information for "Authorized Signature" area of form.
Defined by NAFTA regulations.Defined by NAFTA regulations.Identification of which producer is associated with this commodity (if
multiple producers are used in a single shipment).
Date range over which RVC net cost was calculated.
Net cost method used.
See instructions for NAFTA Certificate of Origin for code definitions.
See instructions for NAFTA Certificate of Origin for code definitions.
The descriptive data regarding the result of the submitted transaction.
The severity of this notification. This can indicate success or failure or
some other information about the request. The values that can be returned are SUCCESS -
Your transaction succeeded with no other applicable information. NOTE - Additional
information that may be of interest to you about your transaction. WARNING - Additional
information that you need to know about your transaction that you may need to take
action on. ERROR - Information about an error that occurred while processing your
transaction. FAILURE - FedEx was unable to process your transaction at this time due to
a system failure. Please try again later
Indicates the source of this notification. Combined with the Code it
uniquely identifies this notification
A code that represents this notification. Combined with the Source it
uniquely identifies this notification.
Human-readable text that explains this notification.The translated message. The language and locale specified in the
ClientDetail. Localization are used to determine the representation. Currently only
supported in a TrackReply.
A collection of name/value pairs that provide specific data to help the
client determine the nature of an error (or warning, etc.) witout having to parse the
message string.
Identifies the type of data contained in Value (e.g. SERVICE_TYPE,
PACKAGE_SEQUENCE, etc..).
The value of the parameter (e.g. PRIORITY_OVERNIGHT, 2, etc..).
Identifies the set of severity values for a Notification.The instructions indicating how to print the OP-900 form for hazardous materials
packages.
Specifies characteristics of a shipping document to be produced.
Identifies which reference type (from the package's customer references)
is to be used as the source for the reference on this OP-900.
Specifies the usage and identification of customer supplied images to be
used on this document.
Data field to be used when a name is to be printed in the document instead
of (or in addition to) a signature image.
The Oversize classification for a package.Data for a package's rates, as calculated per a specific rate type.
Type used for this specific set of rate data.Indicates which weight was used.INTERNAL FEDEX USE ONLY.The dimensional weight of this package (if greater than actual).
The oversize weight of this package (if the package is oversize).
The transportation charge only (prior to any discounts applied) for this
package.
The sum of all discounts on this package.This package's baseCharge - totalFreightDiscounts.The sum of all surcharges on this package.This package's netFreight + totalSurcharges (not including totalTaxes).
The sum of all taxes on this package.This package's netFreight + totalSurcharges + totalTaxes.
All rate discounts that apply to this package.All rebates that apply to this package.All surcharges that apply to this package (either because of
characteristics of the package itself, or because it is carrying per-shipment surcharges
for the shipment of which it is a part).
All taxes applicable (or distributed to) this package.Identifies the collection of special services offered by FedEx.These special services are available at the package level for some or all service
types. If the shipper is requesting a special service which requires additional data, the
package special service type must be present in the specialServiceTypes collection, and the
supporting detail must be provided in the appropriate sub-object below.
The types of all special services requested for the enclosing shipment or
package.
For use with FedEx Ground services only; COD must be present in shipment's
special services.
Identifies the packaging used by the requestor for the package. See PackagingType
for list of valid enumerated values.
The descriptive data for a person or company entitiy doing business with FedEx.
The descriptive data for the monetary compensation given to FedEx for services
rendered to the customer.
Identifies the method of payment for a service.Descriptive data identifying the party responsible for payment for a service.
This information describes the kind of pending shipment being requested.
Date after which the pending shipment will no longer be available for
completion.
Only used with type of EMAIL.This enumeration rationalizes the former FedEx Express international
"admissibility package" types (based on ANSI X.12) and the FedEx Freight packaging types. The
values represented are those common to both carriers.
This class describes the pickup characteristics of a shipment (e.g. for use in a
tag request).
Currently not supported.Indicates the packaging type of the container used to package radioactive
hazardous materials.
Indicates whether packaging type "EXCEPTED" or "EXCEPTED_PACKAGE" is for
radioactive material in reportable quantity.
Indicates the reason that a dim divisor value was chose.Identifies a discount applied to the shipment.Identifies the type of discount applied to the shipment.Selects the value from a set of rate data to which the percentage is applied.
The response to a RateRequest. The Notifications indicate whether the request was
successful or not.
This indicates the highest level of severity of all the notifications
returned in this reply.
The descriptive data regarding the results of the submitted transaction.
Contains the CustomerTransactionId that was sent in the request.
The version of this reply.Each element contains all rate data for a single service. If service was
specified in the request, there will be a single entry in this array; if service was
omitted in the request, there will be a separate entry in this array for each service
being compared.
Shows the specific combination of service options combined with the
service type that produced this committment in the set returned to the caller.
Supporting detail for applied options identified in preceding field.
Not populated by FAST service in Jan07.Not populated by FAST service in Jan07.Not populated by FAST service in Jan07.Maximum expected transit timeNot populated by FAST service in Jan07. Actual signature option applied,
to allow for cases in wihch the original value conflicted with other service features in
the shipment.
Each element contains all rate data for a single rate type.
Descriptive data sent to FedEx by a customer in order to rate a
package/shipment.
Descriptive data to be used in authentication of the sender's identity
(and right to use FedEx web services).
Descriptive data identifying the client submitting the transaction.
Identifies the version/level of a service operation expected by a caller
(in each request) and performed by the callee (in each reply).
Allows the caller to specify that the transit time and commit data are to
be returned in the reply.
Candidate carriers for rate-shopping use case. This field is only
considered if requestedShipment/serviceType is omitted.
Contains zero or more service options whose combinations are to be
considered when replying with available services.
The shipment for which a rate quote (or rate-shopping comparison) is
desired.
Indicates the type of rates to be returned.Select the type of rate from which the element is to be selected.
If requesting rates using the PackageDetails element (one package at a time) in
the request, the rates for each package will be returned in this element. Currently total piece
total weight rates are also retuned in this element.
Echoed from the corresponding package in the rate request (if provided).
Used with request containing PACKAGE_GROUPS, to identify which group of
identical packages was used to produce a reply item.
The difference between "list" and "account" net charge.Ground COD is shipment level.Rate data that are tied to a specific package and rate type combination.
This class groups the shipment and package rating data for a specific rate type
for use in a rating reply, which groups result data by rate type.
The difference between "list" and "account" total net charge.
Express COD is shipment level.The shipment-level totals for this rate type.The package-level data for this rate type.The method used to calculate the weight to be used in rating the package..
Identifies a discount applied to the shipment.Identifies the type of discount applied to the shipment.Specifies how the recipient is identified for customs purposes; the requirements
on this information vary with destination country.
Specifies the kind of identification being used.Contains the actual ID value, of the type specified above.
Type of Brazilian taxpayer identifier provided in
Recipient/TaxPayerIdentification/Number. For shipments bound for Brazil this overrides the value
in Recipient/TaxPayerIdentification/TinType
FOOD_OR_PERISHABLE is required by FDA/BTA; must be true for food/perishable items
coming to US or PR from non-US/non-PR origin
This class rationalizes RequestedPackage and RequestedPackageSummary from previous
interfaces.
Used only with INDIVIDUAL_PACKAGE, as a unique identifier of each
requested package.
Used only with PACKAGE_GROUPS, as a unique identifier of each group of
identical packages.
Used only with PACKAGE_GROUPS, as a count of packages within a group of
identical packages.
Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for
PACKAGE_SUMMARY, in which case totalInsuredValue and packageCount on the shipment will
be used to determine this value.
Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS. Ignored for
PACKAGE_SUMMARY, in which case total weight and packageCount on the shipment will be
used to determine this value.
Provides additional detail on how the customer has physically packaged
this item. As of June 2009, required for packages moving under international and
SmartPost services.
Human-readable text describing the package.Only used for INDIVIDUAL_PACKAGES and PACKAGE_GROUPS.The descriptive data for the shipment being tendered to FedEx.This attribute indicates the currency the caller requests to have used in
all returned monetary values (when a choice is possible).
Descriptive data identifying the party responsible for shipping the
package. Shipper and Origin should have the same address.
Descriptive data identifying the party receiving the package.
Physical starting address for the shipment, if different from shipper's
address.
Data applicable to shipments using FEDEX_FREIGHT_ECONOMY and
FEDEX_FREIGHT_PRIORITY services.
Used with Ground Home Delivery and Freight.Customs clearance data, used for both international and intra-country
shipping.
For use in "process tag" transaction.Specifies the characteristics of a shipment pertaining to SmartPost
services.
If true, only the shipper/payor will have visibility of this shipment.
Contains data used to create additional (non-label) shipping documents.
Specifies whether and what kind of rates the customer wishes to have
quoted on this shipment. The reply will also be constrained by other data on the
shipment and customer.
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.
The total number of packages in the entire shipment (even when the
shipment spans multiple transactions.)
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.
Specifies data structures that may be re-used multiple times with s single
shipment.
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 all packages in the shipment.
Specifies the tracking number of the master associated with the return
shipment.
These values are used to control the availability of certain special services at
the time when a customer uses the e-mail label link to create a return shipment.
Identifies the allowed (merchant-authorized) special services which may be
selected when the subsequent shipment is created. Only services represented in
EMailLabelAllowedSpecialServiceType will be controlled by this list.
The instructions indicating how to print the return instructions( e.g. image type)
Specifies characteristics of a shipping document to be produced.
Specifies additional customer provided text to be inserted into the return
document.
Information relating to a return shipment.The type of return shipment that is being requested. At present the only
type of retrun shipment that is supported is PRINT_RETURN_LABEL. With this option you
can print a return label to insert into the box of an outbound shipment. This option can
not be used to print an outbound label.
The type of return shipment that is being requested.The "PAYOR..." rates are expressed in the currency identified in the payor's rate
table(s). The "RATED..." rates are expressed in the currency of the origin country. Former
"...COUNTER..." values have become "...RETAIL..." values, except for PAYOR_COUNTER and
RATED_COUNTER, which have been removed.
June 2011 ITG 121203 IR-RMA number has been removed from this structure and added
as a new customer reference type. The structure remains because of the reason field below.
These values control the optional features of service that may be combined in a
commitment/rate comparision transaction.
Supporting detail for applied options identified in a rate quote.
Identifies the type of Freight Guarantee applied, if FREIGHT_GUARANTEE is
applied to the rate quote.
Identifies the smartPostHubId used during rate quote, if SMART_POST_HUB_ID
is a variable option on the rate request.
Identifies the indicia used during rate quote, if
SMART_POST_ALLOWED_INDICIA is a variable option on the rate request.
Identifies the FedEx service to use in shipping the package. See ServiceType for
list of valid enumerated values.
Specifies data structures that may be re-used multiple times with s single
shipment.
Specifies the data that is common to dangerous goods packages in the
shipment. This is populated when the shipment contains packages with identical dangerous
goods commodities.
Shipment-level totals of dry ice data across all packages.Total number of packages in the shipment that contain dry ice.
Total shipment dry ice weight for all packages.Data for a single leg of a shipment's total/summary rates, as calculated per a
specific rate type.
Human-readable text describing the shipment leg.Origin for this leg.Specifies the location id the origin of shipment leg.Destination for this leg.Specifies the location id the destination of shipment leg.
Type used for this specific set of rate data.Indicates the rate scale used.Indicates the rate zone used (based on origin and destination).
Indicates which weight was used.INTERNAL FEDEX USE ONLY.Specifies the currency exchange performed on financial amounts for this
rate.
Indicates which special rating cases applied to this shipment.
Identifies the type of dim divisor that was applied.Sum of dimensional weights for all packages.This shipment's totalNetFreight + totalSurcharges (not including
totalTaxes).
Total of the transportation-based taxes.Total of all values under this shipment's dutiesAndTaxes; only provided if
estimated duties and taxes were calculated for this shipment.
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.
Rate data specific to FedEx Freight and FedEx National Freight services.
All rate discounts that apply to this shipment.All rebates that apply to this shipment.All surcharges that apply to this shipment.All transportation-based taxes applicable to this shipment.
All commodity-based duties and taxes applicable to this shipment.
The "order level" variable handling charges.The total of all variable handling charges at both shipment (order) and
package level.
These values identify which package-level data values will be provided at the
shipment-level.
Data for a shipment's total/summary rates, as calculated per a specific rate type.
The "total..." fields may differ from the sum of corresponding package data for Multiweight or
Express MPS.
Type used for this specific set of rate data.Indicates the rate scale used.Indicates the rate zone used (based on origin and destination).
Indicates which weight was used.INTERNAL FEDEX USE ONLY.Specifies the currency exchange performed on financial amounts for this
rate.
Indicates which special rating cases applied to this shipment.
Identifies the type of dim divisor that was applied.Sum of dimensional weights for all packages.This shipment's totalNetFreight + totalSurcharges (not including
totalTaxes).
Total of the transportation-based taxes.Total of all values under this shipment's dutiesAndTaxes; only provided if
estimated duties and taxes were calculated for this shipment.
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.
Identifies the Rate Details per each leg in a Freight Shipment
Rate data specific to FedEx Freight and FedEx National Freight services.
All rate discounts that apply to this shipment.All rebates that apply to this shipment.All surcharges that apply to this shipment.All transportation-based taxes applicable to this shipment.
All commodity-based duties and taxes applicable to this shipment.
The "order level" variable handling charges.The total of all variable handling charges at both shipment (order) and
package level.
Identifies the collection of special service offered by FedEx.These special services are available at the shipment level for some or all service
types. If the shipper is requesting a special service which requires additional data (such as
the COD amount), the shipment special service type must be present in the specialServiceTypes
collection, and the supporting detail must be provided in the appropriate sub-object below.
The types of all special services requested for the enclosing shipment (or
other shipment-level transaction).
This field should be populated for pending shipments (e.g. e-mail label)
It is required by a PENDING_SHIPMENT special service type.
Electronic Trade document references.Specification for date or range of dates on which delivery is to be
attempted.
Each occurrence of this class specifies a particular way in which a kind of
shipping document is to be produced and provided.
Values in this field specify how to create and return the document.
Specifies how to organize all documents of this type.Specifies how to e-mail document images.Specifies how a queued document is to be printed.Specifies how to return a shipping document to the caller.Specifies how to e-mail shipping documents.Provides the roles and email addresses for e-mail recipients.
Identifies the convention by which documents are to be grouped as e-mail
attachments.
Specifies an individual recipient of e-mailed shipping document(s).
Identifies the relationship of this recipient in the shipment.
Address to which the document is to be sent.Specifies characteristics of a shipping document to be produced.
Specifies how to create, organize, and return the document.
Specifies how far down the page to move the beginning of the image; allows
for printing on letterhead and other pre-printed stock.
For those shipping document types which have both a "form" and
"instructions" component (e.g. NAFTA Certificate of Origin and General Agency
Agreement), this field indicates whether to provide the instructions.
Governs the language to be used for this individual document,
independently from other content returned for the same shipment.
Specifies how to organize all shipping documents of the same type.
Specifies the image format used for a shipping document.Specifies printing options for a shipping document.Provides environment-specific printer identification.Contains all data required for additional (non-label) shipping documents to be
produced in conjunction with a specific shipment.
Indicates the types of shipping documents requested by the shipper.
Specifies the production of each package-level custom document (the same
specification is used for all packages).
Specifies the production of a shipment-level custom document.
Specifies the production of the OP-900 document for hazardous materials
packages.
Specifies the production of the 1421c document for dangerous goods
shipment.
Specifies the production of the return instructions document.
Specifies the type of paper (stock) on which a document will be printed.
The descriptive data required for FedEx delivery signature services.
Identifies the delivery signature services option selected by the customer
for this shipment. See OptionType for the list of valid values.
Identifies the delivery signature services options offered by FedEx.
These values are mutually exclusive; at most one of them can be attached to a
SmartPost shipment.
Data required for shipments handled under the SMART_POST and GROUND_SMART_POST
service types.
Indicates which special rating cases applied to this shipment.Identifies each surcharge applied to the shipment.Identifies each tax applied to the shipment.Specifice the kind of tax or miscellaneous charge being reported on a Commercial
Invoice.
The descriptive data for taxpayer identification information.Identifies the category of the taxpayer identification number. See TinType
for the list of values.
Identifies the taxpayer identification number.Identifies the usage of Tax Identification Number in Shipment processing
Required for dutiable international express or ground shipment. This field is not applicable to
an international PIB (document) or a non-document which does not require a commercial invoice
express shipment.
CFR_OR_CPT (Cost and Freight/Carriage Paid TO)
CIF_OR_CIP (Cost Insurance and Freight/Carraige Insurance Paid)
DDP (Delivered Duty Paid)
DDU (Delivered Duty Unpaid)
EXW (Ex Works)
FOB_OR_FCA (Free On Board/Free Carrier)
Identifies the category of the taxpayer identification number.Descriptive data for this customer transaction. The TransactionDetail from the
request is echoed back to the caller in the corresponding reply.
Free form text to be echoed back in the reply. Used to match requests and
replies.
Governs data payload language/translations (contrasted with
ClientDetail.localization, which governs Notification.localizedMessage language
selection).
Time in transit from pickup to delivery.This definition of variable handling charge detail is intended for use in Jan 2011
corp load.
Actual percentage (10 means 10%, which is a mutiplier of 0.1)
Select the value from a set of rate data to which the percentage is
applied.
Select the type of rate from which the element is to be selected.
The variable handling charges calculated based on the type variable handling
charges requested.
Three-dimensional volume/cubic measurement.Units of three-dimensional volume/cubic measure.The descriptive data for the heaviness of an object.Identifies the unit of measure associated with a weight value.
Identifies the weight value of a package/shipment.Identifies the unit of measure associated with a weight value. See WeightUnits for
the list of valid enumerated values.
Used in authentication of the sender's identity.Credential used to authenticate a specific software application. This
value is provided by FedEx after registration.
Two part authentication string used for the sender's identityIdentifying part of authentication credential. This value is provided by
FedEx after registration
Secret part of authentication key. This value is provided by FedEx after
registration.
Identifies the version/level of a service operation expected by a caller (in each
request) and performed by the callee (in each reply).
Identifies a system or sub-system which performs an operation.
Identifies the service business level.Identifies the service interface level.Identifies the service code level.