Download - XML Trans Guide
FedEx Ship Manager® API/DIRECT
XML Transaction Guide
Jun05.0
Confidential and Proprietary
The information contained in this XML Transactions Guide is confidential and proprietary to FedEx Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this XML Transactions Guide may be distributed or disclosed in any form to any third party without written permission of FedEx. This guide is provided to you under and its use is subject to the terms and conditions of the FedEx End User and/or Consultant License Agreement. The information in this document may be changed at any time without notice. Any conflict between either of these guides, the FedEx End User and/or Consultant License Agreement, and the FedEx Service Guide shall be governed by the FedEx End User and/or Consultant License Agreement and the FedEx Service Guide, in that order.
© 2005 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved. Unpublished.
Table of Contents
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 1 1
Table of Contents
Introduction .................................................................................................................................................................................................................. 4 FedEx XML Overview ............................................................................................................................................................................................... 4 UTIs: Universal Transaction Identifiers..................................................................................................................................................................... 5
What’s New ................................................................................................................................................................................................................... 7 Referenced Documents............................................................................................................................................................................................... 9 XML Transaction Layouts ......................................................................................................................................................................................... 10
FDXSubscriptionRequest........................................................................................................................................................................................ 11 Example of a FDXSubscriptionRequest XML Document .................................................................................................................................. 13
FDXSubscriptionReply............................................................................................................................................................................................ 14 Example of a FDXSubscriptionReply XML Document ...................................................................................................................................... 15
FDXRateRequest.................................................................................................................................................................................................... 16 Example of FDXRateRequest XML Document ................................................................................................................................................. 26
FDXRateReply ........................................................................................................................................................................................................ 28 Example of a FDXRateReply XML Document................................................................................................................................................... 41
FDXRateAvailableServicesRequest ....................................................................................................................................................................... 42 Example of FDXRateAvailableServicesRequest XML Document..................................................................................................................... 52
FDXRateAvailableServicesReply ........................................................................................................................................................................... 53 Example of FDXRateAvailableServicesReply XML Document ......................................................................................................................... 61
FDXShipRequest .................................................................................................................................................................................................... 66 Example of FDXShipRequest XML Document (U.S. Domestic Express) ....................................................................................................... 113
FDXShipReply ...................................................................................................................................................................................................... 116 Example of FDXShipReply XML Document (U.S. Domestic Express) ........................................................................................................... 132
FDXShipDeleteRequest........................................................................................................................................................................................ 134 Example of FDXShipDelete Request .............................................................................................................................................................. 135
FDXShipDeleteReply ............................................................................................................................................................................................ 136 Example of FDXShipDeleteReply Transaction................................................................................................................................................ 137
Table of Contents
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 2 2
FDXCloseRequest (Applicable to FedEx Ground only)........................................................................................................................................ 138 Example of FDXCloseRequest XML Document.............................................................................................................................................. 140
FDXCloseReply (Applicable to FedEx Ground only) ............................................................................................................................................ 141 Example of FDXCloseRequest XML Document.............................................................................................................................................. 142
FDXTrackRequest ................................................................................................................................................................................................ 144 Example of FDXTrackRequest XML Document .............................................................................................................................................. 147
FDXTrackReply..................................................................................................................................................................................................... 148 Example of FDXTrackReply XML Document .................................................................................................................................................. 154
FDXSPODRequest ............................................................................................................................................................................................... 157 Example of FDXSPODRequest XML Document............................................................................................................................................. 161
FDXSPODReply ................................................................................................................................................................................................... 162 Example of FDXSPODReply XML Document ................................................................................................................................................. 162 Sample Signature Proof of Delivery (SPOD) Letter ........................................................................................................................................ 163
FDXServiceAvailabilityRequest (Express Only) ................................................................................................................................................... 164 Example of FDXServiceAvailabilityRequest XML Document .......................................................................................................................... 168
FDXServiceAvailabilityReply (Express Only)........................................................................................................................................................ 169 FDXFedExLocatorRequest ................................................................................................................................................................................... 170
Example of FDXFedExLocatorRequest XML Document................................................................................................................................. 174 FDXFedExLocatorReply ....................................................................................................................................................................................... 175
Example of FDXFedExLocatorReply XML Document..................................................................................................................................... 178 FDXEmailLabelRequest........................................................................................................................................................................................ 182
Example of FDXEmailLabelRequest XML Document ..................................................................................................................................... 199 FDXEmailLabelReply............................................................................................................................................................................................ 202
Example of FDXEmailLabelReply XML Document ......................................................................................................................................... 204 FDXCancelEmailLabelRequest ............................................................................................................................................................................ 205
Example of FDXCancelEmailLabelRequest XML Document .......................................................................................................................... 206 FDXCancelEmailLabelReply................................................................................................................................................................................. 207
Example of FDXCancelEmailLabelReply XML Document .............................................................................................................................. 208 FDXExpressTagRequest ...................................................................................................................................................................................... 209
Example of FDXExpressTagRequest XML Document.................................................................................................................................... 217 FDXExpressTagReply .......................................................................................................................................................................................... 219
Example of FDXExpressTagReply XML Document ........................................................................................................................................ 221
Table of Contents
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 3 3
FDXCancelExpressTagRequest........................................................................................................................................................................... 222 Example of FDXCancelExpressTagRequest XML Document......................................................................................................................... 223
FDXCancelExpressTagReply ............................................................................................................................................................................... 224 Example of FDXCancelExpressTag Reply XML Document............................................................................................................................ 225
FDXGroundCallTagRequest................................................................................................................................................................................. 226 Example of FDXGroundCallTaglRequest XML Document.............................................................................................................................. 232
FDXGroundCallTagReply ..................................................................................................................................................................................... 234 Example of FDXGroundCallTagReply XML Document................................................................................................................................... 235
FDXCancelGroundCallTagRequest...................................................................................................................................................................... 236 Example of FDXCancelGroundCallTagRequest XML Document ................................................................................................................... 238
FDXCancelGroundCallTagReply.......................................................................................................................................................................... 239 Example of FDXCancelGroundCallTagReply XML Document........................................................................................................................ 240
FDXExpressTagAvailabilityRequest ..................................................................................................................................................................... 241 Example of FDXExpressTagAvailabilityRequest XML Document................................................................................................................... 244
FDXExpressTagAvailabilityReply ......................................................................................................................................................................... 245 Example of FDXExpressTagAvailabilityReply XML Document....................................................................................................................... 247
Shipping Label Specifications................................................................................................................................................................................ 248 Plain Paper and Thermal Label Specifications..................................................................................................................................................... 248
General Printing Overview and Methods......................................................................................................................................................... 248 PNG Plain Paper Label.................................................................................................................................................................................... 249 Determining Screen Resolution....................................................................................................................................................................... 250 Custom Labels................................................................................................................................................................................................. 251 FedEx Shipping Label Preparation.................................................................................................................................................................. 251
Appendix A: Country Codes ................................................................................................................................................................................... 253 Appendix B: Vague Commodity Descriptions ...................................................................................................................................................... 258 Appendix C: Legal Terms and Conditions ............................................................................................................................................................ 282
Legal Terms .......................................................................................................................................................................................................... 282 Conditions of Contract .......................................................................................................................................................................................... 283
Glossary.................................................................................................................................................................................................................... 286 Index.......................................................................................................................................................................................................................... 291
Introduction
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 4 4
Introduction Welcome
Welcome to the FedEx XML Transactions Guide. This guide explains how you can compose FedEx XML Transactions to interface between your e-commerce application and the FedEx server and vice versa.
FedEx XML Overview
The FedEx XML schemas conform to the W3C XML 2.0 standard. These schemas use W3C data types, in defining all elements.
NOTE:
Clients are required to specify a schema reference in the XML Request. The schema entity reference should specify only the schema name, and no absolute or relative path. The FedEx server will reject XML Request with missing schema references or Requests with a path specified in the schema entity reference.
Communication can be established to send FedEx XML Requests to and receive FedEx XML Replies from the FedEx server by the following methods:
• via a secure Hypertext Transfer Protocol (HTTPS) utilizing the FedEx Direct solution
• via the FedEx Ship Manager API solution
Introduction
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 5 5
UTIs: Universal Transaction Identifiers
NOTE:
The UTI section of this guide is only applicable when the FedEx XML transactions are being used with FedEx Ship Manager API. The UTI codes are not applicable to FedEx Ship Manager Direct.
The Universal Transaction Identifier (UTI) is a unique integral code that has been assigned to a given transaction type. For example, the UTI of the XML Ship Request Transaction (FDXShipRequest) is 2517.
UTIs are unique not just within the XML transaction set, but across all transaction sets that have been or will be approved for transmission via the FedEx Ship Manager API.
The UTI accompanying a transaction indicates where it should be routed within the FedEx systems. The FedEx server recognizes the UTI passed in a call to FedExAPITransaction() and routes the transaction to the correct business server.
Valid UTI codes are listed below:
UTI Schema Applicable Carrier Description
2517 FDXShipRequest / FDXShipReply ALL FedEx Ship-A-Package
2518 FDXRateRequest / FDXRateReply ALL FedEx Rate-A-Package
2519 FDXRateAvailableServicesRequest / FDXRateAvailableServicesReply
ALL Rate Available Services
2521 FDXShipDeleteRequest / FDXShipDeleteReply ALL FedEx Ship Delete-A-Package
2522 FDXCloseRequest / FDXCloseReply FDXG End-of-Day Close
2523 FDXSubscriptionRequest / FDXSubscriptionReply
ALL Subscription
2529 FDXSPODRequest / FDXSPODReply ALL Signature Proof of Delivery
2532 FDXTrackRequest / FDXTrackReply ALL Track By Number, Destination, Ship Date, and Reference
Introduction
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 6 6
UTI Schema Applicable Carrier Description
2534 FDXFedExLocatorRequest / FDXFedExLocatorRequest
ALL FedEx Service Center Locator
2536 FDXServiceAvailabilityRequest / FDXServiceAvailabilityReply
ALL Service Availability
2538 FDXEmailLabelRequest / FDXEmailLabelRequest
FDXE FedEx Express E-mail Label
2539 FDXCancelEmailLabelRequest / FDXCancelEmailLabelReply
FDXE FedEx Express Cancel E-mail Label
2540 FDXExpressTagRequest / FDXExpressTagReply
FDXE FedEx Express Tag
2541 FDXCancelExpressTagRequest / FDXCancelExpressTagReply
FDXE FedEx Cancel Express Tag
2542 FDXExpressTagAvailabilityRequest / FDXExpressTagAvailabilityReply
FDXE FedEx Express Tag Availability
3501 FDXGroundCallTagRequest / FDXGroundCallTagReply
FDXG FedEx Ground Call Tag
3502 FDXCancelGroundCallTagRequest / FDXCancelGroundCallTagReply
FDXG FedEx Ground Cancel Call Tag
What’s New
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 7 7
What’s New International Document Shipping Improvements
• Support documents with commercial value – to improve document shipping process • Clearer field names for International shipments – with ‘Purpose’ description • Allow multiple countries of manufacture for one package containing items manufactured in different countries • Expanded Commodity Description – from 148 characters to 450 • Venezuela Postal Stamp fee – for inbound and outbound packages • Excess Customs Value – allows entry of customs value greater than the default amount
Signature Service Options
• Indirect Signature Required: FedEx will obtain a signature 1) from any person at the delivery address, or 2) from someone at a neighboring address, or 3) the recipient can leave a signed FedEx door tag authorizing release of the package without anyone present. Available for residential deliveries only.
• Direct Signature Required: FedEx will obtain a signature from any person at the delivery address and will reattempt delivery if no one is available to sign for the package. Available for both residential and nonresidential deliveries.
• Adult Signature Required: FedEx will obtain a signature from any person at the delivery address who is at least 21 years old and who has government-issued photo identification as proof of age, and will reattempt delivery if no one is available to sign for the package. Available for both residential and nonresidential deliveries.
• Direct Signature Required replaces FedEx Express Signature Required, FedEx Ground® Auto P.O.D., FedEx Home Delivery® Auto P.O.D. and FedEx Signature Home DeliverySM. Until Direct Signature Required is available, shippers can still choose the above options.
• Label Type 1 – Standard will not print the new Direct Signature code on the Label. • Label Type 1 – Standard does not support Signature Service. • AOD is no longer supported – Error returned if indicated in ship request.
* The impact of signature options fees may vary depending on your agreement with FedEx.
What’s New
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 8 8
Customer Bar Code on Doc Tab
Customer-specific information can be indicated in the bar code and human-readable form on the doc-tab.
New Customs Regulations and Edits for Canada and U.S.
Ineligible for Money Back Guarantee
• For intra-Canada shipments – A warning when an area being shipped to is not eligible for Money Back Guarantee (MBG).
Admissibility Package Type – A 3-character code representing a specific package type. Applicable for:
• All origin countries to Canada, excluding intra-Canada • Canada and Mexico origins to U.S. and Puerto Rico destinations
Vague Commodity Description – A list of descriptions considered vague. Applicable for:
• All origin countries to Canada, excluding intra-Canada • Canada and Mexico origins to U.S. and Puerto Rico destinations
Revised Paper Invoice Format
Provides two additional reference fields for Express shipments
Referenced Documents
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 9 9
Referenced Documents
Title Location
FedEx Service Guide To download in .pdf format: http://www.fedex.com/us/services/express/pdf.html. To request a printed copy, please call 1.800.Go.FedEx (1.800.463.3339).
XML Transaction Layouts
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 10 10
XML Transaction Layouts
This section will introduce the FedEx XML elements included in each of the FedEx XML transactions. It provides semantic information to complement the schemas. For the syntax rules governing transactions, the schemas should be consulted.
Each transaction will be presented in a table format with one row per element. The table columns will be:
Column Description
Element Name The full XPath of the element.
Applicable Carrier This column is used for the shipment and rating transaction only. Valid values:
ALL = All carriers (FedEx Express and FedEx Ground) FDXE = FedEx Express only FDXG = FedEx Ground only
Valid For This column is used for the shipment and rating transaction only. Valid values:
ALL = Applicable to U.S. Domestic and all International shipments INTL = Applicable to non-Intra U.S. Domestic shipments USD = Applicable to U.S. Domestic shipments (U.S. to U.S.) CA = Applicable to Canada (Intra/Inter-Canada) PR = Applicable to Puerto Rico
Element Description/Requirements This column contains information regarding the XML data tag with comments on the meaning of the element, and whether it is required, conditionally required, or optional. “Required” means that the element is required in the case of the specified “Applicable Carrier” and “Valid For” values. For example, if an element is valid for INTL shipping only, but required in that case, it will be noted as “Required.” But the schema will have minOccurs=”0”.
XML Transaction Layouts: FDXSubscriptionRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 11 11
FDXSubscriptionRequest
This is a one-time Request, meaning that a customer needs to subscribe to the FedEx services only once. A unique meter number specific to the customer’s FedEx account number will be returned to the client.
Element Name Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber xs:integer 12 Required. This element should represent the FedEx account number for the FedEx customer to which the unique meter number will be assigned.
RequestHeader / MeterNumber xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a rate quote. Note: This Element should only be supplied within the Request when attempting to update the meter information.
CONTACT
Contact / PersonName xs:string 35 Required. This element is only required if the element CompanyName is not provided.
Contact / CompanyName xs:string 35 Optional. This element is becomes required if the element PersonName is not provided.
Contact / PhoneNumber xs:string 16 Required. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
XML Transaction Layouts: FDXSubscriptionRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 12 12
Element Name Data Type
Max Length Element Description/Requirements
Contact / PagerNumber xs:string 16 Optional. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Contact / FaxNumber xs:string 16 Optional. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Contact / E-mailAddress xs:string 120 Optional.
ADDRESS
Address / Line1 xs:string 35 Required.
Address / Line2 xs:string 35 Optional.
Address / City xs:string 35 Required.
Address / StateOrProvinceCode xs:string 2 Required if Sender Country Code is US or CA.
Address / PostalCode xs:string 16 Required. Represents the postal code of the subscriber of account. Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries. Valid characters: A-Z; 0-9; a-z
Address / CountryCode xs:string 2 Required.
XML Transaction Layouts: FDXSubscriptionRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 13 13
Example of a FDXSubscriptionRequest XML Document
If you are a new subscriber to the FedEx Services, the first thing you need to do is send the FDXSubscriptionRequest to FedEx to register your account. For example, your name is Jim Smith (you are acting on behalf of your company), your company name is “Creative Widgets,” your address is 123 Main Street, Anycity, VA 24060. Your phone number is 540.555.9900, and your FedEx Account Number is 123456789. The input transaction should be formatted as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXSubscriptionRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSubscriptionRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> </RequestHeader> <Contact> <PersonName>Jim Smith</PersonName> <CompanyName>Creative Widgets</CompanyName> <Department>Shipping</Department> <PhoneNumber>5405559900</PhoneNumber> <PagerNumber>9999999999</PagerNumber> <FaxNumber>5405559901</FaxNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>123 Main Street</Line1> <Line2>1st Floor</Line2> <City>Anycity</City> <StateOrProvinceCode>VA</StateOrProvinceCode> <PostalCode>24060</PostalCode> <CountryCode>US</CountryCode> </Address> </FDXSubscriptionRequest>
XML Transaction Layouts: FDXSubscriptionReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 14 14
FDXSubscriptionReply
Element Name Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransactionIdentifier xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code xs:string 8 Passed back in the Reply indicating failed processing. For an erroneous transaction, the error code will be placed in this element.
Error / Message xs:string 120 Passed back in the Reply indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
MeterNumber xs:integer 10 Returned in successful Reply. Meter number assigned to the FedEx account number.
SubscribedService xs:string 32 Returns (in multiple occurrences of the element) the FedEx Services the customer is eligible for.
XML Transaction Layouts: FDXSubscriptionReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 15 15
Example of a FDXSubscriptionReply XML Document
Continuing from the FDXSubscriptionRequest example on the previous page, the FDXSubscriptionReply would be formatted as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXSubscriptionReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSubscriptionReply.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </RequestHeader> <MeterNumber>1234567</MeterNumber> <SubscribedService>FedEx Express Shipping</SubscribedService> </FDXSubscriptionReply>
If the FDXSubscriptionRequest contained an error, an error message number and message text would have been included in the transaction Reply. If, for example, the ZIP code you entered had only 3 digits, FedEx would respond with the following FDXSubscriptionReply:
<?xml version="1.0" encoding="UTF-8" ?> <FDXSubscriptionReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSubscriptionReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>20528</Code> <Message>Invalid Zip Code</Message> </Error> </FDXSubscriptionReply>
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 16 16
FDXRateRequest
As a courtesy to our customers, FedEx will provide an estimated shipping charge for a shipment if requested. The “courtesy rate quotes” returned are only estimates and may differ from the actual amount invoiced depending upon the specific circumstances regarding the shipment.
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransactionIdentifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a rate quote.
RequestHeader / MeterNumber ALL ALL xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a rate quote.
RequestHeader / CarrierCode ALL ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate ALL ALL xs:date 10 Optional. The date in which the package will be shipped. Should not be a past date or a date that is more than 10 days in the future. Defaults to current system date if not present.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 17 17
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ReturnShipmentIndicator ALL ALL xs:string 13 Optional. Valid values: • NONRETURN • PRINTRETURNLABEL • EMAILLABEL • FEDEXTAG (ExpressTag/CallTag – dependent on
carrier code)
DropoffType FDXE ALL xs:string 21 One of the following drop-off types is required: • REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICE CENTER • STATION Only REGULARPICKUP, REQUESTCOURIER, and STATION are allowed with International freight shipping. This element does not dispatch a courier.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 18 18
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Service ALL ALL xs:string 28 One of the following FedEx Services is required: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
Packaging ALL ALL xs:string 13 One of the following package types is required: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING If value entered in this element is FEDEXENVELOPE, FEDEX10KGBOX, or FEDEX25KGBOX, an MPS rate quote is not allowed.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 19 19
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
WeightUnits ALL ALL xs:string 3 Required. Valid weight types: • LBS • KGS Must be LBS for a U.S. Domestic Express rate quote.
Weight ALL ALL xs:decimal 6.1 Required. Format: One explicit decimal position (e.g. 5.0). 8 total length including decimal place.
ListRate FDXE FDXG
USD ALL
xs:boolean Optional. If = true or 1, a list rate courtesy quotes should be returned in addition to the discounted quote.
ORIGINADDRESS
OriginAddress / StateOrProvinceCode
ALL ALL xs:string 2 Required only if Sender Country Code is US or CA. Represents the state or province from which the shipment will be originating.
OriginAddress / PostalCode ALL ALL xs:string 16 Required only if Sender Country Code is US or CA. May be required for other postal-aware countries. Represents the postal code from which the shipment will be originating. Valid characters: A-Z; 0-9; a-z
OriginAddress / CountryCode ALL ALL xs:string 2 Required. Represents the country from which the shipment will be originating.
DESTINATIONADDRESS
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 20 20
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
DestinationAddress / StateOrProvinceCode
ALL ALL xs:string 2 Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined.
DestinationAddress / PostalCode ALL ALL xs:string 16 Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
DestinationAddress / CountryCode ALL ALL xs:string 2 Required. Represents the country code to which the shipment is destined.
PAYMENT
Payment / PayorType ALL ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, NO rates will still be returned.
DIMENSIONS
Dimensions / Length ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 21 21
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Dimensions / Width ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number
Dimensions / Height ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number
Dimensions / Units ALL ALL xs:string 2 Required if dimensions are entered. Only applicable if the package type is YOURPACKAGING. The valid unit of measure codes for the package dimensions:
IN – Inches CM – Centimeters
U.S. Domestic Express must be in inches.
DECLAREDVALUE
DeclaredValue / Value ALL ALL xs:decimal 8.2 Required for all shipments. The declared value of package contents. Format: Two explicit decimal positions (e.g. 100.00); 11 total length including decimal place.
DeclaredValue / CurrencyCode ALL ALL
xs:string 3 Optional. If Declared Value is provided, this element is required and must equal USD. Currency type used for customs value and declared/carriage value elements.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 22 22
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SPECIALSERVICES
Alcohol FDXE ALL xs:boolean Optional. If = true or 1, shipment contains alcohol.
SpecialServices / COD FDXE FDXG
USD ALL
The presence of the COD element indicates that COD is selected for FedEx Express. The CollectionAmount and CollectionType elements must also be provided for FedEx Ground if shipping COD.
SpecialServices / COD / CollectionAmount
FDXG ALL xs:decimal 10.2 Required if COD is selected for FedEx Ground Services. Format: Two explicit decimal positions (e.g. 100.00); 13 total length including decimal place.
SpecialServices / COD / CollectionType
FDXG ALL xs:string 15 Required if COD is selected for FedEx Ground Services. One of the following collection type values are required if shipping FedEx Ground COD: • ANY • GUARANTEEDFUNDS • CASH
SpecialServices / HoldAtLocation FDXE ALL xs:boolean If = true or 1, the shipment is Hold at Location.
SPECIALSERVICES / DANGEROUSGOODS
SpecialServices / DangerousGoods / Accessibility
FDXE ALL xs:string 12 Valid values: ACCESSIBLE – accessible Dangerous Goods INACCESSIBLE – inaccessible Dangerous Goods
SpecialServices / DryIce FDXE ALL xs:boolean If = true or 1, the shipment contains dry ice.
SpecialServices / ResidentialDelivery ALL USD xs:boolean If = true or 1, the shipment is Residential Delivery.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 23 23
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / ResidentialPickup FDXG USD xs:boolean Applicable only when ReturnShipmentIndicator is EMAILLABEL or FEDEXTAG. If = true or 1, the shipment is ResidentialPickup.
SpecialServices / InsidePickup FDXE USD xs:boolean If = true or 1, the shipment is Inside Pickup.
SpecialServices / InsideDelivery FDXE USD xs:boolean If = true or 1, the shipment is Inside Delivery.
SpecialServices / SaturdayPickup FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday pickup.
SpecialServices / SaturdayDelivery FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday delivery.
SpecialServices / NonstandardContainer
FDXG ALL xs:boolean If = true or 1, the nonstandard container is used for this shipment.
SpecialServices / SignatureOption ALL ALL xs:string 21 Optional. Specifies one of the Delivery Signature Options. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
HOMEDELIVERY
HomeDelivery / Type FDXG USD xs:string 11 One of the following values are required for FedEx Home Delivery shipments: • DATECERTAIN • EVENING • APPOINTMENT
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 24 24
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PackageCount ALL ALL xs:integer 4 Required for multiple-piece shipments (MPS). Valid values are 1 to 999. For MPS shipments, 1 piece = 1 box. For International Freight MPS shipments, this is the total number of “units.” Units are the skids, pallets, or boxes that make up a freight shipment. Each unit within a shipment should have its own label.
VARIABLEHANDLINGCHARGES
VariableHandlingCharges / Level ALL ALL xs:string 8 Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: • PACKAGE • SHIPMENT The value “SHIPMENT” is applicable only on last piece of Ground or Express MPS shipment only. Note: Value “SHIPMENT” = shipment level affects the entire shipment. Anything else sent in Child will be ignored.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 25 25
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
VariableHandlingCharges / Type ALL ALL xs:string 28 Optional. If valid value is present, a valid Variable Handling Charge is required. Specifies what type of Variable Handling charges to assess and on which amount. Valid values: • FIXED_AMOUNT • PERCENTAGE_OF_BASE • PERCENTAGE_OF_NET • PERCENTAGE_OF_NET_EXCL_TAXES
VariableHandling Charges / Amount OrPercentage
ALL ALL xs:decimal 7.2 Optional. Required in conjunction with Variable Handling Type. Contains the dollar or percentage amount to be added to the Freight charges. Whether the amount is a dollar or percentage is based on the Variable Handling Type value that is included in this Request. Format: Two explicit decimal positions (e.g. 1.00); 10 total length including decimal place.
INTERNATIONAL
International / BrokerSelectionOption FDXE INTL xs:boolean If = true or 1, the shipment is Broker Select Option (BSO).
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 26 26
Example of FDXRateRequest XML Document
On Friday, February 4, 2005, your customer, ABC Widgets, requests a shipment of parts to be delivered on Saturday, February 12. ABC Widget's delivery address is 123 N. Main Street, Suite 26, Roanoke, VA 24012. Their phone number is 703.555.1212. The requested shipment is one piece and weighs a total of 2 pounds. It is being shipped in a FedEx Box. Your company has agreed to pay the freight charges. Your FedEx account number is 123456789, and your Meter number is 1234567. Your location is in Atlanta, GA 30052.
To receive an estimate of the cost of shipping this package, the FDXRateRequest can be formatted as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXRateRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXRateRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>CTIString</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>2005-02-04</ShipDate> <DropoffType>REGULARPICKUP</DropoffType> <Service>PRIORITYOVERNIGHT</Service> <Packaging>FEDEXBOX</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>10.0</Weight> <OriginAddress> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>37115</PostalCode> <CountryCode>US</CountryCode> </OriginAddress> <DestinationAddress> <StateOrProvinceCode>TX</StateOrProvinceCode> <PostalCode>73301</PostalCode> <CountryCode>US</CountryCode> </DestinationAddress>
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 27 27
<Payment> <PayorType>SENDER</PayorType> </Payment> <PackageCount>1</PackageCount> </FDXRateRequest>
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 28 28
FDXRateReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code ALL ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element.
Error / Message ALL ALL xs:string 120 Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
ESTIMATEDCHARGES
EstimatedCharges / DimWeightUsed FDXE ALL xs:boolean If = true or 1, the the dimmed weight was used to derive freight charges.
EstimatedCharges / RateScale FDXE ALL xs:string 5 Rate scale used to rate package.
EstimatedCharges / RateZone FDXE USD xs:string Zone used for rate if zone rating applies.
EstimatedCharges / CurrencyCode FDXE ALL xs:string 3 Currency code identifier for the rated currency.
EstimatedCharges / BilledWeight FDXE ALL xs:decimal 6.1 Billed weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place. Required for Express.
EstimatedCharges / DimWeight FDXE ALL xs:decimal 6.1 DIM weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 29 29
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ESTIMATEDCHARGES / DISCOUNTEDCHARGES
EstimatedCharges / DiscountedCharges / BaseCharge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalDiscount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / DISCOUNTEDCHARGES / SURCHARGES
EstimatedCharges / DiscountedCharges / Surcharges / COD
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges/ Surcharges / AppointmentDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HomeDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Home DeliveryDateCertain
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 30 30
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / Surcharges / Home DeliveryEveningDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Non StandardContainer
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HazardousMaterials
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Residential
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / VAT
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / GSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / PSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / SaturdayDelivery
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DangerousGoods
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 31 31
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / Surcharges / OutOfPickupOrH3Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / out of DeliveryOrH3Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Inside Pickup
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Inside Delivery
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeliveryArea
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Fuel
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FICE
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Offshore
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Other
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 32 32
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / Surcharges / Oversize
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / ReturnLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FedExTag
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FedExEuropeFirst
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeliverySignatureOptions
ALL ALL Xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalSurcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / ShipmentNetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 33 33
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / TotalRebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / LISTCHARGES
EstimatedCharges / ListCharges / BaseCharge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalDiscount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / LISTCHARGES / SURCHARGES
EstimatedCharges / ListCharges / Surcharges / COD
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / SaturdayPickup
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeclaredValue
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / AppointmentDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HomeDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place
EstimatedCharges / ListCharges / Surcharges / Home DeliveryDateCertain
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 34 34
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / ListCharges / Surcharges / Home DeliveryEvening Delivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Non StandardContainer
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HazardousMaterials
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Residential
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / VAT
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / GSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / PSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / SaturdayDelivery
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DangerousGoods
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / out of PickupOrH3Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / out of DeliveryOrH3 Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / InsidePickup
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 35 35
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / ListCharges / Surcharges / InsideDelivery
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / PriorityAlert
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeliveryArea
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Fuel
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FICE
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Offshore
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Other
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Oversize
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / ReturnLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / EmailLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExTag
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExEuropeFirst
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 36 36
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / ListCharges / Surcharges / DeliverySignatureOptions
ALL ALL Xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / AdditionalHandling
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalSurcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / ShipmentNetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalRebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / EffectiveNetDiscount
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / MTWNetCharge FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / VARIABLEHANDLING
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 37 37
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / VariableHandling / VariableHandling Charge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on Discounted freight (either Freight or Net freight as specified by Variable Handling Charge Type element), plus the value input in Variable Handling Charge. If Variable Handling Type is FIXED_AMOUNT, element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
EstimatedCharges / VariableHandling / ListVariableHandling Charge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on List freight (either Freight or Net freight as specified by Variable Handling Charge Type element), plus the value input in Variable Handling Charge. If Variable Handling Type is FIXED_AMOUNT, element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
EstimatedCharges / VariableHandling / TotalCustomerCharge
ALL ALL xs:decimal 18.2 Contains Shipper’s discounted Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
EstimatedCharges / VariableHandling / ListTotalCustomer Charge
ALL ALL xs:decimal 18.2 Contains Shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 38 38
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / VariableHandling / MultiweightVariableHandlingCharge
FDXG ALL xs:decimal 7.2 Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal.
EstimatedCharges / VariableHandling / MultiweightTotal CustomerCharge
FDXG ALL xs:decimal 18.2 Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 39 39
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / OversizeClass FDXG ALL xs:string Required. Valid values:
1 = A package weighing less than 30 lbs. and measuring more than 84" but equal to or less than 108" in combined length and girth will be classified by FedEx Ground as an Oversize 1 (OS1) package. The transportation charges for an Oversize 1 (OS1) package will be the same as a 30-lb. package being transported under the same circumstances. 2 = A package weighing less than 50 lbs. and measuring more than 108" but equal to or less than 130" in combined length and girth will be classified by FedEx Ground as an Oversize 2 (OS2) package. The transportation charges for an Oversize 2 (OS2) package will be the same as a 50-lb. package being transported under the same circumstances. 3 = A package weighing 150 lbs. or less and measuring more than 130" but equal to or less than 165" in combined length and girth will be classified by FedEx Ground as an Oversize 3 (OS3) package. The transportation charges for an Oversize 3 (OS3) package will be based on the greater of the package's actual rounded weight or a 90-lb. minimum billable weight. An additional oversize charge will be assessed on any package measuring more than 130" in length and girth.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 40 40
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SignatureOption ALL ALL xs:string 21 Optional. Effective Delivery Signature Option. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT Note: This option may differ from that requested due to other characteristics of the shipment.
IneligibleForMoneyBackGuarantee FDXE CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 41 41
Example of a FDXRateReply XML Document
The following is an example of the FDXRateReply:
<?xml version="1.0" encoding="UTF-8" ?> <FDXRateReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>CTIString</CustomerTransactionIdentifier> </ReplyHeader> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>01552</RateScale> <RateZone>5</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>10.0</BilledWeight> <DiscountedCharges> <BaseCharge>47.75</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <Surcharges> <Fuel>2.63</Fuel> <Other>0.00</Other> </Surcharges> <TotalSurcharge>2.63</TotalSurcharge> <NetCharge>50.38</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> <ListCharges> <Surcharges> <Fuel>2.63</Fuel> <Other>0.00</Other> </Surcharges> </ListCharges> </EstimatedCharges> </FDXRateReply>
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 42 42
FDXRateAvailableServicesRequest
Rate Available Services provides the ability to send a single Request in order to receive the FedEx service(s) available and corresponding courtesy quote(s) for your package, service, and origin/destination criteria.
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a rate quote.
RequestHeader / MeterNumber ALL ALL xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a rate quote.
RequestHeader / CarrierCode ALL ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate ALL ALL xs:date 10 Required. The date in which the package will be shipped. Should not be a past date or a date that is more than 10 days in the future.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 43 43
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ReturnShipmentIndicator ALL ALL xs:string 13 Required. Valid values: • NONRETURN • PRINTRETURNLABEL • EMAILLABEL
DropoffType FDXE ALL xs:string 21 One of the following drop-off types is required: • REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICECENTER • STATION Only REGULARPICKUP, REQUESTCOURIER, and STATION are allowed with International freight shipping.This element does not dispatch a courier.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 44 44
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Service ALL ALL xs:string 28 One of the following FedEx Services is optional: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY If provided, only that service’s estimated charges will be returned.
Packaging ALL ALL xs:string 13 One of the following package types is required: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING If value entered in this element is FEDEXENVELOPE, FEDEX10KGBOX, or FEDEX25KGBOX, an MPS rate quote is not allowed.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 45 45
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
WeightUnits ALL ALL xs:string 3 Valid weight types: • LBS • KGS LBS is required for a U.S. Domestic Express rate quote.
Weight ALL ALL xs:decimal 6.1 Required. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place.
ListRate FDXE FDXG
USD ALL
xs:boolean Optional. If = true or 1, list-rate courtesy quotes should be returned in addition to the discounted quote.
ORIGINADDRESS
OriginAddress / StateOrProvinceCode
ALL ALL xs:string 2 Required only if Sender Country Code is US or CA. Represents the state or province from which the shipment will be originating.
OriginAddress / PostalCode ALL ALL xs:string 16 Required only if Sender Country Code is US or CA. May be required for other postal-aware countries when rating an internationally shipment. Represents the postal code from which the shipment will be originating. Valid characters: A-Z; 0-9; a-z
OriginAddress / CountryCode ALL ALL xs:string 2 Required. Represents the country from which the shipment will be originating.
DESTINATIONADDRESS
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 46 46
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
DestinationAddress / StateOrProvinceCode
ALL ALL xs:string 2 Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined.
DestinationAddress / PostalCode ALL ALL xs:string 16 Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries when rating an internationally shipment. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
DestinationAddress / CountryCode ALL ALL xs:string 2 Required. Represents the country code to which the shipment is destined.
PAYMENT
Payment / PayorType ALL ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, no rates will still be returned.
DIMENSIONS
Dimensions / Length ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 47 47
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Dimensions / Width ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number
Dimensions / Height ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number
Dimensions / Units ALL ALL xs:string 2 Required if dimensions are entered. Only applicable if the package type is YOURPACKAGING. The valid unit of measure codes for the package dimensions are:
IN – Inches CM – Centimeters
U.S. Domestic Express must be in inches.
DECLAREDVALUE
DeclaredValue / Value ALL ALL xs:decimal 8.2 Required for all shipments. The declared value of package contents. This value cannot exceed the total customs value. Format: Two explicit decimal positions (e.g. 100.00); 11 total length including decimal place.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 48 48
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
DeclaredValue / CurrencyCode ALL ALL
xs:string 3 Optional. Currency type used for customs value and declared/carriage value elements. If Declared Value is provided, this element is required and must equal USD.
SPECIALSERVICES
Alcohol FDXE ALL
xs:boolean Optional. If = true or 1, shipment contains alcohol.
SpecialServices / COD FDXE FDXG
USD ALL
The presence of the COD element indicates that COD is selected for FedEx Express or Ground. The CollectionAmount and CollectionType elements must also be provided for FedEx Ground if shipping COD.
SpecialServices / COD / Collection Amount
FDXG ALL xs:decimal 10.2 Required if COD is selected for FedEx Ground Services.COD amount that would be collected. Format: Two explicit decimal positions (e.g. 100.00); 13 total length including decimal place.
SpecialServices / COD / CollectionType
FDXG ALL xs:string 15 Required if COD is selected for FedEx Ground Services.Method of obtaining COD Amount. One of the following collection type values are required if shipping FedEx Ground COD: • ANY • GUARANTEEDFUNDS • CASH
SpecialServices / HoldAtLocation FDXE ALL xs:boolean If = true or 1, the shipment is Hold at Location.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 49 49
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / DangerousGoods / Accessibility
FDXE ALL xs:string 12 Valid values: ACCESSIBLE – accessible DG INACCESSIBLE – inaccessible DG
SpecialServices / DryIce FDXE ALL xs:boolean If = true or 1, the shipment contains dry ice.
SpecialServices / ResidentialDelivery
ALL USD xs:boolean If = true or 1, the shipment is Residential Delivery. If Recipient Address is in a rural area (defined by table lookup), additional charge will be applied. This element is not applicable to the FedEx Home Delivery service.
SpecialServices / InsidePickup FDXE USD xs:boolean If = true or 1, the shipment is Inside Pickup.
SpecialServices / InsideDelivery FDXE USD xs:boolean If = true or 1, the shipment is Inside Delivery.
SpecialServices / SaturdayPickup FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday pickup.
SpecialServices / SaturdayDelivery FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday delivery.
SpecialServices / NonstandardContainer
FDXG ALL xs:boolean If = true or 1, a nonstandard container is used for this shipment.
SpecialServices / SignatureOption ALL ALL xs:string 21 Optional. Specifies the Delivery Signature Option requested for the shipment. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
HOMEDELIVERY
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 50 50
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
HomeDelivery / Type FDXG USD xs:string 11 One of the following values are required for FedEx Home Delivery shipments: • DATECERTAIN • EVENING • APPOINTMENT
PackageCount ALL ALL xs:positive integer
4 Required for multiple-piece shipments (MPS). For International Freight MPS shipments, this is the total number of “units.” Units are the skids, pallets, or boxes that make up a freight shipment. For MPS shipments, 1 piece = 1 box. Each unit within a shipment should have its own label. Valid values: 1 – 999
VARIABLEHANDLINGCHARGES
VariableHandling Charges / Level
ALL ALL xs:string 8 Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: • PACKAGE • SHIPMENT The value “SHIPMENT” is applicable only on last piece of Ground or Express MPS shipment only. Note: Value “SHIPMENT” = shipment level affects the entire shipment. Anything else sent in Child will be ignored.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 51 51
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
VariableHandling Charges / Type
ALL ALL xs:string 28 Optional. If valid value is present, a valid Variable Handling Charge is required. Specifies what type of Variable Handling charges to assess and on which amount. Valid values: • FIXED_AMOUNT • PERCENTAGE_OF_BASE • PERCENTAGE_OF_NET • PERCENTAGE_OF_NET_ EXCL_TAXES
VariableHandling Charges / AmountOrPercentage
ALL ALL xs:decimal 7.2 Optional. Required in conjunction with Variable Handling Type. Contains the dollar or percentage amount to be added to the Freight charges. Whether the amount is a dollar or percentage is based on the Variable Handling Type value that is included in this Request. Format: Two explicit decimal positions (e.g. 1.00); 10 total length including decimal place.
International / BrokerSelectionOption
FDXE INTL xs:boolean If = true or 1, the shipment is BSO.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 52 52
Example of FDXRateAvailableServicesRequest XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXRateAvailableServicesRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXRateAvailableServicesRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>2 _S1PK2P1_PASS</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>2003-05-16</ShipDate> <DropoffType>REGULARPICKUP</DropoffType> <Packaging>YOURPACKAGING</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>1.0</Weight> <ListRate>false</ListRate> <OriginAddress> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>37115</PostalCode> <CountryCode>US</CountryCode> </OriginAddress> <DestinationAddress> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </DestinationAddress> <Payment> <PayorType>SENDER</PayorType> </Payment> <PackageCount>1</PackageCount> </FDXRateAvailableServicesRequest>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 53 53
FDXRateAvailableServicesReply
Rate Available Services provides the ability to send a single Request in order to receive the FedEx service(s) available and corresponding courtesy quote(s) for your package, service, and origin/destination criteria.
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / Customer Transaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code ALL ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or server failure, the error code will be placed in this element.
Error / Message ALL ALL xs:string 120 Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
SOFTERROR
SoftError / Type ALL ALL xs:string 25 Returned only if a soft error/warning message is available. Valid values: • WARNING • INFORMATIONAL • SHIPPING_WARNING • SHIPPING_INFO • URSA_HARD • URSA_SOFT
SoftError / Code ALL ALL xs:string 8 Returned only if a soft error/warning message is available.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 54 54
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SoftError / Message ALL ALL xs:string 255 Returned only if a soft error/warning message is available.
ENTRY
Entry / Service ALL ALL xs:string 35 FedEx service(s) available for the Requested origin/destination pairing. There may be up to 22 occurrences of the Entry grouping representing available services available.
Entry / Packaging ALL ALL xs:string 35 Associated package description for available service.
Entry / DeliveryDate FDXE USD xs:date 10 Format: YYYY-MM-DD In regards to International services, the delivery date availability is limited to some postal supported countries. The delivery date will be returned if available.
Entry / DeliveryDay FDXE USD xs:string 3 Day of week: SUN, MON, TUE, WED, THU, FRI, SAT In regards to International services, the delivery date availability is limited to some postal supported countries. The delivery date will be returned if available.
Entry / DestinationStationID FDXE USD xs:string 5 FedEx location identifier of the package destination.
Entry / TimeInTransit FDXG USD xs:string Expected time in transit.
ENTRY / ESTIMATEDCHARGES
Entry/ EstimatedCharges / DimWeightUsed
FDXE USD xs:boolean If = true or 1, the dimmed weight was used to derive freight charges.
Entry / Estimated Charges / RateScale FDXE USD xs:string 5 Rate scale used to rate package.
Entry / Estimated Charges / RateZone FDXE USD xs:string Zone used for rate if zone applies.
Entry / Estimated Charges / Currency Code
FDXE ALL xs:string 3 Currency code identifier for the rated currency.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 55 55
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Entry / Estimated Charges / Billed Weight
FDXE USD xs:decimal 6.1 Billed weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place.
Entry / Estimated Charges / DimWeight FDXE USD xs:decimal 6.1 DIM weight for the shipment. Format: One explicit decimal positions (e.g. 5.0); 8 total length including decimal place.
ENTRY / ESTIMATED CHARGES / DISCOUNTED CHARGES
Entry / Estimated Charges / Discounted Charges / Base Charge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
Entry / Estimated Charges / Discounted Charges / Total Discount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / Discounted Charges / Total Surcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place
Entry / Estimated Charges / Discounted Charges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / Discounted Charges / Shipment NetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place
Entry / Estimated Charges / Discounted Charges / Total Rebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ENTRY / ESTIMATED CHARGES / LISTCHARGES
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 56 56
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Entry / Estimated Charges / ListCharges / BaseCharge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / ListCharges / TotalDiscount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / ListCharges / TotalSurcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / ListCharges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / ListCharges / ShipmentNetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / ListCharges / TotalRebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / Effective NetDiscount
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
Entry / Estimated Charges / MTW NetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ENTRY / ESTIMATED CHARGES / VARIABLE HANDLING
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 57 57
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Entry / Estimated Charges / Variable Handling / Variable HandlingCharge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on Discounted freight (either Freight or Net freight as specified by Variable Handling Charge Type element), plus the value input in Variable Handling Charge. If the Variable Handling Type is FIXED_AMOUNT, this element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
Entry / Estimated Charges / Variable Handling / List VariableHandling Charge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on List freight (either Freight or Net freight as specified by Variable Handling Charge Type element), plus the value input in Variable Handling Charge. If the Variable Handling Type is FIXED_AMOUNT, this element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
Entry / Estimated Charges / Variable Handling / Total CustomerCharge
ALL ALL xs:decimal 18.2 Contains Shipper’s discounted Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
Entry / Estimated Charges / Variable Handling / ListTotal CustomerCharge
ALL ALL xs:decimal 18.2 Contains Shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 58 58
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Entry / Estimated Charges / Variable Handling / Multiweight / Variable HandlingCharge
FDXG ALL xs:decimal 7.2 Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal.
Entry / Estimated Charges / Variable Handling / MultiweightTotal CustomerCharge
FDXG ALL xs:decimal 18.2 Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 59 59
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Entry / EstimatedCharges / OversizeClass
FDXG ALL xs:string Required Valid values:
1 = A package weighing less than 30 lbs. and measuring more than 84" but equal to or less than 108" in combined length and girth will be classified by FedEx Ground as an Oversize 1 (OS1) package. The transportation charges for an Oversize 1 (OS1) package will be the same as a 30-lb. package being transported under the same circumstances. 2 = A package weighing less than 50 lbs. and measuring more than 108" but equal to or less than 130" in combined length and girth will be classified by FedEx Ground as an Oversize 2 (OS2) package. The transportation charges for an Oversize 2 (OS2) package will be the same as a 50-lb. package being transported under the same circumstances. 3 = A package weighing 150 lbs. or less and measuring more than 130" but equal to or less than 165" in combined length and girth will be classified by FedEx Ground as an Oversize 3 (OS3) package. The transportation charges for an Oversize 3 (OS3) package will be based on the greater of the package's actual rounded weight or a 90-lb. minimum billable weight. An additional oversize charge will be assessed on any package measuring more than 130" in length and girth.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 60 60
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SignatureOption ALL ALL xs:string 21 Optional. Effective Delivery Signature Option. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT Note: This option may differ from that requested due to other characteristics of the shipment.
IneligibleForMoneyBackGuarantee ALL CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 61 61
Example of FDXRateAvailableServicesReply XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXRateAvailableServicesReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>2 _S1PK2P1_PASS</CustomerTransactionIdentifier> </ReplyHeader> <Entry> <Service>PRIORITYOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-19</DeliveryDate> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>01508</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>18.75</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>1.03</TotalSurcharge> <NetCharge>19.78</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>FEDEX2DAY</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-20</DeliveryDate>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 62 62
<DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>06002</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>8.30</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.46</TotalSurcharge> <NetCharge>8.76</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>FIRSTOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-19</DeliveryDate> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>00008</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>43.75</BaseCharge>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 63 63
<TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>2.41</TotalSurcharge> <NetCharge>46.16</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-19</DeliveryDate> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>01305</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>16.00</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.88</TotalSurcharge> <NetCharge>16.88</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>FEDEXEXPRESSSAVER</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-20</DeliveryDate>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 64 64
<DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>07169</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>7.80</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.43</TotalSurcharge> <NetCharge>8.23</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>GROUNDHOMEDELIVERY</Service> <Packaging>YOURPACKAGING</Packaging> <TimeInTransit>1</TimeInTransit> <EstimatedCharges> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DiscountedCharges> <BaseCharge>3.50</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>1.21</TotalSurcharge> <NetCharge>4.71</NetCharge> </DiscountedCharges> </EstimatedCharges>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 65 65
</Entry> <Entry> <Service>FEDEXGROUND</Service> <Packaging>YOURPACKAGING</Packaging> <TimeInTransit>1</TimeInTransit> <EstimatedCharges> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DiscountedCharges> <BaseCharge>3.50</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.04</TotalSurcharge> <NetCharge>3.54</NetCharge> </DiscountedCharges> </EstimatedCharges> </Entry> </FDXRateAvailableServicesReply>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 66 66
FDXShipRequest
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber
ALL ALL xs:integer 12 Required. The FedEx account number assigned to the FedEx customer initiating the shipment Request.
RequestHeader / MeterNumber
ALL ALL xs:integer 10 Required. The meter number assigned to the FedEx customer from which the shipment is originating.
RequestHeader / CarrierCode
ALL ALL xs:string 4 Required. Valid carrier codes:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate ALL ALL xs:date 10 Required if Future Ship Date element is present. Will be overridden by today’s date if Future Ship Date element is present. The date in which the package will be shipped. Should not be a past date or a date that is more than 10 days in the future.
ShipTime ALL ALL xs:time 8 Required. Local Time of shipment based on shipper's time zone. Defaults to the current U.S. Central Standard Time, if not provided.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 67 67
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
ReturnShipmentIndicator ALL ALL xs:string 13 Valid values: • NONRETURN • PRINTRETURNLABEL
DropoffType FDXE ALL xs:string 21 Required. Valid drop-off types: • REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICECENTER • STATION Only REGULARPICKUP, REQUESTCOURIER, or STATION are allowed with International freight shipping. This element does not dispatch a courier.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 68 68
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Service ALL ALL xs:string 28 Required. Available FedEx services: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
Packaging ALL ALL xs:string 14 Required. Valid packaging types include: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 69 69
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
WeightUnits ALL ALL xs:string 3 Required. Valid units: • LBS • KGS
Weight ALL ALL xs:decimal 6.1 Required. The weight of the package.
CurrencyCode FDXE FDXG
INTL ALL
xs:string 3 Required for International shipments. Defaults to USD for U.S. Domestic shipments.
ListRate FDXE FDXG
USD ALL
xs:boolean Optional. If true or 1, list rate (general estimated charges) will be returned along with the discounted rates.
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName ALL ALL xs:string 35 Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / CompanyName ALL ALL xs:string 35 Required if the sender contact name is not passed in the transaction. Company from which the shipment is originating. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / Department ALL ALL xs:string 10 Optional. Name of the department from which the shipment is originating.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 70 70
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Origin / Contact / PhoneNumber ALL ALL xs:string 16 Required. The phone number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Origin / Contact / PagerNumber ALL ALL xs:string 16 Optional. The pager number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Origin / Contact / FaxNumber ALL ALL xs:string 16 Optional. The fax number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Origin / Contact / E-MailAddress
ALL ALL xs:string FDXE-120FDXG-35
Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.
ORIGIN / ADDRESS
Origin / Address / Line1 ALL ALL xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 ALL ALL xs:string 35 Optional. Secondary address line from which the shipment is originating.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 71 71
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Origin / Address / City ALL ALL xs:string FDXE-120FDXG-35
Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
Origin / Address / StateOrProvinceCode
ALL ALL xs:string 2 Required for shipping only if Country Code is US or CA. State code from which the shipment is originating.
Origin / Address / PostalCode ALL ALL xs:string 16 Required for shipping only if Country Code is US or CA. May be required for other postal-aware countries when shipping internationally. Postal code from which the shipment is originating. Must be numeric for U.S., no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Origin / Address / CountryCode ALL ALL xs:string 2 Required. Name of the country from which the shipment is originating.
DESTINATION
DESTINATION / CONTACT
Destination / Contact / PersonName
ALL ALL xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. Name of the person to whom the shipment is destined. COD service is selected. If passed in the transaction, a minimum of 3 alpha characters must be passed.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 72 72
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Destination / Contact / CompanyName
ALL ALL xs:string 35 Required if Recipient Contact Name was not passed in the Request transaction. Name of the company to whom the shipment is destined.If entered, a minimum of 3 alpha characters must be passed.
Destination / Contact / Department ALL ALL xs:string 10 Optional. Name of the department to whom the shipment is destined.
Destination / Contact / PhoneNumber
ALL ALL xs:string 16 Required. Phone number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Destination / Contact / PagerNumber
ALL ALL xs:string 16 Optional. Pager number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Destination / Contact / FaxNumber ALL ALL xs:string 16 Optional. Fax number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Destination / Contact / E-MailAddress
ALL ALL xs:string FDXE-120FDXG-35
Optional. E-mail address for the contact person to whom the shipment is destined.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 73 73
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
DESTINATION / ADDRESS
Destination / Address / Line1 ALL ALL xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 ALL ALL xs:string 35 Optional. Secondary address line to which the shipment is destined.
Destination / Address / City ALL ALL xs:string FDXE-35 FDXG-20
Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed.
Destination / Address / StateOrProvince Code
ALL ALL xs:string 2 Required only if Recipient Country Code is US or CA, or if Shipper’s Export Declaration (SED) applies and country is MX. State or province code to which the shipment is destined.
Destination / Address / PostalCode ALL ALL xs:string 16 Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 74 74
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Destination / Address / CountryCode
ALL ALL xs:string 2 Required. Name of the country to which the shipment is destined. Note: A column has been added to the country.dat file to distinguish 'ship-to' countries vs. country of manufacture countries. The ShipToCntry column will be populated with Y/N values: Y = ship-to country, N = country of manufacture. Any country code validations currently done by the software against country rows in country.dat will now have to check the ShipToCntry column to validate the country based on the content of the ShipToCntry column.
PAYMENT
Payment / PayorType ALL ALL xs:string 10 Required. Method of payment for shipment. Valid payment types: • SENDER • RECIPIENT • THIRDPARTY • COLLECT The credit card payment type is only supported for U.S. Domestic Express shipping. For Return Manager, only SENDER and THIRDPARTY are allowed.
PAYMENT / PAYOR
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 75 75
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Payment / Payor / AccountNumber ALL ALL xs:string 12 For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The FedEx account number for the payor of the shipment.
Payment / Payor / CountryCode ALL ALL xs:string 2 For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The country code for the payor of the shipment.
REFERENCEINFO
ReferenceInfo / CustomerReference
ALL ALL xs:string FDXE-40 FDXG-30
Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by reference. This element allows customer-defined notes to print on the shipping label. This element cannot be used if alcohol is declared in the special services element, customer reference information will be discarded.
ReferenceInfo / PONumber ALL ALL xs:string 30 Optional. If passed in the transaction, it can be used later to track by PONumber.
ReferenceInfo / InvoiceNumber ALL ALL xs:string 30 Optional. If passed in the transaction, it can be used later to track by InvoiceNumber reference.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 76 76
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
DIMENSIONS
Dimensions / Length ALL ALL xs:non negative Integer
3 Optional, but recommended, if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The length of the package.
Dimensions / Width ALL ALL xs:non negative Integer
3 Optional, but recommended, if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The width of the package.
Dimensions / Height ALL ALL xs:non negative Integer
3 Optional, but recommended, if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The height of the package.
Dimensions / Units ALL ALL xs:string 2 Required if package dimensions are passed in the Request. Valid dimension unit of measure codes:
IN – inches CM – centimeters
Defaults to inches if a value is not passed in the transaction.
DECLAREDVALUE
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 77 77
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
DeclaredValue ALL ALL xs:decimal 8.2 Optional for a U.S. Domestic, International dutiable Express, and Ground shipments. Required in single-piece shipment Request and in the Request for the master package of a Express International Multipiece shipment. The declared value of entire shipment/ package contents. In multiple-piece shipments, this is ignored in all but the master package Request This value cannot exceed the total customs value for an International shipment. For Express International MPS, Master piece should contain the total declared value/carriage value, with no declared value/carriage value in sequential pieces. For example, piece 1 of n pieces will have the total declared value/carriage value of all the pieces.
SPECIALSERVICES
SPECIALSERVICES / ALCOHOL
SpecialServices / Alcohol / Type FDXE ALL xs:string 16 Required if the Alcohol element is present. The type of alcohol being shipped. Valid types: • BEER • WINE • DISTILLEDSPIRITS • ALE • LIGHTWINE
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 78 78
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / Alcohol / Packaging
FDXE ALL xs:string 6 Required if the Alcohol element is present. The packaging type for the alcohol being shipped. Valid types: • BARREL • BOTTLE • CASE • CARTON • OTHER
SpecialServices / Alcohol / Volume FDXE ALL xs:decimal 3.3 Required if the Alcohol element is present. The quantity of alcohol being shipped. Unit of measurement is liters. Format: Three explicit decimal positions (e.g. 4.321). Maximum length is 7 including decimal.
SpecialServices / Alcohol / PackageCount
FDXE ALL xs:integer 3 Required if the Alcohol element is present. Number of units (bottles, cases, etc.) of alcohol included in the package being shipped.
SPECIALSERVICES / COD
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 79 79
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / COD / Add Transportation Charges
FDXG FDXE
ALL USD
xs:string 45 Required for COD shipments. This element determines which freight charges should be added to the COD collect amount. Valid values: • ADD_DISCOUNTED_NET • ADD_LIST_NET • ADD_DISCOUNTED_COD_ SURCHARGE
(GROUND ONLY) • ADD_LIST_COD_SUR CHARGE (GROUND ONLY)• ADD_DISCOUNTED_
CUSTOMER_TOTAL_CHARGE (GROUND ONLY) • ADD_LIST_CUSTOMER_ TOTAL_CHARGE
(GROUND ONLY) • ADD_MULTIWEIGHT_NET_
CHARGE_TO_SHIPMENT (GROUND ONLY) • ADD_SUM_OF_DISCOUNTED_NET_CHARGES_T
O_ SHIPMENT (GROUND ONLY) • ADD_SUM_OF_LIST_NET_
CHARGES_TO_SHIPMENT (GROUND ONLY)
SpecialServices / COD / CollectionAmount
FDXE FDXG
USD ALL
xs:decimal 10.2 Required if COD element is provided. The Customer input COD amount (prior to any accumulations.) Format: Two explicit decimals (e.g.5.00).
SpecialServices / COD / CollectionType
FDXG FDXE
ALL USD
xs:string 15 Required if the COD element is provided. Valid types: • ANY • GUARANTEEDFUNDS • CASH
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 80 80
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / COD / CODReturn
ALL USD If shipping a COD single-piece shipment, the COD remittance elements can be passed in the FDXShipRequest transaction. If shipping COD MPS, the COD remittance elements can be passed in the FDXShipRequest transaction representing the last piece of the shipment. The COD Return Contact information will default to the Shipper Contact information if not passed in the FDXShipRequest transaction.
SpecialServices / COD / CODReturn / Contact / PersonName
ALL USD xs:string 35 Required only if the COD element is present and the COD Company Name has not been entered. Name of the COD remittance person if different from the Sender.
SpecialServices / COD / CODReturn / Contact / CompanyName
ALL USD xs:string 35 Required only if the COD element is present and a COD contact name has not been entered. Company name of the COD remittance party if different from the Sender’s Company Name.
SpecialServices / COD / CODReturn / Contact / Department
ALL USD xs:string 10 Optional. Department name of the COD remittance party.
SpecialServices / COD / CODReturn / Contact / PhoneNumber
ALL USD xs:string 16 Required only if the COD element is not present and is different a phone number from the Sender is needed. Phone number of the COD remittance party. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
SpecialServices / COD / CODReturn / Address/Line1
ALL USD xs:string 35 Required only if the COD element is not present and a different phone number from the Sender is needed. Primary address of the COD remittance party.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 81 81
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / COD / CODReturn / Address / Line2
ALL USD xs:string 35 Optional. Secondary address of the COD remittance party.
SpecialServices / COD / CODReturn / Address / City
ALL USD xs:string 35 Required only if the COD element is not present and a different address from the Sender is needed. City of the COD remittance party.
SpecialServices / COD / CODReturn / Address / StateorProvinceCode
ALL USD xs:string 2 Required only if the COD element is not present and a different state or province from the Sender is needed. State code of the COD remittance party.
SpecialServices / COD / CODReturn / Address / PostalCode
ALL USD xs:string 16 Required only if the COD element is not present and a different postal code from the Sender is needed. Postal code of the COD remittance party. Must be numeric for U.S., no embedded dashes allowed.Valid characters: A-Z; 0-9; a-z
SpecialServices / COD / CODReturn / Tracking Number
FDXE USD xs:string 20 Required for a COD multiple-piece shipments only. Tracking number assigned to the COD remittance shipment. Must be sent in the FDXShipmentRequest transaction that represents the last piece in a multiple-piece shipment. This tracking number is returned in the FDXShipmentReply to the first FDXShipmentRequest of a COD shipment.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 82 82
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / COD / CODReturn / ReferenceIndicator
FDXG USD xs:string Optional. This indicator determines which reference value will print on the FedEx Ground shipping label. Valid indicator values: • TRACKING • REFERENCE • PO • INVOICE
SPECIALSERVICES / HOLDATLOCATION
SpecialServices / HoldAtLocation / PhoneNumber
FDXE ALL xs:string 16 Required for freight shipping. Required only if Hold At Location. Phone number for the location where the shipment is being held. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
SpecialServices / HoldAtLocation / Address / Line1
FDXE ALL xs:string 35 Required only if Hold At Location. Street address for the location where the shipment is being held.
SpecialServices / HoldAtLocation / Address / City
FDXE ALL xs:string 35 Required only if Hold At Location. City name of the location where the shipment is being held.
SpecialServices / HoldAtLocation / Address / StateOr ProvinceCode
FDXE ALL xs:string 2 Required only if Hold At Location and Country is US or CA. State or province code of the location where the shipment is being held.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 83 83
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / HoldAtLocation / Address / PostalCode
FDXE ALL xs:string 16 Required only if Hold At Location and Country is US or CA. Postal code for the location where the shipment is being held. Must be numeric for U.S., no embedded dashes allowed.Valid characters: A-Z; 0-9; a-z
SPECIALSERVICES / DANGEROUSGOODS Required only for dangerous goods shipping. The DangerousGoods element must be included in the FDXShipmentRequest transaction to identify a shipment for dangerous goods shipping. Classification of Dangerous Goods. Valid values: • Accessible • Inaccessible
SpecialServices / DangerousGoods / Accessibility
FDXE ALL xs:string 12 ACCESSIBLE if shipment contains accessible dangerous goods INACCESSIBLE for inaccessible dangerous goods. ACCESSIBLE or INACCESSIBLE sent assumes shipment is Dangerous Goods.
SpecialServices / HazMatCertificateData / DOTProper ShippingName
FDXG ALL xs:string 50 Required for OP-950. Optional if Hazardous Materials is selected.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 84 84
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / HazMatCertificateData / DOTHazardClassOrDivision
FDXG ALL xs:string 25 Required for OP-950. Optional if Hazardous Materials is selected. Valid values currently are: • 1.4 • 1.6 • 2.1 • 2.2 • 3 • 4.1 • 5.1 • 5.2 • 7 • 8 • 9 • ORM-D
SpecialServices / HazMatCertificateData / DOTIDNumber
FDXG ALL xs:string 6 Optional if Hazardous Materials is selected.
SpecialServices / HazMatCertificateData / DOTLabelType
FDXG ALL xs:string 11 Optional. Type DOT Label(s) Required, Label(s) Required, Ltd., Qty., or Exemption Number.
SpecialServices / HazMatCertificateData / PackingGroup
FDXG ALL xs:string 3 Optional if Hazardous Materials is selected. Valid groups: • I • II • III
SpecialServices / HazMatCertificateData / Quantity
FDXG ALL xs:decimal 6.2 Optional if Hazardous Materials is selected. Format: Two explicit decimal positions (e.g. 5.00).
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 85 85
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / HazMatCertificateData / Units
FDXG ALL xs:string 4 Optional for OP9-50. Valid values: • oz • gal • lb • Lg • qt • kg • pt
SpecialServices / HazMatCertificateData / TwentyFourHour EmergencyResponse ContactNumber
FDXG ALL xs:string 16 Optional if Hazardous Materials is selected. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
SpecialServices / HazMatCertificateData / TwentyFour Hour Emergency Response ContactName
FDXG ALL xs:string 50 Optional if Hazardous Materials is selected.
SPECIALSERVICES / DRYICE
SpecialServices / DryIce / WeightUnits
FDXE ALL xs:string 3 Required for dry ice shipments. Required weight type for dry ice weight is KGS.
SpecialServices / DryIce / Weight FDXE ALL xs:decimal 4.1 Required for dry ice shipments. Represents cumulative dry weight for the entire shipment. Dry ice weight cannot be greater than shipment weight. Weight type is KGS only.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 86 86
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / ResidentialDelivery
FDXG FDXE
ALL USD
xs:boolean If = true or 1, the shipment is Residential Delivery, else false or 0. If Recipient Address is in a rural area, additional charge will be applied.
SpecialServices / FutureDayShipment
ALL ALL xs:boolean Required for FDXG. For FDXE, defaults to false. A value of false causes any passed Ship Date to be overridden by today’s date. If a value of true or 1 is entered, the passed Ship Date will not be overridden. If = true or 1, the shipment is scheduled for a future date.Date must be less than ten days in advance.
SpecialServices/ InsidePickup FDXE USD xs:boolean If = true or 1, the shipment is originated from an inside pickup area. Applicable to freight shipping only.
SpecialServices / InsideDelivery FDXE USD xs:boolean If = true or 1, the shipment is traveling to an inside delivery area. Applicable to freight shipping only.
SpecialServices / SaturdayPickup FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday pickup.
SpecialServices / SaturdayDelivery FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday delivery.
SPECIALSERVICES / EMAILNOTIFICATION
SpecialServices / EMailNotification / ShipAlertFaxNumber
FDXG ALL xs:string 16 Required for shipment notification by fax. Shipment notification by fax number and e-mail notification address cannot both be selected for the same shipment Request transaction. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 87 87
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / ShipAlertOptional Message
ALL ALL xs:string 120 Optional. Customer specified message to be included in the shipment notification.
SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER
SpecialServices / EMailNotification / Shipper / ShipAlert
FDXE ALL xs:boolean Required for ShipAlert Notification to the shipper. When Requesting a ShipAlert in ship Request transaction, sender’s e-mail address, recipient’s e-mail address, broker’s e-mail address, or E-mail Notification Address must be used in conjunction with the ShipAlert elements for shipment notification via e-mail. If true or 1, Sender’s E-mail Address will be e-mailed ShipAlert e-mail.
SpecialServices / EMailNotification / Shipper / Delivery Notification
FDXE ALL xs:boolean Required for Delivery Notification to the shipper. If = true or 1, Sender’s E-mail Address will be e-mailed Delivery Notification e-mail.
SpecialServices / EMailNotification / Shipper / Language Code
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for shipper e-mail address. Defaults to EN (English). Valid language codes:
EN – English FR – French
SPECIALSERVICES / EMAILNOTIFICATION / RECIPIENT
SpecialServices / EMailNotification / Recipient / ShipAlert
FDXE ALL xs:boolean Required for ShipAlert Notification to the recipient. If = true or 1, Recipient’s E-mail Address will be e-mailed ShipAlert e-mail.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 88 88
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Recipient / DeliveryNotification
FDXE ALL xs:boolean Required for Delivery Notification to the recipient. If = true or 1, Recipient E-mail Address will be e-mailed Delivery Notification e-mail.
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for recipient e-mail address. Defaults to EN (English). Valid language codes:
EN – English FR – French
SPECIALSERVICES / EMAILNOTIFICATION / BROKER
SpecialServices / EMailNotification / Broker / ShipAlert
FDXE INTL xs:boolean Required for Delivery Notification to the broker. If = true or 1, Broker E-mail Address will be e-mailed ShipAlert e-mail.
SpecialServices / EMailNotification / Broker Delivery Notification
FDXE INTL xs:boolean Required for Delivery Notification to the broker. If = true or 1, Broker E-mail Address will be e-mail Delivery Notification e-mail.
SpecialServices / EMailNotification / Broker / LanguageCode
FDXE INTL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for broker e-mail address. Defaults to EN (English). Valid language codes:
EN – English FR – French
SPECIALSERVICES / EMAILNOTIFICATION / OTHER
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 89 89
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Other / E-MailAddress
ALL ALL xs:string FDXE- 120FDXG- 35
For FDXE: A minimum of one occurrence is required if shipment notification or delivery notification is selected. A maximum of three occurrences is allowed for FedEx Express shipments for ShipAlert or Delivery Alert Notification. For FDXG: One occurrence is required if shipment notification is selected and ShipAlert fax number is not included in the Request transaction. Delivery Notification is not supported for FDXG. Shipment notification by e-mail address and fax number cannot both be selected for the same shipment Request transaction.
SpecialServices / EMailNotification / Other / ShipAlert
ALL ALL xs:boolean Required for ShipAlert. If = true or 1, corresponding e-mail address will be emailed ShipAlert. For FDXE: Maximum of three occurrences allowed for FedEx Express shipments. For FDXG: One occurrence allowed for FedEx Ground shipments.
SpecialServices / EMailNotification / Other / Delivery Notification
FDXE ALL xs:boolean Required for Delivery Notification. If = true or 1, the corresponding e-mail address will be emailed delivery notification. Maximum of three occurrences allowed for FedEx Express shipments
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 90 90
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Other / LanguageCode
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for corresponding e-mail address. Maximum of three occurrences allowed for FedEx Express shipments. Defaults to EN (English). Valid language codes:
EN – English FR – French
SpecialServices / NonStandard Container
FDXG ALL xs:boolean If = true or 1, the shipment is in a nonstandard container.
SpecialServices / SignatureOption ALL ALL xs:string 21 Optional. Specifies one of the Delivery Signature Options. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
SpecialServices / SignatureRelease FDXE USD CAN
xs:string 10 Release Authorization Number. Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.
HOMEDELIVERY
HomeDelivery / Date FDXG USD xs:date Required for home delivery shipments if delivery type is set to DATECERTAIN.
HomeDelivery / Instructions FDXG USD xs:string 74 Optional. Applicable only to FedEx Home Delivery shipments.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 91 91
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
HomeDelivery / Type FDXG USD xs:string 11 Required for home delivery shipments. Valid values: • DATECERTAIN • EVENING • APPOINTMENT
HomeDelivery / PhoneNumber FDXG USD xs:string 16 Required if home delivery type is set to DATECERTAIN or APPOINTMENT. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
LABEL
Label / Type ALL ALL xs:string 8 Required to receive correct label image in the FDXShipReply transaction. 2DCOMMON is the label type value that must be included in the FDXShipRequest transaction.
Label / ImageType ALL ALL xs:string Required to indicate label formatting. Type of data stream or bitmap to be returned Valid image types:
PNG – plain paper ELTRON – thermal Zebra – thermal UniMark – thermal
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 92 92
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / LabelStockOrientation ALL ALL xs:string 8 Required only for thermal labels (ImageType other than PNG). Specifies whether label stock has doc-tab on leading (LEADING) or trailing (TRAILING) end of label as it emerges from printer, or has no doc-tab (NONE) Valid label stock options: • LEADING • TRAILING • NONE
Label / DocTabLocation ALL ALL xs:string 6 Required only for thermal labels (ImageTypes). Specifies whether the label text will be oriented so that the physical doc-tab appears at the top (TOP) or at the bottom (BOTTOM) of the label when viewed with text upright. When there is no physical doc-tab (LabelStockOrientation of NONE), the label text will be oriented as if LabelStockOrientation were LEADING. Valid values: • TOP • BOTTOM
LABEL / DOCTABCONTENT
Label / DocTabContent / Type ALL ALL xs:string 8 Optional. Required only if using the doc-tab on a thermal label. Valid values: • STANDARD • ZONE001 • BARCODED • NONE Default: STANDARD
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 93 93
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
LABEL / DOCTABCONTENT / ZONE001
LABEL / DOCTABCONTENT / ZONE001 / HEADERVALUEPAIR
Label / DocTabContent / Zone001 / HeaderValuePair / ZoneNumber
ALL ALL xs:positive Integer
12 Optional. Applicable only if using the Zone001 doc-tab type on a thermal label. Maximum of 12 occurrences of Header Value Pair.
Label / DocTabContent / Zone001 / HeaderValuePair / Header
ALL ALL xs:string 12 Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair.
Label / DocTabContent / Zone001 / HeaderValuePair / Value
ALL ALL xs:string 12 Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair.
Label / DisplayedOrigin If DisplayedOrigin elements are included in the FDXShipRequest transaction, the value of these elements prints on label in the “sender” area. The default is for the origin address to print on label in the “sender” area.
LABEL / DOCTABCONTENT / BARCODED
Label / DocTabContent / Barcoded / Symbology
ALL ALL xs:positive Integer
12 Optional. Applicable only if using the Zone001 doc tab type on a thermal label. Specifies which symbology to use for bar code. Valid value: CODE128C Defaults to CODE128C.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 94 94
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / DocTabContent / Barcoded / Header
ALL ALL xs:string 20 Required only if using the bar coded doc-tab on a thermal label. Human-readable text string.
Label / DocTabContent / Barcoded / Value
ALL ALL xs:string 30 Required if parent element is present; can contain only characters legal for the specified symbology. String to be encoded in bar code.
LABEL / DISPLAYEDORIGIN / CONTACT
Label / DisplayedOrigin / Contact / PersonName
ALL ALL xs:string 35 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Contact / CompanyName
ALL ALL xs:string 35 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Contact / PhoneNumber
ALL ALL xs:string 16 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Address / Line1
ALL ALL xs:string 35 Primary address line from which the shipment is destined. Required.
Label / DisplayedOrigin / Address / Line2
ALL ALL xs:string 35 Optional. Secondary address line from which the shipment is destined.
Label / DisplayedOrigin / Address / City
ALL ALL xs:string FDXE-35 FDXG-20
Required. City name from which the shipment is destined. Minimum of 3 alpha characters must be passed for shipping.
Label / DisplayedOrigin / Address / StateOrProvinceCode
ALL ALL xs:string 2 Required for shipping only if Country Code is US or CA. State code from which the shipment is destined.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 95 95
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / DisplayedOrigin / Address / PostalCode
ALL ALL xs:string 16 Required for shipping only if Country Code is US or CA. May be required for other postal-aware countries when shipping internationally. Postal code from which the shipment is destined. Must be numeric for U.S., no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Label / DisplayedOrigin / Address / CountryCode
ALL ALL xs:string 2 Required. Name of the country from which the shipment is destined.
Label / MaskAccountNumber ALL ALL xs:boolean 2 Optional If false, FedEx Account Number will be displayed on label. Default: true
MULTIPIECE
MultiPiece / PackageCount FDXE FDXG
INTL ALL
xs:positive Integer
4 Required for multiple-piece shipping.
MultiPiece / PackageSequence Number
FDXE FDXG
INTL ALL
xs:positive Integer
4 Required for multiple-piece shipping if PackageCount value is greater than 1.
MultiPiece / ShipmentWeight FDXE FDXG
INTL ALL
xs:decimal 6.1 Required for International multiple-piece shipping. The Total Shipment Weight is in the Master only, not the Children. For example, piece 1 of n pieces will have the total shipment weight of all the pieces. Format: One explicit decimal position (e.g. 5.0).
MultiPiece / MasterTracking Number
FDXE FDXG
INTL ALL
xs:string 20 Required for multiple-piece shipping if SequenceNumber value is greater than 1.
MultiPiece / MasterFormID FDXE ALL xs:string 4 Required for multiple-piece shipping if PackageSequenceNumber value is greater than 1.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 96 96
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
FREIGHT
Freight / Packaging ListEnclosed FDXE USD xs:boolean Optional. If = true or 1, the packaging list is enclosed, else false or 0.
Freight / Shippers LoadAnd Count FDXE INTL xs:positive Integer
5 Required for a single piece or on the first piece of an MPS for International freight shipping. Applicable to International Priority Freight (IPFS) and International Economy Freight (IEFS) only. Shipper’s Load and Count (SLAC) = total shipment pieces (e.g. 3 boxes and 3 pallets of 100 pieces each = SLAC of 303). Values must be 1-5 characters in length.
Freight / Booking ConfirmationNumber
FDXE INTL xs:string 12 Required for International freight shipping.
VARIABLEHANDLINGCHARGES
VariableHandling Charges / Level
ALL ALL xs:string 8 Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: • PACKAGE • SHIPMENT “SHIPMENT” is applicable only on last piece of Ground or Express MPS shipment only. Note: “SHIPMENT” = shipment level affects the entire shipment. Anything else sent in Child will be ignored.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 97 97
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
VariableHandling Charges / Type
ALL ALL xs:string 28 Optional. If valid value is present, a valid Variable Handling Charge is required. Valid values: • FIXED_AMOUNT • PERCENTAGE_OF_BASE • PERCENTAGE_OF_NET • PERCENTAGE_OF_NET_ EXCL_ TAXES
VariableHandling Charges / AmountOr Percentage
ALL ALL xs:decimal 7.2 Optional. Required in conjunction with Variable Handling Type. Contains amount (in the billing currency for the shipment) to be added to the Freight charge. Interpreted as a dollar amount if Variable Handling Type is FIXED_AMOUNT. Interpreted as a percentage for all other Variable Handling Types.
INTERNATIONAL
International / RecipientTIN ALL INTL xs:string 15 Optional. U.S. federal Taxpayer Identification Number (ITN) of recipient. No special characters allowed.
International / Broker Optional. Broker designated by the customer to handle customs clearance. Broker information should be included if Broker Select Option is to be cleared using a different broker than FedEx.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 98 98
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Broker / AccountNumber
FDXE INTL xs:string 12 Optional. The FedEx assigned account number of the Broker who will be used to clear the shipment (if other than FedEx).
International / Broker / TIN FDXE INTL xs:string 15 Optional. U.S. federal TIN (taxpayer identification number) of broker. No special characters allowed.
INTERNATIONAL / BROKER / CONTACT
International / Broker / Contact / PersonName
ALL INTL xs:string 35 Required. The contact name of the Broker who will be used to clear the shipment (if other than FedEx). Minimum of 3 alpha characters must be passed.
International / Broker / CompanyName
ALL INTL xs:string 35 Optional. The company name of the Broker who will be used to clear the shipment (if other than FedEx).
International / Broker / PhoneNumber
ALL INTL xs:string 16 Required. The contact’s phone number for the Broker who will be used to clear the shipment (if other than FedEx). The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
International / Broker / PagerNumber
FDXE INTL xs:string 16 Optional. The contact’s pager number for the Broker who will be used to clear the shipment (if other than FedEx). The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 99 99
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Broker / FaxNumber FDXE INTL xs:string 16 Optional. The contact’s fax number for the Broker who will be used to clear the shipment (if other than FedEx). The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
International / Broker / E-MailAddress
FDXE INTL xs:string 120 Optional.
INTERNATIONAL / BROKER / ADDRESS
International / Broker / Address / Line1
ALL INTL xs:string 35 Optional. The primary address of the Broker who will be used to clear the shipment (if other than FedEx).
International / Broker / Address / Line2
ALL INTL xs:string 35 Optional. The secondary address of the Broker who will be used to clear the shipment (if other than FedEx).
International / Broker / Address / City
ALL INTL xs:string 35 Required. The city of the Broker who will be used to clear the shipment (if other than FedEx). Minimum of 3 alpha characters must be passed.
International / Broker / Address / StateOr ProvinceCode
ALL INTL xs:string 2 Optional. Required element if Broker Country Code is US, CA, or MX. The state code for the city of the Broker who will be used to clear the shipment (if other than FedEx).
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 100 100
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Broker / Address / PostalCode
ALL INTL xs:string 16 Required if Broker Country Codes is US and CA. May be required for other postal-aware countries. The postal code for the city of the Broker who will be used to clear the shipment (if other than FedEx). Valid characters: A-Z; 0-9; a-z
International / Broker / Address / CountryCode
ALL INTL xs:string 35 Required. Must be the same as the Recipient Country Code.
International / ImporterOfRecord Optional. Applicable only for Commercial Invoice (CI). If the consignee and importer are not the same, the importer elements are required. If some importer elements are provided in the FDXShipmentRequest, the following required elements must be provided as well.
International / ImporterOfRecord / AccountNumber
FDXE INTL xs:string 12 Optional. FedEx account number for importer of shipment if other than recipient.
International / ImporterOfRecord / TIN
ALL INTL xs:string 15 Optional. U.S. federal TIN (taxpayer identification number) for importer of shipment if other than recipient.
INTERNATIONAL / IMPORTEROFRECORD / CONTACT Importer’s Contact Information
International / ImporterOfRecord / Contact / PersonName
ALL INTL xs:string 35 Required for Importer. Contact for importer of shipment if other than recipient.
International / ImporterOfRecord / Contact / CompanyName
ALL INTL xs:string 35 Required for Importer. Company for importer of shipment if other than recipient.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 101 101
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / ImporterOfRecord / Contact / PhoneNumber
ALL INTL xs:string 16 Required for Importer. Phone number for importer of shipment if other than recipient. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
INTERNATIONAL / IMPORTEROFRECORD / ADDRESS Importer’s Address Information
International / ImporterOfRecord / Address / Line1
ALL INTL xs:string 35 Required for Importer. The primary address for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / Line 2
ALL INTL xs:string 35 Optional. The secondary address for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / City
ALL INTL xs:string 35 Required for Importer. The city for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / StateOrProvinceCode
ALL INTL xs:string 2 Required if Importer Country Code is US or CA. The state or province code for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / PostalCode
ALL INTL xs:string 16 Required if Importer Country Codes is US and CA. May be required for other postal-aware countries. The postal code for importer of shipment if other than recipient. Valid characters: A-Z; 0-9; a-z
International / ImporterOfRecord / Address / CountryCode
ALL INTL xs:string 2 Required for Importer. The country code for importer of shipment if other than recipient.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 102 102
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
INTERNATIONAL / DUTIESPAYMENT
INTERNATIONAL / DUTIESPAYMENT / DUTIESPAYOR Required if PayorType is THIRDPARTY. Optional if RECIPIENT.
International / DutiesPayment / DutiesPayor / AccountNumber
FDXE INTL xs:string 12 Required if Duties Pay Type is THIRDPARTY. FedEx account number billed for duties/taxes.
International / DutiesPayment / DutiesPayor / CountryCode
FDXE INTL xs:string 2 Optional. Country code where the duty/tax payor resides.
International / DutiesPayment / PayorType
FDXE INTL xs:string 9 Required for a dutiable International Express shipment. This element is not applicable to an International document Express shipment. Payment type for duties and taxes. Valid payment types: • SENDER • RECIPIENT • THIRDPARTY
International / TermsOfSale ALL INTL xs:string 10 Required for a dutiable International Express shipment. This element is not applicable to an International document Express shipment. Valid values: • FOB_OR_FCA • CIF_OR_CIP • CFR_OR_CPT • EXW • DDU • DDP
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 103 103
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / PartiesToTransaction FDXE INTL xs:boolean Required. Value of true or 1 required if the exporter and the consignee of the transaction are related. To determine if the parties are related, the company of the exporter and the company of the consignee have a parent/child relationship or either the exporter or consignee must have at least 10% ownership in the other (e.g. subsidiaries, branches of same company, etc.).
International / Documents FDXE INTL xs:boolean 5 Indicates whether this shipment contains only documents or no documents. Defaults to false, which means that this shipment contains NO documents; true means that this shipment contains ONLY documents; Note: A SHIPMENT CAN CONTAIN EITHER DOCUMENTS ONLY, OR NO DOCUMENTS; DOCUMENTS AND OTHER COMMODITIES CANNOT BE MIXED IN A SHIPMENT.
International / NAFTA FDXE INTL xs:boolean May be applicable if origin and destination countries are US, CA, or MX. Value = true or 1 if NAFTA shipment, else false or 0.
International / TotalCustomsValue ALL INTL xs:decimal 12.2 Required. This value includes the total value of the shipment along with freight, insurance, and miscellaneous charges. Format: Two explicit decimal positions (e.g. 100.00).
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 104 104
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
INTERNATIONAL / COMMERCIALINVOICE Optional. CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through FedEx’s System. Customers will print their own Commercial Invoice. Commercial Invoice support consists of a maximum of 20 commodity line items. Applicable only if CommercialInvoice element is included in the FDXShipRequest.
International / CommercialInvoice / Comments
ALL INTL xs:string 444 Optional.
International / CommercialInvoice / FreightCharge
ALL INTL xs:decimal 16.2 Required if Terms Of Sale is CF or CIF. This charge should be added to the total customs value amount. Format: Two explicit decimal positions (e.g. (100.00).
International / CommercialInvoice / InsuranceCharge
ALL INTL xs:decimal 16.2 Required if Terms Of Sale is CIF. This charge should be added to the total customs value amount. Format: Two explicit decimal positions (e.g. (100.00).
International / CommercialInvoice / TaxesOrMiscellaneousCharge
ALL INTL xs:decimal 16.2 Additional Charges is an optional entry for a dutiable International shipment only. No entry should be allowed for additional charges for an International document shipment. This charge should be added to the total customs value amount. Format: Two explicit decimal positions (e.g. (100.00).
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 105 105
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / CommercialInvoice / Purpose
ALL INTL xs:string 17 Optional. Purpose of shipment. Valid values: • Sold • Not Sold • Gift • Sample • Repair and Return • Personal Effects Note: “Sold” is not a valid Purpose for a Proforma Invoice.
International / CommercialInvoice / CustomerInvoice Number
ALL INTL xs:string 15 Optional.
INTERNATIONAL / COMMODITY A maximum of twenty occurrences of commodity line item information is supported in this Request transaction.For International multiple-piece shipments, the first four occurrences of commodity information must be passed in the Master and each Child transaction.
International / Commodity / NumberOfPieces
FDXE INTL xs:non negative Integer
5 At least one occurrence is required for International shipments.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 106 106
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Commodity / Description
FDXE INTL xs:string 450 Complete and accurate description of this commodity. When International/Documents is set to true or 1, only strings from the following list may be used: Correspondence/No Commercial Value, AccountingDocuments, Analysis Reports, Applications (Completed), Bank Statements, Bid Quotations, Birth Certificates, Bills of Sale, Bonds, Business Correspondence, Checks (Completed), Claim Files, Closing Statements, Conference Reports, Contracts, Cost Estimates, Court Transcripts, Credit Applications, Data Sheets, Deeds, Employment Papers, Escrow Instructions, Export Papers, Financial Statements, Immigration Papers, Income Statements, Insurance Documents, Interoffice Memos, Inventory Reports, Invoices (Completed), Leases, Legal Documents, Letters and Cards, Letter of Credit Packets, Loan Documents, Marriage Certificates, Medical Records, Office Records, Operating Agreements, Patent Applications, Permits, Photocopies, Proposals, Prospectuses, Purchase Orders, Quotations, Reservation Confirmation, Resumes, Sales Agreements, Sales Reports, Shipping Documents, Statements/Reports, Statistical Data, Stock Information, Tax Papers, Trade Confirmations, Transcripts, Warranty Deeds. Only a portion of this field will print on the label.
International / Commodity / Country OfManufacture
FDXE INTL xs:string 2 Required. Country code where commodity contents were produced or manufactured in their final form. At least one occurrence is required for International dutiable shipments. XX may be used to indicate multiple countries of manufacture.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 107 107
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Commodity / HarmonizedCode
FDXE INTL xs:string 14 At least one occurrence is required for U.S. Export shipments if the Customs Value is greater than $2500 or if a valid U.S. Export license is required. Unique alpha/numeric representing commodity item. Currently 10 digits, no decimals.
International / Commodity / Weight FDXE INTL xs:decimal 9.1 At least one occurrence is required for International dutiable shipments. Format: One explicit decimal position (e.g. 5.0).
International / Commodity / Quantity
FDXE INTL xs:non negative integer
9 Optional for an International PIB (document) Express shipment. Number of units of a commodity in total number of pieces for this line item. At least one occurrence is required for International dutiable shipments.
International / Commodity / QuantityUnits
FDXE INTL xs:string 3 Optional for an International PIB (document) Express shipment. At least one occurrence is required for International dutiable shipments.
International / Commodity / UnitPrice
FDXE INTL xs:decimal 11.6 Value of each ‘unit’ in Quantity. At least one occurrence is required for International dutiable shipments. Format: Six explicit decimal positions (e.g. 900.000000).
International / Commodity / CustomsValue
FDXE INTL xs:decimal 11.6 At least one occurrence is required for International dutiable shipments. It should equal the commodity unit quantity times commodity unit value.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 108 108
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Commodity / ExportLicenseNumber
FDXE INTL xs:string 12 Required if commodity is shipped on commerce export license; Customs Value is greater than $2500; and ITAR, License Exception Symbol, and FTSR are not supplied. License number (A999999). Applicable to U.S. Export shipping only.
International / Commodity / ExportLicense ExpirationDate
FDXE INTL xs:date 10 Required only if commodity is shipped on commerce export license, and Export License Number is supplied. Date of expiration. Must be at least 1 day into future. The date that the Commerce Export License expires. Export License commodities may not be exported from the U.S. on an expired license. Applicable to U.S. Export shipping only.
International / Commodity / CIMarksAndNumbers
FDXE INTL xs:string 15 Optional. An identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment. Only used for the FedEx CI. Applicable only if the Commercial Invoice element is present.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 109 109
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
INTERNATIONAL / SED The following AES (Automated Export System) data elements are required to be submitted to FedEx by the exporter or the exporter’s authorized agent prior to departure of the merchandise from the U.S. if a Shipper’s Export Declaration (SED) is required. Applicable To U.S. Export Shipments Only. Precedence for government issued licenses or exemptions for SED: • Export License • International Traffic in Arms Regulations (ITAR) • License Exception Symbol • Foreign Trade Statistics Regulations (FTSR) • Custom Value
International / SED / SenderTINOrDUNS
ALL INTL xs:string 15 Optional. Required for U.S. Export shipments Either the federal (United States) TIN (taxpayer identification number) or the Dun and Bradstreet (D-U-N-S) Number of Sender.
International / SED / SenderTINOrDUNS Type
FDXE INTL xs:string 4 Required for any International shipments. Valid values: • SSN • EIN • DUNS
International / SED / AESOrFTSR ExemptionNumber
ALL INTL xs:string 32 Express: Required for non-document U.S. Export Shipments. Ground: Required. The full AES SED exemption legend is entered in this element. Also, when all commodities in the shipment fall under an FTSR exemption, the full FTSR exemption legend is entered in this element.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 110 110
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
INTERNATIONAL / EXPORT
International / Export / B13AFilingOption
FDXE INTL xs:string 4 Required for any International non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands. Specifies which filing option is being exercised by the customer. Valid values: • NOT_REQUIRED • MANUALLY_ATTACHED • FILES_ELECTRONICALLY • SUMMARY_REPORTING
International / Export / StatementData
FDXE INTL xs:string Min: 1 Max: 50
Currently required only if B13AFilingOption is one of the following: • MANUALLY_ATTACHED • FILES_ELECTRONICALLY • SUMMARY_REPORTING
International / Export / PermitNumber
FDXE INTL xs:string Min: 1 Max: 10
Optional. Applicable for any Canada export (International) non-document shipment of any value to any destination: US, PR, US Virgin Islands or Rest of World other than Canada.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 111 111
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / AdmissibilityPackageType
ALL INTL Xs:string 4 Required for shipments inbound to Canada. Applicable for all origins to Canada (excluding Intra-Canada), CA to US, CA to PR, MX to US, and MX to PR. Valid values: • BAG • BBL • BDL • BOX • BSK • BXT • CAG • CAS • CHS • CNT • CRT • CTN • CYL • DRM • ENV • PAL • PCL • PCS • PKG • PLT • REL • ROL • SAK • SHW • SKD • TBE • TBN • TNK • UNT
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 112 112
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SHIPMENTCONTENT
ShipmentContent / BlockShipmentData
FDXE ALL xs:boolean Optional. If = true or 1, means block all but sender from seeing shipment content data in Inbound Visibility/Insight.
SHIPMENTCONTENT / SHIPMENTCONTENTRECORD Optional. This data represents more detailed content description for the shipment. Repeated Grouping up to 50 occurrences per tracking number.
ShipmentContent / ShipmentContentRecord / PartNumber
ALL ALL xs:string 20 Optional.
ShipmentContent / ShipmentContentRecord / ItemNumber
ALL ALL xs:string 15 Optional.
ShipmentContent / ShipmentContentRecord / ReceivedQuantity
ALL ALL xs:non negative integer
6 Optional.
ShipmentContent / ShipmentContentRecord / Description
ALL ALL xs:string 80 Optional.
RMA Return Merchant Authorization
RMA / Number FDXE USD xs:string 20 Return Merchant Authorization that is assigned by the sender.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 113 113
Example of FDXShipRequest XML Document (U.S. Domestic Express)
On Monday, January 3, 2005, your customer, ABC Widgets, requests a shipment of widget parts to be delivered. ABC Widgets’ delivery address is 322 Latta Woods, Roanoke VA 24012. Their phone number is 703.555.1212. You are to send the package to the attention of Bernard F. Smith. The requested shipment is one piece, weighs a total of 4 pounds, and is being shipped using a FedEx Box. It should be sent via FedEx Express using the FedEx 2Day service. Your company is Total Widget Rebuilders, 445 East Street, Dallas TX 75247. Your phone number is 214.555.8765, and your FedEx account number is 123456789. The meter number is 1234567. Your input transaction is formatted as:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>US Ship</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>2005-01-03</ShipDate> <ShipTime>14:20:00</ShipTime> <DropoffType>REGULARPICKUP</DropoffType> <Service>PRIORITYOVERNIGHT</Service> <Packaging>FEDEXBOC\X</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>4.0</Weight> <Origin> <Contact> <PersonName>Contact Name</PersonName> <CompanyName>Company Name</CompanyName> <Department>Department</Department> <PhoneNumber>9015551234</PhoneNumber> <PagerNumber>8001234567</PagerNumber> <FaxNumber>9012638957</FaxNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 114 114
<Address> <Line1>10 Fedex Parkway</Line1> <Line2>2nd fl, Vertical</Line2> <City>Collierville</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <PersonName>Recip Contact</PersonName> <CompanyName>Recip Company</CompanyName> <Department>Recip Department</Department> <PhoneNumber>8705551234</PhoneNumber> <PagerNumber>8001234567</PagerNumber> <FaxNumber>9012635624</FaxNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>123 Main St.</Line1> <Line2>Suite 300</Line2> <City>Berkeley</City> <StateOrProvinceCode>CA</StateOrProvinceCode> <PostalCode>94710</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> </Payment> <ReferenceInfo> <CustomerReference>Reference 12345</CustomerReference>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 115 115
</ReferenceInfo> <Label> <Type>2DCOMMON</Type> <ImageType>PNG</ImageType> </Label> </FDXShipRequest>
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 116 116
FDXShipReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code ALL ALL xs:string 4 Returned only if an error occurred while processing the transaction.
Error / Message ALL ALL xs:string 120 Returned only if an error occurred while processing the transaction.
SOFTERROR
SoftError / Type ALL ALL xs:string 16 Returned only if a soft error/warning message is available. Valid values: • WARNING • INFORMATIONAL • SHIPPING_WARNING • SHIPPING_INFO • URSA_HARD • URSA_SOFT
SoftError / Code ALL ALL xs:string 8 Returned only if a soft error/warning message is available.
SoftError / Message ALL ALL xs:string 255 Returned only if a soft error/warning message is available.
TRACKING
Tracking / TrackingNumber ALL ALL xs:string 20 Contains the tracking number assigned to the shipment if successful.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 117 117
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
Tracking / FormID FDXE ALL xs:string 4 Label form ID returned upon successful transaction Reply.
Tracking / CodReturnTracking Number
FDXE USD xs:string 20 Returned only for COD Express shipments. If a multiple-piece shipment, even though it is only required for the last piece, element CodReturnTrackingNumber will be returned for each corresponding FDXShipRequest.
Tracking / CodReturnFormID FDXE USD xs:string 4 Returned only for COD FedEx Express shipments. If a multiple-piece shipment, this element will only be returned in the FDXShipReply for the first piece.
Tracking / MasterTracking Number FDXE INTL USD-COD
xs:string 20 Returned if an International multiple-piece shipment, or a U.S. Domestic COD multiple-piece shipment.
Tracking/Master FormID FDXE INTL USD-COD
xs:string 4 Returned if an International multiple-piece shipment, or a U.S. Domestic COD multiple-piece shipment.
ServiceType Description FDXE USD xs:string 35 Textual description of the FedEx service.
PackagingDescription FDXE USD xs:string 35 Textual description of the shipment packaging.
ESTIMATEDCHARGES
EstimatedCharges / DimWeightUsed FDXE USD xs:boolean If = true or 1, the dimmed weight was used to derive freight charges.
EstimatedCharges / RateScale FDXE USD xs:string 5 Rate scale used to rate package.
EstimatedCharges / RateZone FDXE USD xs:string Zone used for rate if zone applies.
EstimatedCharges / CurrencyCode FDXE ALL xs:string 3 Currency code identifier for the rated currency.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 118 118
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / BilledWeight FDXE ALL xs:decimal 6.1 Required for Express. Billed weight for the shipment. Format: One explicit decimal positions (e.g. 5.0); 8 total length including decimal place.
EstimatedCharges / DimWeight FDXE ALL xs:decimal 6.1 DIM weight for the shipment. Format: One explicit decimal positions (e.g. 5.0); 8 total length including decimal place.
ESTIMATEDCHARGES / DISCOUNTEDCHARGES
EstimatedCharges / DiscountedCharges / BaseCharge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalDiscount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / DISCOUNTEDCHARGES / SURCHARGES
EstimatedCharges / DiscountedCharges / Surcharges / COD
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / AppointmentDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 119 119
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / Surcharges/Home Delivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HomeDeliveryDateCertain
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HomeDeliveryEvening Delivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / NonStandardContainer
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HazardousMaterials
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Residential
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / VAT
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / HSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / GSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 120 120
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / Surcharges / PSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges/Saturday Delivery
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DangerousGoods
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / out of PickupOrH3Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / out of DeliveryOrH3Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / InsidePickup
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / InsideDelivery
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeliveryArea
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 121 121
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / Surcharges / Fuel
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FICE
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Offshore
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Other
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / Oversize
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / ReturnLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FedExTag
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FedExEuropeFirst
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 122 122
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / Surcharges / DeliverySignatureOptions
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalSurcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / ShipmentNetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalRebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / LISTCHARGES
EstimatedCharges / ListCharges / BaseCharge
ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalDiscount
ALL ALL xs:decimal 11.2 Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / LISTCHARGES / SURCHARGES
EstimatedCharges / ListCharges / Surcharges / COD
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 123 123
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / ListCharges / Surcharges / SaturdayPickup
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeclaredValue
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / AppointmentDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HomeDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HomeDeliveryDate Certain
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HomeDeliveryEveningDelivery
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / NonStandard Container
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HazardousMaterials
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Residential
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / VAT
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / HSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / GSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 124 124
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / ListCharges / Surcharges / PSTSurcharge
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / SaturdayDelivery
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DangerousGoods
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / out of PickupOrH3 Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / out of DeliveryOrH3 Area
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / InsidePickup
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / InsideDelivery
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / PriorityAlert
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeliveryArea
FDXE USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Fuel
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FICE
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Offshore
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 125 125
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / ListCharges / Surcharges / Other
FDXE ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / Oversize
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / ReturnLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / EmailLabel
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExTag
ALL USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExEuropeFirst
FDXE INTL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeliverySignatureOptions
ALL ALL Xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalSurcharge
ALL ALL xs:decimal 11.2 Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / NetCharge
ALL ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / ShipmentNetCharge
FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalRebate
FDXE USD xs:decimal 11.2 Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 126 126
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / EffectiveNetDiscount
ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / MTWNetCharge FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
ESTIMATEDCHARGES / VARIABLEHANDLING
EstimatedCharges / VariableHandling / VariableHandling Charge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on Discounted freight (either Freight or Net freight as specified by Variable Handling Charge Type element) plus the value input in Variable Handling Charge. If the Variable Handling Type is FIXED_AMOUNT, this element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
EstimatedCharges / VariableHandling / ListVariableHandling Charge
ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on List freight (either Freight or Net freight as specified by Variable Handling Charge Type element), plus the value input in Variable Handling Charge. If the Variable Handling Type is FIXED_AMOUNT, this element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place.
EstimatedCharges / VariableHandling / TotalCustomerCharge
ALL ALL xs:decimal 18.2 Contains Shipper’s discounted Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 127 127
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / VariableHandling / ListTotalCustomer Charge
ALL ALL xs:decimal 18.2 Contains Shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling Charge Amount. Will contain piece level or shipment level dependent on the Variable Handling Charge Level element. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal place.
EstimatedCharges / VariableHandling / MultiweightVariable HandlingCharge
FDXG ALL xs:decimal 7.2 Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal.
EstimatedCharges / VariableHandling / MultiweightTotal CustomerCharge
FDXG ALL xs:decimal 18.2 Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 128 128
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / OversizeClass FDXG ALL xs:string Required. Valid values:
1 = A package weighing less than 30 lbs. and measuring more than 84" but equal to or less than 108" in combined length and girth will be classified by FedEx Ground as an Oversize 1 (OS1) package. The transportation charges for an Oversize 1 (OS1) package will be the same as a 30-lb. package being transported under the same circumstances. 2 = A package weighing less than 50 lbs. and measuring more than 108" but equal to or less than 130" in combined length and girth will be classified by FedEx Ground as an Oversize 2 (OS2) package. The transportation charges for an Oversize 2 (OS2) package will be the same as a 50-lb. package being transported under the same circumstances. 3 = A package weighing 150 lbs. or less and measuring more than 130" but equal to or less than 165" in combined length and girth will be classified by FedEx Ground as an Oversize 3 (OS3) package. The transportation charges for an Oversize 3 (OS3) package will be based on the greater of the package's actual rounded weight or a 90-lb. minimum billable weight. An additional oversize charge will be assessed on any package measuring more than 130" in length and girth.
COD
COD / CollectionAmount FDXE USD xs:decimal 10.2 Format: Two explicit decimals (e.g.5.00). The COD cash amount (after any accumulations) that must be collected upon delivery of a package shipped using the COD special service.
COD / Handling FDXE USD xs:string 21 The handling information for the COD Return package.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 129 129
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
COD / Service TypeDescription FDXE USD xs:string 35 A textual description of the Service. The text for each type of Service is subject to change without notice and thus may be displayed or printed, but not relied on for automated decision-making.
COD / Packaging Description FDXE USD xs:string 35 A textual description of the Packaging. The text for each type of Packaging is subject to change without notice and thus may be displayed or printed, but not relied on for automated decision-makingl.
COD / Secured Description FDXE USD xs:string 32 Valid values : • Secured • Unsecured For Express, the value of GuaranteedFunds = Secured. For all others, the value = Unsecured.
ROUTING
Routing / UrsaRouting Code FDXE ALL xs:string 8 URSA routing code returned for all U.S. Domestic shipments. Applicable to a limited number of International countries for International shipping.
Routing / Service Commitment FDXE ALL xs:string 2 The code representing the service commitment. Applicable to a limited number of International countries for International shipping.
Routing / DeliveryDay FDXE ALL xs:string 3 Day of week on which package will be delivered. Applicable to a limited number of International countries for International shipping.
Routing / Destination StationID FDXE ALL xs:string 4 Applicable to a limited number of International countries for International shipping.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 130 130
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
Routing / Delivery Date FDXE ALL xs:string 7 Date on which package will be delivered in DDMMMYY format. Applicable to a limited number of International countries for International shipping.
Routing / CODReturn ServiceCommitment
FDXE USD xs:string 2 Service commitment code for COD return payment. Returned only for COD Express shipments. Returned only in the Reply for the last piece of a multiple-piece shipment.
Routing / UrsaPrefixCode FDXE ALL xs:string 2 Applicable to a limited number of International countries for International shipping.
LABELS
Labels / OutboundLabel ALL ALL xs:base64 Binary
The label for the package. Returned only in FDXShipReply transaction if the label was requested.
Labels / CODReturnLabel FDXE FDXG
USDALL
xs:base64 Binary
Label for COD Return payment. Returned only in FDXShipReply transaction representing the final piece of a FedEx Express COD shipment.
SignatureOption ALL ALL xs:string 21 Optional. Effective Delivery Signature Option. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT Note: This option may differ from that requested due to other characteristics of the shipment.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 131 131
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
IneligibleForMoneyBackGuarantee ALL CAN xs:boolean If true or 1, iIndicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 132 132
Example of FDXShipReply XML Document (U.S. Domestic Express)
In response to the previous FDXShipRequest, your FDXShipReply would be formatted as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>US Ship</CustomerTransactionIdentifier> </ReplyHeader> <Tracking> <TrackingNumber>470012923511</TrackingNumber> <FormID>0201</FormID> </Tracking> <ServiceTypeDescription>PRIORITY OVERNIGHT</ServiceTypeDescription> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>00241</RateScale> <RateZone>7</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>17.45</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <Surcharges> <Fuel>0.96</Fuel> </Surcharges> <TotalSurcharge>0.96</TotalSurcharge> <NetCharge>18.41</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> <Routing> <UrsaRoutingCode>XHJEMA</UrsaRoutingCode>
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 133 133
<ServiceCommitment>A1</ServiceCommitment> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>OAK</DestinationStationID> <DeliveryDate>19MAY03</DeliveryDate> <UrsaPrefixCode>XH</UrsaPrefixCode> </Routing> <Labels> <OutboundLabel>iVBOR...</OutboundLabel> </Labels> </FDXShipReply>
If the FDXShipRequest had contained an error or a server error occurred, an error message number and message text would have been included in the FDXShipReply. If the destination state abbreviation in the example had been invalid, FedEx would respond with the following FDXShipReply:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>US Ship</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>17069</Code> <Message>Invalid Destination State</Message> </Error> </FDXShipReply>
XML Transaction Layouts: FDXShipDeleteRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 134 134
FDXShipDeleteRequest
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL ALL xs:integer 12 Required. The Sender’s FedEx account number.
RequestHeader / MeterNumber ALL ALL xs:integer 10 Required. The meter number associated with the designated shipment to be deleted.
RequestHeader / CarrierCode ALL ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
TrackingNumber ALL ALL xs:string 20 Required. Tracking number assigned to a package.
NOTE:
When shipping with FedEx Ground, you cannot delete a shipment once a Close operation has been performed.
When shipping with FedEx Express, you must delete a shipment prior to the end of business.
XML Transaction Layouts: FDXShipDeleteRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 135 135
Example of FDXShipDelete Request After placing an order, your customer called to cancel. Since you have already processed the shipping transaction for this order, you will need to delete the package from your shipping log. To delete the shipment properly, you will create a FDXShipDeleteRequest. Your iFDXShipDeleteRequest is formatted as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <TrackingNumber>470012923511</TrackingNumber> </FDXShipDeleteRequest>
XML Transaction Layouts: FDXShipDeleteReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 136 136
FDXShipDeleteReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code ALL ALL xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message ALL ALL xs:string 120 Returned only if an error occurred while processing the transaction.
XML Transaction Layouts: FDXShipDeleteReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 137 137
Example of FDXShipDeleteReply Transaction
In response to the previous FDXShipDeleteRequest, the following Reply is returned:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> </FDXShipDeleteReply>
If the FDXShipDeleteRequest had contained an error or a server error had occurred, an error message number and message text would have been included in the FDXShipDeleeReply. If the meter number in the example had been invalid, FedEx would respond with the following Reply:
<?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>32785</Code> <Message>Invalid meter number – non-numeric in string</Message> </Error> </FDXShipDeleteReply>
XML Transaction Layouts: FDXCloseRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 138
FDXCloseRequest (Applicable to FedEx Ground only)
This service allows a customer to Close out all shipments made for the day. Closing is a function to be used only for FedEx Ground shipments. Customers cannot cancel any shipments once they are closed out. However, shipments can be added to a day's shipment after a Close has been performed and multiple Closes can be performed in a day.
The transaction begins when a customer sends a Request to Close out their shipment. The FDXCloseReply transaction includes the text buffer to produce the FedEx Ground Close Manifest.
Element Name Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber xs:integer 12 Required. The FedEx account number associated with the FedEx Ground shipments being closed out.
RequestHeader / MeterNumber xs:integer 10 Required. The meter number associated with the FedEx Ground shipments being closed out.
RequestHeader / CarrierCode xs:string 4 Required. Valid carrier code is FDXG for FedEx Ground.
Date xs:date 10 Required for closing out a FedEx Ground shipping cycle. The Date and Time elements used together specify the time up to which unclosed shipments are to be closed. This element is only used when ReportOnly is not true.
XML Transaction Layouts: FDXCloseRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 139
Element Name Data Type
Max Length Element Description/Requirements
Time xs:time 8 Required for closing out a FedEx Ground shipping cycle. The Date and Time elements used together specify the time up to which unclosed shipments are to be closed. This element is only used when ReportOnly is not true.
ReportOnly xs:boolean Optional. Value = true or 1 if requesting all manifests from the last 3 days’ Closes. For example, if you failed to print your Close Manifest, and you might need the Manifest Data re-sent to you. Value = false or 0 if closing out a shipment cycle and creating the manifest and multiweight, hazmat and COD reports, when applicable. A default value of false or 0 is assumed if this element is not passed in the Request transaction.
ReportIndicator xs:string 10 This element is used only when ReportOnly is true, to indicate which report(s) from the last three days are to be returned. Only one type of report can be returned per Request. Valid values:
MANIFEST – Ground Manifest Report HAZMAT – Ground Hazardous Materials Report COD – Ground COD report MULTIWEIGHT – Ground Multiweight Report
XML Transaction Layouts: FDXCloseRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 140
Example of FDXCloseRequest XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXCloseRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Ground Close</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <Date>2004-10-14</Date> <Time>19:30:00</Time> </FDXCloseRequest>
If an additional copy of a report is needed for previously closed Ground shipments, a Close Request should be submitted with the REPORT ONLY flag set. Please review the following sample of a REPORT ONLY Close Request.
<?xml version="1.0" encoding="UTF-8" ?> <FDXCloseRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Ground COD Report</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <Date>2004-10-14</Date> <Time>19:30:00</Time> <ReportOnly>true</ReportOnly> <ReportIndicator>COD</ReportIndicator> </FDXCloseRequest>
XML Transaction Layouts: FDXCloseReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 141
FDXCloseReply (Applicable to FedEx Ground only)
Reply to the Close Request Transaction. The Close Reply brings back the ASCII Data Buffer which will used by the customer to print the Close Manifest. The Manifest is essential at time of pickup.
Element Name Data Type
Max Length Element Description/Requirements
REPLY
ReplyHeader / CustomerTransactionIdentifier xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message xs:string 120 Returned only if an error occurred while processing the transaction.
MultiweightReport xs:base64Binary
This buffer will contain the multiweight report for FedEx Ground multiweight shipments.
Manifest / FileName xs:string 255 File names of the Manifest(s) to be printed by the customer. (ASCII files) Multiple FedEx Ground manifests may be returned in a single transaction. There is no specific limit on the number of HazMat Certificates returned from a single ReportOnly Request.
Manifest / File xs:base64Binary
Content (ASCII data) of a manifest.
HazMatCertificate xs:base64Binary
This buffer will contain the Hazardous Materials certification report for FedEx Ground Hazmat shipments. There is no specific limit on the number of HazMat Certificates returned from a single ReportOnly Request.
CODReport xs:base64Binary
This buffer will contain the COD report for FedEx Ground COD shipments.
XML Transaction Layouts: FDXCloseReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 142
Example of FDXCloseRequest XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXCloseReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground Close</CustomerTransactionIdentifier> </ReplyHeader> <Manifest> <FileName>010208890000067</FileName> <File>ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBGRURFWCBHUk9VTkQgUElDSy1VUCBNQU5JRkVTVCAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIEZlZEV4IFNlcnZpY2VzICAgICAgICAgICAgICAgICAgICAgICAgICBGZWRFeCBHcm91bmQgU2hpcHBlciAjOiAwMjUwMDAyICAgICAgICAgICAgICAgICAgICAgICAgRGF0ZTogMTAvMTUvMjAwNCAgIAogMzkyNSBFbWJhc3N5IFBrd3kgICAgICAgICAgICAgICAgICAgICAgIEZlZEV4IEFjY291bnQgIzogMTI4MzY1NzQ1ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAybmQgRmxvb3IgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIEFrcm9uLCBPSCA0NDMzMyAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBQYWdlOiAxICAgICAgIAogIAotLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgICAgICAgICAgICAgICAgIHwgQ09EICAgICAgIHwgRGVjbC4gVmFsLiB8IE92ZXJzaXplICB8IE92ZXJzaXplICB8IE92ZXJzaXplICB8IEFkZCdsICAgICB8ICAgICAgICB8ICAgICAgICAgICAgIAogVHJhY2tpbmcgIyAgICAgICAgfCBBbW91bnQgICAgfCAoaWY+JDEwMCkgIHwgICAgIEkgICAgIHwgICAgSUkgICAgIHwgICAgSUlJICAgIHwgSGFuZGxpbmcgIHwgQS5PLkQuIHwgUmVzaWRlbnRpYWwgCiAtLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiAgICBUb3RhbCBQYWNrYWdlczogICAgMCAgICAgICAgICAgICAwICAgICAgICAgICAwICAgICAgICAgIDAgICAgICAgICAgICAwICAgICAgICAgIDAgICAgICAgICAgICAwICAgICAgICAgIDAgICAgICAKICAKLS0tL</File> </Manifest> </FDXCloseReply>
XML Transaction Layouts: FDXCloseReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 143
The following is an example of a Ground Close Report:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCloseReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground COD Report</CustomerTransactionIdentifier> </ReplyHeader> <CODReport>ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIENPRCBSRVBPUlQgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiBDVVNUT01FUiBOQU1FICA6IFNDT1RUICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIFNISVAgREFURSA6IDEwLzE0LzIwMDQgICAKIEFERFJFU1MgMSAgICAgIDogMzkyNSBFTUJBU1NZIFBLV1kgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIEFDQ09VTlQgTlVNQkVSIDogMTI4MzY1NzQ1ICAgIAogQUREUkVTUyAyICAgICAgOiAyTkQgRkxPT1IgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiBDSVRZLFNUQVRFLFpJUCA6IEFLUk9OLE9ILDQ0MzMzICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIFBIT05FIE5VTUJFUiAgIDogMzMwNjY1NDYyMiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiBUUkFDSyBOTyAgICAgICAgICAgICAgICBDT01QIE5NICBBRERSRVNTICAgICAgICBDSVRZICAgICAgU1QgIFpJUCAgICBQSCMgICAgICAgICAgQ09EIFRZUEUgIENPRCBSRVQgQU1UICBDSEFSR0VTICAKIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0gIC0tLS0tLS0gIC0tLS0tLS0tLS0tLS0gIC0tLS0tLS0tICAtLSAgLS0tLS0gIC0tLS0tLS0tLS0gICAtLS0tLS0tLSAgLS0tLS0tLS0tLS0gIC0tLS0tLS0tLQogTk8gQ09EIFBBQ0tBR0VTIFNISVBQRUQgRFVSSU5HIFRISVMgQ0xPU0UgQ1lDTEUgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBQQUdFOiAxICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQog</CODReport> </FDXCloseReply>
XML Transaction Layouts: FDXTrackRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 144
FDXTrackRequest
When sending a shipment tracking Request to the FedEx servers, there is information that the server requires before it will process the Request. The following elements can be sent to the FedEx server in order to track by number or track by reference:
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a tracking response.
RequestHeader / MeterNumber ALL ALL xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a tracking response.
RequestHeader / CarrierCode ALL ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express Tracking Requests FDXG – FedEx Ground Tracking Requests
PACKAGEIDENTIFIER Any one of several kinds of identifier for which all packages will be tracked.
PackageIdentifier / Value ALL ALL xs:string 40 Required. An identifier that relates to one or more packages (or to the shipments of which they are part).
XML Transaction Layouts: FDXTrackRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 145
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PackageIdentifier / Type ALL ALL xs:string Required. The type of the identifier. Some identifiers apply to a single package, while others apply to multiple packages or shipments. Valid values: • TRACKING_NUMBER_OR_DOORTAG • EXPRESS_MPS_MASTER • EXPRESS_REFERENCE • GROUND_PO • GROUND_CUSTOMER_REFERENCE • GROUND_INVOICE_NUMBER • GROUND_SHIPMENT_ID • RMA
ShipDateRangeBegin ALL ALL xs:date Optional, but recommended. If provided, EndDateRange is required. Recommend entry of date range to find desired track number. If not provided, results may vary.
ShipDateRangeEnd ALL ALL xs:date Optional, but recommended. If provided, StartDateRange is required. Recommend entry of date range to find desired track number. If not provided, results may vary.
ShipDate ALL ALL xs:date Optional, but recommended. The date in which the package was shipped. Should not be a future date or a date that is more than 90 days in the past. Ship date +/-5 days is allowed.
DestinationCountryCode FDXE ALL xs:string 2 Optional, but recommended.
XML Transaction Layouts: FDXTrackRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 146
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
DetailScans ALL ALL xs:boolean Optional. If = false or 0 – returns Summary/Profile data, which includes one single scan structure with the most recent scan. If = true or 1 – return Detail Scan Activity (multiple scan structure) for each package.
PagingToken ALL ALL xs:string Variable Optional. Required in order to obtain additional data on second and subsequent TrackShipmentRequest transactions when more related tracking numbers exist that exceed the capacity of any one response structure. Applicable to Track By Reference, MPS, and Door Tag. This element should be absent from any first Track Request. It is only populated if the response results are in more than one page worth of data. If paging token contains value in first Reply, more tracking data exists. You should populate this element with the value returned in the previous transaction.
XML Transaction Layouts: FDXTrackRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 147
Example of FDXTrackRequest XML Document
In order to track a package you have shipped via FedEx, the courier must scan the package before the package information has been entered into the FedEx database. If you have a package that has been scanned, you can track that package by formatting your tracking Request as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXTrackRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance“ xsi:noNamespaceSchemaLocation="FDXTrackRequest.xsd">
<RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <PackageIdentifier> <Value>String</Value> <Type>TRACKING_NUMBER_OR_DOORTAG</Type> </PackageIdentifier> <ShipDateRangeBegin>1967-08-13</ShipDateRangeBegin> <ShipDateRangeEnd>1967-08-13</ShipDateRangeEnd> <ShipDate>1967-08-13</ShipDate> <DestinationCountryCode>AA</DestinationCountryCode> <DetailScans>1</DetailScans> <PagingToken>String</PagingToken> </FDXTrackRequest>
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 148
FDXTrackReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code ALL ALL xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message ALL ALL xs:string 120 Returned only if an error occurred while processing the transaction.
MoreDataFlag ALL ALL xs:boolean Value of true or 1 indicates that more data exists. Returned when more Reply data is available.
PagingToken ALL ALL xs:string Variable Returned for Track by Reference, MPS, Door Tag only when more related tracking numbers exists that exceed the capacity of a single response. Only populated if the response results in more than one page worth of data. Client should populate paging token value in subsequent TrackShipmentRequest transactions with the value returned in the previous TrackShipmentResponse.
TRACKPROFILE The TrackingProfile element will contain the Requested tracking activity for one tracking number.
TrackProfile / TrackingNumber / ALL ALL xs:string 20 Tracking number provided in the Request. Note: Door tag will never be returned in the response.
TrackProfile / SoftError
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 149
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
TrackProfile / SoftError / Type ALL ALL xs:string 25 Returned only if a soft error/warning message is available. Valid values: • WARNING • INFORMATIONAL
TrackProfile / SoftError / Code ALL ALL xs:string 8 Returned only if a soft error/warning message is available.
TrackProfile / SoftError / Message ALL ALL xs:string 255 Returned only if a soft error/warning message is available.
TrackProfile / CarrierCode ALL ALL xs:string 4 Specifies the particular carrier the package was shipped. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
TrackProfile / OtherIdentifierCount ALL ALL xs:integer Optional. Count of other identifiers related to this package returned in this Reply. If not present, count is zero.
TRACKPROFILE / OTHERIDENTIFIER Another identifier that is related to this package.
TrackProfile / OtherIdentifier / Value ALL ALL xs:string 40 Required. An identifier that relates to one or more packages (or to the shipments of which they are part).
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 150
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
TrackProfile / OtherIdentifier / Type ALL ALL xs:string Required. The type of the identifier. Some identifiers apply to a single package, while others apply to multiple packages or shipments. Valid values: • TRACKING_NUMBER_OR_DOORTAG • EXPRESS_MPS_MASTER • EXPRESS_REFERENCE • GROUND_PO • GROUND_CUSTOMER_REFERENCE • GROUND_INVOICE_NUMBER • GROUND_SHIPMENT_ID • IPD
TrackProfile / ShipDate ALL ALL xs:date 10 Date on which package was tendered to FedEx.
TrackProfile / EstimatedDelivery Date ALL ALL xs:date 10 Projected package delivery date based on ship date, service, and destination.
TrackProfile / EstimatedDelivery Time ALL ALL xs:time 10 Projected package delivery time based on ship date, service, and destination.
TRACKPROFILE / DESTINATIONADDRESS Destination Address Information
TrackProfile / DestinationAddress / City
ALL ALL xs:string FDXE-35FDXG-20
Name of the city to which the shipment is destined.
TrackProfile / DestinationAddress / StateOrProvince Code
ALL ALL xs:string 2 State or province code to which the shipment is destined.
TrackProfile / DestinationAddress / PostalCode
ALL ALL xs:string 16 Returned if Recipient Country Code is US or CA.
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 151
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
TrackProfile / DestinationAddress / CountryCode
ALL ALL xs:string 2 Name of the country to which the shipment is destined.
TrackProfile / DeliveredDate ALL ALL xs:date 10 Date when the package was delivered at destination.
TrackProfile / DeliveredTime ALL ALL xs:time Time when the package was delivered at destination.
TrackProfile / SignedForBy ALL ALL xs:string 25 Signature of person who signed for packages, or relative location at which package was left, such as Front Desk or Back Door.
TrackProfile / DeliveredLocation Code
FDXE ALL xs:string Pairs with DeliveredLocation Description element. Returned upon successful Reply only.
TrackProfile / DeliveredLocation Description
FDXE ALL xs:string 25 Relative location at which ackage was left, such as Front Desk or Back Door. Pairs with Delivered LocationCode element. Returned upon successful Reply only.
TrackProfile / Service ALL ALL xs:string 70 String describing services type.
TrackProfile / Weight ALL ALL xs:decimal 6.1 Gross weight of the individual package. Format: One explicit decimal position (e.g. 5.0).
TrackProfile / WeightUnits ALL ALL xs:string 3 Valid values: • KGS • LBS
TrackProfile / PackagingDescription FDXE ALL xs:string 20 Description of packaging type of this package. Returned upon successful Reply for only.
TrackProfile / ReattemptDate FDXE ALL xs:date 10 Returned if Delivery Reattempt was made or a future delivery was scheduled.
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 152
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
TrackProfile / ReattemptTime FDXE ALL xs:time 10 Returned if Delivery Reattempt was made or a future delivery was scheduled.
TrackProfile / PackageSequence Number
FDXE INTL xs:string 4 Package sequence number of package in multiple-piece shipment. Returned upon successful Reply for FedEx Express International Only.
TrackProfile / PackageCount ALL ALL xs:string 4 Count of packages in multiple-piece shipment.
TrackProfile / FedExURL FDXE ALL xs:string A URL containing the tracking number that can be used to track this package via www.fedex.com.
TRACKPROFILE / SCAN Scan Data from package movement through the FedEx system.
TrackProfile / Scan / Date ALL ALL xs:date 10 Date when the scan was performed on package.
TrackProfile / Scan / Time ALL ALL xs:time 10 Time when the scan was performed on package. Local time where scan occurred.
TrackProfile / Scan / ScanType ALL ALL xs:string 3 Carrier’s scan code pairs with the description (e.g. DEX, PUP, HAL, etc.). For FedEx Ground, a value ‘=’ indicates Exception, Scan description is blank.
TrackProfile / Scan / ScanDescription ALL ALL xs:string 80 Literal description of the scan activity.
TrackProfile / Scan / StatusExceptionCode
ALL ALL xs:string 2 Further defines the Scan Type Code’s specific type (e.g. DEX08 business closed). This element pairs with the StatusExceptionDescription.
TrackProfile / Scan / StatusException Description
FDXE ALL xs:string 40 The most recent status exception is returned if applicable. This element pairs with StatusExceptionCode.
TrackProfile / Scan / City ALL ALL xs:string 35 Name of the city where the shipment received scan.
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 153
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
TrackProfile / Scan / StateorProvinceCode
ALL ALL xs:string 2 State or province code where the shipment received scan.
TrackProfile / Scan / CountryCode ALL ALL xs:string 2 Returned if Recipient Country Code is US or CA. Country where the shipment received scan.
TrackProfile / Scan / HoldAtLocationAddress
FDXE ALL xs:string 35 This element will be populated when the most recent scan activity is a HAL scan. This element will not be populated if the package has been delivered. All other data will appear in the Scan Location elements if the scan is a HAL. These elements will appear just like other scans in the package history, regardless if delivered yet or not.
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 154
Example of FDXTrackReply XML Document
In response to the previous FDXTrackRequest, your FDXTrackReply is formatted as follows:
<?xml version="1.0" encoding="UTF-8"?><FDXTrackReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXTrackReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>FDXTrack</CustomerTransactionIdentifier> </ReplyHeader> <MoreData>false</MoreData> <TrackProfile> <TrackingNumber>643133236401</TrackingNumber> <CarrierCode>FDXE</CarrierCode> <OtherIdentifierCount>1</OtherIdentifierCount> <OtherIdentifier> <Value>V6.8 USER GUIDE AND TCR</Value> <Type>EXPRESS_REFERENCE</Type> </OtherIdentifier> <ShipDate>2004-01-21</ShipDate> <DestinationAddress> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38301</PostalCode> <CountryCode>US</CountryCode> </DestinationAddress> <DeliveredDate>2004-01-22</DeliveredDate> <DeliveredTime>09:53</DeliveredTime> <SignedForBy>A.HODGES</SignedForBy> <DeliveredLocationCode>1</DeliveredLocationCode> <DeliveredLocationDescription>Receptionist/Front Desk</DeliveredLocationDescription> <Service>Priority Pak</Service> <Weight>3.0</Weight> <WeightUnits>LBS</WeightUnits> <FedExURL>http://fedex.com/Tracking?action=track&language=english&cntry_code=us&initial=x&tracknumbers=643133236401</
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 155
FedExURL> <ScanCount>6</ScanCount> <Scan> <Date>2004-01-22</Date> <Time>09:53</Time> <ScanType>20</ScanType> <ScanDescription>Delivered</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>07:34</Time> <ScanType>11</ScanType> <ScanDescription>On FedEx vehicle for delivery</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>06:39</Time> <ScanType>02</ScanType> <ScanDescription>Arrived at FedEx Destination Location</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>03:41</Time> <ScanType>10</ScanType>
XML Transaction Layouts: FDXTrackReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 156
<ScanDescription>Left FedEx Sort Facility</ScanDescription> <City>MEMPHIS</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>01:34</Time> <ScanType>10</ScanType> <ScanDescription>Left FedEx Sort Facility</ScanDescription> <City>MEMPHIS</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-21</Date> <Time>18:44</Time> <ScanType>08</ScanType> <ScanDescription>Picked up by FedEx</ScanDescription> <City>CORDOVA</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> </TrackProfile> </FDXTrackReply>
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 157
FDXSPODRequest
When sending a shipment Signature Proof of Delivery (SPOD) Request to the FedEx servers, there is information that the server requires before it will process the Request. The following elements can be sent to the FedEx server to obtain a Signature Proof of Delivery:
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL USD & CA
xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL USD & CA
xs:integer 12 The FedEx account number of the Sender is required to successfully receive a SPOD response.
RequestHeader / MeterNumber ALL USD & CA
xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a SPOD response.
RequestHeader / CarrierCode ALL USD & CA
xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate ALL USD & CA
xs:date 10 Optional for Ground Requests only. For all Express Requests, a ship date is required.
TrackingNumber ALL USD & CA
xs:string 20 Required.
LanguageCode ALL USD & CA
xs:string 2 Code indicating language of SPOD letter. One of the following package types is required:
EN – English FR – French (Canadian)
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 158
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
CONFIGURABLEGROUNDCONSIGNEE Information to be substituted for recipient information in letter.
ConfigurableGroundConsignee / PersonName
FDXG USD & CA
xs:string 35 Optional. Name to be placed as recipient in the SPOD letter.
ConfigurableGroundConsignee / CompanyName
FDXG USD & CA
xs:string 35 Optional. Name to be placed as recipient company name in the SPOD letter.
CONFIGURABLEGROUNDCONSIGNEE / ADDRESS / Optional. Address to be shown as recipient address in the SPOD letter.
ConfigurableGroundConsignee / Address / Line1
FDXG USD & CA
xs:string 35 Optional if Sender Country Code is US or CA.
ConfigurableGroundConsignee / Address / Line2
FDXG USD & CA
xs:string 35 Optional if Sender Country Code is US or CA.
ConfigurableGroundConsignee / Address / City
FDXG USD & CA
xs:string FDXE-35 FDXG-20
Optional if Sender Country Code is US or CA.
ConfigurableGroundConsignee / Address / StateOrProvinceCode
FDXG USD & CA
xs:string 2 Optional if Sender Country Code is US or CA.
ConfigurableGroundConsignee / Address / PostalCode
FDXG USD & CA
xs:string 16 Optional. Must be numeric for U.S. Valid characters: A-Z; 0-9; a-z
ConfigurableGroundConsignee / Address / CountryCode
FDXG USD & CA
xs:string 2 Optional if Sender Country Code is US or CA.
ConfigurableGroundConsignee / MoreInformation
FDXG USD & CA
xs:string 30 Optional.
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 159
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
ReturnLetterFormat ALL USD & CA
xs:string 3 Required if FaxLetter is not selected. Format of SPOD letter to be returned in Reply. Value = PNG.
FAXLETTER Information pertaining to letter to be faxed. Presence of this element indicates the Request for a fax.
FaxLetter / RecipientName ALL USD & CA
xs:string 35 Required. Name of recipient of fax.
FaxLetter / RecipientFaxNumber ALL USD & CA
xs:string 16 Required. Fax machine phone number to which fax will be sent. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
FaxLetter / SenderName FDXE USD & CA
xs:string 35 Required. Name to show as sender of fax.
FaxLetter / SenderPhoneNumber FDXE USD & CA
xs:string 16 Required. Voice phone number of fax sender. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
FAXLETTER / MAILRECIPIENT Recipient name and postal address to which letter can be sent if fax fails.
FaxLetter / MailRecipient / RecipientName
FDXG USD & CA
xs:string 35 Required. Name of recipient.
FAXLETTER / MAILRECIPIENT / ADDRESS Address of the Recipient of the SPOD.
FaxLetter / MailRecipient / Address / Line1
FDXG USD & CA
xs:string 35 Required.
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 160
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
FaxLetter / MailRecipient / Address / Line2
FDXG USD & CA
xs:string 35 Optional.
FaxLetter / MailRecipient / Address / City
FDXE USD & CA
xs:string FDXE-35 FDXG-20
Required.
FaxLetter / MailRecipient / Address / StateOrProvince
FDXE USD & CA
xs:string 2 Required if Sender Country Code is US or CA.
FaxLetter / MailRecipient / Address / PostalCode
FDXG USD & CA
xs:string 16 Required. Must be numeric for U.S. Valid characters: A-Z; 0-9; a-z
FaxLetter / MailRecipient / Address / CountryCode
FDXG USD & CA
xs:string 2 Required.
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 161
Example of FDXSPODRequest XML Document
In order to track a package you have shipped via FedEx, the courier must scan the package before the package information has been entered into the FedEx database. If you have a package that has been scanned, you can track that package by formatting your tracking Request as follows:
<?xml version="1.0" encoding="UTF-8" ?> <FDXSPODRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSPODRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>1967-08-13</ShipDate> <TrackingNumber>String</TrackingNumber> <LanguageCode>EN</LanguageCode> <ConfigurableGroundConsignee> <PersonName>String</PersonName> <CompanyName>String</CompanyName> <Address> <Line1>String</Line1> <Line2>String</Line2> <City>String</City> <StateOrProvinceCode>AA</StateOrProvinceCode> <PostalCode>A</PostalCode> <CountryCode>AA</CountryCode> </Address> <MoreInformation>String</MoreInformation> </ConfigurableGroundConsignee> <ReturnLetterFormat>PNG</ReturnLetterFormat> </FDXSPODRequest>
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 162
FDXSPODReply
Element Name Data Types
Max Length
Element Description/Requirements
REPLY
ReplyHeader / CustomerTransactionIdentifier xs:string 40 Optional. Returned if the customer included a unique transaction identifier in the Request transaction, containing the same value.
ERROR Recipient name and postal address to which letter can be sent if fax fails.
Error / Code xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message xs:string 120 Returned only if an error occurred while processing the transaction.
Letter xs:base64Binary
SPOD Letter in base64-encoded format.
FaxConfirmationNumber xs:string 20 Fax confirmation number for fax.
Example of FDXSPODReply XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXSPODReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSPODReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>SPODRequest</CustomerTransactionIdentifier> </ReplyHeader> <Letter>iVBORw0KGgoAAAANSUhEUgAABJAAAAV4BAMAAAANnjpBAAAAKlBMVEUAAAD///9jAJz/YwDWxq3OtbXGrb3OtZTWtZTWpYzGpbW1nLXGpZS9ra3hhK8gAAAgAElEQVR4nO2di9mrNta2lzqQ9lQw6SDX18JuIS1MC2nhbyEtTAtpYVpIL/+2tE4SYGxY2GA/d7L92hhxELeFTkhUAAiA3n0A4DOASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBIoEQIBIIASKBEP4/X18gx3reVOYAAAAASUVORK5CYII=</Letter> </FDXSPODReply>
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 163
Sample Signature Proof of Delivery (SPOD) Letter
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 164
FDXServiceAvailabilityRequest (Express Only)
The FDXServiceAvailabilityRequest is used to determine which FedEx Express services are available between a given origin and destination. To check the availability of one particular FedEx service and packaging type, include elements Service and Packaging in the Request transaction. Only information regarding that single service and packaging type will be returned in the FDXServiceAvailabilityRequest transaction. To obtain a list of all available services for a certain origin and destination, omit elements Service and Packaing from the Request. The Reply will contain information on every available service.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
FDXE ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber FDXE ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a Service Availability response.
RequestHeader / MeterNumber FDXE ALL xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a Service Availability response.
RequestHeader / CarrierCode FDXE ALL xs:string 4 Required. Valid value:
FDXE – FedEx Express
ORIGINADDRESS
OriginAddress / StateOrProvinceCode
FDXE ALL xs:string 2 Required only if Sender Country Code is US or CA. Represents the state or province from which the shipment will be originating.
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 165
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
OriginAddress / PostalCode FDXE ALL xs:string 16 Required only if Sender Country Code is US or CA. May be required for other postal-aware countries. Represents the postal code from which the shipment will be originating. Valid characters: A-Z; 0-9; a-z
OriginAddress / CountryCode FDXE ALL xs:string 2 Required. Represents the country from which the shipment will be originating.
DESTINATIONADDRESS
DestinationAddress / StateOrProvinceCode
FDXE ALL xs:string 2 Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined.
DestinationAddress / PostalCode FDXE ALL xs:string 16 Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
DestinationAddress / CountryCode FDXE ALL xs:string 2 Required. Represents the country code to which the shipment is destined.
ShipDate FDXE ALL xs:date 10 Optional. The date in which the package will be shipped. Should not be a past date or a date that is more than 10 days in the future. Defaults to current system date if not present.
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 166
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
PackageCount FDXE ALL xs:positive integer
4 Required for multiple-piece shipments. For International Freight MPS shipments, this is the total number of “units.” Units are the skids, pallets, or boxes that make up a freight shipment. Each unit within a shipment should have its own label. For MPS shipments, 1 piece = 1 box. Valid values: 1 – 999
Service FDXE ALL xs:string 28 One of the following FedEx Services is optional: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY If provided, only that service’s estimated charges will be returned.
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 167
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Packaging FDXE ALL xs:string 13 One of the following package types is required: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING If value entered in this element is FEDEXENVELOPE, FEDEX10KGBOX, or FEDEX25KGBOX, an MPS rate quote is not allowed.
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 168
Example of FDXServiceAvailabilityRequest XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXServiceAvailabilityRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXServiceAvailability.xsd"> <RequestHeader> <AccountNumber /> <MeterNumber /> </RequestHeader> <OriginAddress> <PostalCode>38125</PostalCode> <CountryCode>US</CountryCode> </OriginAddress> <DestinationAddress> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </DestinationAddress> <ShipDate>2005-03-27</ShipDate> <PackageCount /> </FDXServiceAvailabilityRequest>
XML Transaction Layouts: FDXServiceAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 169
FDXServiceAvailabilityReply (Express Only)
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / Customer Transaction Identifier
FDXE ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code FDXE ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or server failure, the error code will be placed in this element.
Error / Message FDXE ALL xs:string 120 Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
ENTRY
Entry / Service FDXE ALL xs:string 35 FedEx service(s) available for the Requested origin/destination pairing. There may be up to 22 occurrences of the Entry grouping representing available services available.
ENTRY / PACKAGING
Entry / DeliveryDate FDXE USD xs:date 10 In regards to International services, the delivery date availability is limited to some postal supported countries. The delivery date will be returned if available.
Entry / DeliveryDay FDXE USD xs:string 3 Day of week: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal supported countries. The delivery date will be returned if available.
Entry / DestinationStationID FDXE USD xs:string 5 FedEx location identifier of the package destination.
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 170
FDXFedExLocatorRequest
FedEx Locator allows a search to be performed for the nearest FedEx location through the API Gateway Server. FedEx Locator retrieves a set of FedEx or FedEx-approved locations in proximity to a given address or telephone and is limited to a maximum of ten locations returned with in a 50-mile radius.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a Station Location Information.
RequestHeader / MeterNumber ALL ALL xs:integer 10 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a Station Location Information.
BeginningRecordIndex ALL ALL xs:integer 3 Optional. The index of first location to be returned from among all matching locations
MaximumMatchCount ALL ALL xs:positive integer
2 Optional. Maximum number of locations to be returned. Maximum count allowed is 25. Defaults to 10.
LanguageCode ALL USD xs:string 2 Optional. Defaults to EN. Valid values:
EN – English FR – French
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 171
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
DistanceUnits ALL ALL xs:NMTOKEN
2 Optional. Units in which Distance to location is to be expressed. Valid values:
MI indicates miles KM indicates kilometers
PhoneNumber ALL ALL xs:string 35 Optional if an address is not provided. Phone number for which nearby FedEx locations are to be found.
StreetAddressOrIntersection ALL ALL xs:string 35 Required if phone number is not provided. Street address or intersection for which nearby FedEx locations are to be found.
City ALL ALL xs:string 35 Required. The city of the address which the search is being done against.
StateOrProvinceCode ALL ALL xs:string 2 Required. The address's state or province code. Required only if Recipient Country Code is US or CA.
PostalCode ALL ALL xs:string 16 Required only if Recipient Country Code is US or CA. May be required for other postal-aware countries. The address's postal code. Valid characters: A-Z; 0-9; a-z
CountryCode ALL USD / CA
xs:NMTOKEN
2 Optional. Defaults to US. The address's country code. Valid values:
US for United States CA for Canada
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 172
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
FedExStaffed ALL USD xs:boolean Optional. Value = true or 1 if FedEx Staffed locations should be included in the response.
FedExSelfService FDXE USD xs:boolean Optional. Value = true or 1 if FedEx self-service locations should be included in the response.
FedExAuthorizedShipping Center
ALL USD xs:boolean Optional. Value = true or 1 if FedEx Authorized Shipping Centers should be included in the response.
HoldAtLocation FDXE ALL xs:boolean Optional. Value = true or 1 means that only those locations that support Hold at Location are to be included.
LatestExpressDropoff FDXE USD xs:boolean Optional. Value = true or 1 means that only the location with the latest Express drop-off time of those fitting the supplied critera is to be returned.
ExpressDropOffAfterTime FDXE USD xs:time 8 Optional. Value = true or 1 means that only those locations open after this time are to be included in the response.
DangerousGoods FDXE USD xs:boolean Optional. Value = true or 1 means that only those locations that accept Express shipments containing hazardous materials are to be included in the response.
SaturdayService FDXE USD xs:boolean Optional. Value = true or 1 means that only those locations open on Saturdays are to be included in response.
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 173
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Ground ALL USD xs:boolean Optional. Value = true or 1 means that only those locations that accept FedEx Ground shipments are to be included in response.
PackagingSupplies ALL USD xs:boolean Optional. Value = true or 1 means that only those locations that make packaging supplies available are to be included in the response.
PackingServices ALL USD xs:boolean Optional. Value = true or 1 means that only those locations that provide Pack and Ship services are to be included in response.
ReturnSystem ALL USD xs:boolean Optional. Value = true or 1 means that only those locations that support the FedEx Return System are to be included in response.
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 174
Example of FDXFedExLocatorRequest XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXFedExLocatorRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXFedExLocatorRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Locator Request</CustomerTransactionIdentifier> <AccountNumber>0000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> </RequestHeader> <BeginningRecordIndex>5</BeginningRecordIndex> <MaximumMatchCount>5</MaximumMatchCount> <LanguageCode>EN</LanguageCode> <DistanceUnits>MI</DistanceUnits> <PhoneNumber>8004833339</PhoneNumber> <StreetAddressOrIntersection>10 Fedex ParkWay</StreetAddressOrIntersection> <City>Memphis</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> <FedExStaffed>true</FedExStaffed> <LatestExpressDropoff>true</LatestExpressDropoff> </FDXFedExLocatorRequest>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 175
FDXFedExLocatorReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader /CustomerTransaction Identifier
ALL ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code ALL ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element.
Error / Message ALL ALL xs:string 120 Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
LOCATION A location matching the criteria provided in the FedExLocatorRequest. Can get up to 10 different FedEx locations.
Location / BusinessName ALL USD xs:string 35 Required. The name of the business at this location.
Location / BusinessID ALL USD xs:string Required. Identifier that can be used by IVR attendant to look up directions to location.
Location / BusinessType ALL USD xs:string 35 Required. A textual description of the type of business, such as "FedEx Authorized Ship Center.”
Location / StreetAddressOrIntersection
ALL USD xs:string 35 Optional. Either a street address (e.g. "123 S. Main St.") or an intersection (e.g. "Elm Ave. at S. Main St.).
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 176
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Location / City ALL USD xs:string 35 Required. The address' city.
Location / StateOrProvinceCode ALL USD xs:string 2 Required. The address' state or province code.
Location / PostalCode ALL ALL xs:string 16 Required. The address' postal code. Valid characters: A-Z; 0-9; a-z
Location / HoldAtLocation FDXE USD xs:boolean Optional. Value = true or 1 if this location offers HAL (Hold at Location) service.
Location / ExpressService FDXE ALL xs:boolean Optional. Value = true or 1 if this location offers FedEx Express service.
Location / GroundService FDXG USD xs:boolean Optional. Value = true or 1 if this location offers FedEx Ground services.
Location / DangerousGoods FDXE USD xs:boolean Optional. Value = true i or 1 f this location will accept Hazardous Materials.
Location / Distance ALL USD xs:string 15 Required. Distance of this location from the point indicated by the search criteria (e.g. "12.5 mi").
Location / HoursWeekdays ALL USD xs:string 35 Required. This location's weekday hours of operation (e.g. "9:00 AM - 6:45 PM").
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 177
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Location / HoursSaturdays ALL USD xs:string 35 Required. This location's weekday hours of operation (e.g. "9:00 AM - 6:45 PM" or "No Sat pickup").
Location / LastExpressDropoffTimeWeekdays
ALL USD xs:string 35 Required. The time of day on weekdays by which FedEx Express packages must be dropped off for shipment that day (e.g. "5:00 PM").
Location / LastExpressDropoffTimeSaturdays
ALL USD xs:string 35 Required. The time of day on Saturdays by which FedEx Express packages must be dropped off for shipment that day (e.g. "5:00 PM").
Location / LastGroundDropoffTimeWeekdays
ALL USD xs:string 35 Required. The time of day on weekdays by which FedEx Ground packages must be dropped off for shipment that day (e.g. "5:00 PM").
Location / LastGroundDropoffTimeSaturdays
ALL USD xs:string 35 Required. The time of day on Saturdays by which FedEx Ground packages must be dropped off for shipment that day (e.g. "5:00 PM").
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 178
Example of FDXFedExLocatorReply XML Document <?xml version="1.0" encoding="UTF-8" ?> <FDXFedExLocatorReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXFedExLocatorReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Locator Request</CustomerTransactionIdentifier> </ReplyHeader> <Location> <BusinessID>HKAB</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>1016 W Poplar Ste 105</StreetAddressOrIntersection> <City>Collierville</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <HoldAtLocation>true</HoldAtLocation> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>1.8 miles</Distance> <HoursWeekdays>8:00 AM-10:00 PM</HoursWeekdays> <HoursSaturdays>10:00 AM-5:00 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>10:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>5:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>5:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>5</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>79390</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>1130 N Germantown Pkwy</StreetAddressOrIntersection>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 179
<City>Cordova</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38018</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>9.3 miles</Distance> <HoursWeekdays>12:01 AM-11:59 PM</HoursWeekdays> <HoursSaturdays>12:01 AM-11:59 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>9:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>6</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>NQAKK</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>6165 Stage Rd</StreetAddressOrIntersection> <City>Bartlett</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38134</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>13.9 miles</Distance> <HoursWeekdays>7:00 AM-11:00 PM</HoursWeekdays> <HoursSaturdays>7:00 AM-11:00 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>9:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 180
<RecordIndex>7</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>OLVK</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>1573 Union Ave</StreetAddressOrIntersection> <City>Memphis</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38104</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>17.6 miles</Distance> <HoursWeekdays>12:01 AM-11:59 PM</HoursWeekdays> <HoursSaturdays>12:01 AM-11:59 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>8:30 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>8</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>79676</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>7570 Poplar Ave</StreetAddressOrIntersection> <City>Germantown</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38138</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>6.4 miles</Distance>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 181
<HoursWeekdays>7:00 AM-11:00 PM</HoursWeekdays> <HoursSaturdays>9:00 AM-10:00 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>8:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>9</RecordIndex> </Location> <AvailableRecordsCount>13</AvailableRecordsCount> </FDXFedExLocatorReply>
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 182
FDXEmailLabelRequest
A FedEx Email/Online Label is sent directly to the return shipper without exposing the FedEx customers account information. Returns shippers print labels from their own printer using an application on fedex.com, place the label on the package, and drop-off or request pickup. Cancellations are handled via Cancel E-mail Label Request.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader/CustomerTransactionIdentifier
ALL USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader/AccountNumber ALL USD xs:string 9 The FedEx account number of the Sender is required to successfully receive an E-mail Label.
RequestHeader/MeterNumber ALL USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive an E-mail Label.
RequestHeader/CarrierCode ALL USD xs:string 4 Valid values: • FDXE • FDXG
URLExpirationDate ALL USD xs:date 10 Required. Format: YYYY-MM-DD
URLNotificationE-MailAddress ALL USD xs:string 120 Required.
URLNotificationE-MailMessage ALL USD xs:string Optional.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 183
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
MerchantPhoneNumber ALL USD xs:string 16 Required. The phone number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
ResidentialPickup FDXG USD xs:boolean Value = true or 1 only if pickup location is residential.
DropoffType FDXE USD xs:string Method by which customer tenders package, which might or might not be a drop-off. Valid values: • REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICECENTER • STATION
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 184
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Service ALL USD xs:string Valid values: • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITYFREIGHT • INTERNATIONALECONOMYFREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
Packaging ALL USD xs:string Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KBOX • YOURPACKAGING
WeightUnits ALL USD xs:string 3 Valid values: • LBS • KGS Note: This does NOT pertain to Dry Ice.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 185
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
CurrencyCode ALL USD xs:string 3 Optional.
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName ALL ALL xs:string 35 Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / CompanyName ALL ALL xs:string 35 Required if the sender contact name is not passed in the transaction. Company from which the shipment is originating. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / Department ALL ALL xs:string 10 Optional. Name of the department from which the shipment is originating.
Origin / Contact / PhoneNumber ALL ALL xs:string 16 Required. The phone number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 186
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Origin / Contact / PagerNumber ALL ALL xs:string 16 Optional. The pager number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Origin / Contact / FaxNumber ALL ALL xs:string 16 Optional. The fax number of the person initiating the shipment. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Origin / Contact / E-MailAddress ALL ALL xs:string FDXE-120
FDXG-35
Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.
ORIGIN / ADDRESS
Origin / Address / Line1 ALL ALL xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 ALL ALL xs:string 35 Optional. Secondary address line from which the shipment is originating.
Origin / Address / City ALL ALL xs:string FDXE-35 FDXG-20
Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 187
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Origin / Address / StateOrProvinceCode
ALL ALL xs:string 2 Required for shipping only if Country Code is US or CA. State code from which the shipment is originating.
Origin / Address / PostalCode ALL ALL xs:string 16 Required for shipping only if Country Code is US or CA. May be required for other postal-aware countries when shipping internationally. Postal code from which the shipment is originating. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Origin / Address / CountryCode ALL ALL xs:string 2 Required. Name of the country from which the shipment is originating.
DESTINATION
DESTINATION / CONTACT
Destination / Contact / PersonName ALL ALL xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. Name of the person to whom the shipment is destined. If passed in the transaction, a minimum of 3 alpha characters must be passed.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 188
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Destination / Contact / CompanyName ALL ALL xs:string 35 Required if Recipient Contact Name was not passed in the Request transaction. Name of the company to whom the shipment is destined. If entered, a minimum of 3 alpha characters must be passed.
Destination / Contact / Department ALL ALL xs:string 10 Optional. Name of the department to whom the shipment is destined.
Destination / Contact / PhoneNumber ALL ALL xs:string 16 Required. Phone number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Destination / Contact / PagerNumber ALL ALL xs:string 16 Optional. Pager number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
Destination / Contact / FaxNumber ALL ALL xs:string 16 Optional. Fax number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 189
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Destination / Contact / E-mailAddress
ALL ALL xs:string FDXE-120
FDXG-35
Optional. E-mail address for the contact person to whom the shipment is destined.
DESTINATION / ADDRESS
Destination / Address / Line1 ALL ALL xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 ALL ALL xs:string 35 Optional. Secondary address line to which the shipment is destined.
Destination / Address / City ALL ALL xs:string FDXE-35 FDXG-20
Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed.
Destination / Address / StateOrProvince Code
ALL ALL xs:string 2 Required only if Recipient Country Code is US or CA, or if SED applies and country is MX. State or province code to which the shipment is destined.
Destination / Address / PostalCode ALL ALL xs:string 16 Required only if Recipient Country Code is US or CA.May be required for other postal-aware countries. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
Destination / Address / CountryCode ALL ALL xs:string 2 Required. Name of the country to which the shipment is destined.
PAYMENT
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 190
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Payment/PayorType ALL USD xs:string Required. Valid values: • SENDER • RECIPIENT • THIRDPARTY • COLLECT
PAYMENT / PAYOR
Payment/Payor/AccountNumber ALL USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment/Payor/CountryCode FDXE INTL xs:string Optional.
SPECIALSERVICES
SpecialServices / HoldAtLocation / Address / Line1
FDXE ALL xs:string 16 Required only if Hold At Location. Street address for the location where the shipment is being held.
SpecialServices / HoldAtLocation / Address / Line2
FDXE ALL xs:string 35 Secondary street address for the location where the shipment is being held.
SpecialServices / HoldAtLocation / Address / City
FDXE ALL xs:string 35 Required only if Hold At Location. City name of the location where the shipment is being held.
SpecialServices / HoldAtLocation / Address / StateOr ProvinceCode
FDXE ALL xs:string 2 Required only if Hold At Location and country is US or CA. State or province code of the location where the shipment is being held.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 191
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SpecialServices / HoldAtLocation / Address / PostalCode
FDXE ALL xs:string 16 Required only if Hold At Location and country is US or CA. Postal code for the location where the shipment is being held. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
SpecialServices/HoldAtLocation/ Address/CountryCode
ALL ALL xs:sting 2 [A-Z]{2}
SpecialServices / ResidentialDelivery FDXG FDXE
ALL USD
xs:boolean If = true or 1, the shipment is Residential Delivery, else false or 0. If Recipient Address is in a rural area, additional charge will be applied.
SpecialServices/ InsidePickup FDXE USD xs:boolean If = true or 1, the shipment is originated from an inside pickup area. Applicable to freight shipping only.
SpecialServices / InsideDelivery FDXE USD xs:boolean If = true or 1, the shipment is traveling to an inside delivery area. Applicable to freight shipping only.
SpecialServices / SaturdayPickup FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday pickup.
SpecialServices / SaturdayDelivery FDXE ALL xs:boolean If = true or 1, the shipment is scheduled for Saturday delivery.
SPECIALSERVICES / EMAILNOTIFICATION
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 192
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SpecialServices / EMailNotification / ShipAlertFaxNumber
FDXG ALL xs:string 16 Required for shipment notification by fax. Shipment notification by fax number and e-mail notification address cannot both be selected for the same shipment Request transaction. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.
SpecialServices / EMailNotification / ShipAlertOptional Message
ALL ALL xs:string 120 Optional. Customer specified message to be included in the shipment notification.
SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER
SpecialServices / EMailNotification / Shipper / ShipAlert
FDXE ALL xs:boolean Required for ShipAlert Notification to the shipper. When Requesting a ShipAlert in ship Request transaction, sender’s e-mail address, recipient’s e-mail address, broker’s e-mail address, or E-mail Notification Address must be used in conjunction with the ShipAlert elements for shipment notification via e-mail. If = true or 1, Sender’s E-mail Address will be e-mailed ShipAlert e-mail.
SpecialServices / EMailNotification / Shipper / Delivery Notification
FDXE ALL xs:boolean Required for Delivery Notification to the shipper. If = true or 1, Sender’s E-mail Address will be e-mailed Delivery Notification e-mail.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 193
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SpecialServices / EMailNotification / Shipper / Language Code
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for shipper e-mail address. Defaults to EN (English). Valid language codes:
EN – English FR – French
SPECIALSERVICES / EMAILNOTIFICATION / RECIPIENT
SpecialServices / EMailNotification / Recipient / ShipAlert
FDXE ALL xs:boolean Required for ShipAlert Notification to the recipient. If = true or 1, Recipient’s E-mail Address will be e-mailed ShipAlert e-mail.
SpecialServices / EMailNotification / Recipient / DeliveryNotification
FDXE ALL xs:boolean Required for Delivery Notification to the recipient. If = true or 1, Recipient E-mail Address will be e-mailed Delivery Notification e-mail.
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for recipient e-mail address. Defaults to EN (English). Valid language codes:
EN – English FR – French
SPECIALSERVICES / EMAILNOTIFICATION / OTHER
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 194
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SpecialServices / EMailNotification / Other / E-mailAddress
ALL ALL xs:string FDXE-120
FDXG-35
For FDXE: A minimum of one occurrence is required if shipment notification or delivery notification is selected. A maximum of three occurrences is allowed for FedEx Express shipments for ShipAlert or Delivery Alert Notification. For FDXG: One occurrence is required if shipment notification is selected and ShipAlert fax number is not included in the Request transaction. Delivery Notification is not supported for FDXG. Shipment notification by e-mail address and fax number cannot both be selected for the same shipment Request transaction.
SpecialServices / EMailNotification / Other / ShipAlert
ALL ALL xs:boolean Required for ShipAlert. If = true or 1, corresponding e-mail address will be e-mailed ShipAlert. For FDXE: Maximum of three occurrences allowed for FedEx Express shipments. For FDXG: One occurrence allowed for FedEx Ground shipments.
SpecialServices / EMailNotification / Other / Delivery Notification
FDXE ALL xs:boolean Required for Delivery Notification. If = true or 1, corresponding e-mail address will be e-mailed delivery notification. Maximum of three occurrences allowed for FedEx Express shipments.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 195
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SpecialServices / EMailNotification / Other / LanguageCode
FDXE ALL xs:string 2 Optional for Delivery Notification. Applies to Delivery Alert for corresponding e-mail address. Maximum of three occurrences allowed for FedEx Express shipments. Defaults to EN (English). Valid language codes:
EN – English FR – French
SpecialServices / SignatureRelease FDXE USD xs:string 10 Release Authorization Number. Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.
HOMEDELIVERY
HomeDelivery / Instructions FDXG USD xs:string 74 Optional. Applicable only to FedEx Home Delivery shipments.
BlockShipmentData FDXE USD xs:boolean If = true or 1, means block all but sender from seeing shipment content data.
RMA Return Merchant Authorization
RMA / Number FDXE USD xs:string 20 Return Merchant Authorization that is assigned by the sender.
PACKAGE
Package / Weight ALL USD xs:decimal 6.1 Required. The weight of the package.
PACKAGE / DIMENSIONS
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 196
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Package / Dimensions / Length ALL ALL xs:non negative integer
3 Optional, but recommended if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The length of the package.
Package / Dimensions / Width ALL ALL xs:non negative integer
3 Optional, but recommended if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The width of the package.
Package / Dimensions / Height ALL ALL xs:non negative integer
3 Optional, but recommended if “Your Packaging” is used as Packaging Type. Required only if a FedEx Express heavyweight service is selected for the shipment. The height of the package.
PACKAGE / DECLAREDVALUE
Package / DeclaredValue ALL ALL xs:decimal 8.2 Optional for a U.S. Domestic, International dutiable Express, and Ground shipments. This element is not applicable to an International PIB (document) Express shipment. The declared value of package contents. This value cannot exceed the total customs value for an International shipment. For Express International MPS, Master piece should contain the total declared value/carriage value, with no declared value/carriage value in Child pieces. For example, piece 1 of n pieces will have the total declared value/carriage value of all the pieces.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 197
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
PACKAGE / DRYICE
Package / DryIce / WeightUnits FDXE ALL xs:string 3 Valid values: • LBS • KGS
Package / DryIce / Weight FDXE ALL xs:decimal 4.1
Package / NonStandardContainer FDXG USD xs:boolean
PACKAGE / REFERENCEINFO
Package / ReferenceInfo / CustomerReference
ALL USD xs:string 40 Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by reference. Note: In a FedEx Ground Request, the content of this element will be truncated to 30 characters.
Package / ReferenceInfo / PONumber FDXG USD xs:sting 30 Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by PONumber.
Package / ReferenceInfo / InvoiceNumber
FDXG USD xs:sting 30 Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by InvoiceNumber.
Package / ItemDescription ALL USD xs:string 80 Description of contents within package being shipped.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 198
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Package / SignatureOption ALL ALL xs:sting Optional. Specifies one of the Delivery Signature Options. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 199
Example of FDXEmailLabelRequest XML Document The following is an example of the Request transaction format for the creation of an Email Label:
<?xml version="1.0" encoding="UTF-8" ?> <FDXEmailLabelRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXEmailLabelRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>E-Mail Label Request</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <URLExpirationDate>2004-10-31</URLExpirationDate> <URLNotificationE-MailAddress>[email protected]</URLNotificationE-MailAddress> <MerchantPhoneNumber>8004633339</MerchantPhoneNumber> <Service>FEDEX2DAY</Service> <Packaging>YOURPACKAGING</Packaging> <WeightUnits>LBS</WeightUnits> <CurrencyCode>USD</CurrencyCode> <Origin> <Contact> <PersonName>WAPI Sender Contact</PersonName> <CompanyName>Test Sender Company</CompanyName> <PhoneNumber>8004633339</PhoneNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>Test Sender Address Line 1</Line1> <Line2>Test Sender Address Line 2</Line2> <City>Test Sender City</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38107</PostalCode> <CountryCode>US</CountryCode>
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 200
</Address> </Origin> <Destination> <Contact> <PersonName>FedEx Customer</PersonName> <CompanyName>Test Recipient Company</CompanyName> <PhoneNumber>8004633339</PhoneNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>Test Recipient Address Line 1</Line1> <Line2>Test Recipient Address Line 2</Line2> <City>Test Recipient City</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38115</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> <Payor> <AccountNumber>123456789</AccountNumber> </Payor> </Payment> <DimensionsUnits>IN</DimensionsUnits> <RMA> <Number>RMA45678901234567890</Number> </RMA> <Package> <Weight>1.0</Weight> <DeclaredValue>100.00</DeclaredValue> <ReferenceInfo> <CustomerReference>ShipAlert Test</CustomerReference>
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 201
</ReferenceInfo> <ItemDescription>Books</ItemDescription> </Package> <SpecialServices> <EMailNotification> <ShipAlertOptionalMessage>This is a email Return Label Message</ShipAlertOptionalMessage> <Shipper> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Shipper> <Recipient> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Recipient> <Other> <E-MailAddress>[email protected]</E-MailAddress> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Other> </EMailNotification> </SpecialServices>
</FDXEmailLabelRequest>
XML Transaction Layouts: FDXEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 202
FDXEmailLabelReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
ALL USD xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code ALL USD xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element.
Error / Message ALL USD xs:string 120 Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.
URL ALL USD xs:string
URL of web page at which labels can be found. Required if Error is not returned.
UserID ALL USD xs:string
User ID to be used to manually access the URL of web page at which labels can be found. Required if Error is not returned.
Password ALL USD xs:string
Password to be used to manually access the URL of web page at which labels can be found. Required if Error is not returned.
RequestTimeStamp ALL USD xs:Time Optional.
PACKAGE A location matching the criteria provided in the FedExLocatorRequest. Can get up to 10 different FedEx locations.
Package / TrackingNumber ALL USD xs:string 20 Package tracking number. Required if Error is not returned.
Package / FormID FDXE USD FormID 4 Required if Error is not returned.
XML Transaction Layouts: FDXEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 203
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
SignatureOption ALL ALL xs:string Optional. Effective Delivery Signature Option. Valid values: • DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT Note: This option may differ from that requested due to other characteristics of the shipment.
XML Transaction Layouts: FDXEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 204
Example of FDXEmailLabelReply XML Document
The following is an example of the Reply transaction format for Requests regarding the creation of an E-mail Label:
<?xml version="1.0" encoding="UTF-8" ?> <FDXEMailLabelReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXEMailLabelReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier> E-Mail Label Request </CustomerTransactionIdentifier> </ReplyHeader> <URL>https://wwwtest.fedex.com/OnlineLabel/pLogin.jsp?labelUserCdDesc=TestSender&labelPasswordDesc=843qy3</URL> <UserID>TestSender</UserID> <Password>843qy3</Password> <Requestimestamp>20041008T160634</Requestimestamp> <Package> <TrackingNumber>470026028478</TrackingNumber> <FormID>0223</FormID> </Package> </FDXEMailLabelReply>
XML Transaction Layouts: FDXCancelEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 205
FDXCancelEmailLabelRequest
This transaction cancels an Email Label Request. This transaction will be invalid if customer has already generated the label.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTrans actionIdentifier
ALL USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber ALL USD xs:string 9 The FedEx account number of the Sender is required to successfully cancel the E-mail Label Request.
RequestHeader / MeterNumber ALL USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully cancel the E-mail Label Request.
RequestHeader / CarrierCode ALL USD xs:string 4 Valid values: • FDXE • FDXG
TrackingNumber ALL USD xs:string Required. Tracking number of E-mail Label/shipment to be deleted.
XML Transaction Layouts: FDXCancelEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 206
Example of FDXCancelEmailLabelRequest XML Document
The following is an example of the Request transaction format for the cancellation of an E-mail Label:
<?xml version="1.0" encoding="UTF-8" ?> <FDXEmailLabelRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelEmailLabelRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Cancel E-Mail Label Request</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <TrackingNumber>470026028478</TrackingNumber> </FDXEmailLabelRequest>
XML Transaction Layouts: FDXCancelEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 207
FDXCancelEmailLabelReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader/CustomerTransaction Identifier
ALL USD xs:string 40 Optional. Returned containing the same value if the customer included information for this element in the Request transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error/Code ALL USD xs:string 8 Required if error. Error code returned when a transaction fails.
Error/Message ALL USD xs:string 120 Required if error. Error message returned when a transaction fails.
XML Transaction Layouts: FDXCancelEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 208
Example of FDXCancelEmailLabelReply XML Document
The following is an example of the Reply transaction format for Requests regarding the cancellation of an E-mail Label:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelEmailLabelReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelEmailLabelReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Cancel E-Mail Label Request</CustomerTransactionIdentifier> </ReplyHeader> </FDXCancelEmailLabelReply>
If the input transaction had contained an error, an error message number and message text would have been included in the transaction Reply. For example, if the account information was not accurate, the response transaction would be:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelEmailLabelReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelEmailLabelReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Cancel E-Mail Label Request</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>61521</Code> <Message>FedEx Logon service error.</Message> </Error> </FDXCancelEmailLabelReply>
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 209
FDXExpressTagRequest
The FedEx Express Tag return label combines the delivery of the Express label with the pickup function. This transaction will dispatch a FedEx driver with a label to the location specified in the transaction. Upon arrival, the driver will pick up the parcel using the label they have with them. Service areas for this service are limited and should be checked using FDXExpressTagAvailibilityRequest. Cancellations are handled via FDXCancelExpressTagRequest.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransactionIdentifier
FDXE USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / Account Number
FDXE USD xs:string 9 The FedEx account number of the Sender is required to successfully Request an Express Tag.
RequestHeader / MeterNumber FDXE USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully Request an Express Tag.
RequestHeader / Carrier Code FDXE USD xs:string 4 Valid value: FDXE
DispatchDate FDXE USD xs:date Required. Format: YYYY-MM-DD
LatestPickupTime FDXE USD xs:time Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
ReadyTime FDXE USD xs:time Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 210
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName FDXE USD xs:string 35 Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / CompanyName FDXE USD xs:string 35 Required if the sender contact name is not passed in the transaction. Company from which the shipment is originating. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / Department FDXE USD xs:string 10 Optional. Name of the department from which the shipment is originating.
Origin / Contact / PhoneNumber FDXE USD xs:string 16 Required. The phone number of the person initiating the shipment. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
Origin / Contact / PagerNumber FDXE USD xs:string 16 Optional. The pager number of the person initiating the shipment. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 211
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Origin / Contact / FaxNumber FDXE USD xs:string 16 Optional. The fax number of the person initiating the shipment. The maximum length is 10 for U.S. and CA Do not include embedded special characters.
Origin / Contact / E-MailAddress FDXE USD xs:string 120 Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.
ORIGIN / ADDRESS
Origin / Address / Line1 FDXE USD xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 FDXE USD xs:string 35 Optional. Secondary address line from which the shipment is originating.
Origin / Address / City FDXE USD xs:string 35 Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
Origin / Address / StateOrProvinceCode FDXE USD xs:string 2 Required. State code from which the shipment is originating.
Origin / Address / PostalCode FDXE USD xs:string 16 Required. Postal code from which the shipment is originating. Must be numeric and no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 212
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Origin / Address / CountryCode FDXE USD xs:string 2 Required. Name of the country from which the shipment is originating.
DESTINATION
DESTINATION / CONTACT
Destination / Contact / PersonName FDXE USD xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. COD service is selected. Name of the person to whom the shipment is destined. if passed in the transaction, a minimum of 3 alpha characters must be passed.
Destination / Contact / CompanyName FDXE USD xs:string 35 Required if Recipient Contact Name was not passed in the Request transaction. Name of the company to whom the shipment is destined. If entered, a minimum of 3 alpha characters must be passed.
Destination / Contact / Department FDXE USD xs:string 10 Optional. Name of the department to whom the shipment is destined.
Destination / Contact / PhoneNumber FDXE USD xs:string 16 Required. Phone number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 213
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Destination / Contact / PagerNumber FDXE USD xs:string 16 Optional. Pager number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
Destination / Contact / FaxNumber FDXE USD xs:string 16 Optional. Fax number for the contact person to whom the shipment is destined. The maximum length is 10 for U.S. and CA, Do not include embedded special characters.
Destination / Contact / E-mailAddress
FDXE USD xs:string 120 Optional. E-mail address for the contact person to whom the shipment is destined.
DESTINATION / ADDRESS
Destination / Address / Line1 FDXE USD xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 FDXE USD xs:string 35 Optional. Secondary address line to which the shipment is destined.
Destination / Address / City FDXE USD xs:string 35 Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed.
Destination / Address / StateOrProvince Code
FDXE USD xs:string 2 Required. State or province code to which the shipment is destined.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 214
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Destination / Address / PostalCode FDXE USD xs:string 16 Required. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
Destination / Address / CountryCode FDXE USD xs:string 2 Required. Name of the country to which the shipment is destined.
PAYMENT
Payment / PayorType FDXE USD xs:string Required. Valid values: • SENDER • RECIPIENT • THIRDPARTY • COLLECT
PAYMENT / PAYOR
Payment / Payor / AccountNumber FDXE USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment / Payor / CountryCode FDXE USD xs:string Optional.
RMA Return Merchant Authorization Information
RMA/Number FDXE USD xs:string 20 Required if RMA element is included. Return Merchant Authorization number provided by the sender.
CourierInstructions FDXE USD xs:string 60 Optional. Instruction to courier.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 215
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
CustomerReference FDXE USD xs:string 30 Optional. Customer reference information.
CurrencyCode FDXE USD xs:string 3 Optional. Required if DeclaredValue is present
Service FDXE USD xs:string Required. Valid values: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER
Packaging FDXE USD xs:string Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • YOURPACKAGING
WeightUnits FDXE USD xs:string 3 Required. Valid values: • LBS • KGS
Weight FDXE USD xs:integer 9 Required. Weight of the entire shipment.
DeclaredValue FDXE USD xs:integer 10 Optional. Declared value of entire shipment. Defaults to zero.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 216
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
PackageCount FDXE USD xs:integer 1 Required for multipiece shipment. Valid values are 1 thru 5.
SPECIALSERVICES
SpecialServices/HoldAtLocation FDXE USD xs:boolean Optional.
SpecialServices/ResidentialDelivery FDXE USD xs:boolean Optional.
SpecialServices/SaturdayDelivery FDXE USD xs:boolean Optional.
SpecialServices/NonIndirectDelivery FDXE USD xs:boolean Optional. If = true or 1, indirect delivery is not allowed. Prevents an "indirect" delivery, which will not allow for a completed delivery to an address or location other than the address on the airbill. FedEx does not offer a "restricted delivery" service and may deliver to someone other than the person named as the recipient.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 217
Example of FDXExpressTagRequest XML Document
The following is an example of the Request transaction format for an Express Tag:
<?xml version="1.0" encoding="UTF-8" ?> FDXExpressTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXExpressTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Express Tag Test</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>0101010</MeterNumber> </RequestHeader> <DispatchDate>2004-10-12</DispatchDate> <LatestPickupTime>16:00:00</LatestPickupTime> <ReadyTime>12:00:00</ReadyTime> <Origin> <Contact> <CompanyName>Sender Company</CompanyName> <PhoneNumber>9015559999</PhoneNumber> </Contact> <Address> <Line1>1350 Merry Circle</Line1> <City>Anytown</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38138</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <CompanyName>Recipient Company</CompanyName> <PhoneNumber>8005559999</PhoneNumber> </Contact> <Address>
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 218
<Line1>400 W. Arbor Ave.</Line1> <City>Ypsilanti</City> <StateOrProvinceCode>MI</StateOrProvinceCode> <PostalCode>48197</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> </Payment> <RMA> <Number>1234567</Number> </RMA> <CourierInstructions>Do it right!</CourierInstructions> <CustomerReference>MyRef</CustomerReference> <CurrencyCode>USD</CurrencyCode> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>12</Weight> <DeclaredValue>13</DeclaredValue> <PackageCount>2</PackageCount> <SpecialServices> <HoldAtLocation>false</HoldAtLocation> <ResidentialDelivery>false</ResidentialDelivery> <SaturdayDelivery>false</SaturdayDelivery> <NoIndirectDelivery>false</NoIndirectDelivery> </SpecialServices> </FDXExpressTagRequest>
XML Transaction Layouts: FDXExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 219
FDXExpressTagReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Requirements
REPLYHEADER
ReplyHeader/Customer TransactionIdentifier
FDXE USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error/Code FDXE USD xs:string 8 Optional. Returned only if an Error has occurred.
Error/Message FDXE USD xs:string 40 Optional. Returned only if an Error has occurred.
DispatchConfirmationNumber FDXE USD xs:string 30 Required. Also known as Pickup Confirmation Number or Dispatch Number.
Location FDXE USD xs:string 5 Express Location Identifier.
AccessTime FDXE USD xs:time 10 The latest time at which the package must become available for pickup; the earliest that the courier will show up for the packages. Format: HH:MM:SS
CutoffTime FDXE USD xs:time 10 The earliest time at which the package can become unavailable for pickup; the latest that the courier will show up for the packages. Format: HH:MM:SS
XML Transaction Layouts: FDXExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 220
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Requirements
DeliveryCommitmentDate FDXE USD xs:date 10 The date by which FedEx commits to deliver the package to the recipient if it is tendered on the Dispatch Date. Format: YYYY-MM-DD
DeliveryCommitmentTime FDXE USD xs:time 10 The time on the DeliveryCommitmentDate by which FedEx commits to deliver the package to the recipient if it is tendered on the Dispatch Date. Format: HH:MM:SS
TrackingNumber FDXE USD xs:string 16 The package tracking number.
XML Transaction Layouts: FDXExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 221
Example of FDXExpressTagReply XML Document
The following is an example of the Reply transaction format for Requests regarding the creation of an Express Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>Express Tag Test</CustomerTransactionIdentifier> </ReplyHeader> <DispatchConfirmationNumber>00001</ConfirmationNumber> <Location>HKAA</Location> <AccessTime>02:00:00</AccessTime> <CutoffTime>21:00:00</CutoffTime> <DeliveryCommitmentDate>2004-10-13</DeliveryCommitmentDate> <DeliveryCommitmentTime>15:00:00</DeliveryCommitmentTime> <TrackingNumber>301000658338</TrackingNumber> </FDXExpressTagReply>
XML Transaction Layouts: FDXCancelExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 222
FDXCancelExpressTagRequest
This transaction cancels and Express Tag Request. This transaction is only valid until driver is dispatched. Erroneous Requests should be canceled as soon as possible.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader/CustomerTransactionIdentifier
FDXE ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber FDXE ALL xs:string 9 The FedEx account number of the Sender is required to successfully receive cancel an Express Tag Request.
RequestHeader / Meter Number
FDXE ALL xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully cancel an Express Tag Request.
DispatchConfirmationNumber FDXE ALL xs:string 30 Required. Otherwise known as Pickup Confirmation Number.
Location FDXE ALL xs:string 5 Express Location Identifier.
DispatchDate FDXE ALL xs:date 10 The date FedEx was scheduled to pick up the shipment. Format: YYYY-MM-DD
XML Transaction Layouts: FDXCancelExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 223
Example of FDXCancelExpressTagRequest XML Document
The following is an example of the Request transaction format for the cancellation of an Express Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelExpressTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelExpressTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>1001001</MeterNumber> </RequestHeader> <DispatchConfirmationNumber>00001</ConfirmationNumber> <Location>HKAA</Location> <DispatchDate>2004-10-12</DispatchDate> </FDXCancelExpressTagRequest>
XML Transaction Layouts: FDXCancelExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 224
FDXCancelExpressTagReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader/CustomerTransaction Identifier
FDXE ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error/Code FDXE ALL xs:string 8 Optional. Returned only if an Error has occurred.
Error/Message FDXE ALL xs:string 40 Optional. Returned only if an Error has occurred.
XML Transaction Layouts: FDXCancelExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 225
Example of FDXCancelExpressTag Reply XML Document
If the input transaction had contained an error, an error message number and message text would have been included in the transaction Reply. For example, if the dispatch/confirmation number was not valid, the response transaction would be:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelExpressTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelExpressTagReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>ExpressTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>20553</Code> <Message>No Dispatch found for this account.</Message> </Error> </FDXCancelExpressTagReply>
The following is an example of the Reply transaction format for Requests regarding the cancellation of an Express Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelExpressTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=" FDXCancelExpressTagReply.xsd "> <ReplyHeader> <CustomerTransactionIdentifier>ExpressTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> </FDXCancelExpressTagReply>
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 226
FDXGroundCallTagRequest
The FedEx Ground Call Tag return label combines the delivery of the Ground label with the pickup function. This transaction will dispatch a FedEx driver with a label to the location specified in the transaction. Upon arrival, the driver will pick up the parcel using the label they have with them. Cancellations are handled via FDXCancelGroundCallTagRequest.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransactionIdentifier
FDXG USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber FDXG USD xs:string 9 The FedEx account number of the Sender is required to successfully Request a Ground Call Tag.
RequestHeader / Meter Number
FDXG USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully Request a Ground Call Tag.
RequestHeader / Carrier Code FDXG USD xs:string 4 Valid value: FDXG
DispatchDate FDXG USD xs:date Required. Format: YYYY-MM-DD
LatestPickupTime FDXG USD xs:time Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
ReadyTime FDXG USD xs:time Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 227
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
ResidentialPickup FDXG USD xs:boolean Optional. Defaults to false; true only if pickup location is residential.
ResidentialDelivery FDXG USD xs:boolean Optional.
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName FDXG USD xs:string 35 Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / CompanyName FDXG USD xs:string 35 Required if the sender contact name is not passed in the transaction. Company from which the shipment is originating. If included in the transaction, a minimum of 3 alpha characters must be passed.
Origin / Contact / Department FDXG USD xs:string 10 Optional. Name of the department from which the shipment is originating.
Origin / Contact / PhoneNumber FDXG USD xs:string 16 Required. The phone number of the person initiating the shipment. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
Origin / Contact / PagerNumber FDXG USD xs:string 16 Optional. The pager number of the person initiating the shipment. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 228
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Origin / Contact / FaxNumber FDXG USD xs:string 16 Optional. The fax number of the person initiating the shipment. The maximum length is 10 for U.S. and CA. Do not include embedded special characters.
Origin / Contact / E-MailAddress FDXG USD xs:string 35 Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.
ORIGIN / ADDRESS
Origin / Address / Line1 FDXG USD xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 FDXG USD xs:string 35 Optional. Secondary address line from which the shipment is originating.
Origin / Address / City FDXG USD xs:string 20 Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
Origin / Address / StateOrProvinceCode
FDXG USD xs:string 2 Required. State code from which the shipment is originating.
Origin / Address / PostalCode FDXG USD xs:string 16 Required. Postal code from which the shipment is originating. Must be numeric and no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Origin / Address / CountryCode FDXG USD xs:string 2 Required. Name of the country from which the shipment is originating.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 229
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
DESTINATION
DESTINATION / CONTACT
Destination / Contact / PersonName FDXG USD xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. COD service is selected. Name of the person to whom the shipment is destined. If passed in the transaction, a minimum of 3 alpha characters must be passed.
Destination / Contact / CompanyName
FDXG USD xs:string 35 Required if Recipient Contact Name was not passed in the Request transaction. Name of the company to whom the shipment is destined. If entered, a minimum of 3 alpha characters must be passed.
Destination / Address
Destination / Address / Line1 FDXG USD xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 FDXG USD xs:string 35 Optional. Secondary address line to which the shipment is destined.
Destination / Address / City FDXG USD xs:string 20 Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed.
Destination / Address / StateOrProvince Code
FDXG USD xs:string 2 Required. State or province code to which the shipment is destined.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 230
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Destination / Address / PostalCode FDXG USD xs:string 16 Required. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z
Destination / Address / CountryCode FDXG USD xs:string 2 Required. Name of the country to which the shipment is destined.
PAYMENT
Payment / PayorType FDXG USD xs:string Required. Valid values: • SENDER • RECIPIENT • THIRDPARTY • COLLECT
PAYMENT / PAYOR
Payment / Payor / AccountNumber FDXG USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment / Payor / CountryCode FDXG USD xs:string Optional.
RMA Return Merchant Authorization Information
RMA/Number FDXG USD xs:string 20 Required if RMA element is included. Return Merchant Authorization number provided by the sender.
CourierInstructions FDXG USD xs:string 40 Optional. Instruction to courier.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 231
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
CustomerReference FDXG USD xs:string 30 Optional. Customer reference information.
CurrencyCode FDXG USD xs:string 3 Optional. Required if DeclaredValue is present.
PACKAGE Package Information
Package / DeclaredValue FDXG USD xs:integer 10 Optional. Declared value of entire shipment. Defaults to zero.
Package / ItemDescription FDXG USD xs:integer 80 Required for multiple-piece shipment. Required per piece. Description of item being shipped. Max 20.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 232
Example of FDXGroundCallTaglRequest XML Document
The following is an example of the Request transaction format of a Ground Call Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Ground Call Tag Request</CustomerTransactionIdentifier> <AccountNumber>1234567890</AccountNumber> <MeterNumber>9999999</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <DispatchDate>2004-09-07</DispatchDate> <LatestPickupTime>14:20:00-05:00</LatestPickupTime> <ReadyTime>10:20:00-05:00</ReadyTime> <Origin> <Contact> <PersonName>Bettie Betts</PersonName> <CompanyName>FedEx</CompanyName> <PhoneNumber>8004633339</PhoneNumber> </Contact> <Address> <Line1>3925 Embassy Pkwy</Line1> <City>Test</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38098</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <PersonName>Molly Pooly</PersonName> <CompanyName>ABC Widget</CompanyName>
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 233
</Contact> <Address> <Line1>1234 Main St</Line1> <City>Test</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38099</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> </Payment> <RMA> <Number>0123456789</Number> </RMA> <CourierInstructions>Test Transaction</CourierInstructions> <CustomerReference>Cust Ref 1234</CustomerReference> <CurrencyCode>USD</CurrencyCode> <Package> <DeclaredValue>100.00</DeclaredValue> <ItemDescription>Keyboards</ItemDescription> </Package> </FDXGroundCallTagRequest>
XML Transaction Layouts: FDXGroundCallTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 234
FDXGroundCallTagReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransactionIdentifier
FDXG USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error / Code FDXG USD xs:string 8 Optional. Returned only if an Error has occurred.
Error / Message FDXG USD xs:string 40 Optional. Returned only if an Error has occurred.
DispatchConfirmationNumber FDXG USD xs:string 16 Required. Otherwise known as Pickup Confirmation Number.
TrackingNumber FDXG USD xs:string 16 Required.
XML Transaction Layouts: FDXGroundCallTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 235
Example of FDXGroundCallTagReply XML Document The following is an example of the Reply transaction format for Requests regarding the creation of a Ground Call Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground Call Tag Request</CustomerTransactionIdentifier> </ReplyHeader> <DispatchConfirmationNumber>997038000005630</ConfirmationNumber> <TrackingNumber>997038000005630</TrackingNumber> </FDXGroundCallTagReply>
XML Transaction Layouts: FDXCancelGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 236
FDXCancelGroundCallTagRequest
This transaction cancels and Call Tag Request. This transaction is only valid until tags are generated at the terminal (generally next day). Erroneous Requests should be canceled as soon as possible.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransactionIdentifier
FDXG USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader / AccountNumber FDXG USD xs:string 9 The FedEx account number of the Sender is required to successfully cancel a Ground Call Tag.
RequestHeader / MeterNumber FDXG USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully cancel a Ground Call Tag.
RequestHeader / CarrierCode FDXG USD xs:string 4 Valid value: FDXG
DispatchConfirmationNumber FDXG USD xs:string 16 Required. Otherwise known as Pickup Confirmation Number.
PAYMENT
XML Transaction Layouts: FDXCancelGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 237
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Payment / PayorType ALL ALL xs:string 10 Required. Method of payment for shipment. The credit card payment type is only supported for U.S. Domestic Express shipping. Valid payment types: • SENDER • RECIPIENT • THIRDPARTY • COLLECT For Return Manager, only SENDER and THIRDPARTY are allowed.
PAYMENT / PAYOR
Payment / Payor / AccountNumber ALL ALL xs:string 12 For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The FedEx account number for the payor of the shipment.
Payment / Payor / CountryCode ALL ALL xs:string 2 For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The country code for the payor of the shipment.
XML Transaction Layouts: FDXCancelGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 238
Example of FDXCancelGroundCallTagRequest XML Document
The following is an example of the Request transaction format for the cancellation of a Ground Call Tag:
<?xml version="1.0" encoding="UTF-8" ?> <FDXCancelGroundCallTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelGroundCallTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1010101</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <DispatchConfirmationNumber>997038000005630</ConfirmationNumber> </FDXCancelGroundCallTagRequest>
XML Transaction Layouts: FDXCancelGroundCallTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 239
FDXCancelGroundCallTagReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransactionIdentifier
FDXG USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error / Code FDXG USD xs:string 8 Optional. Returned only if an Error has occurred.
Error / Message FDXG USD xs:string 40 Optional. Returned only if an Error has occurred.
XML Transaction Layouts: FDXCancelGroundCallTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 240
Example of FDXCancelGroundCallTagReply XML Document
If the input transaction had contained an error, an error message number and message text would have been included in the transaction Reply. For example, if the confirmation number was not valid, the response transaction would be:
<?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>F5CC</Code> <Message>Unable to retrieve details: confirmation number not found Additional Info:</Message> </Error> </FDXGroundCallTagReply>
The following is an example of the Reply transaction format for Requests regarding the cancellation of a Ground Call Tag:
<?xml version="1.0" encoding="UTF-8" ?> < FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=" FDXGroundCallTagReply.xsd "> <ReplyHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> </ FDXGroundCallTagReply >
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 241
FDXExpressTagAvailabilityRequest
Express Tag is a premium Express service and has limited coverage. Effective applications will include this option to allow customer to see if an area has coverage. This is done to prevent a user from filling out an entire screen full of shipment information just to find out there is no coverage. This is determined using dates and ZIP codes for service areas.
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransactionIdentifier
FDXE USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
RequestHeader /AccountNumber FDXE USD xs:string 9 The FedEx account number of the Sender is required to successfully receive an Express Tag Availability response.
RequestHeader / Meter Number
FDXE USD xs:string 8 The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive an Express Tag Availability response.
RequestHeader / CarrierCode FDXE USD xs:string 4 Valid value: FDXE
DispatchDate FDXE USD xs:date 10 Required. Format: YYYY-MM-DD
ReadyTime FDXE USD xs:time 10 Required. The beginning of the pickup window promised by the customer; the earliest the courier can rely on the package being ready. Format: HH:MM:SS
ORIGINADDRESS
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 242
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
OriginAddress / Line1 FDXE USD xs:string 35 Required. Primary address line from which the shipment is originating.
OriginAddress / Line2 FDXE USD xs:string 35 Optional. Secondary address line from which the shipment is originating.
OriginAddress / City FDXE USD xs:string 20 Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
OriginAddress / StateOrProvinceCode FDXE USD xs:string 2 Required. State code from which the shipment is originating.
OriginAddress / PostalCode FDXE USD xs:string 16 Required.Postal code from which the shipment is origin ating. Must be numeric and no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
OriginAddress / CountryCode FDXE USD xs:string 2 Required. Name of the country from which the shipment is originating.
Service FDXE USD xs:string Required. Valid values: • PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 243
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
Packaging FDXE USD xs:string Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • YOURPACKAGING
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 244
Example of FDXExpressTagAvailabilityRequest XML Document
The following is an example of the Request transaction format for Express Tag Availability:
<?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagAvailabilityRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXExpressTagAvailabilityRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Express Tag Availability Test</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> </RequestHeader> <DispatchDate>2004-10-13</DispatchDate> <ReadyTime>14:00:00</ReadyTime> <OriginAddress> <Line1>SN2000 Test Meter 8</Line1> <Line2>10 Fedex Parkway</Line2> <City>Collierville</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </OriginAddress> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> </FDXExpressTagAvailabilityRequest>
XML Transaction Layouts: FDXExpressTagAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 245
FDXExpressTagAvailabilityReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE USD xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR
Error / Code FDXE USD xs:string 8 Optional. Returned only if an Error has occurred.
Error / Message FDXE USD xs:string 40 Optional. Returned only if an Error has occurred.
AccessTime FDXE USD xs:time Optional. The latest time at which the package must become available for pickup; the earliest that the courier will show up for the packages. Format: HH:MM:SS
CutoffTime FDXE USD xs:time Optional. The earliest time at which the package can become unavailable for pickup; the latest that the courier will show up for the packages. Format: HH:MM:SS
XML Transaction Layouts: FDXExpressTagAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 246
Element Name Applicable Carrier
Valid For
Data Type
Max Length
Element Description/Requirements
AvailabilityCode FDXE USD xs:string 1 Optional. Valid values: • 2 • 3
XML Transaction Layouts: FDXExpressTagAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 247
Example of FDXExpressTagAvailabilityReply XML Document
The following is an example of the Reply transaction format for Requests regarding the Express Tag Availability:
<?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagAvailabilityReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>Express Tag Availability Test</CustomerTransactionIdentifier> </ReplyHeader> <AccessTime>03:00:00</AccessTime> <CutoffTime>20:00:00</CutoffTime> <AvailabilityCode>3</AvailabilityCode> </FDXExpressTagAvailabilityReply>
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 248
Shipping Label Specifications
Plain Paper and Thermal Label Specifications
General Printing Overview and Methods
The FedEx ASTRA bar code was designed to accommodate automated scanning and sorting at the stations and hubs. The specifications are written to allow the various scanning systems throughout FedEx to accurately and reliably de-code the information in the bar code. The only way to ensure that the bar codes will work reliably with present and future scanning systems is to make sure that they always meet FedEx minimum standard specifications for print quality. There can be no deviation from these specifications nor can any waiver or modifications be allowed.
*PRINT METHODS: Preferred print methods include direct thermal, thermal transfer, LASER (xerographic) or ink jet. These print methods are chosen due to their ability to maintain a high and constant quality output throughout the life of the printer and supplies. With these systems, FedEx can check the quality of a customer produced bar code once to verify that the major print components are correct, and be confident that the production bar code will continue to maintain very similar quality.
Dot-matrix printers are not permitted. This is because even in the best of conditions, the print quality is highly variable. Some dot matrix printers are capable of printing quality bar codes when the ribbon life and platen pressure are in optimum condition, but in actual production this is nearly impossible to monitor and control.
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 249
PNG Plain Paper Label Printing the plain paper label is different than printing the thermal label. The image orientation dimensions can be manipulated when using a print manager to print a plain paper label. Image Orientation Dimensions are determined when the label is viewed in an imaging editor applcation. Image orientations for both Shipping and Tracking Signature Proof of Delivery (SPOD) PNG plain paper shipping labels are listed in the corresponding table:
Print Manager Dimensions PNG Plain Paper Image Orientation Dimensions
Width By Height
Shipping PNG (browser and non-browser) 7.0 X 4.75
SPOD PNG (browser and non-browser) 6.8 X 7.6
When the label is printed, it can either increase or decrease in size if the print manager dimensions are not properly set. If the dimensions are increased, the following will result: • All human readable, bar code data and bar codes will be increased in size, and bar codes may become unable to be scanned by the Courier
and Ground Operations division. • Since the label will need to be folded in half and inserted into the FedEx Pouch, the ASTRA bar code will need to be fully visible. To ensure full
visibility, there should be between 5/16" and ¾" of white space from the bottom of the ASTRA bar code to the fold.
If the dimensions are decreased, the following will result:
• All human readable, bar code data and bar codes will be decreased in size. • When the label is decreased in size, bar codes may become unable to be scanned by the Courier and Ground Operations division.
Additionally, if the size is increased or decreased, this may result in the delay of switching the user's application from the validation to production environment.
For the Browser based label, the user will need to ensure the appropriate HTML wrapper is attached (reference section Creating a Shipping Label). The following represents the Page name and File path of a Browser based label:
• FedEx Ship Manager API Label Page file://C:/Program Files/FedEx/Fed…ples/vb/470004122710.html
Reference the Browser-based shipping label in the following plain paper shipping label attachments for verbiage orientation.
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 250
Determining Screen Resolution Printing the plain paper shipping labels and SPOD letters require proper sizing. This requires determining the screen resolution selected on the device running the browser. The HTTP parameters <WIDTH> and <HEIGHT> will need to be calculated using the screen DPI values and the desired reproduced screen width and height.
Below lists the typical screen resolutions for Windows and Macintosh based on the font size selected.
Browser Screen resolution (typical default)
Windows using small fonts 96 DPI
Windows using large fonts 120 DPI
Macintosh 72 DPI
Examples on populating HTML tag Height and Width values:
Width (pixels) = ScreenDPI * (desired image reproduced width)
Height (pixels = ScreenDPI * (desired image reproduced height)
Example: Sample code implementing Shipping plain paper label in Netscape Browser:
<HTML> <SCRIPT LANGUAGE="JavaScript1.1"> var NS4 = (document.layers) ? true : false ; var resolution = 96; if (NS4 && navigator.javaEnabled()) { var toolkit = java.awt.Toolkit.getDefaultToolkit(); resolution = toolkit.getScreenResolution(); } </SCRIPT> <SCRIPT LANGUAGE="JavaScript"> document.write('<img WIDTH=' + (700 * resolution )/100 + '<img HEIGHT=' + (475 * resolution )/100 + ' alt="ASTRA Barcode" src="path/test.png">');
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 251
</SCRIPT> </HTML>
Example for getting Screen resolution using Microsoft MFC library:
DC hDC = CreateDC( “DISPLAY”, NULL, NULL, NULL ); int DPI = getDeviceCaps ( hDC, LOGPIXELSX); DeleteDC(hDC);
Custom Labels
FedEx does not support the creation or use of a custom label for either FedEx Ship Manager API Ground or Express shipping.
FedEx Shipping Label Preparation To prepare your package for shipment, you need to do the following:
• Print the label on your printer.
• Fold the first printed page in half and use as the shipping label. The second page is for your records, and contains both the terms and conditions of shipping, and information useful for tracking your package.
• After printing the label, place it in a waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned.
NOTE:
When printing labels for COD shipments, you must make sure to print one label and two COD tags with each label You must print additional COD tags as needed.
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 252
NOTE:
If you are using the WAPI label extensions, 1 shipping label and 2 COD tags are printed. However, label extensions are not mandatory. This is the proper procedure.
NOTE:
Use only the printed original labels for shipping to ensure the timely delivery of your package.
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 253
Appendix A: Country Codes
Country Code Ship to: Country Code Ship
to: Country Code Ship to:
Afghanistan AF Y Bermuda BM Y China CN Y Albania AL Y Bhutan BT Y Christmas Island CX N Algeria DZ N Bolivia BO Y Cocos (Keeling) Islands CC N American Samoa AS Y Bonaire AN Y Colombia CO Y Andorra AD Y Bosnia-Herzegovina BA Y Comoros KM N Angola AO Y Botswana BW Y Congo CG Y Anguilla AI Y Bouvet Island BV N Congo Dem. Rep. Of CD Y Antarctica AQ N Brazil BR Y Cook Islands CK Y Antigua AG Y British Indian Ocean Territory IO N Costa Rica CR Y Argentina AR Y British Virgin Islands VG Y Croatia HR Y Armenia AM Y Brunei BN Y Cuba CU N Aruba AW Y Bulgaria BG Y Curacao AN Y Australia AU Y Burkina Faso BF Y Cyprus CY Y Austria AT Y Burundi BI Y Czech Republic CZ Y Azerbaijan AZ Y Cambodia KH Y Denmark DK Y Bahamas BS Y Cameroon CM Y Djibouti DJ Y Bahrain BH Y Canada CA Y Dominica DM Y Bangladesh BD Y Canary Islands ES Y Dominican Republic DO Y Barbados BB Y Cape Verde CV Y East Timor TL Y Barbuda AG Y Cayman Islands KY Y Ecuador EC Y Belarus BY Y Central African Republic CF N Egypt EG Y Belgium BE Y Chad TD Y El Salvador SV Y Belize BZ Y Channel Islands GB Y England GB Y Benin BJ Y Chile CL Y Equatorial Guinea GQ Y
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 254
Country Code Ship to: Country Code Ship
to: Country Code Ship to:
Eritrea ER Y Guyana GY Y Liberia LR Y Estonia EE Y Haiti HT Y Libya LY N Ethiopia ET Y Heard & McDonald Islands HM N Liechtenstein LI Y Faeroe Islands FO Y Holland NL Y Lithuania LT Y Falkland Islands FK N Honduras HN Y Luxembourg LU Y Fiji FJ Y Hong Kong HK Y Macau MO Y Finland FI Y Hungary HU Y Macedonia MK Y France FR Y Iceland IS Y Madagascar MG Y French Guiana GF Y India IN Y Malawi MW Y French Polynesia PF Y Indonesia ID Y Malaysia MY Y French Southern Territories TF N Iran IR N Maldives MV Y Gabon GA Y Iraq IQ Y Mali ML Y Gambia GM Y Ireland IE Y Malta MT Y Georgia GE Y Israel IL Y Marshall Islands MH Y Germany DE Y Italy IT Y Martinique MQ Y Ghana GH Y Ivory Coast CI Y Mauritania MR Y Gibraltar GI Y Jamaica JM Y Mauritius MU Y Grand Cayman KY Y Japan JP Y Mayotte YT N Great Britain GB Y Jordan JO Y Mexico MX Y Great Thatch Island VG Y Jost Van Dyke Islands VG Y Micronesia FM Y Great Tobago Islands VG Y Kazakhstan KZ Y Moldova MD Y Greece GR Y Kenya KE Y Monaco MC Y Greenland GL Y Kiribati KI N Mongolia MN Y Grenada GD Y Kuwait KW Y Montserrat MS Y Guadeloupe GP Y Kyrgyzstan KG Y Morocco MA Y Guam GU Y Laos LA Y Mozambique MZ Y Guatemala GT Y Latvia LV Y Myanmar / Burma MM N Guinea GN Y Lebanon LB Y Nambia NA Y Guinea Bissau GW N Lesotho LS Y Nauru NR N
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 255
Country Code Ship to: Country Code Ship
to: Country Code Ship to:
Nepal NP Y Qatar QA Y St. Christopher KN Y Netherlands NL Y Reunion RE Y St. Croix Island VI Y Netherlands Antilles AN Y Romania RO Y St. Eustatius AN Y New Caledonia NC Y Rota MP Y St. Helena SH N New Zealand NZ Y Russia RU Y St. John VI Y Nicaragua NI Y Rwanda RW Y St. Kitts and Nevis KN Y Niger NE Y Saba AN Y St. Lucia LC Y Nigeria NG Y Saipan MP Y St. Maarten AN Y Niue NU N Samoa WS Y St. Pierre PM N Norfolk Island NF N San Marino IT Y St. Thomas VI Y Norman Island VG Y Sao Tome & Principe ST N St. Vincent VC Y North Korea KP N Saudi Arabia SA Y Sudan SD N Northern Ireland GB Y Scotland GB Y Suriname SR Y Northern Mariana Islands MP Y Senegal SN Y Svalbard & Jan Mayen Is SJ N Norway NO Y Serbia & Montenegro CS Y Swaziland SZ Y Oman OM Y Seychelles SC Y Sweden SE Y Pakistan PK Y Sierra Leone SL N Switzerland CH N Palau PW Y Singapore SG Y Syria SY N Palestine PS Y Slovak Republic SK Y Tahiti PF Y Panama PA Y Slovenia SI Y Taiwan TW Y Papua New Guinea PG Y Solomon Islands SB N Tajikistan TJ N Paraguay PY Y Somalia SO N Tanzania TZ Y Peru PE Y South Africa ZA Y Thailand TH Y Philippines
PH Y South Georgia & South Sandwich Islands GS N
Tinian MP Y
Pitcairn PN N South Korea KR Y Togo TG Y Poland PL Y Spain ES Y Tokelau TK N Portugal PT Y Sri Lanka LK Y Tonga TO Y Puerto Rico PR Y St. Barthelemy GP Y Tortola Island VG Y
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 256
Country Code Ship to: Country Code Ship
to: Country Code Ship to:
Trinidad & Tobago TT Y Tunisia TN Y Turkey TR Y Turkmenistan TM Y Turks & Caicos Islands TC Y Tuvalu TV N U.S. Minor Outlying Islands UM N U.S. Virgin Islands VI Y Uganda UG Y Ukraine UA Y Union Island VC Y United Arab Emirates AE Y United Kingdom GB Y United States US Y Uruguay UY Y Uzbekistan UZ Y Vanuatu VU Y Vatican City IT Y Venezuela VE Y Vietnam VN Y Wales GB Y Wallis & Futuna Islands WF Y Western Sahara EH N Yemen YE Y Zambia ZM Y Zimbabwe ZW Y
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 257
NOTE:
The following South Pacific Islands (7 new destination countries) shall be allowed in the Ship, Rate, Rate Service Availability, and Tracking functions: • Kiribati (country code = 'KI') • Nauru (country code = 'NR') • Solomon Islands (country code = 'SB') • Nuie (country code = 'NU') • Tonga (country code = 'TO') • Tuvalu (country code = 'TV') • Samoa (country code = 'WS')
However, the seven new countries shall NOT be allowed as the Shipper/Origin country in the Ship, Rate, and Rate Service Availability functions.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 258
Appendix B: Vague Commodity Descriptions
The following table is a list of commodity descriptions considered vague by U.S. Customs:
Vague Commodity Vague Commodity Description
"A/C Parts" "A/C Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Break Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"AC Parts" "AC Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Break Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Accessories" "Accessories" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Advertising Material" "Advertising Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Advertising Signs." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft Parts" "Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft Spare Parts" "Aircraft Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft spares" "Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Antibodies" "Antibodies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibodies." Clearance delays may result if the contents are not completely and accurately described.
"Antibody" "Antibody" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibody." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 259
Vague Commodity Vague Commodity Description
"Apparel" "Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirt." Clearance delays may result if the contents are not completely and accurately described.
"Appliance" "Appliance" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial Dishwasher." Clearance delays may result if the contents are not completely and accurately described.
"Appliances" "Appliances" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial Dishwasher." Clearance delays may result if the contents are not completely and accurately described.
"Art" "Art" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Water Color Painting." Clearance delays may result if the contents are not completely and accurately described.
"As Per Attached INV" "As Per Attached INV" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Assorted Merchandise" "Assorted Merchandise" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Auto Part" "Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Auto Parts" "Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Automotive Parts" "Automotive Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Autoparts" "Autoparts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Bag" "Bag" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 260
Vague Commodity Vague Commodity Description
"Battery" "Battery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Car Battery." Clearance delays may result if the contents are not completely and accurately described.
"Bearing" "Bearing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ball Bearing." Clearance delays may result if the contents are not completely and accurately described.
"Belts" "Belts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts." Clearance delays may result if the contents are not completely and accurately described.
"Box" "Box" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Brake Parts" "Brake Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper." Clearance delays may result if the contents are not completely and accurately described.
"Brake" "Brake" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Automobile Brake." Clearance delays may result if the contents are not completely and accurately described.
"Business Correspondence"
"Business Correspondence" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described.
"Cable" "Cable" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Cable." Clearance delays may result if the contents are not completely and accurately described.
"Cap" "Cap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps." Clearance delays may result if the contents are not completely and accurately described.
"Caps" "Caps" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps." Clearance delays may result if the contents are not completely and accurately described.
"Carton" "Carton" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"CD" "CD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CD." Clearance delays may result if the contents are not completely and accurately described.
"CDs" "CDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CDs." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 261
Vague Commodity Vague Commodity Description
"Cell Line" "Cell Line" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Cells" "Cells" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Chemical" "Chemical" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Chemicals" "Chemicals" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Chip" "Chip" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Integrated Circuit." Clearance delays may result if the contents are not completely and accurately described.
"Christmas Gifts" "Christmas Gift" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"CI Attached" "CI Attached" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Civil Aircraft Parts" "Civil Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Civil Aircraft Spares" "Civil Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Clothes / Textiles" "Clothes / Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described.
"Clothes" "Clothes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 262
Vague Commodity Vague Commodity Description
"Clothing and Accessories"
"Clothing and Accessories" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described.
"Clothing" "Clothing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described.
"Comat" "Comat" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Commercial Invoice" "Commercial Invoice" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Components" "Components" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Computer Parts" "Computer Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Computer Peripherals" "Computer Peripherals" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer CD Players." Clearance delays may result if the contents are not completely and accurately described.
"Connector" "Connector" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Cosmetic Products" "Cosmetic Products" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fragrance." Clearance delays may result if the contents are not completely and accurately described.
"Cosmetics" "Cosmetics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fragrance." Clearance delays may result if the contents are not completely and accurately described.
"Culture" "Culture" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 263
Vague Commodity Vague Commodity Description
"Dangerous Good" "Dangerous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Dangerous Goods" "Dangerous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Data Processing Part" "Data Processing Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Data Processing Parts" "Data Processing Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Defective Goods" "Defective Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"DESC N" "DESC N" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"DESCRI" "DESCRI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"DG" "DG" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"DGs" "DGs" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Disk" "Disk" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence on a Floppy Disk." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 264
Vague Commodity Vague Commodity Description
"Disks" "Disks" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence on Floppy Disks." Clearance delays may result if the contents are not completely and accurately described.
"Display" "Display" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Liquid Crystal Display (LCD) - Desktop Projector ." Clearance delays may result if the contents are not completely and accurately described.
"DNA" "DNA" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Doc" "Doc" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Document" "Document" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate." Clearance delays may result if the contents are not completely and accurately described.
"Documentation" "Documentation" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Documents" "Documents" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate." Clearance delays may result if the contents are not completely and accurately described.
"Drug" "Drug" is an incomplete description and not accepted by Customs. Please specify the name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Drugs" "Drugs" is an incomplete description and not accepted by Customs. Please specify the name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Dry Ice" "Dry Ice" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Pork Ribs in Dry Ice." Clearance delays may result if the contents are not completely and accurately described.
"DVD" "DVD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 265
Vague Commodity Vague Commodity Description
"DVDs" "DVDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Movies." Clearance delays may result if the contents are not completely and accurately described.
"Electrical Parts" "Electrical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Component" "Electronic Component" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Components" "Electronic Components" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Capacitor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Equipment" "Electronic Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Good" "Electronic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Goods" "Electronic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Part" "Electronic Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Parts" "Electronic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistors." Clearance delays may result if the contents are not completely and accurately described.
"Electronic" "Electronic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described.
"Electronics" "Electronics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 266
Vague Commodity Vague Commodity Description
"Equipment" "Equipment" is an incomplete description and not accepted by Customs. Specific Description of the Type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described.
"Fabric Samples" "Fabric Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"Fabric" "Fabric" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"Fabrics" "Fabrics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"FAC " "FAC " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"FAK " "FAK " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Flooring" "Flooring" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described.
"Food Items" "Food Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Canned Pasta." Clearance delays may result if the contents are not completely and accurately described.
"Food" "Food" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Homemade Cookies." Clearance delays may result if the contents are not completely and accurately described.
"Foodstuff" "Foodstuff" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars." Clearance delays may result if the contents are not completely and accurately described.
"Foodstuffs" "Foodstuffs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 267
Vague Commodity Vague Commodity Description
"Freight Of All Kinds" "Freight Of All Kinds" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"General Cargo" "General Cargo" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Gift" "Gift" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Book sent as a Christmas Gift." Clearance delays may result if the contents are not completely and accurately described.
"Gifts" "Gifts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Books sent as a Christmas Gift." Clearance delays may result if the contents are not completely and accurately described.
"Goods" "Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Effects." Clearance delays may result if the contents are not completely and accurately described.
"Hardware" "Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "CD Player." Clearance delays may result if the contents are not completely and accurately described.
"Haz Mat" "Haz Mat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Haz Material" "Haz Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Haz Materials" "Haz Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Chemical" "Hazardous Chemical" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Chemicals" "Hazardous Chemicals" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 268
Vague Commodity Vague Commodity Description
"Hazardous Good" "Hazardous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Goods" "Hazardous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Material" "Hazardous Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Materials" "Hazardous Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"HazMat" "HazMat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Household Goods" "Household Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"HS #" "HS #" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described.
"HS NON" "HS NON" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described.
"HS#" "HS#" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described.
"I C" "I C" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 269
Vague Commodity Vague Commodity Description
"IC" "IC" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"ILLEDG" "ILLEDG" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Illegible" "Illegible" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Implants" "Implants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Dental Implants." Clearance delays may result if the contents are not completely and accurately described.
"Industrial Goods" "Industrial Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Integrated Circuit" "Integrated Circuit" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuit - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"Integrated Circuits" "Integrated Circuits" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"Iron" "Iron" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steam Iron." Clearance delays may result if the contents are not completely and accurately described.
"Items" "Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Jeans" "Jeans" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ladies Denim Jeans." Clearance delays may result if the contents are not completely and accurately described.
"Jewelry" "Jewelry" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold Necklace." Clearance delays may result if the contents are not completely and accurately described.
"Laboratory Reagents" "Laboratory Reagents" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 270
Vague Commodity Vague Commodity Description
"Ladies Apparel" "Ladies Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's leather shoes." Clearance delays may result if the contents are not completely and accurately described.
"Leather Article" "Leather Article" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse." Clearance delays may result if the contents are not completely and accurately described.
"Leather Articles" "Leather Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse." Clearance delays may result if the contents are not completely and accurately described.
"Leather" "Leather" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts." Clearance delays may result if the contents are not completely and accurately described.
"letter" "Letter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Liquid" "Liquid" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Luggage" "Luggage" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Machine Part" "Machine Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described.
"Machine Parts" "Machine Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described.
"Machinery" "Machinery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting Machine." Clearance delays may result if the contents are not completely and accurately described.
"Machines" "Machines" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting Machine." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 271
Vague Commodity Vague Commodity Description
"Medical Equipment" "Medical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Defibrillator." Clearance delays may result if the contents are not completely and accurately described.
"Medical Parts" "Medical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric Wire for Medical Equipment." Clearance delays may result if the contents are not completely and accurately described.
"Medical Spare Parts" "Medical Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric Wire for Medical Equipment." Clearance delays may result if the contents are not completely and accurately described.
"Medical Supplies" "Medical Supplies" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicaments" "Medicaments" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medication" "Medication" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medications" "Medications" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicine" "Medicine" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicines" "Medicines" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 272
Vague Commodity Vague Commodity Description
"Meds" "Meds" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Men’s Apparel" "Men’s Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Summer T-Shirt." Clearance delays may result if the contents are not completely and accurately described.
"Metal Work" "Metal Work" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Pipe." Clearance delays may result if the contents are not completely and accurately described.
"Miscellaneous Items" "Miscellaneous Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"NAFTA" "NAFTA" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"New Goods" "New Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"No CI" "No CI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"NO COM" "NO COM" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"NO DES" "NO DES" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"NON G" "NON G" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Non-Hazardous" "Non-Hazardous" is an incomplete description and not accepted by Customs. Please provide the proper name of the goods, if chemical, proper name and the UN #. Clearance delays may result if the contents are not completely and accurately described.
"NOT GI" "NOT GI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 273
Vague Commodity Vague Commodity Description
"Packaging Supplies" "Packaging Supplies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Bubble Plastic Wrap." Clearance delays may result if the contents are not completely and accurately described.
"Pants" "Pants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Boy's Cotton Twill Pants." Clearance delays may result if the contents are not completely and accurately described.
"Paper" "Paper" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described.
"Paperwork" "Paperwork" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described.
"Part" "Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Parts Of" "Parts Of" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Parts" "Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"PC Hardware" "PC Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer CD Player." Clearance delays may result if the contents are not completely and accurately described.
"PCB" "PCB" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board with Components for Television Set." Clearance delays may result if the contents are not completely and accurately described.
"PCBA" "PCBA" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board Assembly for Computer." Clearance delays may result if the contents are not completely and accurately described.
"Peripheral" "Peripheral" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Printer." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 274
Vague Commodity Vague Commodity Description
"Personal Effects" "Personal Effects" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Personal Item" "Personal Item" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Personal Items" "Personal Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Pharmaceuticals" "Pharmaceuticals" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"PIB" "PIB" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"PIBs" "PIBs" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Pipe" "Pipe" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipe." Clearance delays may result if the contents are not completely and accurately described.
"Pipes" "Pipes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipes." Clearance delays may result if the contents are not completely and accurately described.
"Plastic Good" "Plastic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knive." Clearance delays may result if the contents are not completely and accurately described.
"Plastic Goods" "Plastic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives." Clearance delays may result if the contents are not completely and accurately described.
"Plastic Parts" "Plastic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives." Clearance delays may result if the contents are not completely and accurately described.
"Plastic" "Plastic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Plastic Shoes." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 275
Vague Commodity Vague Commodity Description
"Polyurethane" "Polyurethane" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Polyurethane Medical Gloves." Clearance delays may result if the contents are not completely and accurately described.
"Power Supply" "Power Supply" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Supply Module for ADP Machines." Clearance delays may result if the contents are not completely and accurately described.
"Precious Metal" "Precious Metal" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold Necklace." Clearance delays may result if the contents are not completely and accurately described.
"Printed Circuit Board" "Printed Circuit Board" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board with Components for Television Set." Clearance delays may result if the contents are not completely and accurately described.
"Printed Material" "Printed Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manual." Clearance delays may result if the contents are not completely and accurately described.
"Printed Materials" "Printed Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manuals." Clearance delays may result if the contents are not completely and accurately described.
"Printed Matter" "Printed Matter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manual" Clearance delays may result if the contents are not completely and accurately described.
"Printed Matters" "Printed Matters" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manuals" Clearance delays may result if the contents are not completely and accurately described.
"Promo Item" "Promo Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 276
Vague Commodity Vague Commodity Description
"Promo Items" "Promo Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promo Material" "Promo Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promo Materials" "Promo Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Item" "Promotional Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Items" "Promotional Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Material" "Promotional Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Materials" "Promotional Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional" "Promotional" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Receivers" "Receivers" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stereo Receiver." Clearance delays may result if the contents are not completely and accurately described.
"Records" "Records" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 277
Vague Commodity Vague Commodity Description
"Report" "Report" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence - Annual Report." Clearance delays may result if the contents are not completely and accurately described.
"Rod" "Rod" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Fishing Rods." Clearance delays may result if the contents are not completely and accurately described.
"Rods" "Rods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Aluminum Rods." Clearance delays may result if the contents are not completely and accurately described.
"Rubber Articles" "Rubber Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Hoses." Clearance delays may result if the contents are not completely and accurately described.
"Rubber" "Rubber" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Tires." Clearance delays may result if the contents are not completely and accurately described.
"Said To Contain" "Said To Contain" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Sample" "Sample" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Samples" "Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Scrap" "Scrap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Scrap Billets." Clearance delays may result if the contents are not completely and accurately described.
"See Attached" "See Attached" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"SEE CO" "SEE CO" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"SEE IN" "SEE IN" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 278
Vague Commodity Vague Commodity Description
"See Invoice" "See Invoice" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Shirt" "Shirt" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's 100% Cotton Long Sleeve Shirt." Clearance delays may result if the contents are not completely and accurately described.
"Software" "Software" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Software Game on CD-ROM - "Halo 2"." Clearance delays may result if the contents are not completely and accurately described.
"Spare Parts for Machine" "Spare Parts for Machine" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - New." Clearance delays may result if the contents are not completely and accurately described.
"Spare Parts" "Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - Used." Clearance delays may result if the contents are not completely and accurately described.
"Spares" "Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - New." Clearance delays may result if the contents are not completely and accurately described.
"Sportswear" "Sportswear" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Men's Running Shorts." Clearance delays may result if the contents are not completely and accurately described.
"STC " "STC " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Steel" "Steel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stainless Steel Pots." Clearance delays may result if the contents are not completely and accurately described.
"Surgical Instruments" "Surgical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Scalpels." Clearance delays may result if the contents are not completely and accurately described.
"Swatches" "Swatches" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Fabric Sample Swatches." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 279
Vague Commodity Vague Commodity Description
"Tape" "Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described.
"Tapes" "Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described.
"Textile Samples" "Textile Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textile" "Textile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Dress - 100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textiles Samples" "Textiles Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textiles" "Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Tile" "Tile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described.
"Tiles" "Tiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described.
"Tools" "Tools" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Drill." Clearance delays may result if the contents are not completely and accurately described.
"Toy" "Toy" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Doll House." Clearance delays may result if the contents are not completely and accurately described.
"Training Material" "Training Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training Material for Basketball." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 280
Vague Commodity Vague Commodity Description
"Training Materials" "Training Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training Materials for Basketball." Clearance delays may result if the contents are not completely and accurately described.
"Tubes" "Tubes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Glass Tubes." Clearance delays may result if the contents are not completely and accurately described.
"Unlist" "Unlist" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Used Goods" "Used Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Various Goods" "Various Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Video Tape" "Video Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described.
"Video Tapes" "Video Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described.
"Video" "Video" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described.
"Videotape" "Videotape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described.
"Videotapes" "Videotapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described.
"VISA MDR Table" "VISA MDR Table" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described.
"Wafer" "Wafer" is an incomplete description and not accepted by Customs. An example of an acceptable description is "semiconductor wafers." Clearance delays may result if the contents are not completely and accurately described.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 281
Vague Commodity Vague Commodity Description
"Waste" "Waste" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Oil Waste for Testing." Clearance delays may result if the contents are not completely and accurately described.
"Wearing Apparel" "Wearing Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Leather Sandals." Clearance delays may result if the contents are not completely and accurately described.
"Wire" "Wire" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire." Clearance delays may result if the contents are not completely and accurately described.
"Wires" "Wires" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire." Clearance delays may result if the contents are not completely and accurately described.
Appendix C: Legal Terms and Conditions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 282
Appendix C: Legal Terms and Conditions
Legal Terms
In addition to creating and printing the waybill Label, you will need to print copies of the U.S. Domestic and International Legal Terms and Conditions to accompany each Label with your International shipments. The following defines international handling instructions for the waybill labels and Legal Terms and Conditions document.
If International – U.S. Export: Print 2 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to the shipment so that the bar code portion of the label can be read and scanned. Place the additional consignee copy of the waybill Label in the pouch.
If International – Shipments originating outside of the U.S.: Print 3 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned. Place the 2 consignee copies of the waybill Label in the pouch.
The following defines U.S. Domestic handling instructions for the waybill labels and Legal Terms and Conditions.
If U.S. Domestic shipment: Print 1 copy of the waybill Label to your laser printer, fold the printed page in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned.
NOTE:
The International and U.S. Domestic waybill Legal Terms and Conditions information must be supplied with test labels when completing the certification process.
WARNING: Use only the printed original labels for shipping to ensure the timely delivery of your package.
Appendix C: Legal Terms and Conditions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 283
Conditions of Contract
CONDITIONS OF CONTRACT Definitions: On this Air Waybill, "we", "our", "us", and "FedEx" refer to Federal Express Corporation, its subsidiaries and branches and their respective employees, agents, and independent contractors. The terms "you" and "your" refer to the shipper, its employees, principals and agents. If your shipment originates outside the United States, your contract of carriage is with the FedEx subsidiary, branch or independent contractor who originally accepts the shipment from you. The term "package" means any container or envelope that is accepted by us for delivery, including any such items tendered by you utilizing our automated systems, meters, manifests or waybills. The term "shipment" means all packages which are tendered to and accepted by us on a single Air Waybill. Agreement To Terms: By processing and giving us your shipment, you agree, regardless of whether you sign the front of this Air Waybill, for yourself and as agent for and on behalf of any other person having an interest in this shipment, to all terms on this NON-NEGOTIABLE Air Waybill, and as appropriate any FedEx transportation agreement between you and FedEx covering this shipment and in any applicable tariff, and in our current applicable Service Guide, or Standard Conditions of Carriage, copies of which are available upon request. If there is a conflict between this Air Waybill and any such document then in effect, the transportation agreement, tariff, Service Guide or Standard Conditions of Carriage will control in that order of priority. No one is authorized to alter or modify the terms of our agreement. This Air Way bill shall be binding on us when the shipment is accepted: we may mark this Air Waybill with an employee number as our signature, or our printed name shall be sufficient to constitute our signature of this Waybill. Your Obligations - Printed Signature: You acknowledge that if you process shipments to locations outside the country where your shipment originates, you must enter, to print in lieu of a manual signature on the Air Waybill, the name of the person completing the Air Waybill for all such shipments tendered to FedEx by you using this application. You further acknowledge that such printed name shall be sufficient to constitute your signature on the Air Waybill and acceptance of FedEx's terms and conditions of carriage for purposes of the Warsaw Convention, an International treaty related to International carriage by air and any amendments and protocols thereto, (collectively "Warsaw Convention") and for all other purposes. You warrant that each article in each shipment will be properly described on this Air Waybill and any export documents, is acceptable for transport by FedEx, and that the shipment will be properly marked, addressed and packed to ensure safe transportation with ordinary care in handling. You are responsible for all charges, including transportation charges and all duties, customs, assessments governmental penalties and fines, taxes and FedEx legal costs related to your shipment. Air Carriage Notice: IF THE CARRIAGE OF YOUR SHIPMENT BY AIR INVOLVES AN ULTIMATE DESTINATION OR STOP IN A COUNTRY OTHER THAN THE COUNTRY OF DEPARTURE, THE WARSAW CONVENTION MAY BE APPLICABLE, WHICH TREATY WOULD THEN GOVERN AND IN MOST CASES LIMIT FEDEX'S LIABILITY FOR LOSS, DELAY OF, SHORTAGE, MISDELIVERY, MISINFORMATION, DAMAGE OR FAILURE TO PROVIDE INFORMATION REGARDING YOUR SHIPMENT. In certain countries, the Warsaw convention limits FedEx's liability to u.s. $9.07 per pound (US $20.38 per kilogram or equivalent local currency for the country of origin), unless a higher value for carriage is declared as described below and you pay any applicable supplementary charges. The interpretation and operation of the Warsaw convention's liability limits may vary in each country. There are no specific stopping places which are agreed to and FedEx reserves the right to route the shipment in any way FedEx deems appropriate. Road Transport Notice: Shipments transported partly or solely by road, be there an explicit agreement to do so or not, into or from a country which is a party to the Convention on the Contract for the International Carriage of Goods by Road (the "CMR") are subject to the terms and conditions of the CMR, notwithstanding any other provision of this Air Waybill to the contrary except that the higher limitations of liability as set forth in these conditions shall remain applicable as opposed to those set forth in the CMR. Limitation of Liability: If not governed by the Warsaw Convention, the CMR, or other International treaties, laws, other government regulations, orders, or requirements, FedEx's maximum liability for loss, damage, delay, shortage, misdelivery, or nondelivery of your shipment is limited by this Air Waybill to the greater of the amount of US $100 or US $9.07 per pound (US $20.38 per kilo) (or
Appendix C: Legal Terms and Conditions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 284
equivalent local currency for the country of origin) (or in Canada, the amount of actual damages or CDN$100 per shipment, whichever is less) unless you declare, in advance, a higher value for carriage as described below and pay any applicable supplementary charges. FedEx does not provide cargo liability or all-risk insurance, but you may pay an additional charge for each additional US $100 (or equivalent local currency for the country of origin) of declared value for carriage. If a higher value for carriage is declared and the additional charge is paid, FedEx's maximum liability will be the lesser of the declared value for carriage or your actual damages. Declared Value Limits: The highest declared value FedEx allows for a FedEx Letter/Envelope and FedEx Pak shipment is US$100 or US$9.07 per pound (US$20.38 per kilo)(or the equivalent in local currency), whichever is greater. In Canada, the maximum declared value allowed for customs and carriage per Air Waybill for each FedEx Letter and FedEx Pak is CAN$100. For other shipments, in particular shipments of extraordinary value, including, but not limited to jewelry, artwork, antiques, precious metals, and furs and fur clothing, the declared value of carriage is limited and depends on the contents and the destination of the shipment. Please check the applicable Service Guide, contract of carriage, tariff, or Standard Conditions for an explanation of the declared value limits. If you send more than one package using a single Air Waybill, the declared value for carriage of each package will be determined by dividing the total declared value for carriage by the number of packages in the shipment. Liabilities Not Assumed. IN ANY EVENT, SUBJECT TO THE SERVICE CONDITIONS ON THIS AIR WAYBILL, OR THE APPLICABLE SERVICE GUIDE, STANDARD CONDITIONS, TARIFF OR CONTRACT OF CARRIAGE, FEDEX WON'T BE LIABLE FOR ANY DAMAGES, WHETHER DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL, IN EXCESS OF THE DECLARED VALUE US$100 OR US$9.07 PER LB. (US$20.38 PER KILO) (OR THE EQUIVALENT IN LOCAL CURRENCY) WHICHEVER IS GREATER (OR IN CANADA IN EXCESS OF THE DECLARED VALUE FOR CARRIAGE) (INCLUDING BUT NOT LIMITED TO LOSS OF INCOME OR PROFITS) WHETHER OR NOT FEDEX HAD ANY KNOWLEDGE THAT SUCH DAMAGES MIGHT BE INCURRED. FedEx won't be liable for your acts or omissions, including but not limited to incorrect declaration of cargo, improper or insufficient packing, securing, marking or addressing of the shipment, or for the acts or omissions of the recipient or anyone else with an interest in the shipment. Also, FedEx won't be liable if you or the recipient violate any of the terms of our Agreement. FedEx won't be liable for damage, loss, delay, shortage, misdelivery, nondelivery, misinformation or failure to provide information regarding shipments of cash, currency or other prohibited items. FedEx won't be liable for loss, damage, delay, shortage, misdelivery, nondelivery, misinformation or failure to provide information (i) in connection with shipments of cash, currency, or other prohibited items; or, (ii) caused by events FedEx cannot control, including but not limited to acts of God, perils of the air, weather conditions, mechanical delays, acts of public enemies, war, strikes, civil commotions, or acts or omissions of public authorities (including customs and health officials) with actual or apparent authority. No Warranty: We make no warranties, express or implied. Claims for Loss, Damage or Delay: ALL CLAIMS MUST BE MADE IN WRITING AND WITHIN STRICT TIME LIMITS. SEE OUR TARIFF, APPLICABLE SERVICE GUIDE, OR STANDARD CONDITIONS OF CARRIAGE FOR DETAILS. The Warsaw Convention provides that written claims for damage must be received within 14 days from the date of receipt and within twenty-one days in the event of delay. FedEx may have expanded the claims periods in certain countries and the periods may differ from country to country. Moreover, the interpretation and operation of the Warsaw Convention's claims provisions may vary in each country. Contact the FedEx representative in the country of origin to determine the claims period for your shipment. In the event of nondelivery or misdelivery, we must receive written notice of the claim within 90 days after we accept the shipment. The right to damages against us shall be extinguished unless an action is brought within two years from the date of delivery of the shipment or from the date on which the shipment should have been delivered, or from the date on which the carriage stopped. Within 90 days after notification to us of the claim, it must be documented by sending us all relevant information about it. FedEx is not obligated to act on any claim until all transportation charges have been paid. The claim amount may not be deducted from the transportation charges. If the recipient accepts the shipment without noting any damage on the delivery record, FedEx will assume the shipment was delivered in good condition. In order for us to consider a claim for damage, the contents, original shipping carton and packing must be made available to us for inspection. Right to Inspect: Your shipments may, at FedEx's option, or at the request of customs or other regulatory or government authorities, be opened and inspected by FedEx or such authorities at any time. Responsibility For Payment: Even if you give FedEx different payment
Appendix C: Legal Terms and Conditions
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 285
instructions, you will always be primarily responsible for all charges, including transportation charges, and all duties, custom assessments, governmental penalties and fines, taxes, and FedEx's attorney fees and legal costs, related to shipments tendered under this Agreement. You also will be responsible for any costs FedEx may incur in returning your shipments to you or warehousing them pending disposition. Customs Clearance: By giving us this shipment, you hereby appoint FedEx, or its independent contractor as applicable, as your agent solely for performance of customs clearance and certify FedEx as the nominal consignee for the purpose of designating a customs broker to perform customs clearance. In some instances, local authorities may require additional documentation confirming FedEx's appointment. It is your responsibility to provide proper documentation and confirmation, where required. You are responsible for and warrant your compliance with all applicable laws, rules and regulations, including but not limited to customs laws, import and export laws and government regulations of any country to, from, through or over which your shipments may be carried. You agree to furnish such information and complete and attach to the shipments such documents as are necessary to comply with such laws, rules and regulations. FedEx assumes no liability to you or any other person for any loss or expense due to your failure to comply with this provision. You are also responsible for all charges, including transportation charges, and all duties, customs assessments, governmental penalties and fines, taxes, and FedEx lawyer's fees and legal costs, related to any shipment. Letter of Instruction: You do not complete all the documents required for carriage or if the documents submitted are not appropriate for the services or destination requested, you hereby instruct FedEx, or its independent contractor, as applicable, where permitted by law to complete, correct or replace the documents for you at your expense. However, FedEx is not obligated to do so. If a substitute form of air waybill is needed to complete delivery of your shipment and FedEx completes that document, the terms of this Agreement will continue to govern. FedEx is not liable to you or any other person for FedEx's actions on your behalf under this provision. Items Not Acceptable for Transportation: FedEx does not accept transportation of money (including, but not limited to, coins (except collectible) or negotiable instruments equivalent to cash such as endorsed stocks and bonds.) FedEx excludes all liability for shipments of such items accepted by mistake. Other items may be accepted for carriage only to limited destinations or under restricted conditions. FedEx reserves the right to reject packages based upon these limitations or for reasons of safety or security. You may consult the applicable Service Guide, contract of carriage, tariff or Standard Conditions for specific details. Export Control. You authorize FedEx, and its independent contractors, as applicable, to act as forwarding agent for you for export and customs purposes. You hereby certify that all statements and information contained on all Air Waybills, SEDs and accompanying documentation relating to exportation are true and correct. You further certify that all Commercial Invoice information submitted via API is true and correct. You expressly authorize FedEx and its independent contractors, as applicable, to forward all information of any nature regarding shipments to any and all governmental or regulatory agencies which request or require such information. Furthermore, you understand that civil and criminal penalties, including forfeiture and sale, may be imposed for making false or fraudulent statements or for the violation of any country laws on exportation, including but not limited to, for shipments originating in the U.S., 13 USC. §305; 22 USC. §401; 18 USC. §1001; and 50 USC. App. 2410, and for shipments originating in Canada, the Export and Import Permits Act, R.S.C. E-17. Consult the laws in the country of origin for similar restrictions. You acknowledge that no shipments tendered by you from the United States using API will be sent to any entity listed on the Department of Commerce's Denied Parties List 15 C.F.R. Part 764, Supp. 2, or the list of Special Designated Nationals as published by the Office of Foreign Assets Control of the U.S. Department of the Treasury and that you are neither a denied party or a specially designated national. Consult the laws of the origin country of your shipment for similar provisions. Mandatory Law: Insofar as any provision contained or referred to in the Air Waybill may be contrary to any applicable International treaties, laws, governmental regulations, orders or requirements, such provision shall remain in effect as part of our agreement to the extent that it is not overridden. The invalidity or unenforceability of any provision shall not affect any other provision contained or referred to in the Air Waybill. Unless otherwise indicated, the shipper's address indicated on the face of the Air Waybill is the place of execution and the place of departure and the recipient's address listed on the face of the Air Waybill is the place of destination. Unless otherwise indicated, the first carrier of this shipment is Federal Express Corporation, P.O. Box 727, Memphis, TN 38194.
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 286
Glossary
AES: Automatic Export System
AHS: Additional Handling Charge
API: Application Programming Interface
ASTRA: Advanced Sorting Tracking Routing Assistance
BSO: Broker Select Option
CAD: Canadian Dollars (also $CAD)
CCI: Canada Customs Invoice
CFR or C&F (Cost and Freight): (Destination port-paid to arrival at destination port) Title, risk and insurance cost pass to buyer when delivered on board the ship by seller who pays the transportation cost to the destination port. Used for sea or inland waterway transportation.
CI: Commercial Invoice
CIF (Cost, Insurance and Freight): (Destination port-same as CFR, but includes insurance) Title and risk pass to buyer when delivered on board the ship by seller who pays transportation and insurance cost to destination port. Used for sea or inland waterway transportation.
CIP (Carriage and Insurance Paid To): (Place at destination – CPT, but insurance). Title and risk pass to buyer when delivered to carrier by seller who pays transportation and insurance cost to destination. Used for any mode of transportation.
COD: Collect on Delivery
CPT (Carriage Paid To): (Place at destination – includes all destination port charges). Title, risk, and insurance cost pass to buyer when delivered to carrier or seller who pays transportation and insurance cost to destination. Used for any mode of transportation.
DDP (Delivered Duty Paid): (Consignee door – includes all charges origin to destination). Title and risk pass to buyer when seller delivers goods to named destination point cleared for import. Used for any mode of transportation.
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 287
DDU (Delivered Duty Unpaid): (Consignee door-excluding duties and taxes). Title, risk and responsibility for vessel discharge and import clearance pass to buyer when seller delivers goods on board the ship to destination port. Used for sea or inland waterway transportation.
DG: Dangerous Goods
DUNS: A number assigned to a firm by Duns and Bradstreet.
ECI: Electronic Commercial Invoice
ECOD: Electronic Collect on Delivery
EIN: Employer Identification Number
EXW (Ex Works): (Factory, mill, warehouse: your door) Title and risk pass to buyer including payment of all transportation and insurance cost from the seller's door. Used for any mode of transportation.
FASC: FedEx Authorized Shipping Center
FCA (Free Carrier): (Pick a place after your origin to start) Title and risk pass to buyer including transportation and insurance cost when the seller delivers goods cleared for export to the carrier. Seller is obligated to load the goods on the Buyer's collecting vehicle; it is the Buyer's obligation to receive the Seller's arriving vehicle unloaded.
FDXE: FedEx Express
FDXG: FedEx Ground
FHD: FedEx Home Delivery
FICE: FedEx International Controlled Export
FOB (Free On Board): (Port-same as FAS) Risk pass to buyer including payment of all transportation and insurance cost once delivered on board the ship by the seller. Used for sea or inland waterway transportation.
FTSR: Foreign Trade Statistics Regulations
Girth: Girth is the sum of the four smallest dimensions of a package. Girth = (2” Width + 2” Height).
GST: Global Sales Tax
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 288
GST: Goods and Services (Governmental) Tax
HAL: Hold at Location
HazMat: Hazardous Materials
HST: Harmonized Sales Tax
HTTP: Hypertext Transfer Protocol
IEFS: International Economy Freight Service
IPFS: International Priority Freight Service
ITAR: International Traffic in Arms
KGS: Kilograms
LBS: Pounds
MBG: Money Back Guarantee
MPS: Multiple-Piece Shipment
NAFTA: North America Free Trade Agreement
OP-950: FedEx Ground HazMat Report
OS: Oversize
Oversize Packages (Ground): A package whose Length plus Girth is greater than 84 inches is considered to be Oversize. Oversize packages are considered to have a minimum weight of 30 lbs. (or 50 lbs. if the Length plus the Girth is greater than 108 inches) for U.S. shipments and 50 lbs. for Canadian shipments. There is also a maximum allowable size of “Length plus Girth less than or equal to 130 inches,” as well as a maximum allowable single dimension of 108 inches.
PNG: Portable Network Graphic
PO: Priority Overnight OR Purchase Order
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 289
POD: Proof of Delivery
PST: Provincial Sales Tax
QST: Quebec Provincial Sales Tax
RMA: Return Merchandise Authorization
SASV: Service Availability Shipment Validation
SED: Shipper’s Export Declaration
SLAC: Shipper’s Load and Count
SPOD: Signature Proof of Delivery
SSN: Social Security Number
TIN: Taxpayer Identification Number
URSA: Universal Routing and Sorting Aid
USD: U.S. Dollars (also $USD)
USPS: United States Postal Service
UTI: Universal Transaction Identifier
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 290
Unit of Measure Codes:
Unit of Measure Codes
AR – Carat GR – Gross LYD – Linear Yard
CFT – Cubic Feet GAL – Gallon M – Meters
CG – Centigrams KG – Kilograms MG – Milligram
CM – Centimeters KGM – Kilogram ML – Milliliter
CM3 – Cubic Centimeters L – Liter M2 – Square Meters
DOZ – Dozen LB – Pound M3 – Cubic Meters
DPR – Dozen Pair LFT – Linear Foot NO – Number
EA – Each LNM – Linear Meters OZ – Ounces
G – Grams LTR – Liters PCS – Pieces
ZIP: Zone Improvement Plan code
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 291
Index
C Country Codes table, 253
F FDXCancelEmailLabelReply, 207 FDXCancelEmailLabelReply, example, 208 FDXCancelEmailLabelRequest, 205 FDXCancelEmailLabelRequest, example, 206 FDXCancelExpressTag Reply, example, 225 FDXCancelExpressTagReply, 224 FDXCancelExpressTagRequest, 222 FDXCancelExpressTagRequest, example, 223 FDXCancelGroundCallTagReply, 239 FDXCancelGroundCallTagReply, example, 240 FDXCancelGroundCallTagRequest, 236 FDXCancelGroundCallTagRequest, example, 238 FDXCloseReply, 141 FDXCloseRequest, 138 FDXCloseRequest, example, 140, 142 FDXEmailLabelReply, 202 FDXEmailLabelReply, example, 204 FDXEmailLabelRequest, 182 FDXEmailLabelRequest, example, 199 FDXExpressTagAvailabilityReply, 245 FDXExpressTagAvailabilityReply, example, 247 FDXExpressTagAvailabilityRequest, 241 FDXExpressTagAvailabilityRequest, example, 244 FDXExpressTagReply, 219 FDXExpressTagReply, example, 221 FDXExpressTagRequest, 209 FDXExpressTagRequest, example, 217 FDXFedExLocatorReply, 175
FDXFedExLocatorReply, example, 178 FDXFedExLocatorRequest, 170 FDXFedExLocatorRequest, example, 174 FDXGroundCallTaglRequest, example, 232 FDXGroundCallTagReply, 234 FDXGroundCallTagReply, example, 235 FDXGroundCallTagRequest, 226 FDXRateAvailableServicesReply, 53 FDXRateAvailableServicesReply, example, 61 FDXRateAvailableServicesRequest, 42 FDXRateAvailableServicesRequest, example, 52 FDXRateReply, 28 FDXRateReply, example, 41 FDXRateRequest, 16 FDXRateRequest, example, 26 FDXServiceAvailabilityReply, 169 FDXServiceAvailabilityRequest, 164 FDXServiceAvailabilityRequest, example, 168 FDXShipDelete Request, example, 135 FDXShipDeleteReply, 136 FDXShipDeleteReply, example, 137 FDXShipDeleteRequest, 134 FDXShipReply, 116 FDXShipReply, example, 132 FDXShipRequest, 66 FDXShipRequest, example, 113 FDXSPODReply, 162 FDXSPODRequest
sample letter, 163 FDXSPODRequest, 157 FDXSPODRequest, example, 161, 162 FDXSubscriptionReply, 14
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 292
FDXSubscriptionReply, example, 15 FDXSubscriptionRequest, 11 FDXSubscriptionRequest, example, 13 FDXTrackReply, 148 FDXTrackReply, example, 154 FDXTrackRequest, 144 FDXTrackRequest, example, 147
G Glossary, 286
I Introduction, 4
L label specifications
custom labels, 251 determining screen resolution, 250 general printing overview and methods, 248 label preparation, 251 plain paper and thermal, 248 PNG plain paper label, 249
Legal Terms and Conditions, 282
O overview, 4
R Referenced Documents, 9
S Shipping Label Specifications, 248
T Transaction Layouts, 10 transactions
FDXCancelEmailLabelReply, 207 FDXCancelEmailLabelRequest, 205 FDXCancelExpressTagReply, 224 FDXCancelExpressTagRequest, 222 FDXCancelGroundCallTagReply, 239 FDXCancelGroundCallTagRequest, 236 FDXCloseReply, 141 FDXCloseRequest, 138 FDXEmailLabelReply, 202 FDXEmailLabelRequest, 182 FDXExpressTagAvailabilityReply, 245 FDXExpressTagAvailabilityRequest, 241 FDXExpressTagReply, 219 FDXExpressTagRequest, 209 FDXFedExLocatorReply, 175 FDXFedExLocatorRequest, 170 FDXGroundCallTagReply, 234 FDXGroundCallTagRequest, 226 FDXRateAvailableServicesReply, 53 FDXRateAvailableServicesRequest, 42 FDXRateReply, 28 FDXRateRequest, 16 FDXServiceAvailabilityReply, 169 FDXServiceAvailabilityRequest, 164 FDXShipDeleteReply, 136 FDXShipDeleteRequest, 134 FDXShipReply, 116 FDXShipRequest, 66 FDXSPODReply, 162 FDXSPODRequest, 157
Glossary
FedEx Ship Manager® API/Direct XML Transaction Guide, Jun05.0 293
FDXSubscriptionReply, 14 FDXSubscriptionRequest, 11 FDXTrackReply, 148 FDXTrackRequest, 144
U UTIs: Universal Transaction Identifiers, 5
V Vague Commodity Descriptions table, 258
W What’s New, 7