FedEx Ship Manager API/DIRECT · FedEx Ship Manager® API/DIRECT ... but across all transaction...
Transcript of FedEx Ship Manager API/DIRECT · FedEx Ship Manager® API/DIRECT ... but across all transaction...
Confidential and Proprietary
The information contained in this XML Transaction Guide is confidential and proprietary to FedEx® Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this XML Transaction 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.
© 2006 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, June 2006 1
Table of Contents
Table of Contents .......................................................................................................................................................................................................................................... 1 Revision History ............................................................................................................................................................................................................................................ 4 Introduction.................................................................................................................................................................................................................................................... 7
FedEx XML Overview.................................................................................................................................................................................................................................... 7 UTIs: Universal Transaction Identifiers.......................................................................................................................................................................................................... 8
What’s New .................................................................................................................................................................................................................................................. 10 Referenced Documents............................................................................................................................................................................................................................... 11 XML Transaction Layouts ........................................................................................................................................................................................................................... 12
FDXSubscriptionRequest ............................................................................................................................................................................................................................ 13 Example of a FDXSubscriptionRequest XML Document ....................................................................................................................................................................... 15
FDXSubscriptionReply ................................................................................................................................................................................................................................ 16 Example of a FDXSubscriptionReply XML Document ........................................................................................................................................................................... 17
FDXRateRequest ........................................................................................................................................................................................................................................ 18 Example of FDXRateRequest XML Document ...................................................................................................................................................................................... 26
FDXRateReply............................................................................................................................................................................................................................................. 28 Example of a FDXRateReply XML Document ....................................................................................................................................................................................... 37
FDXRateAvailableServicesRequest ............................................................................................................................................................................................................ 38 Example of FDXRateAvailableServicesRequest XML Document .......................................................................................................................................................... 46
FDXRateAvailableServicesReply ................................................................................................................................................................................................................ 47 Example of FDXRateAvailableServicesReply XML Document .............................................................................................................................................................. 54
FDXShipRequest......................................................................................................................................................................................................................................... 58 Example of FDXShipRequest XML Document (U.S. FedEx Express) ................................................................................................................................................... 97
FDXShipReply ........................................................................................................................................................................................................................................... 100 Example of FDXShipReply XML Document (U.S. FedEx Express) ..................................................................................................................................................... 112
FDXShipDeleteRequest ............................................................................................................................................................................................................................ 114 Example of FDXShipDelete Request ................................................................................................................................................................................................... 115
FDXShipDeleteReply................................................................................................................................................................................................................................. 116 Example of FDXShipDeleteReply Transaction .................................................................................................................................................................................... 117
FDXCloseRequest (Applicable to FedEx Ground only) ............................................................................................................................................................................. 118 Example of FDXCloseRequest XML Document................................................................................................................................................................................... 120
Table of Contents
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 2
FDXCloseReply (Applicable to FedEx Ground only) ................................................................................................................................................................................. 121 Example of FDXCloseRequest XML Document................................................................................................................................................................................... 122
FDXTrack2Request ................................................................................................................................................................................................................................... 124 Example of FDXTrack2Request XML Document................................................................................................................................................................................. 128
FDXTrack2Reply ....................................................................................................................................................................................................................................... 129 Example of FDXTrack2Reply XML Document ..................................................................................................................................................................................... 139
FDXSPODRequest.................................................................................................................................................................................................................................... 141 Example of FDXSPODRequest XML Document.................................................................................................................................................................................. 145
FDXSPODReply ........................................................................................................................................................................................................................................ 146 Example of FDXSPODReply XML Document...................................................................................................................................................................................... 147 Sample FULL Signature Proof of Delivery (SPOD) Letter.................................................................................................................................................................... 148 Sample PARTIAL Signature Proof of Delivery (SPOD) Letter ............................................................................................................................................................. 149
FDXServiceAvailabilityRequest (FedEx Express Only) ............................................................................................................................................................................. 150 Example of FDXServiceAvailabilityRequest XML Document ............................................................................................................................................................... 153
FDXServiceAvailabilityReply (FedEx Express Only) ................................................................................................................................................................................. 154 Example of FDXServiceAvailabilityReply XML Document ................................................................................................................................................................... 155
FDXFedExLocatorRequest........................................................................................................................................................................................................................ 157 Example of FDXFedExLocatorRequest XML Document...................................................................................................................................................................... 160
FDXFedExLocatorReply............................................................................................................................................................................................................................ 161 Example of FDXFedExLocatorReply XML Document.......................................................................................................................................................................... 163
FDXEmailLabelRequest ............................................................................................................................................................................................................................ 167 Example of FDXEmailLabelRequest XML Document .......................................................................................................................................................................... 182
FDXEmailLabelReply ................................................................................................................................................................................................................................ 185 Example of FDXEmailLabelReply XML Document .............................................................................................................................................................................. 186
FDXCancelEmailLabelRequest ................................................................................................................................................................................................................. 187 Example of FDXCancelEmailLabelRequest XML Document ............................................................................................................................................................... 188
FDXCancelEmailLabelReply ..................................................................................................................................................................................................................... 189 Example of FDXCancelEmailLabelReply XML Document ................................................................................................................................................................... 190
FDXExpressTagRequest ........................................................................................................................................................................................................................... 191 Example of FDXExpressTagRequest XML Document......................................................................................................................................................................... 197
FDXExpressTagReply ............................................................................................................................................................................................................................... 199 Example of FDXExpressTagReply XML Document............................................................................................................................................................................. 200
FDXCancelExpressTagRequest................................................................................................................................................................................................................ 201 Example of FDXCancelExpressTagRequest XML Document.............................................................................................................................................................. 202
FDXCancelExpressTagReply .................................................................................................................................................................................................................... 203
Table of Contents
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 3
Example of FDXCancelExpressTag Reply XML Document................................................................................................................................................................. 204 FDXGroundCallTagRequest...................................................................................................................................................................................................................... 205
Example of FDXGroundCallTagRequest XML Document.................................................................................................................................................................... 210 FDXGroundCallTagReply.......................................................................................................................................................................................................................... 212
Example of FDXGroundCallTagReply XML Document........................................................................................................................................................................ 213 FDXCancelGroundCallTagRequest........................................................................................................................................................................................................... 214
Example of FDXCancelGroundCallTagRequest XML Document ........................................................................................................................................................ 215 FDXCancelGroundCallTagReply............................................................................................................................................................................................................... 216
Example of FDXCancelGroundCallTagReply XML Document............................................................................................................................................................. 217 FDXExpressTagAvailabilityRequest .......................................................................................................................................................................................................... 218
Example of FDXExpressTagAvailabilityRequest XML Document........................................................................................................................................................ 220 FDXExpressTagAvailabilityReply .............................................................................................................................................................................................................. 221
Example of FDXExpressTagAvailabilityReply XML Document ............................................................................................................................................................ 222 FDXNotificationRequest ............................................................................................................................................................................................................................ 223
Example of FDXNotificationRequest.................................................................................................................................................................................................... 228 FDXNotificationReply ................................................................................................................................................................................................................................ 231
Example of FDXNotificationReply........................................................................................................................................................................................................ 235 Shipping Label Specifications.................................................................................................................................................................................................................. 236
Plain Paper and Thermal Label Specifications .......................................................................................................................................................................................... 236 General Printing Overview and Methods ............................................................................................................................................................................................. 236 PNG Plain Paper Label........................................................................................................................................................................................................................ 236 PDF Label............................................................................................................................................................................................................................................ 237 4x6 PNG Label .................................................................................................................................................................................................................................... 238 Determining Screen Resolution ........................................................................................................................................................................................................... 238 Custom Labels..................................................................................................................................................................................................................................... 239 FedEx Shipping Label Preparation ...................................................................................................................................................................................................... 240
Appendix A: Country Codes..................................................................................................................................................................................................................... 241 Appendix B: Vague Commodity Descriptions......................................................................................................................................................................................... 245 Appendix C: Legal Terms and Conditions .............................................................................................................................................................................................. 263 Glossary ..................................................................................................................................................................................................................................................... 264 Index ........................................................................................................................................................................................................................................................... 269
Revision History
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 4
Revision History
Date Section Description
4/04/06 Cover, footer Changed version from March, 2006 to June, 2006
4/04/06 Reference Documents Changed URL link for FedEx Service Guide to current URL
4/04/06 FDXNotificationRequest Added example for entering 3 email addresses in transaction; formatted first example to match
4/04/06 Entire document For language codes and language locale codes, changed font from Times New Roman to Arial
4/04/06 FDXNotificationRequest Deleted strikethrough verbiage in PagingToken description
4/10/06 FDXShipRequest
• Changed element requirements for International / RecipientTIN, updating for destination of Brazil • Added new element, International / RecipientTaxIDType
4/10/06 FDXShipRequest Updated PONumber, InvoiceNumber, and Origin / Contact / Department data element requirements to indicate that if this data is passed in the transaction, it displays on the Express thermal label.
4/10/06 FDXShipRequest Added new value, PDF, to ImageType element to support PDF label generation
4/10/06 Shipping Label Specifications Added PDF Label section with requirements
4/10/06 Entire document Added values of the language code of es and language locale code of US for data elements LanguageCode and LocaleCode to support US Spanish
4/11/06 What’s New Added the following new features: • Brazil Tax ID Validation • Pass References to Print on Thermal Label • PDF Label • US Spanish
4/14/06 FDXShipRequest For element AdmissibilityPackageType, added descriptions to the values
4/17/06 Entire document Formatted all XML sample transactions to be consistent in appearance throughout document
5/1/06 FDXExpressTagRequest Replaced example of FDXExpressTagRequest
5/1/06 FDXExpressTagRequest FDXEmailLabelRequest
Corrected "E-mailAddress" field to "E-MailAddress" for the destination contact
5/2/06 FDXEmailLabelRequest FDXExpressTagRequest FDXGroundCallTagRequest
Changed values for PayorType element to SENDER and THIRDPARTY only
Revision History
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 5
Date Section Description
5/3/06 Entire document Changed RMA acronym meaning to Return Materials Authorization as defined at fedex.com
5/15/06 FDXRateAvailableServicesReply In the example of the reply, removed the Ground portion of the reply since the request example indicated only a search for Express
5/15/06 Entire document In the SignatureOption element, removed "intra-Canada" from "For intra-Canada FedEx Express shipments, the 'Deliver without Signature' option will not be allowed when …."
5/15/06 FDXShipRequest Removed "( ImageType other than PNG)" from description of LabelStockOrientation.
5/15/06 FDXShipRequest In the Multipiece section, • Changed the "Valid For" column for elements shown to "All" instead of "Intl All" • In PackageCount element, removed MPS from "FDXE only applies to COD, MPS, and
international.
5/15/06 FDXServiceAvailabilityRequest In the Service element, removed the following values since this is an Express transaction: • FEDEXGROUND • GROUNDHOMEDELIVERY
5/15/06 FDXExpressTagRequest In the LatestPickupTime and ReadyTime elements, removed verbiage about ResidentialPickup element, as that is a Ground element
5/15/06 FDXShipRequest Made SignatureRelease an optional element
5/16/06 FDXFedExLocatorRequest Removed FDXE as applicable carrier from Ground element
5/16/06 FDXTrack2Request Added parent element of Destination to the following elements: • DestinationCountryCode • DestinationPostalCode
5/16/06 FDXShipRequest In International / Commodity section header, deleted from description " the first four occurrences of" and replaced with "this"
5/16/06 FDXShipRequest In Payment / Payor / AccountNumber element description, clarified requirements
5/17/06 FDXExpressTagRequest In SpecialServices, deleted NonIndirectDelivery element
5/17/06 FDXExpressTagAvailabilityReply Provided explanation of values in AvailabilityCode element
5/17/06 FDXCloseReport In the ReportIndicator element, deleted value of MULTIWEIGHT
5/18/06 FDXShipRequest In International / Commodity section, provided further explanation of NumberOfPieces and Quantity elements
6/08/06 FDXShipRequest For Label / Image Type, changed description of PNG4X6 to " PNG4X6 – PNG image. Valid for domestic shipping only."
Revision History
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 6
Date Section Description
6/08/06 FDXShipReply, FDXRateReply
For RateZone element, changed applicable carrier from "FDXE" to "FDXE/FDXG"
6/21/06 Appendix C Removed Conditions of Contract. This is printed with the label.
Introduction
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 7
Introduction Welcome
Welcome to the FedEx XML Transaction 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, June 2006 8
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
FDXE/FDXG FedEx Ship-A-Package
2518 FDXRateRequest / FDXRateReply
FDXE/FDXG FedEx Rate-A-Package
2519 FDXRateAvailableServicesRequest / FDXRateAvailableServicesReply
FDXE/FDXG Rate Available Services
2521 FDXShipDeleteRequest / FDXShipDeleteReply
FDXE/FDXG FedEx Ship Delete-A-Package
2522 FDXCloseRequest / FDXCloseReply
FDXG End-of-Day Close
2523 FDXSubscriptionRequest / FDXSubscriptionReply FDXE/FDXG Subscription
2529 FDXSPODRequest / FDXSPODReply
FDXE/FDXG Signature Proof of Delivery
2534 FDXFedExLocatorRequest / FDXFedExLocatorRequest
FDXE/FDXG FedEx Service Center Locator
Introduction
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 9
UTI Schema Applicable Carrier Description
2536 FDXServiceAvailabilityRequest / FDXServiceAvailabilityReply
FDXE Service Availability (FedEx Express Only)
2538 FDXEmailLabelRequest / FDXEmailLabelRequest FDXE/FDXG FedEx Express E-mail Label FedEx Ground E-mail Label
2539 FDXCancelEmailLabelRequest / FDXCancelEmailLabelReply
FDXE/FDXG 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
2544 FDXTrack2Request / FDXTrack2Reply
FDXE FDXG FDXC FXCC FXFR
Track By Number, Destination, Ship Date, and Reference
2545 FDXNotificationRequest / FDXNotificationReply FDXE FDXG FDXC FXCC FXFR
FedEx Notification
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, June 2006 10
What’s New
Feature Benefits Brazil Tax ID Validation Due to the mandatory regulations governing non-document shipments to Brazil, enhancements have been
made to the FDXShipRequest transaction to curb custom delays and shipment returns. The two changes are : • The element International / RecipientTIN is now required for non-document shipments to Brazil.
• A new element, RecipientTaxIDType, has been added to identify the type of data entered in RecipientTIN. The valid values for this element are:
• PASSPORT (If the recipient is not a Brazilian resident.)
• INDIVIDUAL (Brazilian resident Tax ID)
• COMPANY (Brazilian company Tax ID) Non-document shipments to Brazil will fail without values in both RecipientTIN and RecipientTaxIDType.
Pass References to Print on Thermal Label API will now pass reference fields so that thermal labels can be printed with these references. FDXShipRequest uses the following optional elements for you to send values:
• ReferenceInfo / PONumber
• Reference Info / InvoiceNumber
• Origin / Contact / Department
PDF Label The ImageType element has a new value, PDF, to request Portable Document Format (PDF) labels. This helps to resolve the scaling (resizing) issues that affect label certification. To generate PDF labels, you will need: • Adobe Reader 6.0 or higher to process requested labels in PDF
• The printer driver configuration set to ‘none’ for print scaling
US Spanish There is a large Spanish speaking population in the United States who only speak Spanish. To embrace this portion of the population, FedEx has enlarged the language/locale code to include Spanish in the US. This will affect the FDXNotificationRequest, the FDXShipRequest, and the FDXEmailLabelRequest transactions. The new language/locale combination value is esUS and requires entry of es in LanguageCode and US in LocaleCode.
Referenced Documents
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 11
Referenced Documents
Title Location
FedEx Service Guide To download in .pdf format: http://www.fedex.com/us/services/pdf/index.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, June 2006 12
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:
FDXE = FedEx Express FDXG = FedEx Ground FDXC – FedEx Cargo FXCC – FedEx Custom Critical FXFR – FedEx Freight
Valid For This column is used for the shipment and rating transaction only. Valid values:
ALL = Applicable to U.S. and all international shipments INTL = Applicable to non-Intra U.S. shipments USD = Applicable to U.S. 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, June 2006 13
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.
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.
XML Transaction Layouts: FDXSubscriptionRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 14
Element Name Data Type Max Length Element Description/Requirements
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, June 2006 15
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, June 2006 16
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, June 2006 17
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">
<ReplyHeader>
<CustomerTransactionIdentifier>String</CustomerTransactionIdentifier>
</ReplyHeader>
<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, June 2006 18
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
FDXE/FDXG 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/FDXG ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a rate quote.
RequestHeader / MeterNumber FDXE/FDXG 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 FDXE/FDXG ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ReturnShipmentIndicator FDXE/FDXG ALL xs:string 13 Optional. Valid values:
• NONRETURN • PRINTRETURNLABEL • EMAILLABEL • FEDEXTAG (ExpressTag/CallTag – dependent on carrier
code)
ShipDate FDXE/FDXG 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, June 2006 19
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
Service FDXE/FDXG ALL xs:string 32 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 FDXE/FDXG ALL xs:string 13 One of the following package types is required: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 20
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
• FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING
If value entered in this element is FEDEXENVELOPE, FEDEX10KGBOX, or FEDEX25KGBOX, an MPS rate quote is not allowed.
WeightUnits FDXE/FDXG ALL xs:string 3 Required. Valid weight types:
• LBS • KGS
Must be LBS for a U.S. FedEx Express rate quote.
Weight FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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/FDXG ALL xs:string 2 Required. Represents the country from which the shipment will be originating.
DESTINATIONADDRESS
DestinationAddress / StateOrProvinceCode
FDXE/FDXG 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/FDXG ALL xs:string 16 Required only if Recipient Country Code is US or CA.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 21
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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/FDXG ALL xs:string 2 Required. Represents the country code to which the shipment is destined.
PAYMENT
Payment / PayorType FDXE/FDXG ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, NO rates will still be returned.
DIMENSIONS
Dimensions / Length FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number
Dimensions / Width FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number
Dimensions / Height FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number
Dimensions / Units FDXE/FDXG 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. FedEx Express must be in inches.
DECLAREDVALUE
DeclaredValue / Value FDXE/FDXG ALL xs:decimal 8.2 Required for all shipments. The declared value of package contents. Format: Two explicit decimal positions (e.g. 100.00);
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 22
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
11 total length including decimal place.
DeclaredValue / CurrencyCode FDXE/FDXG 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.
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 FDXE/FDXG USD xs:boolean If = true or 1, the shipment is Residential Delivery.
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 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 FDXE/FDXG ALL xs:string 21 Optional. Specifies one of the Delivery Signature Options. Valid values:
• DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
For FedEx Express shipments, the DELIVERWITHOUTSIGNATURE option will not be allowed when the following special services are requested:
• Alcohol • Hold at Location • Dangerous Goods • Declared Value greater than $500
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, June 2006 24
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PackageCount FDXE/FDXG ALL xs:integer 4 Required for multiple-piece shipments (MPS). 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. FDXE only applies to COD, MPS, and international. Valid values: 1 to 999
VARIABLEHANDLINGCHARGES
VariableHandlingCharges / Level FDXE/FDXG 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 FedEx Ground or FedEx Express MPS shipment only.
Note: Value "SHIPMENT" = shipment level affects the entire shipment. Anything else sent in Child will be ignored.
VariableHandlingCharges / Type FDXE/FDXG 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
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 25
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
VariableHandling Charges / Amount OrPercentage
FDXE/FDXG 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, June 2006 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>
<Payment>
XML Transaction Layouts: FDXRateRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 27
<PayorType>SENDER</PayorType>
</Payment>
<PackageCount>1</PackageCount>
</FDXRateRequest>
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 28
FDXRateReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE/FDXG ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code FDXE/FDXG 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 FDXE/FDXG 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 dimmed weight was used to derive freight charges.
EstimatedCharges / RateScale FDXE ALL xs:string 5 Rate scale used to rate package.
EstimatedCharges / RateZone FDXE/FDXG 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 FedEx 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.
ESTIMATEDCHARGES / DISCOUNTEDCHARGES
EstimatedCharges / DiscountedCharges / BaseCharge
FDXE/FDXG 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.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 29
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / TotalDiscount
FDXE/FDXG 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
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue
FDXE/FDXG 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.
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
FDXE/FDXG 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: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 30
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 / 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.
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/FDXG 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.
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
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel
FDXE/FDXG 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, June 2006 31
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / DiscountedCharges / Surcharges / FedExTag
FDXE/FDXG 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
FDXE/FDXG ALL Xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalSurcharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / SaturdayPickup
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeclaredValue
FDXE/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, June 2006 32
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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
FDXE/FDXG 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.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 33
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 / 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/FDXG 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
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / EmailLabel
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExTag
FDXE/FDXG 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
FDXE/FDXG 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.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 34
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / ListCharges / TotalSurcharge
FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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.
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 35
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
EstimatedCharges / VariableHandling / TotalCustomerCharge
FDXE/FDXG 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
FDXE/FDXG 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 / 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.
EstimatedCharges / OversizeClass FDXG ALL xs:string 1
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
XML Transaction Layouts: FDXRateReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 36
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
SignatureOption FDXE/FDXG 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/FDXG CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For FedEx 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, June 2006 37
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, June 2006 38
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
FDXE/FDXG 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/FDXG ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a rate quote.
RequestHeader / MeterNumber FDXE/FDXG 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 FDXE/FDXG ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate FDXE/FDXG 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.
ReturnShipmentIndicator FDXE/FDXG ALL xs:string 13 Required. Valid values:
• NONRETURN • PRINTRETURNLABEL • EMAILLABEL
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 39
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
Service FDXE/FDXG ALL xs:string 32 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: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 40
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Packaging FDXE/FDXG 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.
WeightUnits FDXE/FDXG ALL xs:string 3 Valid weight types: • LBS • KGS
LBS is required for a U.S. FedEx Express rate quote.
Weight FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 41
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
OriginAddress / CountryCode FDXE/FDXG ALL xs:string 2 Required. Represents the country from which the shipment will be originating.
DESTINATIONADDRESS
DestinationAddress / StateOrProvinceCode
FDXE/FDXG 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/FDXG 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 FDXE/FDXG ALL xs:string 2 Required. Represents the country code to which the shipment is destined.
PAYMENT
Payment / PayorType FDXE/FDXG ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, no rates will still be returned.
DIMENSIONS
Dimensions / Length FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number
Dimensions / Width FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number
Dimensions / Height FDXE/FDXG ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 42
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Dimensions / Units FDXE/FDXG 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. FedEx Express must be in inches.
DECLAREDVALUE
DeclaredValue / Value FDXE/FDXG 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.
DeclaredValue / CurrencyCode FDXE/FDXG 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 FedEx 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.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 43
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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 FDXE/FDXG 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.
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 44
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / SignatureOption FDXE FDXG
ALL xs:string 21 Optional. Specifies the Delivery Signature Option requested for the shipment. Valid values:
• DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
For FedEx Express shipments, the DELIVERWITHOUTSIGNATURE option will not be allowed when the following special services are requested:
• Alcohol • Hold at Location • Dangerous Goods • Declared Value greater than $500
HOMEDELIVERY
HomeDelivery / Type FDXG USD xs:string 11 One of the following values are required for FedEx Home Delivery shipments:
• DATECERTAIN • EVENING • APPOINTMENT
PackageCount FDXE/FDXG ALL xs:positive integer
4 Required for multiple-piece shipments (MPS). 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. FDXE only applies to COD, MPS, and international. Valid values: 1 to 999
VARIABLEHANDLINGCHARGES
XML Transaction Layouts: FDXRateAvailableServicesRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 45
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
VariableHandlingCharges / Level FDXE/FDXG 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 FedEx Ground or FedEx Express MPS shipment only.
Note: Value "SHIPMENT" = shipment level affects the entire shipment. Anything else sent in Child will be ignored.
VariableHandlingCharges / Type FDXE/FDXG 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
VariableHandlingCharges / AmountOrPercentage
FDXE/FDXG 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, June 2006 46
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, June 2006 47
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
FDXE/FDXG ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code FDXE/FDXG 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/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 8 Returned only if a soft error/warning message is available.
SoftError / Message FDXE/FDXG ALL xs:string 255 Returned only if a soft error/warning message is available.
ENTRY
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 48
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
Entry / Service FDXE/FDXG 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 FDXE/FDXG 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/FDXG USD xs:string 5 Rate scale used to rate package.
Entry / Estimated Charges / RateZone FDXE/FDXG 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.
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
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 49
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
Entry / Estimated Charges / Discounted Charges / Base Charge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
Entry / Estimated Charges / ListCharges / BaseCharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG ALL xs:decimal 11.2 Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 50
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
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
FDXE/FDXG 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
Entry / Estimated Charges / Variable Handling / Variable HandlingCharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 51
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
Entry / Estimated Charges / Variable Handling / ListTotal CustomerCharge
FDXE/FDXG 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.
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, June 2006 52
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
Entry / EstimatedCharges / OversizeClass FDXG ALL xs:string 1
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.
SignatureOption FDXE/FDXG 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: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 53
Element Name Applicable Carrier
Valid For Data Type Max
Length Element Description/Requirements
IneligibleForMoneyBackGuarantee FDXE/FDXG CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For FedEx 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, June 2006 54
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>
<DeliveryDay>TUE</DeliveryDay>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 55
<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>
<TotalDiscount>0.00</TotalDiscount>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 56
<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>
<DeliveryDay>TUE</DeliveryDay>
XML Transaction Layouts: FDXRateAvailableServicesReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 57
<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>
</FDXRateAvailableServicesReply>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 58
FDXShipRequest
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
FDXE/FDXG 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
FDXE/FDXG ALL xs:integer 12 Required. The FedEx account number assigned to the FedEx customer initiating the shipment Request.
RequestHeader / MeterNumber
FDXE/FDXG ALL xs:integer 10 Required. The meter number assigned to the FedEx customer from which the shipment is originating.
RequestHeader / CarrierCode
FDXE/FDXG ALL xs:string 4 Required. Valid carrier codes:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate FDXE/FDXG 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 FDXE/FDXG 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.
DropoffType FDXE ALL xs:string 21 Required. Valid drop-off types:
• REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICECENTER • STATION
Only REGULARPICKUP, REQUESTCOURIER, or STATION are
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 59
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
allowed with international freight shipping. This element does not dispatch a courier.
Service FDXE/FDXG ALL xs:string 32 Required. Available FedEx services:
• PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
Packaging FDXE/FDXG ALL xs:string 13 Required. Valid packaging types include:
• FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KGBOX • YOURPACKAGING
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 60
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
WeightUnits FDXE/FDXG ALL xs:string 3 Required. Valid units:
• LBS • KGS
Weight FDXE/FDXG 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. 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.
ReturnShipmentIndicator FDXE/FDXG ALL xs:string 13 Valid values: • NONRETURN • PRINTRETURNLABEL
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 10 Optional. Name of the department from which the shipment is originating. If passed in the transaction, displays on the Express thermal label.
Origin / Contact / PhoneNumber FDXE/FDXG 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: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 61
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Origin / Contact / PagerNumber FDXE/FDXG 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 FDXE/FDXG 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
FDXE/FDXG ALL xs:string FDXE-120 FDXG-35
Optional. Required element for ShipAlert. The email address of the person initiating the shipment.
ORIGIN / ADDRESS
Origin / Address / Line1 FDXE/FDXG ALL xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 FDXE/FDXG ALL xs:string 35 Optional. Secondary address line from which the shipment is originating.
Origin / Address / City FDXE/FDXG ALL xs:string FDXE-120 FDXG-35
Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.
Origin / Address / StateOrProvinceCode
FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 2 Required. Name of the country from which the shipment is originating.
DESTINATION
DESTINATION / CONTACT
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 62
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Destination / Contact / PersonName FDXE/FDXG 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.
Destination / Contact / CompanyName FDXE/FDXG 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 FDXE/FDXG ALL xs:string 10 Optional. Name of the department to whom the shipment is destined.
Destination / Contact / PhoneNumber FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG ALL xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 FDXE/FDXG ALL xs:string 35 Optional. Secondary address line to which the shipment is destined.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 63
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Destination / Address / City FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 10 Required. Method of payment for shipment. Valid payment types:
• SENDER • RECIPIENT • THIRDPARTY • COLLECT
For Return Manager, only SENDER and THIRDPARTY are allowed.
PAYMENT / PAYOR
Payment / Payor / AccountNumber FDXE/FDXG ALL xs:string 12 Required if PayorType is RECIPIENT or THIRDPARTY. The FedEx account number for the payor of the shipment.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 64
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Payment / Payor / CountryCode FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 30 Optional. If passed in the transaction, it will print on the Express thermal label, and can be used later to track by PONumber for Ground.
ReferenceInfo / InvoiceNumber FDXE/FDXG ALL xs:string 30 Optional. If passed in the transaction, it will print on the Express thermal label and can be used later to track by InvoiceNumber reference for Ground.
DIMENSIONS
Dimensions / Length FDXE/FDXG 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 FDXE/FDXG 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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 65
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Dimensions / Height FDXE/FDXG 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 FDXE/FDXG 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
DeclaredValue FDXE/FDXG ALL xs:decimal 8.2 Optional for U.S., international dutiable FedEx Express, and FedEx Ground shipments.
This field is not applicable to an international PIB (document) FedEx Express shipment.
For FedEx Express international MPS, Master piece should contain the total declared value/carriage value, with no declared value/carriage value in Children 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, June 2006 66
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
SpecialServices / COD / Add Transportation Charges
FDXE/FDXG ALL USD
xs:string 45 Required if Freight charges are to be added to the COD amount. 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)
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 67
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
• ADD_SUM_OF_DISCOUNTED_NET_CHARGES_TO_ 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
FDXE/FDXG ALL USD
xs:string 15 Required if the COD element is provided. Valid types:
• ANY • GUARANTEEDFUNDS • CASH
SpecialServices / COD / CODReturn FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG USD xs:string 10 Optional. Department name of the COD remittance party.
SpecialServices / COD / CODReturn / Contact / PhoneNumber
FDXE/FDXG 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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 68
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / COD / CODReturn / Address/Line1
FDXE/FDXG 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.
SpecialServices / COD / CODReturn / Address / Line2
FDXE/FDXG USD xs:string 35 Optional. Secondary address of the COD remittance party.
SpecialServices / COD / CODReturn / Address / City
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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.
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
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 69
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
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.
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 / DangerousGoods / HazMatCertificateData / DOTProperShippingName
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, June 2006 70
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / DangerousGoods / HazMatCertificateData / DOTHazardClassOrDivision
FDXG ALL xs:string 25 Required for OP-950. Optional if Hazardous Materials is selected. Valid values:
• 1.4 • 1.6 • 2.1 • 2.2 • 3 • 4.1 • 5.1 • 5.2 • 7 • 8 • 9 • ORM-D
SpecialServices / DangerousGoods / HazMatCertificateData / DOTIDNumber
FDXG ALL xs:string 6 Optional if Hazardous Materials is selected.
SpecialServices / DangerousGoods / HazMatCertificateData / DOTLabelType
FDXG ALL xs:string 11 Optional. Type DOT Label(s) Required, Label(s) Required, Ltd., Qty., or Exemption Number.
SpecialServices / DangerousGoods / HazMatCertificateData HazMatCertificateData / PackingGroup
FDXG ALL xs:string 3 Optional if Hazardous Materials is selected. Valid groups:
• I • II • III
SpecialServices / DangerousGoods / HazMatCertificateData 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, June 2006 71
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / DangerousGoods / HazMatCertificateData / Units
FDXG ALL xs:string 4 Optional for OP9-50. Valid values:
• oz • gal • lb • Lg • qt • kg • pt
SpecialServices / DangerousGoods / 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 / DangerousGoods / 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.
SpecialServices / ResidentialDelivery FDXE/FDXG 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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 72
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / FutureDayShipment FDXE/FDXG 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.
SpecialServices / EMailNotification / ShipAlertOptional Message
FDXE/FDXG ALL xs:string 120 Optional. Customer specified message to be included in all EMail notifications.
SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER NOTE : ONE OF THE FOLLOWING NOTIFICATION ELEMENTS (SHIPALERT, DELIVERY AND/OR EXCEPTION) MUST BE SET TRUE IN ORDER FOR A NOTIFICATION TO BE SENT
SpecialServices / EMailNotification / Shipper / ShipAlert
FDXE/FDXG ALL xs:boolean Optional If true or 1, Sender’s Email Address will be emailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Shipper / DeliveryNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Shipper / ExceptionNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 73
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Shipper / Format
FDXE/FDXG xs:string 8
Format of email to be sent to the shipper. Valid language codes:
• Text • HTML • WIRELESS
SpecialServices / EMailNotification / Shipper / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 74
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Shipper / LocaleCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SPECIALSERVICES / EMAILNOTIFICATION / RECIPIENT NOTE : ONE OF THE FOLLOWING NOTIFICATION ELEMENTS (SHIPALERT, DELIVERY AND/OR EXCEPTION) MUST BE SET TRUE IN ORDER FOR A NOTIFICATION TO BE SENT
SpecialServices / EMailNotification / Recipient / ShipAlert
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Recipient E-Mail Address will be e-mailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Recipient / DeliveryNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Recipient E-mail Address will be e-mailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Recipient / ExceptionNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Recipient / Format
FDXE/FDXG xs:string 8
Format of email to be sent to the recipient. Valid language codes:
• Text • HTML • WIRELESS
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 75
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SPECIALSERVICES / EMAILNOTIFICATION / BROKER NOTE : ONE OF THE FOLLOWING NOTIFICATION ELEMENTS (SHIPALERT, DELIVERY AND/OR EXCEPTION) MUST BE SET TRUE IN ORDER FOR A NOTIFICATION TO BE SENT
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 76
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Broker / ShipAlert
FDXE/FDXG INTL xs:boolean Optional. If = true or 1, Broker E-mail Address will be e-mailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Broker Delivery Notification
FDXE/FDXG INTL xs:boolean Optional. If = true or 1, Broker E-mail Address will be e-mail notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Broker / ExceptionNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Broker / Format
FDXE/FDXG xs:string 8 Format of email to be sent to the broker. Valid language codes:
• Text • HTML • WIRELESS
SpecialServices / EMailNotification / Broker / LanguageCode
FDXE/FDXG INTL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English).
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 77
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Broker / LocaleCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SPECIALSERVICES / EMAILNOTIFICATION / OTHER Note : One of the following Notification elements (ShipAlert, Delivery and/or exception) must be set true in order for a notification to be sent A maximum of three occurrences are allowed to requests notification Emails to three additional recipients.
SpecialServices / EMailNotification / Other / EMailAddress
FDXE/FDXG ALL xs:string 120 Required.
SpecialServices / EMailNotification / Other / ShipAlert
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, corresponding E-Mail Address will be e-mailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Other / DeliveryNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, the corresponding e-mail address will be emailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Other / ExceptionNotification
FDXE/FDXG ALL xs:boolean Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Other / Format
FDXE/FDXG xs:string 8
Format of email to be sent to the corresponding e-mail address. Valid language codes:
• Text • HTML • WIRELESS
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 78
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / EMailNotification / Other / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Other / LocaleCode
ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SpecialServices / NonStandard Container
FDXG ALL xs:boolean If = true or 1, the shipment is in a nonstandard container.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 79
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
SpecialServices / SignatureOption FDXE/FDXG ALL xs:string 21 Optional. Specifies one of the Delivery Signature Options. Valid values:
• DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
For FedEx Express shipments, the DELIVERWITHOUTSIGNATURE option will not be allowed when the following special services are requested:
• Alcohol • Hold at Location • Dangerous Goods • Declared Value greater than $500
SpecialServices / SignatureRelease FDXE USD CAN
xs:string 10 Optional. Release Authorization Number Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.
HOMEDELIVERY
HomeDelivery / Date FDXG USD xs:date 10 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.
HomeDelivery / Type FDXG USD xs:string 11 Required for home delivery shipments. Valid values:
• DATECERTAIN • EVENING • APPOINTMENT
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 80
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 7 Required to indicate label formatting. Type of data stream or bitmap to be returned. Valid image types:
PNG – plain paper PNG4X6 – PNG image. Valid for domestic shipping only. ELTRON – thermal ZEBRA – thermal UNIMARK – thermal PDF – plain paper
Label / LabelStockOrientation FDXE/FDXG ALL xs:string 8 Required only for thermal labels. 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
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 81
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / DocTabLocation FDXE/FDXG 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 FDXE/FDXG ALL xs:string 8 Optional. Required only if using the doc-tab on a thermal label. Valid values:
• STANDARD • ZONE001 • BARCODED • NONE
Default: STANDARD
LABEL / DOCTABCONTENT / ZONE001
LABEL / DOCTABCONTENT / ZONE001 / HEADERVALUEPAIR
Label / DocTabContent / Zone001 / HeaderValuePair / ZoneNumber
FDXE/FDXG 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
FDXE/FDXG ALL xs:string 12 Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 82
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / DocTabContent / Zone001 / HeaderValuePair / Value
FDXE/FDXG ALL xs:string 12 Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair. FedEx Express path format: FDXShipRequest/ReferenceInfo/CustomerReference FedEx Ground path format: FDXShipRequestReferenceInfoCustomerReference
LABEL / DOCTABCONTENT / BARCODED
Label / DocTabContent / Barcoded / Symbology
FDXE/FDXG 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.
Label / DocTabContent / Barcoded / Header
FDXE/FDXG 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
FDXE/FDXG 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 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 / DISPLAYEDORIGIN / CONTACT
Label / DisplayedOrigin / Contact / PersonName
FDXE/FDXG ALL xs:string 35 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Contact / CompanyName
FDXE/FDXG ALL xs:string 35 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Contact / PhoneNumber
FDXE/FDXG ALL xs:string 16 Required if Label/DisplayedOrigin element is present.
Label / DisplayedOrigin / Address / Line1
FDXE/FDXG ALL xs:string 35 Primary address line from which the shipment is destined. Required.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 83
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
Label / DisplayedOrigin / Address / Line2
FDXE/FDXG ALL xs:string 35 Optional. Secondary address line from which the shipment is destined.
Label / DisplayedOrigin / Address / City
FDXE/FDXG 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
FDXE/FDXG ALL xs:string 2 Required for shipping only if Country Code is US or CA. State code from which the shipment is destined.
Label / DisplayedOrigin / Address / PostalCode
FDXE/FDXG 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
FDXE/FDXG ALL xs:string 2 Required. Name of the country from which the shipment is destined.
Label / MaskAccountNumber FDXE/FDXG ALL xs:boolean 2 Optional If false, FedEx Account Number will be displayed on label. Default: true
MULTIPIECE
MultiPiece / PackageCount FDXE/FDXG ALL xs:positive Integer
4 Required for multiple-piece shipments (MPS). 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. FDXE only applies to COD and international. Valid values: 1 to 999
MultiPiece / PackageSequence Number
FDXE/FDXG ALL xs:positive Integer
4 Required for multiple-piece shipping if PackageCount value is greater than 1.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 84
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
MultiPiece / ShipmentWeight FDXE/FDXG 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 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.
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
FDXE/FDXG 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 FedEx Ground or FedEx 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, June 2006 85
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
VariableHandling Charges / Type
FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG INTL xs:string 15 Optional for destinations other than Brazil. No special characters allowed. Required for non-document shipments to Brazil. For these shipments, data element should contain Brazilian resident tax ID or Brazilian company tax ID or passport number of recipient if the recipient is not a Brazilian citizen.
International / RecipientTaxIDType FDXE INTL Xs :string Required for non-document shipments to Brazil. Optional for other destinations. Type of Brazil Tax ID used in RecipientTIN. Valid values :
• PASSPORT • INDIVIDUAL • COMPANY
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, June 2006 86
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
FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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.
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
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 87
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / Broker / Address / Line1 FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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
FDXE/FDXG 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).
International / Broker / Address / PostalCode
FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG 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
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 88
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / ImporterOfRecord / Contact / PersonName
FDXE/FDXG INTL xs:string 35 Required for Importer. Contact for importer of shipment if other than recipient.
International / ImporterOfRecord / Contact / CompanyName
FDXE/FDXG INTL xs:string 35 Required for Importer. Company for importer of shipment if other than recipient.
International / ImporterOfRecord / Contact / PhoneNumber
FDXE/FDXG 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
FDXE/FDXG INTL xs:string 35 Required for Importer. The primary address for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / Line 2
FDXE/FDXG INTL xs:string 35 Optional. The secondary address for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / City
FDXE/FDXG INTL xs:string 35 Required for Importer. The city for importer of shipment if other than recipient.
International / ImporterOfRecord / Address / StateOrProvinceCode
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG INTL xs:string 2 Required for Importer. The country code for importer of shipment if other than recipient.
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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 89
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / DutiesPayment / PayorType
FDXE INTL xs:string 9 Required for a dutiable international FedEx Express shipment. This element is not applicable to an international document FedEx Express shipment. Payment type for duties and taxes. Valid payment types:
• SENDER • RECIPIENT • THIRDPARTY
International / TermsOfSale FDXE/FDXG INTL xs:string 10 Required for a dutiable international FedEx Express shipment. This element is not applicable to an international document FedEx Express shipment. Valid values:
• FOB_OR_FCA • CIF_OR_CIP • CFR_OR_CPT • EXW • DDU • DDP
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 FDXE/FDXG 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, June 2006 90
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
FDXE/FDXG INTL xs:string 444 Optional.
International / CommercialInvoice / FreightCharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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).
International / CommercialInvoice / Purpose
FDXE/FDXG 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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 91
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / CommercialInvoice / CustomerInvoice Number
FDXE/FDXG 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, this 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. The total number of packages within the shipment that contain this commodity. (Can be greater than or equal to PackageCount.)
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 / CountryOfManufacture
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, June 2006 92
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) FedEx Express shipment. Number of units of a commodity in total number of pieces for this line item. Total quantity of an individual commodity within this shipment. (Used in conjunction with QuantityUnits.) At least one occurrence is required for international dutiable shipments.
International / Commodity / QuantityUnits
FDXE INTL xs:string 3 Optional for an international PIB (document) FedEx 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.
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.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 93
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
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.
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
FDXE/FDXG 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
FDXE/FDXG INTL xs:string 32 FedEx Express: Required for non-document U.S. Export Shipments. FedEx 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, June 2006 94
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
INTERNATIONAL / EXPORT "IF YOU HAVE SELECTED THE B13A OPTION: ‘MANUAL B13A ATTACHED – FEDEX TO STAMP’, FEDEX WILL SUBMIT THE B13A TO CANADA CUSTOMS ON YOUR BEHALF. THE MONEY BACK GUARANTEE WILL NOT BE APPLICABLE TO YOUR SHIPMENT, AND DELIVERY WILL BE DELAYED BY AT LEAST ONE DAY. TO HELP AVOID DELAYS, HAVE YOUR B13A STAMPED PRIOR TO SHIPPING AND INDICATE THE ASSOCIATED TRANSACTION# IN THE FIELD PROVIDED. IF YOU HAVE QUESTIONS PLEASE CALL FEDEX AT 1-800-GO-FEDEX."
International / Export / B13AFilingOption
FDXE INTL xs:string 4 Required for any international non-document shipments with high value ($2000 CAD or higher) originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands must submit proof of a filed B13A declaration prior to export.. 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, June 2006 95
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
International / AdmissibilityPackageType
FDXE/FDXG 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 = BAG BBL = BARREL BSK = BASKET OR HAMPER BOX = BOX BXT = BUCKET BDL = BUNDLE CAG = CAGE CTN = CARTON CAS = CASE CHS = CHEST CNT = CONTAINER CRT = CRATE CYL = CYLINDER DRM = DRUM ENV = ENVELOPE
PKG = PACKAGE PAL = PAIL PLT = PALLET PCL = PARCEL PCS = PIECES REL = REEL ROL = ROLL SAK = SACK SHW = SHRINK WRAPPED SKD = SKID TNK = TANK TBN = TOTE BIN TBE = TUBE UNT = UNIT BOX = OTHER PACKAGING
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
FDXE/FDXG ALL xs:string 20 Optional.
ShipmentContent / ShipmentContentRecord / ItemNumber
FDXE/FDXG ALL xs:string 15 Optional.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 96
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Requirements
ShipmentContent / ShipmentContentRecord / ReceivedQuantity
FDXE/FDXG ALL xs:non negative integer
6 Optional.
ShipmentContent / ShipmentContentRecord / Description
FDXE/FDXG ALL xs:string 80 Optional.
RMA Return Materials Authorization
RMA / Number FDXE/FDXG USD xs:string 20 Return Materials Authorization that is assigned by the sender.
RecipientLocationNumber FDXG ALL xs:string 10 Optional. Recipient location number/store number. The value in this field is embedded in the 2D barcode. Valid characters: [A-Z ;a-z ;0-9] Any character other than A-Z, a-z, 0-9 will be stripped. If the length is greater than 10, characters beyond the 10th position will be truncated.
RMA / Reason FDXE/FDXG USD xs:string 60 Reason for return shipment.
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 97
Example of FDXShipRequest XML Document (U.S. FedEx 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>FEDEXBOX</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>9015558957</FaxNumber>
<E-MailAddress>[email protected]</E-MailAddress>
</Contact>
<Address>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 98
<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>9015555624</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>
</ReferenceInfo>
XML Transaction Layouts: FDXShipRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 99
<Label>
<Type>2DCOMMON</Type>
<ImageType>PNG</ImageType>
</Label>
</FDXShipRequest>
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 100
FDXShipReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE/FDXG ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code FDXE/FDXG ALL xs:string 4 Returned only if an error occurred while processing the transaction.
Error / Message FDXE/FDXG ALL xs:string 120 Returned only if an error occurred while processing the transaction.
SOFTERROR
SoftError / Type FDXE/FDXG 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 FDXE/FDXG ALL xs:string 8 Returned only if a soft error/warning message is available.
SoftError / Message FDXE/FDXG ALL xs:string 255 Returned only if a soft error/warning message is available.
TRACKING
Tracking / TrackingNumber FDXE/FDXG ALL xs:string 20 Contains the tracking number assigned to the shipment if successful.
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 FedEx 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.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 101
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
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. 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. 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/FDXG USD xs:string Zone used for rate if zone applies.
EstimatedCharges / CurrencyCode FDXE ALL xs:string 3 Currency code identifier for the rated currency.
EstimatedCharges / BilledWeight FDXE ALL xs:decimal 6.1 Required for FedEx 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
FDXE/FDXG 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.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 102
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / TotalDiscount
FDXE/FDXG 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
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue
FDXE/FDXG 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/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
FDXE/FDXG 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.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 103
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
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/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/FDXG 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: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 104
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / DiscountedCharges / Surcharges / Oversize
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / ReturnLabel
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / Surcharges / FedExTag
FDXE/FDXG 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
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / DiscountedCharges / TotalSurcharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 105
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
ESTIMATEDCHARGES / LISTCHARGES / SURCHARGES
EstimatedCharges / ListCharges / Surcharges / COD
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / SaturdayPickup
FDXE/FDXG ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / DeclaredValue
FDXE/FDXG 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
FDXE/FDXG 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, June 2006 106
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/FDXG 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/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / ReturnLabel
FDXE/FDXG 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, June 2006 107
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / ListCharges / Surcharges / EmailLabel
FDXE/FDXG USD xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / Surcharges / FedExTag
FDXE/FDXG 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
FDXE/FDXG ALL Xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.
EstimatedCharges / ListCharges / TotalSurcharge
FDXE/FDXG 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
FDXE/FDXG 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 FDXE/FDXG 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: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 108
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
EstimatedCharges / VariableHandling / VariableHandlingCharge
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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 / 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.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 109
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
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.
EstimatedCharges / OversizeClass FDXG ALL xs:string 1
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, June 2006 110
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-making.
COD / Secured Description FDXE USD xs:string 32 Valid values : • Secured • Unsecured
For FedEx 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. 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.
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 FedEx Express shipments. Returned only in the Reply for the last piece of a multiple-piece shipment.
XML Transaction Layouts: FDXShipReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 111
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description / Requirements
Routing / UrsaPrefixCode FDXE ALL xs:string 2 Applicable to a limited number of international countries for international shipping.
LABELS
Labels / OutboundLabel FDXE/FDXG ALL xs:base64 Binary
The label for the package. Returned only in FDXShipReply transaction if the label was requested.
Labels / CODReturnLabel FDXE/FDXG USD ALL
xs:base64 Binary
Label for COD Return payment. Returned only in FDXShipReply transaction representing the final piece of a FedEx Express COD shipment.
SignatureOption FDXE/FDXG 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/FDXG CAN xs:boolean If true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For FedEx 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, June 2006 112
Example of FDXShipReply XML Document (U.S. FedEx 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>PRIORITYOVERNIGHT</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, June 2006 113
<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, June 2006 114
FDXShipDeleteRequest
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
FDXE/FDXG 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/FDXG ALL xs:integer 12 Required. The Sender’s FedEx account number.
RequestHeader / MeterNumber FDXE/FDXG ALL xs:integer 10 Required. The meter number associated with the designated shipment to be deleted.
RequestHeader / CarrierCode FDXE/FDXG ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
TrackingNumber FDXE/FDXG 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, June 2006 115
Example of FDXShipDeleteRequest XML Document 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 FDXShipDeleteRequest 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, June 2006 116
FDXShipDeleteReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE/FDXG ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code FDXE/FDXG ALL xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message FDXE/FDXG 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, June 2006 117
Example of FDXShipDeleteReply XML Document
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 FDXShipDeleteReply. 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, June 2006 118
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.
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.
TrackingNumber xs:string 20 Optional. Provided to obtain the manifest containing this tracking number.
XML Transaction Layouts: FDXCloseRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 119
Element Name Data Type
Max Length Element Description/Requirements
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
XML Transaction Layouts: FDXCloseRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 120
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, June 2006 121
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, June 2006 122
Example of FDXCloseReply 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, June 2006 123
The following is an example of a FedEx 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: FDXTrack2Request
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 124
FDXTrack2Request
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
FDXE FDXG FDXC FXCC FXFR
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 FDXG FDXC FXCC FXFR
ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a tracking response.
RequestHeader / MeterNumber FDXE FDXG FDXC FXCC FXFR
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 FDXE FDXG FDXC FXCC FXFR
ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express Tracking Requests FDXG – FedEx Ground Tracking Requests FDXC – FedEx Cargo Tracking Requests FXCC – FedEx Custom Critical Tracking Requests FXFR – FedEx Freight Tracking Requests
PACKAGEIDENTIFIER Any one of several kinds of identifier for which all packages will be tracked.
XML Transaction Layouts: FDXTrack2Request
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 125
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PackageIdentifier / Value FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Required. An identifier that relates to one or more packages (or to the shipments of which they are part).
PackageIdentifier / Type FDXE FDXG FDXC FXCC FXFR
ALL xs:string 32
Optional. Specifies the type of track desired on the "Search String" field. Valid values:
• EXPRESS_MPS_MASTER (Applicable to FDXE Only) • GROUND_SHIPMENT_ID (Applicable to FDXG Only) • RMA (Applicable for FDXE, FDXG) • TCN (becomes SHR, CUS) (Valid for Request only) • BOL (bill of lading) (multi) • PARTNERCARNBR (Applicable to FXFR Only) • REF (Valid for Request only) • INV (Applicable for FDXG, FXFR) • PO (Applicable for FDXG, FXFR) • CUSTAUTHNUM (Applicable to FXFR Only) • CUR (Applicable for FDXG, FXFR) • DEPARTMENT (Applicable to FDXG Only) • PARTNUM (Applicable to FXCC Only) • SHR (Applicable for FDXE, FDXC, FXFR)
* REF value is non-carrier specific and allows a search by Reference across all available Carrier Codes. Some Search Types limit the search to a carrier (e.g., FedEx Ground Shipment ID, Express MPS). If value is omitted from transaction, defaults to TrackingNumber _Or_Door Tag.
TrackingNumberUniqueIdentifier FDXE FDXG FDXC FXCC
ALL xs:string One of the TrackingNumberUniqueIdentifiers returned in a previous Reply.
XML Transaction Layouts: FDXTrack2Request
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 126
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ShipDateRangeBegin FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Optional, but recommended. If provided, ShipDateRangeEnd is required. Required entry of date range to find desired results for reference tracking number. If not provided, results may vary. Format: YYYY-MM-DD
ShipDateRangeEnd FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Optional, but recommended. If provided, ShipDateRangeBegin is required. Required entry of date range to find desired results for reference tracking number. If not provided, results may vary. Format: YYYY-MM-DD
ShipmentAccountNumber FDXE FDXG FDXC FXCC FXFR
ALL xs:string 9 Optional, but recommended. Account number associated with shipment (as opposed to account number in RequestHeader, which is that of party sending request). If not specified, then the DestinationCountryCode and DestinationPostalCode (where applicable) are required.
Destination / DestinationCountryCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional, but recommended. Country code of shipment destination.
Destination / DestinationPostalCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 16 Optional, but recommended. Postal code of shipment destination. Returned if Recipient Country Code is US or CA.
Language / LanguageCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional. Alpha 2-character code of language desired for certain text elements in Reply. Defaults to EN (English).
XML Transaction Layouts: FDXTrack2Request
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 127
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Language / LocaleCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional. Can be used to specify the dialect or sublanguage of some languages specified with the LanguageCode. Defaults to EN (English).
DetailScans FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean Optional. Defaults to false If set to false or 0 – returns Summary/Profile data, which includes one single scan structure with the most recent scan. If set to true or 1 – returns Detail Scan Activity (multiple scan structure) for each package.
PagingToken FDXE FDXG FDXC FXCC FXFR
ALL xs:string variable Optional. This element is utilized to obtain additional data on second and subsequent FDXTrack2Request transactions when more related tracking information exist that exceed the capacity of any one response structure. 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 the PagingToken element contains value in first FDXTrack2Reply, more tracking data exists. You should populate this element with the value returned in the PagingToken element of the previous transaction.
XML Transaction Layouts: FDXTrack2Request
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 128
Example of FDXTrack2Request 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" ?>
<FDXTrack2Request xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXTrack2Request.xsd">
<RequestHeader>
<CustomerTransactionIdentifier>String</CustomerTransactionIdentifier>
<AccountNumber>123456789</AccountNumber>
<MeterNumber>1234567</MeterNumber>
<CarrierCode>FDXE</CarrierCode>
</RequestHeader>
<PackageIdentifier>
<Value>987654321987</Value>
<Type></Type>
</PackageIdentifier>
<ShipDateRangeBegin>2006-01-01</ShipDateRangeBegin>
<ShipDateRangeEnd>2006-01-23</ShipDateRangeEnd>
<DetailScans>0</DetailScans>
</FDXTrack2Request>
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 129
FDXTrack2Reply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code FDXE FDXG FDXC FXCC FXFR
ALL xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Returned only if an error occurred while processing the transaction.
Error / LocalLanguageMessage FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Error message returned when a transaction fails. Returned only in certain transactions when requested.
DuplicateWaybill FDXE FDXG FDXC FXCC
xs:boolean true if duplicate packages with the same tracking number have been found, and only limited data will be provided for each one.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 130
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
MoreDataFlag FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean Value of true or 1 indicates that more data exists. Returned when additional packages remain to be retrieved.
PagingToken FDXE FDXG FDXC FXCC FXFR
ALL xs:string Variable A string that must be passed in a TrackRequest to retrieve the next set of packages.
PACKAGE Data pertaining to a single package that matches the PackageIdentifier given in the Request.
Package / TrackingNumber FDXE FDXG FDXC FXCC FXFR
ALL xs:string 20 Tracking number provided in the Request.
Note: Door tag will never be returned in the response.
Package / SoftError
Package / SoftError / Type FDXE FDXG FDXC FXCC FXFR
ALL xs:string 25 Returned only if a soft error/warning message is available. Valid values:
• WARNING • INFORMATIONAL
Package / SoftError / Code FDXE FDXG FDXC FXCC FXFR
ALL xs:string 8 Returned only if a soft error/warning message is available.
Package / SoftError / Message FDXE FDXG FDXC FXCC FXFR
ALL xs:string 255 Returned only if a soft error/warning message is available.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 131
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / TrackingNumberUniqueIdentifier
FDXE FDXG FDXC FXCC
ALL xs:string
A string which, together with the tracking number, can be used to uniquely identify a package in a follow-up Request. It is returned when duplicate waybills were found with the same tracking number.
Package / StatusCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 100
Package / StatusDescription FDXE FDXG FDXC FXCC FXFR
ALL xs:string 4
Package / ServiceCommitMessage FDXE ALL xs:string 4
Package / CarrierCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 4 Specifies the particular carrier the package was shipped. Valid values:
FDXE – FedEx Express Tracking Requests FDXG – FedEx Ground Tracking Requests FDXC – FedEx Cargo Tracking Requests FXCC – FedEx Custom Critical Tracking Requests FXFR – FedEx Freight Tracking Requests
PACKAGE / OTHERIDENTIFIER Another identifier that is related to this package.
Package / OtherIdentifier / Value FDXE FDXG FDXC FXCC FXFR
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: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 132
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / OtherIdentifier / Type FDXE FDXG FDXC FXCC FXFR
ALL xs:string 32 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 • GROUND_SHIPMENT_ID • RMATCNBOL • PARTNERCARNBR • REF • INV • PO • CUSTAUTHNUM • CUR • DEPARTMENT • PARTNUM • SHR • GOVBOL • COD • RETURNTOSHIPPER
Package / Service FDXE FDXG FDXC FXCC FXFR
ALL xs:string 70 String describing service type.
Package / Weight FDXE/FDXG ALL xs:decimal 6.1 Gross weight of the individual package. Format: One explicit decimal position (e.g. 5.0)
Package / ShipmentWeight FXFR FXCC FDXC FDXE
ALL xs:decimal 8.1 Gross weight of shipment of which this package is a part.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 133
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / WeightUnits FXFR FXCC FDXC FDXE FDXG
ALL xs :nmtoken 3 Valid values: • KGS • LBS
Package / PackagingDescription FDXE FDXG FDXC FXCC FXFR
ALL xs:string 20 Description of packaging type of this package. Returned upon successful Reply for only.
Package / 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.
Package / PackageCount FDXE/FDXG ALL xs:string 4 Count of packages in multiple-piece shipment.
PACKAGE / SHIPPERADDRESS Shipper address information.
Package / ShipperAddress / City FXFR/FXCC ALL xs:string 40 Name of the city to which the shipment is destined.
Package / ShipperAddress / StateOrProvince Code
FXFR/FXCC ALL xs:string 2 State or province to which the shipment is destined.
Package / ShipperAddress / PostalCode FXFR/FXCC ALL xs:string 16 Postal code of the State or province to which the shipment is destined. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Package / ShipperAddress / CountryCode FXFR/FXCC ALL xs:string 2 Name of the country to which the shipment is destined.
PACKAGE / ORIGINLOCATIONADDRESS Origin location (carrier facility) address.
Package / OriginLocationAddress / City FXFR/FXCC ALL xs:string 40 Name of the city to which the shipment is destined.
Package / OriginLocationAddress / StateOrProvince Code
FXFR/FXCC ALL xs:string 2 State or province to which the shipment is destined.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 134
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / OriginLocationAddress / PostalCode
FXFR/FXCC ALL xs:string 16 Postal code of the State or province to which the shipment is destined. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Package / OriginLocationAddress / CountryCode
FXFR/FXCC ALL xs:string 2 Name of the country to which the shipment is destined.
Package / EstimatedPickupDate FXCC ALL xs:date 10 Projected pickup date.
Package / EstimatedPickupTime FXCC ALL xs:date 10 Projected pickup time.
Package / ShipDate FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Date on which package was tendered to FedEx.
Package / TotalTransitDistance FXCC ALL xs:non negative integer
Package / DistanceToDestination FXCC ALL xs:non negative integer
Package / DistanceUnits FXCC ALL xs:non negative integer
Units in which TotalTransitDistance and DistanceToDestination are expressed. Valid values:
• KM • MI
PACKAGE / DESTINATIONADDRESS Destination address information.
Package / DestinationAddress / City FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Name of the city to which the shipment is destined.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 135
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / DestinationAddress / StateOrProvince Code
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 State or province code to which the shipment is destined.
Package / DestinationAddress / PostalCode
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 16 Postal Code returned if Recipient Country Code is US or CA.
Package / DestinationAddress / CountryCode
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Name of the country to which the shipment is destined.
PACKAGE / DESTINATIONLOCATIONADDRESS Destination location (carrier facility) address.
Package / DestinationLocationAddress / City
FXFR/FXCC ALL xs:string 40 Name of the city of the carrier facility for the package destination.
Package / DestinationLocationAddress / StateOrProvince Code
FXFR/FXCC ALL xs:string 2 State or province of the carrier facility for the package destination.
Package / DestinationLocationAddress / PostalCode
FXFR/FXCC ALL xs:string 16 Postal code of the State or province of the carrier facility for the package destination. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Package / DestinationLocationAddress / CountryCode
FXFR/FXCC ALL xs:string 2 Name of the country of the carrier facility for the package destination.
Package / EstimatedDelivery Date FDXE FDXG FXCC FXFR
ALL xs:date 10 Projected package delivery date based on ship date, service, and destination.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 136
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / EstimatedDelivery Time FDXE FDXG FXCC FXFR
ALL xs:time 10 Projected package delivery time based on ship date, service, and destination.
Package / DeliveredDate FDXE/FDXG ALL xs:date 10 Date when the package was delivered at destination.
Package / DeliveredTime FDXE/FDXG ALL xs:time Time when the package was delivered at destination.
TrackProfile / DeliveredLocation Code FDXE ALL xs:string 2 Pairs with DeliveredLocation Description element. Returned upon successful Reply only.
TrackProfile / DeliveredLocation Description
FDXE ALL xs:string 25 Relative location at which package was left, such as Front Desk or Back Door. Pairs with Delivered LocationCode element. Returned upon successful Reply only.
Package / SignedForBy FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Signature of person who signed for packages, or relative location at which package was left, such as Front Desk or Back Door.
Package / SignatureProofOfDeliveryAvailable
FDXE/FDXG USD/ALL
xs :boolean Whether image of signature given upon delivery is available.
Package / PODNotificationsAvaiilable FDXE FDXG FDXC FXCC FXFR
ALL xs :boolean True if and only if Proof Of Delivery Notifications are available.
Package / ExceptionNotificationsAvaiilable
FDXE FDXG FXFR
ALL xs :boolean True if and only if Exception Notifications are available.
PACKAGE / SPLITSHIPMENTPART A portion of a shipment that has been split across vehicles; will not be returned if the parts have been rejoined or if all have been delivered. Count of pieces or skids traveling together.
Package / SplitShipmentPart / Date FDXC ALL xs:date 10
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 137
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / SplitShipmentPart / Time FDXC ALL xs:time
Package / SplitShipmentPart / StatusCode
FDXC ALL xs:string 4
Package / SplitShipmentPart / StatusDescription
FDXC ALL xs:string 100
PACKAGE / EVENT One scan or other event related to the package.
Package / Event / Date FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Date when the scan event occurred on package.
Package / Event / Time FDXE FDXG FDXC FXCC FXFR
ALL xs:time Time when the scan event occurred on package.
Package / Event / Type FDXE FDXG FDXC FXCC FXFR
ALL xs:string 3 the type of scan event occurred on package.
Package / Event / Description FDXE FDXG FDXC FXCC FXFR
ALL xs:string 80 the description of the scan event type occurred on package.
Package / Event / StatusExceptionCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 3
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 138
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / Event / StatusExceptionDescription
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 80
PACKAGE / EVENT / ADDRESS Address to which the event occurred.
Package / Event / Address / City FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Name of the city to which the event occurred.
Package / Event / Address / StateOrProvince Code
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 State or province to which the event occurred.
Package / Event / Address / PostalCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 16 Postal code of the State or province to which the event occurred. Must be numeric for U.S. No embedded dashes allowed. Valid characters: A-Z; 0-9; a-z
Package / Event / Address / CountryCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Name of the country to which the event occurred.
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 139
Example of FDXTrack2Reply XML Document
<?xml version="1.0" encoding="UTF-8"?> <FDXTrack2Reply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXTrack2Reply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> <Package> <TrackingNumber>123456789123</TrackingNumber> <TrackingNumberUniqueIdentifier>1234567890~123456789123</TrackingNumberUniqueIdentifier> <StatusCode>DL</StatusCode> <StatusDescription>Delivered</StatusDescription> <CarrierCode>FDXE</CarrierCode> <Service>Priority Box</Service> <Weight>6.0</Weight> <ShipmentWeight>6.0</ShipmentWeight> <WeightUnits>LBS</WeightUnits> <PackagingDescription>FedEx Box</PackagingDescription> <PackageSequenceNumber>1</PackageSequenceNumber> <PackageCount>1</PackageCount> <ShipDate>2006-01-12</ShipDate> <DestinationAddress> <City>PEORIA</City> <StateOrProvinceCode>OH</StateOrProvinceCode> <CountryCode>US</CountryCode> </DestinationAddress> <DeliveredDate>2006-01-16</DeliveredDate> <DeliveredTime>15:03:00</DeliveredTime> <DeliveredLocationCode>01</DeliveredLocationCode> <DeliveredLocationDescription>Receptionist/Front Desk</DeliveredLocationDescription> <SignedForBy>E.STHER</SignedForBy> <SignatureProofOfDeliveryAvailable>false</SignatureProofOfDeliveryAvailable> <PODNotificationsAvailable>true</PODNotificationsAvailable> <Event> <Date>2006-01-16</Date> <Time>15:03:00</Time> <Type>DL</Type>
XML Transaction Layouts: FDXTrack2Reply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 140
<Description>Delivered</Description> <Address> <City>PEORIA</City> <PostalCode>10402</PostalCode> <StateOrProvinceCode>OH</StateOrProvinceCode> <CountryCode>US</CountryCode> </Address> </Event> </Package> </FDXTrack2Reply>
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 141
FDXSPODRequest
The Signature Proof of Delivery (SPOD) offers you the ability to request proof of shipment delivery and the signature of the party which accepted the package in the form of a Letter or Fax. Based on the information you provide in the FDXSPODRequest, you will receive a full or partial SPOD Letter or Fax.
A full SPOD displays the full shipper and recipient information on the document. To receive a full SPOD, you must provide an account number associated with the shipment tracking number.
A partial SPOD will not display the confidential shipper nor recipient information on the SPOD document. A partial SPOD is returned if the account number specified in the FDXSPODRequest is not related to the shipment tracking number.
Note: The PDF formatted SPOD Letters are supported with Adobe Reader 4.0 or higher.
The following fields 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
FDXE/FDXG 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 FDXE/FDXG USD & CA
xs:integer 12 The FedEx account number of the Sender is required to successfully receive a SPOD response.
RequestHeader / MeterNumber FDXE/FDXG 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 FDXE/FDXG USD & CA
xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
ShipDate FDXE/FDXG USD & CA
xs:date 10 Optional for FedEx Ground Requests only. For all FedEx Express Requests, a ship date is required.
TrackingNumber FDXE/FDXG USD & CA
xs:string 20 Required.
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 142
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
LanguageCode FDXE/FDXG USD & CA
xs:string 2 Code indicating language of SPOD letter. One of the following package types is required:
EN – English FR – French (Canadian)
ShipmentAccountNumber FDXE/FDXG ALL xs:string 12 Optional, but recommended. Specific account number associated with a shipment (as opposed to account number in RequestHeader, which is that of party sending request). This account number is not necessarily the same as the "sender" or "bill to" account number for a shipment, but it could contain either.
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, June 2006 143
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ReturnLetterFormat FDXE/FDXG USD & CA
xs:string 3 Required if FaxLetter is not selected. Format of SPOD letter to be returned in Reply. Valid value:
PDF = PDF format
FAXLETTER Information pertaining to letter to be faxed. Presence of this element indicates the Request for a fax.
FaxLetter / RecipientName FDXE/FDXG USD & CA
xs:string 35 Required. Name of recipient of fax.
FaxLetter / RecipientFaxNumber FDXE/FDXG 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.
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.
XML Transaction Layouts: FDXSPODRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 144
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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, June 2006 145
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:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSPODRequest.xsd">
<RequestHeader>
<CustomerTransactionIdentifier>SPOD Letter</CustomerTransactionIdentifier>
<AccountNumber>0123456789</AccountNumber>
</RequestHeader>
<ShipDate>2005-05-31</ShipDate>
<ShipmentAccountNumber>123456789</ShipmentAccountNumber>
<TrackingNumber>123456789123</TrackingNumber>
<LanguageCode>EN</LanguageCode>
<ReturnLetterFormat>PDF</ReturnLetterFormat>
</FDXSPODRequest>
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 146
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.
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 147
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>SPOD Letter</CustomerTransactionIdentifier>
</ReplyHeader>
<Letter>JVBERi0xLjQKJeLjz9MKMSAwIG9iaiA8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvVHlwZS9YT2JqZWN0L0xlbmd0aCAyMjk3L0JpdHNQZXJDb21w
b25lbnQgOC9IZWlnaHQgNDQvQ29sb3JTcGFjZVsvSW5kZXhlZC9EZXZpY2VSR0IgMjU1KPXy8/n3+Pv4+v77/vHu8fb19vfu+Ozm7e/q8PLt9F8EjF0Fh82/1MO3yefd7OLY51kAimMZi7mXzL+d0c2z29G+29/O6OHW510AlVxcAJJbAJJZAJBaAJBaAI9ZAI9aAI1YAI1WAIpVAIlWAYlXA4mKRrGESKmxisi3msi+pM6tlrvJtdXazOLp3fDl3unz7vZaAJdcXACXWwCUWQCSVgCOVACNVwCNVQCKUgCKUgCJTwCCUAGGVwKPVgKMVAKIUgKGWwOVWgOQVgSLWQaRWAaLWVxijlRcYohaXG6NXQ+QYRCVWBCGYBaQXFwWi28jn2QhkWcllGsql3Atm3k5o4BAqn9CpYJMpYhSrJFes4BUnphot5ZqtJ5vvKl8xaF4vJx1tq6DyqWAvayHxKiEv6SGuLqezLCZv8Gsz8az0tPF3N7T5fDq9Pbz+FgAlVYAkVIAj1QAj1IAjVEAilAAiU8Ah00AhkwAhUsAgkkAflUPhmIbk2cemWw0lHM4nXtIn4hbqJJlsotjp5d0saKAup5+tbCQxrSUyqmLvqSMtsWr18u52OTW7lAAj1AAjU4AiksAhUxcYoFlL4+SbK+xmMRHAILs5vL7+vz08/b9/f/6/f/2/v/5///6///9///4//z6/vz5/Pr5+/n9//z9//v+//38/vj+//v///j39vH6+fX28+z9/Prz6drv4c/07OHv5NrepXbr0bzv2MXrkk/nxarxz7X24tPpYQDtk1Prk1fyYADyXwDxXFwA8FoA71sA71xcAO5eAO1aAO1dAOxZAOxeAOpaAepdAeNcXFxu42ES4mUZ5YRG5YlN5opR3I1d6aN26byh78iv9uLW+vXy71cA71gA61cA6lUA6VQA5lUA8FkC51kE6lsG6lhcYuleD+VkGOFhGeVjGuFmHeVqIeZyMeSTY+qykerHs/LSv/ji1e9UAO1SAOlRAOhNAeZTXGLoVVx06F4Y5GId3Gcr4nlD6JZq3p5+9d3R8t/V9ebe0VEn1FNcKdNTXCnFWz///f3//v79/Pzz8vL///8pXS9TdWJ0eXBlL0ltYWdlL1dpZHRoIDEwMD4+c3RyZWFtCnic3Zd7XFPnGccFYYmbk+rK7ZyTk4RtKBJvIYnJus2tqxNFBTJCrWkYUMbVKBFqiwIiXqYtdl6AqDmiJ4eIdrLJquJWcmvsWqBYx7XOdhWkFXTrZF52ydG3z0kIFz9aHZ/P/tkPQt7znuec7/u87/s87wNJjpEAy/8uix4plmbQC+tJkljzjX//wTYqZ9e5Rz8EIv+vGPj/nkEIRQqBECTVRzJPyHC6bFablVOTo7vx8QxpmKxwPWi34ZUS45P64bJaz3dzGhy88bvHMnCpSjNrm0c7Mp/Qj9+DE53N/cM6/VgGIS18aaTjSRlNNsf1tq989TiGiKhIRSwIDf+Fb8tDWewow2GzehkURY034X5Gr4YZpHBDOTKDLHTtm2+yaG6GNrlEszk92A9RRpplKYaBrudLtbPmotUj69Hh6mmjTKDDNcaqqgOHDplMBw5RjJGiJ9ccPHjg8EGj6Yg/7R5mCAQLEzQeJaUcRUGrlyoLDUplwe4fJc5gkNttRFNSlxpeX1ugUsZlvGDwMRxnHX2tLS0t3KftanNrS2tra8tpykwdoE60NUN/a8sHdyjG5wdByPLlnHarUcj0wjURQoFAEB5OKAvSwVkmV12IkxhBCgWy2BWykfhw2doHOLUP3GjsvzEwCM3BvnqKMR1q49qdAzf+cdQzjx5GmIAQkjiOiw1JIfEGUiwSqFSqhUIBLntmixv5awxiWDQcJxYQmIL0xYcdxEWg1W7tOnf01mXHWZft7a7meoQuXHbYnFZnT+ufTGbWt+YYF4UgHF+RqFyAfWdhfvKMtCI9rsBiVDtRWiEpVMiF+op8Ay4gRxlWL8PmcvU0Uqa2604ISXv3UN1nH3fY7U7HYMsJiqF9DCKMEIhE0IjBvq3HBALpoh1GBk1LVuEYvj45Zzk3DFyfoJtVnqgXjDCcQHCAOpo6BhsRdaJ5ALKK </Letter>
</FDXSPODReply>
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 148
Sample FULL Signature Proof of Delivery (SPOD) Letter
XML Transaction Layouts: FDXSPODReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 149
Sample PARTIAL Signature Proof of Delivery (SPOD) Letter
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 150
FDXServiceAvailabilityRequest (FedEx 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 Packaging 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.
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
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 151
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
PackageCount FDXE ALL xs:positive integer
4 Required for multiple-piece shipments (MPS). 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. FDXE only applies to COD, MPS, and international. Valid values: 1 to 999
XML Transaction Layouts: FDXServiceAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 152
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 • INTERNATIONALPRIORITY FREIGHT • INTERNATIONALECONOMY FREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
If provided, only that service’s estimated charges will be returned.
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, June 2006 153
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, June 2006 154
FDXServiceAvailabilityReply (FedEx 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: FDXServiceAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 155
Example of FDXServiceAvailabilityReply XML Document
<?xml version="1.0" encoding="UTF-8"?> <FDXServiceAvailabilityReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXServiceAvailabilityReply.xsd"> <ReplyHeader/> <Entry> <Service>PRIORITYOVERNIGHT</Service> <DeliveryDate>2005-03-29</DeliveryDate> <DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FEDEX2DAY</Service> <DeliveryDate>2005-03-30</DeliveryDate> <DeliveryDay>WED</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FIRSTOVERNIGHT</Service> <DeliveryDate>2005-03-29</DeliveryDate> <DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>STANDARDOVERNIGHT</Service> <DeliveryDate>2005-03-29</DeliveryDate> <DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FEDEX2DAYFREIGHT</Service> <DeliveryDate>2005-03-30</DeliveryDate> <DeliveryDay>WED</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FEDEX1DAYFREIGHT</Service>
XML Transaction Layouts: FDXServiceAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 156
<DeliveryDate>2005-03-29</DeliveryDate> <DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FEDEXEXPRESSSAVER</Service> <DeliveryDate>2005-03-31</DeliveryDate> <DeliveryDay>THU</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> <Entry> <Service>FEDEX3DAYFREIGHT</Service> <DeliveryDate>2005-03-31</DeliveryDate> <DeliveryDay>THU</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> </Entry> </FDXServiceAvailabilityReply>
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 157
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
FDXE/FDXG 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/FDXG ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a Station Location Information.
RequestHeader / MeterNumber FDXE/FDXG 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 FDXE/FDXG ALL xs:integer 3 Optional. The index of first location to be returned from among all matching locations
MaximumMatchCount FDXE/FDXG ALL xs:positive integer
2 Optional. Maximum number of locations to be returned. Maximum count allowed is 25. Defaults to 10.
LanguageCode FDXE/FDXG USD xs:string 2 Optional. Defaults to EN. Valid values:
EN – English FR – French
DistanceUnits FDXE/FDXG ALL xs:nmtoken 2 Optional. Units in which Distance to location is to be expressed. Valid values:
MI – miles KM – kilometers
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 158
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PhoneNumber FDXE/FDXG ALL xs:string 35 Optional if an address is not provided. Phone number for which nearby FedEx locations are to be found.
StreetAddressOrIntersection FDXE/FDXG 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 FDXE/FDXG ALL xs:string 35 Required. The city of the address which the search is being done against.
StateOrProvinceCode FDXE/FDXG ALL xs:string 2 Required. The address's state or province code. Required only if Recipient Country Code is US or CA.
PostalCode FDXE/FDXG 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 FDXE/FDXG USD / CA
xs:nmtoken
2 Optional. Defaults to US. The address's country code. Valid values:
US – United States CA – Canada
FedExStaffed FDXE/FDXG 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
FDXE/FDXG 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.
XML Transaction Layouts: FDXFedExLocatorRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 159
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 criteria 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 FedEx 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.
Ground FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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, June 2006 160
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, June 2006 161
FDXFedExLocatorReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransactionIdentifier
FDXE/FDXG ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG USD xs:string 35 Required. The name of the business at this location.
Location / BusinessID FDXE/FDXG USD xs:string Required. Identifier that can be used by IVR attendant to look up directions to location.
Location / BusinessType FDXE/FDXG USD xs:string 35 Required. A textual description of the type of business, such as "FedEx Authorized Ship Center."
Location / StreetAddressOrIntersection FDXE/FDXG 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.).
Location / City FDXE/FDXG USD xs:string 35 Required. The address' city.
Location / StateOrProvinceCode FDXE/FDXG USD xs:string 2 Required. The address' state or province code.
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 162
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Location / PostalCode FDXE/FDXG 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 or 1 if this location will accept Hazardous Materials.
Location / Distance FDXE/FDXG USD xs:string 15 Required. Distance of this location from the point indicated by the search criteria (e.g. "12.5 mi").
Location / HoursWeekdays FDXE/FDXG USD xs:string 35 Required. This location's weekday hours of operation (e.g. "9:00 AM - 6:45 PM").
Location / HoursSaturdays FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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
FDXE/FDXG 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, June 2006 163
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>
<City>Cordova</City>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 164
<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>
<RecordIndex>7</RecordIndex>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 165
</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>
<HoursWeekdays>7:00 AM-11:00 PM</HoursWeekdays>
XML Transaction Layouts: FDXFedExLocatorReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 166
<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, June 2006 167
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 FDXCancelEmailLabelRequest.
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader/CustomerTransactionIdentifier
FDXE/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 FDXE/FDXG USD xs:string 9 The FedEx account number of the Sender is required to successfully receive an E-mail Label.
RequestHeader/MeterNumber FDXE/FDXG 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 FDXE/FDXG USD xs:string 4 Valid values: • FDXE • FDXG
URLExpirationDate FDXE/FDXG USD xs:date 10 Required. Format: YYYY-MM-DD
URLNotificationE-MailAddress FDXE/FDXG USD xs:string 120 Required.
URLNotificationE-MailMessage FDXE/FDXG USD xs:string
Optional.
MerchantPhoneNumber FDXE/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, 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.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 168
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
DropoffType FDXE USD xs:string 21 Method by which customer tenders package, which might or might not be a drop-off. Valid values:
• REGULARPICKUP • REQUESTCOURIER • DROPBOX • BUSINESSSERVICECENTER • STATION
Service FDXE/FDXG USD xs:string 32 Valid values: • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER • INTERNATIONALPRIORITY • INTERNATIONALECONOMY • INTERNATIONALFIRST • FEDEX1DAYFREIGHT • FEDEX2DAYFREIGHT • FEDEX3DAYFREIGHT • FEDEXGROUND • GROUNDHOMEDELIVERY • INTERNATIONALPRIORITYFREIGHT • INTERNATIONALECONOMYFREIGHT • EUROPEFIRSTINTERNATIONALPRIORITY
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 169
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Packaging FDXE/FDXG USD xs:string 13
Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • FEDEX10KGBOX • FEDEX25KBOX • YOURPACKAGING
WeightUnits FDXE/FDXG USD xs:string 3 Valid values: • LBS • KGS
Note: This does NOT pertain to Dry Ice.
CurrencyCode FDXE/FDXG USD xs:string 3 Optional.
ORIGIN
ORIGIN / CONTACT
Origin / Contact / PersonName FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 10 Optional. Name of the department from which the shipment is originating.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 170
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Origin / Contact / PhoneNumber FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 35 Required. Primary address line from which the shipment is originating.
Origin / Address / Line2 FDXE/FDXG ALL xs:string 35 Optional. Secondary address line from which the shipment is originating.
Origin / Address / City FDXE/FDXG 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.
Origin / Address / StateOrProvinceCode FDXE/FDXG 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 FDXE/FDXG 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
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 171
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Origin / Address / CountryCode FDXE/FDXG ALL xs:string 2 Required. Name of the country from which the shipment is originating.
DESTINATION
DESTINATION / CONTACT
Destination / Contact / PersonName FDXE/FDXG 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.
Destination / Contact / CompanyName FDXE/FDXG 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 FDXE/FDXG ALL xs:string 10 Optional. Name of the department to whom the shipment is destined.
Destination / Contact / PhoneNumber FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG 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, June 2006 172
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Destination / Contact / E-MailAddress
FDXE/FDXG ALL xs:string FDXE-120FDXG-35
Optional. E-mail address for the contact person to whom the shipment is destined.
DESTINATION / ADDRESS
Destination / Address / Line1 FDXE/FDXG ALL xs:string 35 Required. Primary address line to which the shipment is destined.
Destination / Address / Line2 FDXE/FDXG ALL xs:string 35 Optional. Secondary address line to which the shipment is destined.
Destination / Address / City FDXE/FDXG ALL xs:string FDXE-35FDXG-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
FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG ALL xs:string 2 Required. Name of the country to which the shipment is destined.
PAYMENT
Payment/PayorType FDXE/FDXG USD xs:string 9 Required. Valid values:
• SENDER • THIRDPARTY
PAYMENT / PAYOR
Payment/Payor/AccountNumber FDXE/FDXG USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment/Payor/CountryCode FDXE INTL xs:string 2 Optional.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 173
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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
FDXE/FDXG ALL xs:sting 2 [A-Z]{2}
SpecialServices / ResidentialDelivery FDXE/FDXG 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, June 2006 174
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
FDXE/FDXG ALL xs:string 120 Optional. Customer specified message to be included in all EMail notification.
SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER NOTE : ONE OF THE FOLLOWING NOTIFICATION ELEMENTS (SHIPALERT, DELIVERY AND/OR EXCEPTION) MUST BE SET TRUE IN ORDER FOR A NOTIFICATION TO BE SENT
SpecialServices / EMailNotification / Shipper / ShipAlert
FDXE/FDXG ALL xs:boolean 4 Optional If true or 1, Sender’s Email Address will be emailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Shipper / DeliveryNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Shipper / ExceptionNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Shipper / Format
FDXE/FDXG ALL xs:string 8 Format of email to be sent to the shipper. Valid language codes:
• Text • HTML • WIRELESS
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 175
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / EMailNotification / Shipper / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Shipper / LocaleCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SpecialServices / EMailNotification / Recipient Note : One of the following Notification elements (ShipAlert, Delivery and/or exception) must be set true in order for a notification to be sent
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 176
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / EMailNotification / Recipient / ShipAlert
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Recipient E-Mail Address will be e-mailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Recipient / DeliveryNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Recipient E-mail Address will be e-mailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Recipient / ExceptionNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Recipient / Format
FDXE/FDXG ALL xs:string 8 Format of email to be sent to the recipient. Valid language codes:
• Text • HTML • WIRELESS
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English).
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 177
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Recipient / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SPECIALSERVICES / EMAILNOTIFICATION / OTHER Note : One of the following Notification elements (ShipAlert, Delivery and/or exception) must be set true in order for a notification to be sent A maximum of three occurrences are allowed to requests notification Emails to three additional recipients.
SpecialServices / EMailNotification / Other / EMailAddress
FDXE/FDXG ALL xs:string 120 Required.
SpecialServices / EMailNotification / Other / ShipAlert
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, corresponding E-Mail Address will be e-mailed a notification email when the shipment has been picked up.
SpecialServices / EMailNotification / Other / DeliveryNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, the corresponding e-mail address will be emailed notification email upon delivery of the shipment.
SpecialServices / EMailNotification / Other / ExceptionNotification
FDXE/FDXG ALL xs:boolean 4 Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
SpecialServices / EMailNotification / Other / Format
FDXE/FDXG ALL xs:string 8 Format of email to be sent to the corresponding e-mail address. Valid language codes:
• Text • HTML • WIRELESS
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 178
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SpecialServices / EMailNotification / Other / LanguageCode
FDXE/FDXG ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
SpecialServices / EMailNotification / Other / LocaleCode
FDXE/FDXG ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SpecialServices / SignatureRelease FDXE USD xs:string 10 Optional. Release Authorization Number. Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 179
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 Materials Authorization
RMA / Number FDXE USD xs:string 20 Return Materials Authorization that is assigned by the sender.
RecipientLocationNumber FDXG ALL xs:string 10 Optional. Recipient location number/store number. The value in this field is embedded in the 2D barcode. Valid characters: [A-Z ;a-z ;0-9] Any character other than A-Z, a-z, 0-9 will be stripped. If the length is greater than 10, characters beyond the 10th position will be truncated.
PACKAGE
Package / Weight FDXE/FDXG USD xs:decimal 6.1 Required. The weight of the package.
PACKAGE / DIMENSIONS
Package / Dimensions / Length FDXE/FDXG 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 FDXE/FDXG 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.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 180
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / Dimensions / Height FDXE/FDXG 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 FDXE/FDXG ALL xs:decimal 8.2 Optional for a U.S., international dutiable FedEx Express, and FedEx Ground shipments. This element is not applicable to an international PIB (document) FedEx Express shipment. The declared value of package contents. This value cannot exceed the total customs value for an international shipment. For FedEx 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.
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
FDXE/FDXG 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.
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 181
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 FDXE/FDXG USD xs:string 80 Description of contents within package being shipped.
Package / SignatureOption FDXE/FDXG ALL xs:sting 21 Optional. Specifies one of the Delivery Signature Options. Valid values:
• DELIVERWITHOUTSIGNATURE • INDIRECT • DIRECT • ADULT
For FedEx Express shipments, the DELIVERWITHOUTSIGNATURE option will not be allowed when the following special services are requested:
• Alcohol • Hold at Location • Dangerous Goods • Declared Value greater than $500
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 182
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>
</Address>
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 183
</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>
</ReferenceInfo>
XML Transaction Layouts: FDXEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 184
<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, June 2006 185
FDXEmailLabelReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE/FDXG USD xs:string 40 Returned if the customer included it in the Request, containing the same value.
ERROR
Error / Code FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG USD xs:string
URL of web page at which labels can be found. Required if Error is not returned.
UserID FDXE/FDXG 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 FDXE/FDXG 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 FDXE/FDXG USD xs:time Optional.
PACKAGE A location matching the criteria provided in the FedExLocatorRequest. Can get up to 10 different FedEx locations.
Package / TrackingNumber FDXE/FDXG 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.
SignatureOption FDXE/FDXG 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: FDXEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 186
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, June 2006 187
FDXCancelEmailLabelRequest
This transaction cancels an FDXEmailLabelRequest. 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 / CustomerTransactionIdentifier
FDXE/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 FDXE/FDXG USD xs:string 9 The FedEx account number of the Sender is required to successfully cancel the E-mail Label Request.
RequestHeader / MeterNumber FDXE/FDXG 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 FDXE/FDXG USD xs:string 4 Valid values: • FDXE • FDXG
TrackingNumber FDXE/FDXG USD xs:string 20 Required. Tracking number of E-mail Label/shipment to be deleted.
XML Transaction Layouts: FDXCancelEmailLabelRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 188
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" ?>
<FDXCancelEmailLabelRequest 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>
</FDXCancelEmailLabelRequest>
XML Transaction Layouts: FDXCancelEmailLabelReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 189
FDXCancelEmailLabelReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader/CustomerTransaction Identifier
FDXE FDXG
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 FDXE FDXG
USD xs:string 8 Required if error. Error code returned when a transaction fails.
Error/Message FDXE FDXG
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, June 2006 190
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, June 2006 191
FDXExpressTagRequest
The FedEx Express Tag return label combines the delivery of the FedEx 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 FDXExpressTagAvailabilityRequest. 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 a FedEx 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 a FedEx Express Tag.
RequestHeader / Carrier Code FDXE USD xs:string 4 Valid value: FDXE
DispatchDate FDXE USD xs:date 10 Required. Format: YYYY-MM-DD
LatestPickupTime FDXE USD xs:time 8 Required. Format: HH:MM:SS
ReadyTime FDXE USD xs:time 8 Required. Format: HH:MM:SS
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.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 192
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 193
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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
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.
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.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 194
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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 10 Required. Valid values:
• SENDER • THIRDPARTY
PAYMENT / PAYOR
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 195
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Payment / Payor / AccountNumber FDXE USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment / Payor / CountryCode FDXE USD xs:string 2 Optional.
RMA Return Materials Authorization Information
RMA/Number FDXE USD xs:string 20 Required if RMA element is included. Return Materials Authorization number provided by the sender.
CourierInstructions FDXE USD xs:string 60 Optional. Instruction to courier.
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 32 Required. Valid values:
• PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER
Packaging FDXE USD xs:string 13 Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • YOURPACKAGING
WeightUnits FDXE USD xs:string 3 Required. Valid values:
• LBS • KGS
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 196
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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.
XML Transaction Layouts: FDXExpressTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 197
Example of FDXExpressTagRequest XML Document
The following is an example of the Request transaction format for a FedEx 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>1111111</MeterNumber>
</RequestHeader>
<DispatchDate>2006-04-28</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, June 2006 198
<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>Test Request</CourierInstructions>
<CustomerReference>Ref Value</CustomerReference>
<CurrencyCode>USD</CurrencyCode>
<Service>STANDARDOVERNIGHT</Service>
<Packaging>YOURPACKAGING</Packaging>
<WeightUnits>LBS</WeightUnits>
<Weight>12</Weight>
<DeclaredValue>13</DeclaredValue>
<PackageCount>1</PackageCount>
</FDXExpressTagRequest>
XML Transaction Layouts: FDXExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 199
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.
ConfirmationNumber 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
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, June 2006 200
Example of FDXExpressTagReply XML Document
The following is an example of the Reply transaction format for Requests regarding the creation of a FedEx 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>
<ConfirmationNumber>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, June 2006 201
FDXCancelExpressTagRequest
This transaction cancels a FedEx 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 a FedEx 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 a FedEx Express Tag Request.
ConfirmationNumber 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, June 2006 202
Example of FDXCancelExpressTagRequest XML Document
The following is an example of the Request transaction format for the cancellation of a FedEx 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>
<ConfirmationNumber>00001</ConfirmationNumber>
<Location>HKAA</Location>
<DispatchDate>2004-10-12</DispatchDate>
</FDXCancelExpressTagRequest>
XML Transaction Layouts: FDXCancelExpressTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 203
FDXCancelExpressTagReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / 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.
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, June 2006 204
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, June 2006 205
FDXGroundCallTagRequest
The FedEx Ground Call Tag return label combines the delivery of the FedEx 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 10 Required. Format: YYYY-MM-DD
LatestPickupTime FDXG USD xs:time 8 Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
ReadyTime FDXG USD xs:time 8 Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS
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
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 206
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 207
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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.
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.
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 208
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Destination / Address / StateOrProvince Code
FDXG USD xs:string 2 Required. State or province code to which the shipment is destined.
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 10 Required. Valid values:
• SENDER • THIRDPARTY
PAYMENT / PAYOR
Payment / Payor / AccountNumber FDXG USD xs:string 9 Optional. Shipping charges payor FedEx account number.
Payment / Payor / CountryCode FDXG USD xs:string 2 Optional.
RMA Return Materials Authorization Information
RMA/Number FDXG USD xs:string 20 Required if RMA element is included. Return Materials Authorization number provided by the sender.
CourierInstructions FDXG USD xs:string 40 Optional. Instruction to courier.
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
XML Transaction Layouts: FDXGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 209
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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, June 2006 210
Example of FDXGroundCallTagRequest XML Document
The following is an example of the Request transaction format of a FedEx 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, June 2006 211
</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, June 2006 212
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.
ConfirmationNumber 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, June 2006 213
Example of FDXGroundCallTagReply XML Document
The following is an example of the Reply transaction format for Requests regarding the creation of a FedEx 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>
<ConfirmationNumber>997038000005630</ConfirmationNumber>
<TrackingNumber>997038000005630</TrackingNumber>
</FDXGroundCallTagReply>
XML Transaction Layouts: FDXCancelGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 214
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 FedEx 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 FedEx Ground Call Tag.
RequestHeader / CarrierCode FDXG USD xs:string 4 Valid value: FDXG
ConfirmationNumber FDXG USD xs:string 16 Required. Otherwise known as Pickup Confirmation Number.
XML Transaction Layouts: FDXCancelGroundCallTagRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 215
Example of FDXCancelGroundCallTagRequest XML Document
The following is an example of the Request transaction format for the cancellation of a FedEx 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>
<ConfirmationNumber>997038000005630</ConfirmationNumber>
</FDXCancelGroundCallTagRequest>
XML Transaction Layouts: FDXCancelGroundCallTagReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 216
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, June 2006 217
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 FedEx 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, June 2006 218
FDXExpressTagAvailabilityRequest
Express Tag is a premium FedEx 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 a FedEx 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 a FedEx 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
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.
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 219
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
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 originating. 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 32 Required. Valid values:
• PRIORITYOVERNIGHT • STANDARDOVERNIGHT • FIRSTOVERNIGHT • FEDEX2DAY • FEDEXEXPRESSSAVER
Packaging FDXE USD xs:string 13 Valid values: • FEDEXENVELOPE • FEDEXPAK • FEDEXBOX • FEDEXTUBE • YOURPACKAGING
XML Transaction Layouts: FDXExpressTagAvailabilityRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 220
Example of FDXExpressTagAvailabilityRequest XML Document
The following is an example of the Request transaction format for FedEx 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, June 2006 221
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 8 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 8 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
AvailabilityCode FDXE USD xs:string 1 Optional. Valid values:
• 2 = FedEx Express Tag service next day available • 3 = FedEx Express Tag service same day and next day available
XML Transaction Layouts: FDXExpressTagAvailabilityReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 222
Example of FDXExpressTagAvailabilityReply XML Document
The following is an example of the Reply transaction format for Requests regarding the FedEx 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>
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 223
FDXNotificationRequest Requests that email notifications be sent upon the occurrence of certain events related to movement of a package.
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REQUESTHEADER
RequestHeader / CustomerTransaction Identifier
FDXE FDXG FDXC FXCC FXFR
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 FDXG FDXC FXCC FXFR
ALL xs:integer 12 The FedEx account number of the Sender is required to successfully receive a tracking response.
RequestHeader / MeterNumber FDXE FDXG FDXC FXCC FXFR
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 FDXE FDXG FDXC FXCC FXFR
ALL xs:string 4 Required. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground FXFR – FedEx Freight FXCC – FedEx Custom Critical FDXC – FedEx Cargo
PagingToken FDXE FDXG FDXC FXCC FXFR
ALL xs:string variable Optional.
PACKAGEIDENTIFIER Tracking number of a package. Other types of identifier not allowed in this transaction
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 224
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PackageIdentifier / Value FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Required. Only Tracking_Number Or DoorTag is applicable
PackageIdentifier / Type FDXE FDXG FDXC FXCC FXFR
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 value:
• TRACKING_NUMBER_Or_DoorTag
TrackNumberUniqueIdentifier FDXE FDXG FDXC FXCC
ALL xs:string One of the TrackingNumberUniqueIdentifiers returned in a previous Reply.
ShipDateRangeBegin FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 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 FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Optional, but recommended. If provided, StartDateRange is required. Recommend entry of date range to find desired track number. If not provided, results may vary.
REPLYLANGUAGE Tracking number of a package. Other types of identifier not allowed in this transaction
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 225
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
ReplyLanguage / LanguageCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
ReplyLanguage / LocaleCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
SenderEmailAddress FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Required. Email address of notification requester to be shown in email content.
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 226
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
SenderContactName FDXE FDXG FDXC FXCC FXFR
ALL xs:string 35 Name of notification requester to be shown in email content.
OptionalMessage FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Optional. Customer specified message to be included in all the notifications.
Recipient / EMailAddress FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Required. Email Address of the person to whom the notification will be sent.
Recipient / DeliveryNotification FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean 4 Optional. If = true or 1, Recipient E-mail Address will be e-mailed notification email upon delivery of the shipment.
Recipient / ExceptionNotification FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean 4 Optional. If = true or 1, Sender’s E-mail Address will be e-mailed notification email upon the occurrence of exceptions related to the shipment.
Recipient / Format FDXE FDXG FDXC FXCC FXFR
ALL xs:string 8 Format of email to be sent to the recipient. Valid language codes:
• Text • HTML • WIRELESS
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 227
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Recipient / LanguageCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional. Specifies the language the Email notification will be formatted. Valid values:
da = Danish de = German en = English es = Spanish es with language locale code US = US Spanish es with language locale code ES = Spain fr = French fr with language local code CA = Canadian French it = Italian ja = Kanji ko = Korean nl = Dutch pt = Portuguese sv = Swedish zh with local code CN = Chinese Simple zh with locale code HK – Chinese Traditional Hong Kong zh with locale code TW – Chinese Traditional Taiwan
Defaults to en (English). ISO 639-1 alpha-2 character code
Recipient / LanguageCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Optional Pairs with the Language code to obtain a specific dialect of the language selected. Valid Values:
ES CA US (pairs with es for US Spanish) CN =Chinese Simple HK =Chinese Traditional Hong Kong TW = Chinese Traditional Taiwan
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 228
Example of FDXNotificationRequest
<?xml version="1.0" encoding="UTF-8" ?>
<FDXNotificationRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXNotificationRequest.xsd">
<RequestHeader>
<CustomerTransactionIdentifier>String</CustomerTransactionIdentifier>
<AccountNumber>123456789</AccountNumber>
<MeterNumber>1234567</MeterNumber>
<CarrierCode>FDXE</CarrierCode>
</RequestHeader>
<PackageIdentifier>
<Value>123456789123</Value>
<Type>TRACKING_NUMBER_OR_DOORTAG</Type>
</PackageIdentifier>
<ShipDateRangeBegin>2006-01-20</ShipDateRangeBegin>
<ShipDateRangeEnd>2006-01-23</ShipDateRangeEnd>
<SenderEmailAddress>[email protected]</SenderEmailAddress>
<SenderContactName>John doe</SenderContactName>
<Recipient>
<ExceptionNotification>1</ExceptionNotification>
<EMailAddress>[email protected]</EMailAddress>
<Format>HTML</Format>
</Recipient>
</FDXNotificationRequest>
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 229
Up to 6 e-mail notification addresses can be sent in one transaction. The following is an example of 3 e-mail addresses within the FDXNotificationRequest.
<?xml version="1.0" encoding="UTF-8" ?> - <FDXNotificationRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXNotificationRequest.xsd"> - <RequestHeader>
<CustomerTransactionIdentifier>Notification x3</CustomerTransactionIdentifier>
<AccountNumber>123456789</AccountNumber>
<MeterNumber>1234567</MeterNumber>
</RequestHeader>
- <PackageIdentifier>
<Value>123456789123</Value>
<Type>TRACKING_NUMBER_OR_DOORTAG</Type>
</PackageIdentifier>
<SenderEmailAddress>[email protected]</SenderEmailAddress>
<SenderContactName>Jane Doe</SenderContactName>
<OptionalMessage>This is an API notification request</OptionalMessage>
- <Recipient>
<EMailAddress>email#[email protected]</EMailAddress>
<ShipAlert>1</ShipAlert>
<DeliveryNotification>1</DeliveryNotification>
<Format>HTML</Format>
</Recipient>
- <Recipient>
<EMailAddress>email#[email protected]</EMailAddress>
<ShipAlert>1</ShipAlert>
<DeliveryNotification>1</DeliveryNotification>
<Format>HTML</Format>
</Recipient>
- <Recipient>
<EMailAddress>email#[email protected]</EMailAddress>
<ShipAlert>1</ShipAlert>
<DeliveryNotification>1</DeliveryNotification>
XML Transaction Layouts: FDXNotificationRequest
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 230
<Format>HTML</Format>
</Recipient>
</FDXNotificationRequest>
XML Transaction Layouts: FDXNotificationReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 231
FDXNotificationReply
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
REPLYHEADER
ReplyHeader / CustomerTransaction Identifier
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.
ERROR
Error / Code FDXE FDXG FDXC FXCC FXFR
ALL xs:string 8 Returned only if an error occurred while processing the transaction.
Error / Message FDXE FDXG FDXC FXCC FXFR
ALL xs:string 120 Returned only if an error occurred while processing the transaction.
DuplicateWaybill FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean True if duplicate packages with the same tracking number have been found, and only limited data will be provided for each one.
MoreDataFlag FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean Value of true or 1 indicates that more data exists. Returned when additional packages remain to be retrieved.
XML Transaction Layouts: FDXNotificationReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 232
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
PagingToken FDXE FDXG FDXC FXCC FXFR
ALL xs:string Variable This element is utilized to obtain additional data on second and subsequent FDXNotificationRequest transactions when more related tracking information exist that exceed the capacity of any one response structure. This element should be absent from the first FDXNotificationRequest. It is only populated if the response results are in more than one page worth of data. If the PagingToken element contains value in first FDXNotificationReply, more tracking data exists. You should populate this element with the value returned in the PagingToken element of the previous transaction.
PACKAGE Data pertaining to a single package that matches the PackageIdentifier given in the Request.
Package / TrackingNumber FDXE FDXG FDXC FXCC FXFR
ALL xs:string 20 Tracking number provided in the Request.
Note: Door tag will never be returned in the response.
PACKAGE / SOFTERROR
Package / SoftError / Type FDXE FDXG FDXC FXCC FXFR
ALL xs:string 25 Returned only if a soft error/warning message is available. Valid values:
• WARNING • INFORMATIONAL
Package / SoftError / Code FDXE FDXG FDXC FXCC FXFR
ALL xs:string 8 Returned only if a soft error/warning message is available.
XML Transaction Layouts: FDXNotificationReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 233
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / SoftError / Message FDXE FDXG FDXC FXCC FXFR
ALL xs:string 255 Returned only if a soft error/warning message is available.
Package / TrackingNumberUniqueIdentifier
FDXE FDXG FDXC FXCC
ALL xs:string A string which, together with the tracking number, can be used to uniquely identify a package in a follow-up request. It is returned when duplicate waybills were found with the same tracking number.
Package / CarrierCode FDXE FDXG FDXC FXCC FXFR
ALL xs:string 4 Specifies the particular carrier the package was shipped. Valid values:
FDXE – FedEx Express FDXG – FedEx Ground
Package / ShipDate FDXE FDXG FDXC FXCC FXFR
ALL xs:date 10 Date on which package was tendered to FedEx.
PACKAGE / DESTINATIONADDRESS Destination Address Information
Package / DestinationAddress / City FDXE FDXG FDXC FXCC FXFR
ALL xs:string 40 Name of the city to which the shipment is destined.
Package / DestinationAddress / StateOrProvince Code
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 State or province code to which the shipment is destined.
XML Transaction Layouts: FDXNotificationReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 234
Element Name Applicable Carrier
Valid For
Data Type
Max Length Element Description/Requirements
Package / DestinationAddress / CountryCode
FDXE FDXG FDXC FXCC FXFR
ALL xs:string 2 Name of the country to which the shipment is destined.
Recipient / UponDelivery FDXE FDXG FDXC FXCC FXFR
ALL xs:boolean True if this recipient was requested to receive email upon delivery of package, and it is available.
Recipient / UponException FDXE FDXG FXFR
ALL xs:boolean True if this recipient was requested to receive email upon an exception occurring for this package, and it is available.
XML Transaction Layouts: FDXNotificationReply
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 235
Example of FDXNotificationReply
<?xml version="1.0" encoding="UTF-8"?>
<FDXNotificationReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXNotificationReply.xsd">
<ReplyHeader>
<CustomerTransactionIdentifier>String</CustomerTransactionIdentifier>
</ReplyHeader>
<Error>
<Code>64268</Code>
<Message>An exception raised by the service.</Message>
</Error>
</FDXNotificationReply>
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 236
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.
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 application. 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
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 237
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 FedEx 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 FedEx 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.
PDF Label
Plain paper labels can be generated in PDF (Portable Document Format) which will alleviate scaling problems for different size paper or label stock. The PDF is produced when element ImageType is set to PDF.
The following requirements apply to PDF labels:
• Adobe Reader 6.0 or higher is needed to process the labels.
• Printer driver configuration must be set to have print scaling set to ‘none’.
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 238
4x6 PNG Label
FedEx Ship Manager API allows users to request a 4" x 6" PNG graphic of the current FedEx thermal label. These label images can then be embedded into your shipping documentation to alleviate the need for a custom label.
The following requirements apply when using the 4"x 6" PNG graphic embedded into your shipping document:
• 4"x 6" PNG labels should only be used with peel & stick label stock. 4"x 6" PNG labels that are not on peel & stick label stock will be rejected by the FedEx Ground and FedEx Express label certification teams.
• Laserjet printers are recommended for printing labels. Inkjet printers should not be used. Most labels created with inkjet printers have been rejected by the label certification teams due to poor print quality.
• 4"x 6" PNG format should NOT be used on plain paper and will be rejected automatically if submitted for certification on plain paper.
• 4"x 6" PNG labels should not be printed with a color printer. Most labels created with a color printer have been rejected by the label certification teams due to poor print quality.
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
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 239
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">'); </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 FedEx Ground or FedEx Express shipping.
Shipping Label Specifications
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 240
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.
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, June 2006 241
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 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
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 242
Country Code Ship to: Country Code Ship to: Country Code Ship to:
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 Namibia NA Y Guinea Bissau GW N Lesotho LS Y Nauru NR N 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
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 243
Country Code Ship to: Country Code Ship to: Country Code Ship to:
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 Y
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
Trinidad & Tobago TT Y Ukraine UA Y Venezuela VE Y
Tunisia TN Y Union Island VC Y Vietnam VN Y
Turkey TR Y United Arab Emirates AE Y Wales GB Y Turkmenistan TM Y United Kingdom GB Y Wallis & Futuna Islands WF Y Turks & Caicos Islands TC Y United States US Y Western Sahara EH N Tuvalu TV N Uruguay UY Y Yemen YE Y U.S. Minor Outlying Islands UM N Uzbekistan UZ Y Zambia ZM Y U.S. Virgin Islands VI Y Vanuatu VU Y Zimbabwe ZW Y Uganda UG Y Vatican City IT Y
Appendix A: Country Codes
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 244
NOTE:
The following South Pacific Islands 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 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, June 2006 245
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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 246
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 247
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 248
Vague Commodity Vague Commodity Description
"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.
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 249
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 250
Vague Commodity Vague Commodity Description
"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.
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 251
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 252
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 253
Vague Commodity Vague Commodity Description
"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.
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 254
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 255
Vague Commodity Vague Commodity Description
"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.
"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, June 2006 256
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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 257
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 258
Vague Commodity Vague Commodity Description
"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.
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 259
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 260
Vague Commodity Vague Commodity Description
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 261
Vague Commodity Vague Commodity Description
"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.
"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.
"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.
Appendix B: Vague Commodity Descriptions
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 262
Vague Commodity Vague Commodity Description
"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, June 2006 263
Appendix C: Legal Terms and Conditions
In addition to creating and printing the waybill Label, you will need to print copies of the U.S. 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. handling instructions for the waybill labels and Legal Terms and Conditions.
If U.S. 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. 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.
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 264
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.
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 265
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
EEI: Electronic Export Information
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.
FDXC: FedEx Cargo
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.
FTR: Foreign Trade Regulations (Formerly FTSR - Foreign Trade Statistics Regulations)
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 266
FXCC: FedEx Custom Critical
FXFR: FedEx Freight
Girth: Girth is the sum of the four smallest dimensions of a package. Girth = (2" Width + 2" Height).
GST: Goods and Services 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
MTW : Multiweight
NAFTA: North America Free Trade Agreement
OP-950: FedEx Ground HazMat Report
OS: Oversize
Oversize Packages (FedEx Ground): A package whose Length plus Girth is greater than 84 inches is considered to be Oversize. Oversize packages are considered to
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 267
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
POD: Proof of Delivery
PST: Provincial Sales Tax
QST: Quebec Provincial Sales Tax
RMA: Return Materials 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
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 268
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
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 269
Index
C Country Codes table, 241
F FDXCancelEmailLabelReply, 189 FDXCancelEmailLabelReply, example, 190 FDXCancelEmailLabelRequest, 187 FDXCancelEmailLabelRequest, example, 188 FDXCancelExpressTag Reply, example, 204 FDXCancelExpressTagReply, 203 FDXCancelExpressTagRequest, 201 FDXCancelExpressTagRequest, example, 202 FDXCancelGroundCallTagReply, 216 FDXCancelGroundCallTagReply, example, 217 FDXCancelGroundCallTagRequest, 214 FDXCancelGroundCallTagRequest, example, 215 FDXCloseReply, 121 FDXCloseRequest, 118 FDXCloseRequest, example, 120, 122 FDXEmailLabelReply, 185 FDXEmailLabelReply, example, 186 FDXEmailLabelRequest, 167 FDXEmailLabelRequest, example, 182 FDXExpressTagAvailabilityReply, 221 FDXExpressTagAvailabilityReply, example, 222 FDXExpressTagAvailabilityRequest, 218 FDXExpressTagAvailabilityRequest, example, 220 FDXExpressTagReply, 199 FDXExpressTagReply, example, 200 FDXExpressTagRequest, 191 FDXExpressTagRequest, example, 197
FDXFedExLocatorReply, 161 FDXFedExLocatorReply, example, 163 FDXFedExLocatorRequest, 157 FDXFedExLocatorRequest, example, 160 FDXGroundCallTagRequest, example, 210 FDXGroundCallTagReply, 212 FDXGroundCallTagReply, example, 213 FDXGroundCallTagRequest, 205 FDXNotificationReply, 231 FDXNotificationReply, example, 235 FDXNotificationRequest, 223 FDXNotificationRequest, example, 228 FDXRateAvailableServicesReply, 47 FDXRateAvailableServicesReply, example, 54 FDXRateAvailableServicesRequest, 38 FDXRateAvailableServicesRequest, example, 46 FDXRateReply, 28 FDXRateReply, example, 37 FDXRateRequest, 18 FDXRateRequest, example, 26 FDXServiceAvailabilityReply, 154 FDXServiceAvailabilityReply, example, 155 FDXServiceAvailabilityRequest, 150 FDXServiceAvailabilityRequest, example, 153 FDXShipDelete Request, example, 115 FDXShipDeleteReply, 116 FDXShipDeleteReply, example, 117 FDXShipDeleteRequest, 114 FDXShipReply, 100 FDXShipReply, example, 112 FDXShipRequest, 58 FDXShipRequest, example, 97
Index
FedEx Ship Manager® API/Direct XML Transaction Guide, June 2006 270
FDXSPODReply, 146 FDXSPODReply, example, 147
Full SPOD sample letter, 148 Partial SPOD sample letter, 149
FDXSPODRequest, 141 FDXSPODRequest, example, 145 FDXSubscriptionReply, 16 FDXSubscriptionReply, example, 17 FDXSubscriptionRequest, 13 FDXSubscriptionRequest, example, 15 FDXTrack2Reply, 129 FDXTrack2Reply, example, 139 FDXTrack2Request, 124 FDXTrack2Request, example, 128
G Glossary, 264
I Introduction, 7
L label specifications
4x6 PNG Label, 238 custom labels, 239 determining screen resolution, 238 general printing overview and methods, 236
label preparation, 240 PDF Label, 237 plain paper and thermal, 236 PNG plain paper label, 236
Legal Terms and Conditions, 263
O overview, 7
R Referenced Documents, 11 Revision History, 4
S Shipping Label Specifications, 236
T Transaction Layouts, 12
U UTIs: Universal Transaction Identifiers, 8
V Vague Commodity Descriptions table, 245
W What’s New, 10