0% found this document useful (0 votes)
531 views

XML Trans Guide

XML Transactions Guide is confidential and proprietary to FedEx and its affiliates. No part of this guide may be distributed or disclosed to any third party without written permission of FedEx. This guide is provided 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.

Uploaded by

Positive Pause
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
531 views

XML Trans Guide

XML Transactions Guide is confidential and proprietary to FedEx and its affiliates. No part of this guide may be distributed or disclosed to any third party without written permission of FedEx. This guide is provided 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.

Uploaded by

Positive Pause
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 295

FedEx Ship Manager API/DIRECT

XML Transaction Guide

Jun05.0

Confidential and Proprietary The information contained in this XML Transactions Guide is confidential and proprietary to FedEx Corporate Services, Inc. and its affiliates (collectively "FedEx"). No part of this XML Transactions Guide may be distributed or disclosed in any form to any third party without written permission of FedEx. This guide is provided to you under and its use is subject to the terms and conditions of the FedEx End User and/or Consultant License Agreement. The information in this document may be changed at any time without notice. Any conflict between either of these guides, the FedEx End User and/or Consultant License Agreement, and the FedEx Service Guide shall be governed by the FedEx End User and/or Consultant License Agreement and the FedEx Service Guide, in that order. 2005 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved. Unpublished.

Table of Contents

Table of Contents
Introduction .................................................................................................................................................................................................................. 4 FedEx XML Overview ............................................................................................................................................................................................... 4 UTIs: Universal Transaction Identifiers..................................................................................................................................................................... 5 Whats New ................................................................................................................................................................................................................... 7 Referenced Documents ............................................................................................................................................................................................... 9 XML Transaction Layouts ......................................................................................................................................................................................... 10 FDXSubscriptionRequest........................................................................................................................................................................................ 11 Example of a FDXSubscriptionRequest XML Document .................................................................................................................................. 13 FDXSubscriptionReply............................................................................................................................................................................................ 14 Example of a FDXSubscriptionReply XML Document ...................................................................................................................................... 15 FDXRateRequest.................................................................................................................................................................................................... 16 Example of FDXRateRequest XML Document ................................................................................................................................................. 26 FDXRateReply ........................................................................................................................................................................................................ 28 Example of a FDXRateReply XML Document................................................................................................................................................... 41 FDXRateAvailableServicesRequest ....................................................................................................................................................................... 42 Example of FDXRateAvailableServicesRequest XML Document..................................................................................................................... 52 FDXRateAvailableServicesReply ........................................................................................................................................................................... 53 Example of FDXRateAvailableServicesReply XML Document ......................................................................................................................... 61 FDXShipRequest .................................................................................................................................................................................................... 66 Example of FDXShipRequest XML Document (U.S. Domestic Express) ....................................................................................................... 113 FDXShipReply ...................................................................................................................................................................................................... 116 Example of FDXShipReply XML Document (U.S. Domestic Express) ........................................................................................................... 132 FDXShipDeleteRequest........................................................................................................................................................................................ 134 Example of FDXShipDelete Request .............................................................................................................................................................. 135 FDXShipDeleteReply ............................................................................................................................................................................................ 136 Example of FDXShipDeleteReply Transaction................................................................................................................................................ 137

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Table of Contents

FDXCloseRequest (Applicable to FedEx Ground only)........................................................................................................................................ 138 Example of FDXCloseRequest XML Document.............................................................................................................................................. 140 FDXCloseReply (Applicable to FedEx Ground only) ............................................................................................................................................ 141 Example of FDXCloseRequest XML Document.............................................................................................................................................. 142 FDXTrackRequest ................................................................................................................................................................................................ 144 Example of FDXTrackRequest XML Document .............................................................................................................................................. 147 FDXTrackReply..................................................................................................................................................................................................... 148 Example of FDXTrackReply XML Document .................................................................................................................................................. 154 FDXSPODRequest ............................................................................................................................................................................................... 157 Example of FDXSPODRequest XML Document............................................................................................................................................. 161 FDXSPODReply ................................................................................................................................................................................................... 162 Example of FDXSPODReply XML Document ................................................................................................................................................. 162 Sample Signature Proof of Delivery (SPOD) Letter ........................................................................................................................................ 163 FDXServiceAvailabilityRequest (Express Only) ................................................................................................................................................... 164 Example of FDXServiceAvailabilityRequest XML Document .......................................................................................................................... 168 FDXServiceAvailabilityReply (Express Only)........................................................................................................................................................ 169 FDXFedExLocatorRequest ................................................................................................................................................................................... 170 Example of FDXFedExLocatorRequest XML Document................................................................................................................................. 174 FDXFedExLocatorReply ....................................................................................................................................................................................... 175 Example of FDXFedExLocatorReply XML Document..................................................................................................................................... 178 FDXEmailLabelRequest........................................................................................................................................................................................ 182 Example of FDXEmailLabelRequest XML Document ..................................................................................................................................... 199 FDXEmailLabelReply............................................................................................................................................................................................ 202 Example of FDXEmailLabelReply XML Document ......................................................................................................................................... 204 FDXCancelEmailLabelRequest ............................................................................................................................................................................ 205 Example of FDXCancelEmailLabelRequest XML Document .......................................................................................................................... 206 FDXCancelEmailLabelReply................................................................................................................................................................................. 207 Example of FDXCancelEmailLabelReply XML Document .............................................................................................................................. 208 FDXExpressTagRequest ...................................................................................................................................................................................... 209 Example of FDXExpressTagRequest XML Document.................................................................................................................................... 217 FDXExpressTagReply .......................................................................................................................................................................................... 219 Example of FDXExpressTagReply XML Document ........................................................................................................................................ 221

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Table of Contents

FDXCancelExpressTagRequest........................................................................................................................................................................... 222 Example of FDXCancelExpressTagRequest XML Document......................................................................................................................... 223 FDXCancelExpressTagReply ............................................................................................................................................................................... 224 Example of FDXCancelExpressTag Reply XML Document............................................................................................................................ 225 FDXGroundCallTagRequest................................................................................................................................................................................. 226 Example of FDXGroundCallTaglRequest XML Document.............................................................................................................................. 232 FDXGroundCallTagReply ..................................................................................................................................................................................... 234 Example of FDXGroundCallTagReply XML Document................................................................................................................................... 235 FDXCancelGroundCallTagRequest...................................................................................................................................................................... 236 Example of FDXCancelGroundCallTagRequest XML Document ................................................................................................................... 238 FDXCancelGroundCallTagReply.......................................................................................................................................................................... 239 Example of FDXCancelGroundCallTagReply XML Document........................................................................................................................ 240 FDXExpressTagAvailabilityRequest ..................................................................................................................................................................... 241 Example of FDXExpressTagAvailabilityRequest XML Document................................................................................................................... 244 FDXExpressTagAvailabilityReply ......................................................................................................................................................................... 245 Example of FDXExpressTagAvailabilityReply XML Document ....................................................................................................................... 247 Shipping Label Specifications................................................................................................................................................................................ 248 Plain Paper and Thermal Label Specifications..................................................................................................................................................... 248 General Printing Overview and Methods......................................................................................................................................................... 248 PNG Plain Paper Label.................................................................................................................................................................................... 249 Determining Screen Resolution....................................................................................................................................................................... 250 Custom Labels................................................................................................................................................................................................. 251 FedEx Shipping Label Preparation.................................................................................................................................................................. 251 Appendix A: Country Codes ................................................................................................................................................................................... 253 Appendix B: Vague Commodity Descriptions ...................................................................................................................................................... 258 Appendix C: Legal Terms and Conditions ............................................................................................................................................................ 282 Legal Terms .......................................................................................................................................................................................................... 282 Conditions of Contract .......................................................................................................................................................................................... 283 Glossary .................................................................................................................................................................................................................... 286 Index .......................................................................................................................................................................................................................... 291

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Introduction

Introduction
Welcome
Welcome to the FedEx XML Transactions Guide. This guide explains how you can compose FedEx XML Transactions to interface between your e-commerce application and the FedEx server and vice versa.

FedEx XML Overview


The FedEx XML schemas conform to the W3C XML 2.0 standard. These schemas use W3C data types, in defining all elements.

NOTE: Clients are required to specify a schema reference in the XML Request. The schema entity reference should specify only the schema name, and no absolute or relative path. The FedEx server will reject XML Request with missing schema references or Requests with a path specified in the schema entity reference.

Communication can be established to send FedEx XML Requests to and receive FedEx XML Replies from the FedEx server by the following methods:

via a secure Hypertext Transfer Protocol (HTTPS) utilizing the FedEx Direct solution via the FedEx Ship Manager API solution

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Introduction

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
2517 2518 2519 2521 2522 2523 2529 2532

Schema
FDXShipRequest / FDXShipReply FDXRateRequest / FDXRateReply FDXRateAvailableServicesRequest / FDXRateAvailableServicesReply FDXShipDeleteRequest / FDXShipDeleteReply FDXCloseRequest / FDXCloseReply FDXSubscriptionRequest / FDXSubscriptionReply FDXSPODRequest / FDXSPODReply FDXTrackRequest / FDXTrackReply

Applicable Carrier
ALL ALL ALL ALL FDXG ALL ALL ALL FedEx Ship-A-Package FedEx Rate-A-Package Rate Available Services

Description

FedEx Ship Delete-A-Package End-of-Day Close Subscription Signature Proof of Delivery Track By Number, Destination, Ship Date, and Reference

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Introduction

UTI
2534 2536 2538 2539 2540 2541 2542 3501 3502

Schema
FDXFedExLocatorRequest / FDXFedExLocatorRequest FDXServiceAvailabilityRequest / FDXServiceAvailabilityReply FDXEmailLabelRequest / FDXEmailLabelRequest FDXCancelEmailLabelRequest / FDXCancelEmailLabelReply FDXExpressTagRequest / FDXExpressTagReply FDXCancelExpressTagRequest / FDXCancelExpressTagReply FDXExpressTagAvailabilityRequest / FDXExpressTagAvailabilityReply FDXGroundCallTagRequest / FDXGroundCallTagReply FDXCancelGroundCallTagRequest / FDXCancelGroundCallTagReply

Applicable Carrier
ALL ALL FDXE FDXE FDXE FDXE FDXE FDXG FDXG

Description
FedEx Service Center Locator Service Availability FedEx Express E-mail Label FedEx Express Cancel E-mail Label FedEx Express Tag FedEx Cancel Express Tag FedEx Express Tag Availability FedEx Ground Call Tag FedEx Ground Cancel Call Tag

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Whats New

Whats New
International Document Shipping Improvements
Support documents with commercial value to improve document shipping process Clearer field names for International shipments with Purpose description Allow multiple countries of manufacture for one package containing items manufactured in different countries Expanded Commodity Description from 148 characters to 450 Venezuela Postal Stamp fee for inbound and outbound packages Excess Customs Value allows entry of customs value greater than the default amount

Signature Service Options


Indirect Signature Required: FedEx will obtain a signature 1) from any person at the delivery address, or 2) from someone at a neighboring address, or 3) the recipient can leave a signed FedEx door tag authorizing release of the package without anyone present. Available for residential deliveries only. Direct Signature Required: FedEx will obtain a signature from any person at the delivery address and will reattempt delivery if no one is available to sign for the package. Available for both residential and nonresidential deliveries. Adult Signature Required: FedEx will obtain a signature from any person at the delivery address who is at least 21 years old and who has government-issued photo identification as proof of age, and will reattempt delivery if no one is available to sign for the package. Available for both residential and nonresidential deliveries. Direct Signature Required replaces FedEx Express Signature Required, FedEx Ground Auto P.O.D., FedEx Home Delivery Auto P.O.D. and FedEx Signature Home DeliverySM. Until Direct Signature Required is available, shippers can still choose the above options. Label Type 1 Standard will not print the new Direct Signature code on the Label. Label Type 1 Standard does not support Signature Service. AOD is no longer supported Error returned if indicated in ship request.

* The impact of signature options fees may vary depending on your agreement with FedEx.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Whats New

Customer Bar Code on Doc Tab


Customer-specific information can be indicated in the bar code and human-readable form on the doc-tab.

New Customs Regulations and Edits for Canada and U.S.


Ineligible for Money Back Guarantee For intra-Canada shipments A warning when an area being shipped to is not eligible for Money Back Guarantee (MBG).

Admissibility Package Type A 3-character code representing a specific package type. Applicable for: All origin countries to Canada, excluding intra-Canada Canada and Mexico origins to U.S. and Puerto Rico destinations

Vague Commodity Description A list of descriptions considered vague. Applicable for: All origin countries to Canada, excluding intra-Canada Canada and Mexico origins to U.S. and Puerto Rico destinations

Revised Paper Invoice Format


Provides two additional reference fields for Express shipments

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

Referenced Documents

Referenced Documents
Title
FedEx Service Guide

Location
To download in .pdf format: http://www.fedex.com/us/services/express/pdf.html. To request a printed copy, please call 1.800.Go.FedEx (1.800.463.3339).

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

XML Transaction Layouts

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
Element Name Applicable Carrier The full XPath of the element.

Description

This column is used for the shipment and rating transaction only. Valid values: ALL = All carriers (FedEx Express and FedEx Ground) FDXE = FedEx Express only FDXG = FedEx Ground only This column is used for the shipment and rating transaction only. Valid values: ALL = Applicable to U.S. Domestic and all International shipments INTL = Applicable to non-Intra U.S. Domestic shipments USD = Applicable to U.S. Domestic shipments (U.S. to U.S.) CA = Applicable to Canada (Intra/Inter-Canada) PR = Applicable to Puerto Rico 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.

Valid For

Element Description/Requirements

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

10

XML Transaction Layouts: FDXSubscriptionRequest

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 customers FedEx account number will be returned to the client.

Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Data Type

Max Length

Element Description/Requirements

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. Required. This element should represent the FedEx account number for the FedEx customer to which the unique meter number will be assigned. The unique meter number assigned to the Senders 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.

RequestHeader / AccountNumber

xs:integer

12

RequestHeader / MeterNumber

xs:integer

10

CONTACT Contact / PersonName xs:string 35 Required. This element is only required if the element CompanyName is not provided. Optional. This element is becomes required if the element PersonName is not provided. Required. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters.

Contact / CompanyName

xs:string

35

Contact / PhoneNumber

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

11

XML Transaction Layouts: FDXSubscriptionRequest

Element Name
Contact / PagerNumber

Data Type
xs:string

Max Length
16

Element Description/Requirements
Optional. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters. Optional. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters. Optional.

Contact / FaxNumber

xs:string

16

Contact / E-mailAddress ADDRESS Address / Line1 Address / Line2 Address / City Address / StateOrProvinceCode Address / PostalCode

xs:string

120

xs:string xs:string xs:string xs:string xs:string

35 35 35 2 16

Required. Optional. Required. Required if Sender Country Code is US or CA. 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 Required.

Address / CountryCode

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

12

XML Transaction Layouts: FDXSubscriptionRequest

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/XMLSchemainstance" 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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

13

XML Transaction Layouts: FDXSubscriptionReply

FDXSubscriptionReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransactionIdentifier ERROR Error / Code Error / Message MeterNumber SubscribedService xs:string xs:string xs:integer xs:string 8 120 10 32 Passed back in the Reply indicating failed processing. For an erroneous transaction, the error code will be placed in this element. Passed back in the Reply indicating failed processing. For an erroneous transaction, the error message will be placed in this element. Returned in successful Reply. Meter number assigned to the FedEx account number. Returns (in multiple occurrences of the element) the FedEx Services the customer is eligible for. xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.

Data Type

Max Length

Element Description/Requirements

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

14

XML Transaction Layouts: FDXSubscriptionReply

Example of a FDXSubscriptionReply XML Document


Continuing from the FDXSubscriptionRequest example on the previous page, the FDXSubscriptionReply would be formatted as follows: <?xml version="1.0" encoding="UTF-8" ?> <FDXSubscriptionReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSubscriptionReply.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </RequestHeader> <MeterNumber>1234567</MeterNumber> <SubscribedService>FedEx Express Shipping</SubscribedService> </FDXSubscriptionReply>

If the FDXSubscriptionRequest contained an error, an error message number and message text would have been included in the transaction Reply. If, for example, the ZIP code you entered had only 3 digits, FedEx would respond with the following FDXSubscriptionReply: <?xml version="1.0" encoding="UTF-8" ?> <FDXSubscriptionReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSubscriptionReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>20528</Code> <Message>Invalid Zip Code</Message> </Error> </FDXSubscriptionReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

15

XML Transaction Layouts: FDXRateRequest

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
REQUESTHEADER RequestHeader / CustomerTransactionIdentifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ALL

ALL

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive a rate quote. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a rate quote. Required. Valid values: FDXE FedEx Express FDXG FedEx Ground 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.

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

ALL ALL

xs:integer xs:integer

12 10

RequestHeader / CarrierCode

ALL

ALL

xs:string

ShipDate

ALL

ALL

xs:date

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

16

XML Transaction Layouts: FDXRateRequest

Element Name
ReturnShipmentIndicator

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
13

Element Description/Requirements
Optional. Valid values: NONRETURN PRINTRETURNLABEL EMAILLABEL FEDEXTAG (ExpressTag/CallTag dependent on carrier code) 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.

DropoffType

FDXE

ALL

xs:string

21

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

17

XML Transaction Layouts: FDXRateRequest

Element Name
Service

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
28

Element Description/Requirements
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 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.

Packaging

ALL

ALL

xs:string

13

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

18

XML Transaction Layouts: FDXRateRequest

Element Name
WeightUnits

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
3

Element Description/Requirements
Required. Valid weight types: LBS KGS Must be LBS for a U.S. Domestic Express rate quote. Required. Format: One explicit decimal position (e.g. 5.0). 8 total length including decimal place. Optional. If = true or 1, a list rate courtesy quotes should be returned in addition to the discounted quote.

Weight

ALL

ALL

xs:decimal

6.1

ListRate

FDXE FDXG

USD ALL

xs:boolean

ORIGINADDRESS OriginAddress / StateOrProvinceCode ALL ALL xs:string 2 Required only if Sender Country Code is US or CA. Represents the state or province from which the shipment will be originating. 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 Required. Represents the country from which the shipment will be originating.

OriginAddress / PostalCode

ALL

ALL

xs:string

16

OriginAddress / CountryCode

ALL

ALL

xs:string

DESTINATIONADDRESS

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

19

XML Transaction Layouts: FDXRateRequest

Element Name
DestinationAddress / StateOrProvinceCode

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined. 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 Required. Represents the country code to which the shipment is destined.

DestinationAddress / PostalCode

ALL

ALL

xs:string

16

DestinationAddress / CountryCode

ALL

ALL

xs:string

PAYMENT Payment / PayorType ALL ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, NO rates will still be returned.

DIMENSIONS Dimensions / Length ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

20

XML Transaction Layouts: FDXRateRequest

Element Name
Dimensions / Width

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
3

Element Description/Requirements
Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number Required if dimensions are entered. Only applicable if the package type is YOURPACKAGING. The valid unit of measure codes for the package dimensions: IN Inches CM Centimeters U.S. Domestic Express must be in inches.

Dimensions / Height

ALL

ALL

xs:string

Dimensions / Units

ALL

ALL

xs:string

DECLAREDVALUE DeclaredValue / Value ALL ALL xs:decimal 8.2 Required for all shipments. The declared value of package contents. Format: Two explicit decimal positions (e.g. 100.00); 11 total length including decimal place. 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.

DeclaredValue / CurrencyCode

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

21

XML Transaction Layouts: FDXRateRequest

Element Name
SPECIALSERVICES Alcohol

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

FDXE

ALL

xs:boolean

Optional. If = true or 1, shipment contains alcohol. 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

FDXE FDXG

USD ALL

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. 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 If = true or 1, the shipment is Hold at Location.

SpecialServices / COD / CollectionType

FDXG

ALL

xs:string

15

SpecialServices / HoldAtLocation

FDXE

ALL

xs:boolean

SPECIALSERVICES / DANGEROUSGOODS SpecialServices / DangerousGoods / Accessibility SpecialServices / DryIce SpecialServices / ResidentialDelivery FDXE ALL xs:string 12 Valid values: ACCESSIBLE accessible Dangerous Goods INACCESSIBLE inaccessible Dangerous Goods If = true or 1, the shipment contains dry ice. If = true or 1, the shipment is Residential Delivery.

FDXE ALL

ALL USD

xs:boolean xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

22

XML Transaction Layouts: FDXRateRequest

Element Name
SpecialServices / ResidentialPickup

Applicable Carrier
FDXG

Valid For
USD

Data Type
xs:boolean

Max Length

Element Description/Requirements
Applicable only when ReturnShipmentIndicator is EMAILLABEL or FEDEXTAG. If = true or 1, the shipment is ResidentialPickup. If = true or 1, the shipment is Inside Pickup. If = true or 1, the shipment is Inside Delivery. If = true or 1, the shipment is scheduled for Saturday pickup. If = true or 1, the shipment is scheduled for Saturday delivery. If = true or 1, the nonstandard container is used for this shipment.

SpecialServices / InsidePickup SpecialServices / InsideDelivery SpecialServices / SaturdayPickup SpecialServices / SaturdayDelivery SpecialServices / NonstandardContainer SpecialServices / SignatureOption

FDXE FDXE FDXE FDXE FDXG ALL

USD USD ALL ALL ALL ALL

xs:boolean xs:boolean xs:boolean xs:boolean xs:boolean xs:string 21

Optional. Specifies one of the Delivery Signature Options. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT

HOMEDELIVERY HomeDelivery / Type FDXG USD xs:string 11 One of the following values are required for FedEx Home Delivery shipments: DATECERTAIN EVENING APPOINTMENT

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

23

XML Transaction Layouts: FDXRateRequest

Element Name
PackageCount

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:integer

Max Length
4

Element Description/Requirements
Required for multiple-piece shipments (MPS). Valid values are 1 to 999. For MPS shipments, 1 piece = 1 box. For International Freight MPS shipments, this is the total number of units. Units are the skids, pallets, or boxes that make up a freight shipment. Each unit within a shipment should have its own label.

VARIABLEHANDLINGCHARGES VariableHandlingCharges / Level ALL ALL xs:string 8 Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: PACKAGE SHIPMENT The value SHIPMENT is applicable only on last piece of Ground or Express MPS shipment only. Note: Value SHIPMENT = shipment level affects the entire shipment. Anything else sent in Child will be ignored.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

24

XML Transaction Layouts: FDXRateRequest

Element Name
VariableHandlingCharges / Type

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
28

Element Description/Requirements
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 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.

VariableHandling Charges / Amount OrPercentage

ALL

ALL

xs:decimal

7.2

INTERNATIONAL International / BrokerSelectionOption FDXE INTL xs:boolean If = true or 1, the shipment is Broker Select Option (BSO).

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

25

XML Transaction Layouts: FDXRateRequest

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

26

XML Transaction Layouts: FDXRateRequest

<Payment> <PayorType>SENDER</PayorType> </Payment> <PackageCount>1</PackageCount> </FDXRateRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

27

XML Transaction Layouts: FDXRateReply

FDXRateReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransaction Identifier ERROR Error / Code ALL ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element. Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element. ALL ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

Error / Message

ALL

ALL

xs:string

120

ESTIMATEDCHARGES EstimatedCharges / DimWeightUsed EstimatedCharges / RateScale EstimatedCharges / RateZone EstimatedCharges / CurrencyCode EstimatedCharges / BilledWeight FDXE FDXE FDXE FDXE FDXE ALL ALL USD ALL ALL xs:boolean xs:string xs:string xs:string xs:decimal 3 6.1 5 If = true or 1, the the dimmed weight was used to derive freight charges. Rate scale used to rate package. Zone used for rate if zone rating applies. Currency code identifier for the rated currency. Billed weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place. Required for Express. DIM weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place.

EstimatedCharges / DimWeight

FDXE

ALL

xs:decimal

6.1

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

28

XML Transaction Layouts: FDXRateReply

Element Name

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ESTIMATEDCHARGES / DISCOUNTEDCHARGES EstimatedCharges / DiscountedCharges / BaseCharge ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

EstimatedCharges / DiscountedCharges / TotalDiscount

ALL

ALL

xs:decimal

11.2

ESTIMATEDCHARGES / DISCOUNTEDCHARGES / SURCHARGES EstimatedCharges / DiscountedCharges / Surcharges / COD EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue EstimatedCharges / DiscountedCharges/ Surcharges / AppointmentDelivery EstimatedCharges / DiscountedCharges / Surcharges / HomeDelivery EstimatedCharges / DiscountedCharges / Surcharges / Home DeliveryDateCertain ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

ALL

xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

29

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / Home DeliveryEveningDelivery EstimatedCharges / DiscountedCharges / Surcharges / Non StandardContainer EstimatedCharges / DiscountedCharges / Surcharges / HazardousMaterials EstimatedCharges / DiscountedCharges / Surcharges / Residential EstimatedCharges / DiscountedCharges / Surcharges / VAT EstimatedCharges / DiscountedCharges / Surcharges / HSTSurcharge EstimatedCharges / DiscountedCharges / Surcharges / GSTSurcharge EstimatedCharges / DiscountedCharges / Surcharges / PSTSurcharge EstimatedCharges / DiscountedCharges / Surcharges / SaturdayDelivery EstimatedCharges / DiscountedCharges / Surcharges / DangerousGoods

Applicable Carrier
FDXG

Valid For
ALL

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

FDXE FDXE

ALL INTL

xs:decimal xs:decimal

11.2 11.2

FDXE

INTL

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

30

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / OutOfPickupOrH3Area EstimatedCharges / DiscountedCharges / Surcharges / out of DeliveryOrH3Area EstimatedCharges / DiscountedCharges / Surcharges / Inside Pickup EstimatedCharges / DiscountedCharges / Surcharges / Inside Delivery EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert EstimatedCharges / DiscountedCharges / Surcharges / DeliveryArea EstimatedCharges / DiscountedCharges / Surcharges / Fuel EstimatedCharges / DiscountedCharges / Surcharges / FICE EstimatedCharges / DiscountedCharges / Surcharges / Offshore EstimatedCharges / DiscountedCharges / Surcharges / Other

Applicable Carrier
FDXE

Valid For
USD

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE FDXE

ALL INTL

xs:decimal xs:decimal

11.2 11.2

FDXE

INTL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

31

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / Oversize EstimatedCharges / DiscountedCharges / Surcharges / ReturnLabel EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel EstimatedCharges / DiscountedCharges / Surcharges / FedExTag EstimatedCharges / DiscountedCharges / Surcharges / FedExEuropeFirst EstimatedCharges / DiscountedCharges / Surcharges / DeliverySignatureOptions EstimatedCharges / DiscountedCharges / TotalSurcharge

Applicable Carrier
FDXE

Valid For
USD

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

USD

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

ALL

ALL

Xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

EstimatedCharges / DiscountedCharges / NetCharge

ALL

ALL

xs:decimal

11.2

EstimatedCharges / DiscountedCharges / ShipmentNetCharge

FDXG

ALL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

32

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / DiscountedCharges / TotalRebate

Applicable Carrier
FDXE

Valid For
USD

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ESTIMATEDCHARGES / LISTCHARGES EstimatedCharges / ListCharges / BaseCharge ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

EstimatedCharges / ListCharges / TotalDiscount

ALL

ALL

xs:decimal

11.2

ESTIMATEDCHARGES / LISTCHARGES / SURCHARGES EstimatedCharges / ListCharges / Surcharges / COD EstimatedCharges / ListCharges / Surcharges / SaturdayPickup EstimatedCharges / ListCharges / Surcharges / DeclaredValue EstimatedCharges / ListCharges / Surcharges / AppointmentDelivery EstimatedCharges / ListCharges / Surcharges / HomeDelivery EstimatedCharges / ListCharges / Surcharges / Home DeliveryDateCertain ALL ALL ALL FDXG FDXG FDXG ALL ALL ALL ALL ALL ALL xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal 11.2 11.2 11.2 11.2 11.2 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

33

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / ListCharges / Surcharges / Home DeliveryEvening Delivery EstimatedCharges / ListCharges / Surcharges / Non StandardContainer EstimatedCharges / ListCharges / Surcharges / HazardousMaterials EstimatedCharges / ListCharges / Surcharges / Residential EstimatedCharges / ListCharges / Surcharges / VAT EstimatedCharges / ListCharges / Surcharges / HSTSurcharge EstimatedCharges / ListCharges / Surcharges / GSTSurcharge EstimatedCharges / ListCharges / Surcharges / PSTSurcharge EstimatedCharges / ListCharges / Surcharges / SaturdayDelivery EstimatedCharges / ListCharges / Surcharges / DangerousGoods EstimatedCharges / ListCharges / Surcharges / out of PickupOrH3Area EstimatedCharges / ListCharges / Surcharges / out of DeliveryOrH3 Area EstimatedCharges / ListCharges / Surcharges / InsidePickup

Applicable Carrier
FDXG

Valid For
ALL

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXG FDXG ALL FDXE FDXE FDXE FDXE FDXE FDXE FDXE FDXE FDXE

ALL ALL ALL ALL INTL INTL INTL ALL ALL USD USD USD

xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal

11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

34

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / ListCharges / Surcharges / InsideDelivery EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert EstimatedCharges / ListCharges / Surcharges / PriorityAlert EstimatedCharges / ListCharges / Surcharges / DeliveryArea EstimatedCharges / ListCharges / Surcharges / Fuel EstimatedCharges / ListCharges / Surcharges / FICE EstimatedCharges / ListCharges / Surcharges / Offshore EstimatedCharges / ListCharges / Surcharges / Other EstimatedCharges / ListCharges / Surcharges / Oversize EstimatedCharges / ListCharges / Surcharges / ReturnLabel EstimatedCharges / ListCharges / Surcharges / EmailLabel EstimatedCharges / ListCharges / Surcharges / FedExTag EstimatedCharges / ListCharges / Surcharges / FedExEuropeFirst

Applicable Carrier
FDXE FDXE

Valid For
USD USD

Data Type
xs:decimal xs:decimal

Max Length
11.2 11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE FDXE FDXE FDXE FDXE FDXE FDXE ALL ALL ALL FDXE

USD USD ALL INTL INTL ALL USD USD USD USD INTL

xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal

11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2 11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

35

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / ListCharges / Surcharges / DeliverySignatureOptions EstimatedCharges / DiscountedCharges / Surcharges / AdditionalHandling EstimatedCharges / ListCharges / TotalSurcharge

Applicable Carrier
ALL FDXE

Valid For
ALL ALL

Data Type
Xs:decimal xs:decimal

Max Length
11.2 11.2

Element Description/Requirements
Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

ALL

xs:decimal

11.2

EstimatedCharges / ListCharges / NetCharge

ALL

ALL

xs:decimal

11.2

EstimatedCharges / ListCharges / ShipmentNetCharge EstimatedCharges / ListCharges / TotalRebate

FDXG FDXE

ALL USD

xs:decimal xs:decimal

11.2 11.2

EstimatedCharges / EffectiveNetDiscount EstimatedCharges / MTWNetCharge

ALL FDXG

ALL ALL

xs:decimal xs:decimal

11.2 11.2

ESTIMATEDCHARGES / VARIABLEHANDLING

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

36

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / VariableHandling / VariableHandling Charge

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:decimal

Max Length
7.2

Element Description/Requirements
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. 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. Contains Shippers 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. Contains Shippers 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 / ListVariableHandling Charge

ALL

ALL

xs:decimal

7.2

EstimatedCharges / VariableHandling / TotalCustomerCharge

ALL

ALL

xs:decimal

18.2

EstimatedCharges / VariableHandling / ListTotalCustomer Charge

ALL

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

37

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / VariableHandling / MultiweightVariableHandlingCharge

Applicable Carrier
FDXG

Valid For
ALL

Data Type
xs:decimal

Max Length
7.2

Element Description/Requirements
Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal. Shippers Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.

EstimatedCharges / VariableHandling / MultiweightTotal CustomerCharge

FDXG

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

38

XML Transaction Layouts: FDXRateReply

Element Name
EstimatedCharges / OversizeClass

Applicable Carrier
FDXG

Valid For
ALL

Data Type
xs:string

Max Length

Element Description/Requirements
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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

39

XML Transaction Layouts: FDXRateReply

Element Name
SignatureOption

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
21

Element Description/Requirements
Optional. Effective Delivery Signature Option. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT

Note: This option may differ from that requested due to other characteristics of the shipment. IneligibleForMoneyBackGuarantee FDXE CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

40

XML Transaction Layouts: FDXRateReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

41

XML Transaction Layouts: FDXRateAvailableServicesRequest

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
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ALL

ALL

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive a rate quote. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a rate quote. Required. Valid values: FDXE FedEx Express FDXG FedEx Ground 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.

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

ALL ALL

xs:integer xs:integer

12 10

RequestHeader / CarrierCode

ALL

ALL

xs:string

ShipDate

ALL

ALL

xs:date

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

42

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
ReturnShipmentIndicator

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
13

Element Description/Requirements
Required. Valid values: NONRETURN PRINTRETURNLABEL EMAILLABEL 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.

DropoffType

FDXE

ALL

xs:string

21

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

43

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
Service

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
28

Element Description/Requirements
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 services estimated charges will be returned. 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.

Packaging

ALL

ALL

xs:string

13

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

44

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
WeightUnits

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
3

Element Description/Requirements
Valid weight types: LBS KGS LBS is required for a U.S. Domestic Express rate quote. Required. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place. Optional. If = true or 1, list-rate courtesy quotes should be returned in addition to the discounted quote.

Weight

ALL

ALL

xs:decimal

6.1

ListRate

FDXE FDXG

USD ALL

xs:boolean

ORIGINADDRESS OriginAddress / StateOrProvinceCode ALL ALL xs:string 2 Required only if Sender Country Code is US or CA. Represents the state or province from which the shipment will be originating. 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 Required. Represents the country from which the shipment will be originating.

OriginAddress / PostalCode

ALL

ALL

xs:string

16

OriginAddress / CountryCode

ALL

ALL

xs:string

DESTINATIONADDRESS

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

45

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
DestinationAddress / StateOrProvinceCode

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined. 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 Required. Represents the country code to which the shipment is destined.

DestinationAddress / PostalCode

ALL

ALL

xs:string

16

DestinationAddress / CountryCode

ALL

ALL

xs:string

PAYMENT Payment / PayorType ALL ALL xs:string 10 Optional. Defaults to SENDER. If value other than SENDER is used, no rates will still be returned.

DIMENSIONS Dimensions / Length ALL ALL xs:string 3 Optional. Only applicable if the package type is YOURPACKAGING. The length of a package. Format: Numeric, whole number

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

46

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
Dimensions / Width

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
3

Element Description/Requirements
Optional. Only applicable if the package type is YOURPACKAGING. The width of a package. Format: Numeric, whole number Optional. Only applicable if the package type is YOURPACKAGING. The height of a package. Format: Numeric, whole number Required if dimensions are entered. Only applicable if the package type is YOURPACKAGING. The valid unit of measure codes for the package dimensions are: IN Inches CM Centimeters U.S. Domestic Express must be in inches.

Dimensions / Height

ALL

ALL

xs:string

Dimensions / Units

ALL

ALL

xs:string

DECLAREDVALUE DeclaredValue / Value ALL ALL xs:decimal 8.2 Required for all shipments. The declared value of package contents. This value cannot exceed the total customs value. Format: Two explicit decimal positions (e.g. 100.00); 11 total length including decimal place.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

47

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
DeclaredValue / CurrencyCode

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
3

Element Description/Requirements
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. The presence of the COD element indicates that COD is selected for FedEx Express or Ground. The CollectionAmount and CollectionType elements must also be provided for FedEx Ground if shipping COD. 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. 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: SpecialServices / HoldAtLocation FDXE ALL xs:boolean ANY GUARANTEEDFUNDS CASH

SpecialServices / COD

FDXE FDXG

USD ALL

SpecialServices / COD / Collection Amount

FDXG

ALL

SpecialServices / COD / CollectionType

FDXG

ALL

xs:string

15

If = true or 1, the shipment is Hold at Location.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

48

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
SpecialServices / DangerousGoods / Accessibility SpecialServices / DryIce SpecialServices / ResidentialDelivery

Applicable Carrier
FDXE

Valid For
ALL

Data Type
xs:string

Max Length
12

Element Description/Requirements
Valid values: ACCESSIBLE accessible DG INACCESSIBLE inaccessible DG If = true or 1, the shipment contains dry ice. 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. If = true or 1, the shipment is Inside Pickup. If = true or 1, the shipment is Inside Delivery. If = true or 1, the shipment is scheduled for Saturday pickup. If = true or 1, the shipment is scheduled for Saturday delivery. If = true or 1, a nonstandard container is used for this shipment.

FDXE ALL

ALL USD

xs:boolean xs:boolean

SpecialServices / InsidePickup SpecialServices / InsideDelivery SpecialServices / SaturdayPickup SpecialServices / SaturdayDelivery SpecialServices / NonstandardContainer SpecialServices / SignatureOption

FDXE FDXE FDXE FDXE FDXG ALL

USD USD ALL ALL ALL ALL

xs:boolean xs:boolean xs:boolean xs:boolean xs:boolean xs:string 21

Optional. Specifies the Delivery Signature Option requested for the shipment. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT

HOMEDELIVERY

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

49

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
HomeDelivery / Type

Applicable Carrier
FDXG

Valid For
USD

Data Type
xs:string

Max Length
11

Element Description/Requirements
One of the following values are required for FedEx Home Delivery shipments: DATECERTAIN EVENING APPOINTMENT Required for multiple-piece shipments (MPS). For International Freight MPS shipments, this is the total number of units. Units are the skids, pallets, or boxes that make up a freight shipment. For MPS shipments, 1 piece = 1 box. Each unit within a shipment should have its own label. Valid values: 1 999

PackageCount

ALL

ALL

xs:positive integer

VARIABLEHANDLINGCHARGES VariableHandling Charges / Level ALL ALL xs:string 8 Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: PACKAGE SHIPMENT The value SHIPMENT is applicable only on last piece of Ground or Express MPS shipment only. Note: Value SHIPMENT = shipment level affects the entire shipment. Anything else sent in Child will be ignored.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

50

XML Transaction Layouts: FDXRateAvailableServicesRequest

Element Name
VariableHandling Charges / Type

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
28

Element Description/Requirements
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 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. If = true or 1, the shipment is BSO.

VariableHandling Charges / AmountOrPercentage

ALL

ALL

xs:decimal

7.2

International / BrokerSelectionOption

FDXE

INTL

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

51

XML Transaction Layouts: FDXRateAvailableServicesRequest

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/XMLSchemainstance" 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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

52

XML Transaction Layouts: FDXRateAvailableServicesReply

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
REPLYHEADER ReplyHeader / Customer Transaction Identifier ERROR Error / Code

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ALL

ALL

xs:string

40

Returned if the customer included it in the Request, containing the same value.

ALL

ALL

xs:string

Passed back in response indicating failed processing. For an erroneous Request or server failure, the error code will be placed in this element. Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element.

Error / Message

ALL

ALL

xs:string

120

SOFTERROR SoftError / Type ALL ALL xs:string 25 Returned only if a soft error/warning message is available. Valid values: WARNING INFORMATIONAL SHIPPING_WARNING SHIPPING_INFO URSA_HARD URSA_SOFT Returned only if a soft error/warning message is available.

SoftError / Code

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

53

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
SoftError / Message ENTRY Entry / Service

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
255

Element Description/Requirements
Returned only if a soft error/warning message is available.

ALL

ALL

xs:string

35

FedEx service(s) available for the Requested origin/destination pairing. There may be up to 22 occurrences of the Entry grouping representing available services available. Associated package description for available service. 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. 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. FedEx location identifier of the package destination. Expected time in transit.

Entry / Packaging Entry / DeliveryDate

ALL FDXE

ALL USD

xs:string xs:date

35 10

Entry / DeliveryDay

FDXE

USD

xs:string

Entry / DestinationStationID Entry / TimeInTransit ENTRY / ESTIMATEDCHARGES Entry/ EstimatedCharges / DimWeightUsed Entry / Estimated Charges / RateScale Entry / Estimated Charges / RateZone Entry / Estimated Charges / Currency Code

FDXE FDXG

USD USD

xs:string xs:string

FDXE FDXE FDXE FDXE

USD USD USD ALL

xs:boolean xs:string xs:string xs:string 3 5

If = true or 1, the dimmed weight was used to derive freight charges. Rate scale used to rate package. Zone used for rate if zone applies. Currency code identifier for the rated currency.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

54

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
Entry / Estimated Charges / Billed Weight

Applicable Valid Carrier For


FDXE USD

Data Type
xs:decimal

Max Length
6.1

Element Description/Requirements
Billed weight for the shipment. Format: One explicit decimal position (e.g. 5.0); 8 total length including decimal place. DIM weight for the shipment. Format: One explicit decimal positions (e.g. 5.0); 8 total length including decimal place.

Entry / Estimated Charges / DimWeight

FDXE

USD

xs:decimal

6.1

ENTRY / ESTIMATED CHARGES / DISCOUNTED CHARGES Entry / Estimated Charges / Discounted Charges / Base Charge ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

Entry / Estimated Charges / Discounted Charges / Total Discount

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / Discounted Charges / Total Surcharge

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / Discounted Charges / NetCharge

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / Discounted Charges / Shipment NetCharge Entry / Estimated Charges / Discounted Charges / Total Rebate

FDXG FDXE

ALL USD

xs:decimal xs:decimal

11.2 11.2

ENTRY / ESTIMATED CHARGES / LISTCHARGES

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

55

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
Entry / Estimated Charges / ListCharges / BaseCharge

Applicable Valid Carrier For


ALL ALL

Data Type
xs:decimal

Max Length
11.2

Element Description/Requirements
Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

Entry / Estimated Charges / ListCharges / TotalDiscount

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / ListCharges / TotalSurcharge

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / ListCharges / NetCharge

ALL

ALL

xs:decimal

11.2

Entry / Estimated Charges / ListCharges / ShipmentNetCharge Entry / Estimated Charges / ListCharges / TotalRebate

FDXG FDXE

ALL USD

xs:decimal xs:decimal

11.2 11.2

Entry / Estimated Charges / Effective NetDiscount Entry / Estimated Charges / MTW NetCharge

ALL FDXG

ALL ALL

xs:decimal xs:decimal

11.2 11.2

ENTRY / ESTIMATED CHARGES / VARIABLE HANDLING

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

56

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
Entry / Estimated Charges / Variable Handling / Variable HandlingCharge

Applicable Valid Carrier For


ALL ALL

Data Type
xs:decimal

Max Length
7.2

Element Description/Requirements
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. 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. Contains Shippers 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. Contains Shippers 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 / List VariableHandling Charge

ALL

ALL

xs:decimal

7.2

Entry / Estimated Charges / Variable Handling / Total CustomerCharge

ALL

ALL

xs:decimal

18.2

Entry / Estimated Charges / Variable Handling / ListTotal CustomerCharge

ALL

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

57

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
Entry / Estimated Charges / Variable Handling / Multiweight / Variable HandlingCharge

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:decimal

Max Length
7.2

Element Description/Requirements
Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal. Shippers Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.

Entry / Estimated Charges / Variable Handling / MultiweightTotal CustomerCharge

FDXG

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

58

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
Entry / EstimatedCharges / OversizeClass

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:string

Max Length

Element Description/Requirements
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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

59

XML Transaction Layouts: FDXRateAvailableServicesReply

Element Name
SignatureOption

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
21

Element Description/Requirements
Optional. Effective Delivery Signature Option. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT

Note: This option may differ from that requested due to other characteristics of the shipment. IneligibleForMoneyBackGuarantee ALL CAN xs:boolean If = true or 1, indicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

60

XML Transaction Layouts: FDXRateAvailableServicesReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

61

XML Transaction Layouts: FDXRateAvailableServicesReply

<DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>06002</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>8.30</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.46</TotalSurcharge> <NetCharge>8.76</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>FIRSTOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-19</DeliveryDate> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>00008</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>43.75</BaseCharge>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

62

XML Transaction Layouts: FDXRateAvailableServicesReply

<TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>2.41</TotalSurcharge> <NetCharge>46.16</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-19</DeliveryDate> <DeliveryDay>MON</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>01305</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>16.00</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.88</TotalSurcharge> <NetCharge>16.88</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>FEDEXEXPRESSSAVER</Service> <Packaging>YOURPACKAGING</Packaging> <DeliveryDate>2003-05-20</DeliveryDate>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

63

XML Transaction Layouts: FDXRateAvailableServicesReply

<DeliveryDay>TUE</DeliveryDay> <DestinationStationID>MEM</DestinationStationID> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>07169</RateScale> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>7.80</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.43</TotalSurcharge> <NetCharge>8.23</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> </Entry> <Entry> <Service>GROUNDHOMEDELIVERY</Service> <Packaging>YOURPACKAGING</Packaging> <TimeInTransit>1</TimeInTransit> <EstimatedCharges> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DiscountedCharges> <BaseCharge>3.50</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>1.21</TotalSurcharge> <NetCharge>4.71</NetCharge> </DiscountedCharges> </EstimatedCharges>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

64

XML Transaction Layouts: FDXRateAvailableServicesReply

</Entry> <Entry> <Service>FEDEXGROUND</Service> <Packaging>YOURPACKAGING</Packaging> <TimeInTransit>1</TimeInTransit> <EstimatedCharges> <RateZone>3</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DiscountedCharges> <BaseCharge>3.50</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <TotalSurcharge>0.04</TotalSurcharge> <NetCharge>3.54</NetCharge> </DiscountedCharges> </EstimatedCharges> </Entry> </FDXRateAvailableServicesReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

65

XML Transaction Layouts: FDXShipRequest

FDXShipRequest
Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier RequestHeader / AccountNumber RequestHeader / MeterNumber RequestHeader / CarrierCode ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply to aid in matching transaction Requests to Replies. Required. The FedEx account number assigned to the FedEx customer initiating the shipment Request. Required. The meter number assigned to the FedEx customer from which the shipment is originating. Required. Valid carrier codes: FDXE FedEx Express FDXG FedEx Ground Required if Future Ship Date element is present. Will be overridden by todays 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. Required. Local Time of shipment based on shipper's time zone. Defaults to the current U.S. Central Standard Time, if not provided.

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

ALL

ALL

xs:integer

12

ALL

ALL

xs:integer

10

ALL

ALL

xs:string

ShipDate

ALL

ALL

xs:date

10

ShipTime

ALL

ALL

xs:time

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

66

XML Transaction Layouts: FDXShipRequest

Element Name
ReturnShipmentIndicator

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
13

Element Requirements
Valid values: NONRETURN PRINTRETURNLABEL Required. Valid drop-off types: REGULARPICKUP REQUESTCOURIER DROPBOX BUSINESSSERVICECENTER STATION Only REGULARPICKUP, REQUESTCOURIER, or STATION are allowed with International freight shipping. This element does not dispatch a courier.

DropoffType

FDXE

ALL

xs:string

21

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

67

XML Transaction Layouts: FDXShipRequest

Element Name
Service

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
28

Element Requirements
Required. Available FedEx services: PRIORITYOVERNIGHT STANDARDOVERNIGHT FIRSTOVERNIGHT FEDEX2DAY FEDEXEXPRESSSAVER INTERNATIONALPRIORITY INTERNATIONALECONOMY INTERNATIONALFIRST FEDEX1DAYFREIGHT FEDEX2DAYFREIGHT FEDEX3DAYFREIGHT FEDEXGROUND GROUNDHOMEDELIVERY INTERNATIONALPRIORITY FREIGHT INTERNATIONALECONOMY FREIGHT EUROPEFIRSTINTERNATIONALPRIORITY Required. Valid packaging types include: FEDEXENVELOPE FEDEXPAK FEDEXBOX FEDEXTUBE FEDEX10KGBOX FEDEX25KGBOX YOURPACKAGING

Packaging

ALL

ALL

xs:string

14

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

68

XML Transaction Layouts: FDXShipRequest

Element Name
WeightUnits

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
3 Required. Valid units: LBS KGS

Element Requirements

Weight

ALL

ALL

xs:decimal

6.1

Required. The weight of the package. Required for International shipments. Defaults to USD for U.S. Domestic shipments. Optional. If true or 1, list rate (general estimated charges) will be returned along with the discounted rates.

CurrencyCode

FDXE FDXG FDXE FDXG

INTL ALL USD ALL

xs:string

ListRate

xs:boolean

ORIGIN ORIGIN / CONTACT Origin / Contact / PersonName ALL ALL xs:string 35 Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed. 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. Optional. Name of the department from which the shipment is originating.

Origin / Contact / CompanyName

ALL

ALL

xs:string

35

Origin / Contact / Department

ALL

ALL

xs:string

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

69

XML Transaction Layouts: FDXShipRequest

Element Name
Origin / Contact / PhoneNumber

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
16

Element Requirements
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. 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. 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 / PagerNumber

ALL

ALL

xs:string

16

Origin / Contact / FaxNumber

ALL

ALL

xs:string

16

Origin / Contact / E-MailAddress

ALL

ALL

xs:string

FDXE-120 Optional. FDXG-35 Required element for ShipAlert. The e-mail address of the person initiating the shipment.

ORIGIN / ADDRESS Origin / Address / Line1 ALL ALL xs:string 35 Required. Primary address line from which the shipment is originating. Optional. Secondary address line from which the shipment is originating.

Origin / Address / Line2

ALL

ALL

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

70

XML Transaction Layouts: FDXShipRequest

Element Name
Origin / Address / City

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length

Element Requirements

FDXE-120 Required. FDXG-35 City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping. 2 Required for shipping only if Country Code is US or CA. State code from which the shipment is originating. 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 Required. Name of the country from which the shipment is originating.

Origin / Address / StateOrProvinceCode Origin / Address / PostalCode

ALL

ALL

xs:string

ALL

ALL

xs:string

16

Origin / Address / CountryCode

ALL

ALL

xs:string

DESTINATION DESTINATION / CONTACT Destination / Contact / PersonName ALL ALL xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. Name of the person to whom the shipment is destined. COD service is selected. If passed in the transaction, a minimum of 3 alpha characters must be passed.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

71

XML Transaction Layouts: FDXShipRequest

Element Name
Destination / Contact / CompanyName

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
35

Element Requirements
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. Optional. Name of the department to whom the shipment is destined. 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. 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. 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 / Department

ALL

ALL

xs:string

10

Destination / Contact / PhoneNumber

ALL

ALL

xs:string

16

Destination / Contact / PagerNumber

ALL

ALL

xs:string

16

Destination / Contact / FaxNumber

ALL

ALL

xs:string

16

Destination / Contact / E-MailAddress

ALL

ALL

xs:string

FDXE-120 Optional. FDXG-35 E-mail address for the contact person to whom the shipment is destined.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

72

XML Transaction Layouts: FDXShipRequest

Element Name
DESTINATION / ADDRESS Destination / Address / Line1

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

ALL

ALL

xs:string

35

Required. Primary address line to which the shipment is destined. Optional. Secondary address line to which the shipment is destined. Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed. Required only if Recipient Country Code is US or CA, or if Shippers Export Declaration (SED) applies and country is MX. State or province code to which the shipment is destined. 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 / Line2

ALL

ALL

xs:string

35

Destination / Address / City

ALL

ALL

xs:string

FDXE-35 FDXG-20

Destination / Address / StateOrProvince Code

ALL

ALL

xs:string

Destination / Address / PostalCode

ALL

ALL

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

73

XML Transaction Layouts: FDXShipRequest

Element Name
Destination / Address / CountryCode

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
2

Element Requirements
Required. Name of the country to which the shipment is destined. Note: A column has been added to the country.dat file to distinguish 'ship-to' countries vs. country of manufacture countries. The ShipToCntry column will be populated with Y/N values: Y = ship-to country, N = country of manufacture. Any country code validations currently done by the software against country rows in country.dat will now have to check the ShipToCntry column to validate the country based on the content of the ShipToCntry column.

PAYMENT Payment / PayorType ALL ALL xs:string 10 Required. Method of payment for shipment. Valid payment types: SENDER RECIPIENT THIRDPARTY COLLECT The credit card payment type is only supported for U.S. Domestic Express shipping. For Return Manager, only SENDER and THIRDPARTY are allowed.

PAYMENT / PAYOR

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

74

XML Transaction Layouts: FDXShipRequest

Element Name
Payment / Payor / AccountNumber

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
12

Element Requirements
For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The FedEx account number for the payor of the shipment. 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.

Payment / Payor / CountryCode

ALL

ALL

xs:string

REFERENCEINFO ReferenceInfo / CustomerReference ALL ALL xs:string FDXE-40 FDXG-30 Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by reference. This element allows customer-defined notes to print on the shipping label. This element cannot be used if alcohol is declared in the special services element, customer reference information will be discarded. Optional. If passed in the transaction, it can be used later to track by PONumber. Optional. If passed in the transaction, it can be used later to track by InvoiceNumber reference.

ReferenceInfo / PONumber

ALL

ALL

xs:string

30

ReferenceInfo / InvoiceNumber

ALL

ALL

xs:string

30

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

75

XML Transaction Layouts: FDXShipRequest

Element Name
DIMENSIONS Dimensions / Length

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

ALL

ALL

xs:non negative Integer

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. 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. 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. 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.

Dimensions / Width

ALL

ALL

xs:non negative Integer

Dimensions / Height

ALL

ALL

xs:non negative Integer

Dimensions / Units

ALL

ALL

xs:string

DECLAREDVALUE

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

76

XML Transaction Layouts: FDXShipRequest

Element Name
DeclaredValue

Applicable Valid Carrier For


ALL ALL

Data Type
xs:decimal

Max Length
8.2

Element Requirements
Optional for a U.S. Domestic, International dutiable Express, and Ground shipments. Required in single-piece shipment Request and in the Request for the master package of a Express International Multipiece shipment. The declared value of entire shipment/ package contents. In multiple-piece shipments, this is ignored in all but the master package Request This value cannot exceed the total customs value for an International shipment. For Express International MPS, Master piece should contain the total declared value/carriage value, with no declared value/carriage value in sequential pieces. For example, piece 1 of n pieces will have the total declared value/carriage value of all the pieces.

SPECIALSERVICES SPECIALSERVICES / ALCOHOL SpecialServices / Alcohol / Type FDXE ALL xs:string 16 Required if the Alcohol element is present. The type of alcohol being shipped. Valid types: BEER WINE DISTILLEDSPIRITS ALE LIGHTWINE

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

77

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / Alcohol / Packaging

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
6

Element Requirements
Required if the Alcohol element is present. The packaging type for the alcohol being shipped. Valid types: BARREL BOTTLE CASE CARTON OTHER 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. Required if the Alcohol element is present. Number of units (bottles, cases, etc.) of alcohol included in the package being shipped.

SpecialServices / Alcohol / Volume

FDXE

ALL

xs:decimal

3.3

SpecialServices / Alcohol / PackageCount

FDXE

ALL

xs:integer

SPECIALSERVICES / COD

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

78

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / COD / Add Transportation Charges

Applicable Valid Carrier For


FDXG FDXE ALL USD

Data Type
xs:string

Max Length
45

Element Requirements
Required for COD shipments. This element determines which freight charges should be added to the COD collect amount. Valid values: ADD_DISCOUNTED_NET ADD_LIST_NET ADD_DISCOUNTED_COD_ SURCHARGE (GROUND ONLY) ADD_LIST_COD_SUR CHARGE (GROUND ONLY) ADD_DISCOUNTED_ CUSTOMER_TOTAL_CHARGE (GROUND ONLY) ADD_LIST_CUSTOMER_ TOTAL_CHARGE (GROUND ONLY) ADD_MULTIWEIGHT_NET_ CHARGE_TO_SHIPMENT (GROUND ONLY) ADD_SUM_OF_DISCOUNTED_NET_CHARGES_T O_ SHIPMENT (GROUND ONLY) ADD_SUM_OF_LIST_NET_ CHARGES_TO_SHIPMENT (GROUND ONLY) Required if COD element is provided. The Customer input COD amount (prior to any accumulations.) Format: Two explicit decimals (e.g.5.00). Required if the COD element is provided. Valid types: ANY GUARANTEEDFUNDS CASH

SpecialServices / COD / CollectionAmount

FDXE FDXG

USD ALL

xs:decimal

10.2

SpecialServices / COD / CollectionType

FDXG FDXE

ALL USD

xs:string

15

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

79

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / COD / CODReturn

Applicable Valid Carrier For


ALL USD

Data Type

Max Length

Element Requirements
If shipping a COD single-piece shipment, the COD remittance elements can be passed in the FDXShipRequest transaction. If shipping COD MPS, the COD remittance elements can be passed in the FDXShipRequest transaction representing the last piece of the shipment. The COD Return Contact information will default to the Shipper Contact information if not passed in the FDXShipRequest transaction.

SpecialServices / COD / CODReturn / Contact / PersonName

ALL

USD

xs:string

35

Required only if the COD element is present and the COD Company Name has not been entered. Name of the COD remittance person if different from the Sender. 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 Senders Company Name. Optional. Department name of the COD remittance party. 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. 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 / Contact / CompanyName

ALL

USD

xs:string

35

SpecialServices / COD / CODReturn / Contact / Department SpecialServices / COD / CODReturn / Contact / PhoneNumber

ALL

USD

xs:string

10

ALL

USD

xs:string

16

SpecialServices / COD / CODReturn / Address/Line1

ALL

USD

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

80

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / COD / CODReturn / Address / Line2 SpecialServices / COD / CODReturn / Address / City

Applicable Valid Carrier For


ALL USD

Data Type
xs:string

Max Length
35

Element Requirements
Optional. Secondary address of the COD remittance party. Required only if the COD element is not present and a different address from the Sender is needed. City of the COD remittance party. 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. 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 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.

ALL

USD

xs:string

35

SpecialServices / COD / CODReturn / Address / StateorProvinceCode SpecialServices / COD / CODReturn / Address / PostalCode

ALL

USD

xs:string

ALL

USD

xs:string

16

SpecialServices / COD / CODReturn / Tracking Number

FDXE

USD

xs:string

20

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

81

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / COD / CODReturn / ReferenceIndicator

Applicable Valid Carrier For


FDXG USD

Data Type
xs:string

Max Length

Element Requirements
Optional. This indicator determines which reference value will print on the FedEx Ground shipping label. Valid indicator values: TRACKING REFERENCE PO INVOICE

SPECIALSERVICES / HOLDATLOCATION SpecialServices / HoldAtLocation / PhoneNumber FDXE ALL xs:string 16 Required for freight shipping. Required only if Hold At Location. Phone number for the location where the shipment is being held. The maximum length is 10 for U.S. and CA, 16 for all other countries. Do not include embedded special characters. Required only if Hold At Location. Street address for the location where the shipment is being held. Required only if Hold At Location. City name of the location where the shipment is being held. 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 / Line1

FDXE

ALL

xs:string

35

SpecialServices / HoldAtLocation / Address / City

FDXE

ALL

xs:string

35

SpecialServices / HoldAtLocation / Address / StateOr ProvinceCode

FDXE

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

82

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / HoldAtLocation / Address / PostalCode

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
16

Element Requirements
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 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

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. Required for OP-950. Optional if Hazardous Materials is selected.

SpecialServices / HazMatCertificateData / DOTProper ShippingName

FDXG

ALL

xs:string

50

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

83

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / HazMatCertificateData / DOTHazardClassOrDivision

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:string

Max Length
25

Element Requirements
Required for OP-950. Optional if Hazardous Materials is selected. Valid values currently are: 1.4 1.6 2.1 2.2 3 4.1 5.1 5.2 7 8 9 ORM-D Optional if Hazardous Materials is selected.

SpecialServices / HazMatCertificateData / DOTIDNumber SpecialServices / HazMatCertificateData / DOTLabelType SpecialServices / HazMatCertificateData / PackingGroup

FDXG

ALL

xs:string

FDXG

ALL

xs:string

11

Optional. Type DOT Label(s) Required, Label(s) Required, Ltd., Qty., or Exemption Number. Optional if Hazardous Materials is selected. Valid groups: I II III Optional if Hazardous Materials is selected. Format: Two explicit decimal positions (e.g. 5.00).

FDXG

ALL

xs:string

SpecialServices / HazMatCertificateData / Quantity

FDXG

ALL

xs:decimal

6.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

84

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / HazMatCertificateData / Units

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:string

Max Length
4

Element Requirements
Optional for OP9-50. Valid values: oz gal lb Lg qt kg pt 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. Optional if Hazardous Materials is selected.

SpecialServices / HazMatCertificateData / TwentyFourHour EmergencyResponse ContactNumber SpecialServices / HazMatCertificateData / TwentyFour Hour Emergency Response ContactName SPECIALSERVICES / DRYICE SpecialServices / DryIce / WeightUnits SpecialServices / DryIce / Weight

FDXG

ALL

xs:string

16

FDXG

ALL

xs:string

50

FDXE

ALL

xs:string

Required for dry ice shipments. Required weight type for dry ice weight is KGS. 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.

FDXE

ALL

xs:decimal

4.1

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

85

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / ResidentialDelivery SpecialServices / FutureDayShipment

Applicable Valid Carrier For


FDXG FDXE ALL ALL USD ALL

Data Type
xs:boolean

Max Length

Element Requirements
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. Required for FDXG. For FDXE, defaults to false. A value of false causes any passed Ship Date to be overridden by todays 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. If = true or 1, the shipment is originated from an inside pickup area. Applicable to freight shipping only. If = true or 1, the shipment is traveling to an inside delivery area. Applicable to freight shipping only. If = true or 1, the shipment is scheduled for Saturday pickup. If = true or 1, the shipment is scheduled for Saturday delivery.

xs:boolean

SpecialServices/ InsidePickup SpecialServices / InsideDelivery SpecialServices / SaturdayPickup SpecialServices / SaturdayDelivery

FDXE FDXE FDXE FDXE

USD USD ALL ALL

xs:boolean xs:boolean xs:boolean xs:boolean

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

86

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / EMailNotification / ShipAlertOptional Message

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
120

Element Requirements
Optional. Customer specified message to be included in the shipment notification.

SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER SpecialServices / EMailNotification / Shipper / ShipAlert FDXE ALL xs:boolean Required for ShipAlert Notification to the shipper. When Requesting a ShipAlert in ship Request transaction, senders e-mail address, recipients e-mail address, brokers e-mail address, or E-mail Notification Address must be used in conjunction with the ShipAlert elements for shipment notification via e-mail. If true or 1, Senders E-mail Address will be e-mailed ShipAlert e-mail. Required for Delivery Notification to the shipper. If = true or 1, Senders E-mail Address will be e-mailed Delivery Notification e-mail. 2 Optional for Delivery Notification. Applies to Delivery Alert for shipper e-mail address. Defaults to EN (English). Valid language codes: EN English FR French

SpecialServices / EMailNotification / Shipper / Delivery Notification

FDXE

ALL

xs:boolean

SpecialServices / EMailNotification / Shipper / Language Code

FDXE

ALL

xs:string

SPECIALSERVICES / EMAILNOTIFICATION / RECIPIENT SpecialServices / EMailNotification / Recipient / ShipAlert FDXE ALL xs:boolean Required for ShipAlert Notification to the recipient. If = true or 1, Recipients E-mail Address will be e-mailed ShipAlert e-mail.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

87

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / EMailNotification / Recipient / DeliveryNotification

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:boolean

Max Length

Element Requirements
Required for Delivery Notification to the recipient. If = true or 1, Recipient E-mail Address will be e-mailed Delivery Notification e-mail.

SpecialServices / EMailNotification / Recipient / LanguageCode

FDXE

ALL

xs:string

Optional for Delivery Notification. Applies to Delivery Alert for recipient e-mail address. Defaults to EN (English). Valid language codes: EN English FR French

SPECIALSERVICES / EMAILNOTIFICATION / BROKER SpecialServices / EMailNotification / Broker / ShipAlert FDXE INTL xs:boolean Required for Delivery Notification to the broker. If = true or 1, Broker E-mail Address will be e-mailed ShipAlert e-mail. Required for Delivery Notification to the broker. If = true or 1, Broker E-mail Address will be e-mail Delivery Notification e-mail. 2 Optional for Delivery Notification. Applies to Delivery Alert for broker e-mail address. Defaults to EN (English). Valid language codes: EN English FR French

SpecialServices / EMailNotification / Broker Delivery Notification

FDXE

INTL

xs:boolean

SpecialServices / EMailNotification / Broker / LanguageCode

FDXE

INTL

xs:string

SPECIALSERVICES / EMAILNOTIFICATION / OTHER

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

88

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / EMailNotification / Other / E-MailAddress

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length

Element Requirements

FDXE- 120 For FDXE: FDXG- 35 A minimum of one occurrence is required if shipment notification or delivery notification is selected. A maximum of three occurrences is allowed for FedEx Express shipments for ShipAlert or Delivery Alert Notification. For FDXG: One occurrence is required if shipment notification is selected and ShipAlert fax number is not included in the Request transaction. Delivery Notification is not supported for FDXG. Shipment notification by e-mail address and fax number cannot both be selected for the same shipment Request transaction.

SpecialServices / EMailNotification / Other / ShipAlert

ALL

ALL

xs:boolean

Required for ShipAlert. If = true or 1, corresponding e-mail address will be emailed ShipAlert. For FDXE: Maximum of three occurrences allowed for FedEx Express shipments. For FDXG: One occurrence allowed for FedEx Ground shipments. Required for Delivery Notification. If = true or 1, the corresponding e-mail address will be emailed delivery notification. Maximum of three occurrences allowed for FedEx Express shipments

SpecialServices / EMailNotification / Other / Delivery Notification

FDXE

ALL

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

89

XML Transaction Layouts: FDXShipRequest

Element Name
SpecialServices / EMailNotification / Other / LanguageCode

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
2

Element Requirements
Optional for Delivery Notification. Applies to Delivery Alert for corresponding e-mail address. Maximum of three occurrences allowed for FedEx Express shipments. Defaults to EN (English). Valid language codes: EN English FR French If = true or 1, the shipment is in a nonstandard container.

SpecialServices / NonStandard Container SpecialServices / SignatureOption

FDXG ALL

ALL ALL

xs:boolean xs:string 21

Optional. Specifies one of the Delivery Signature Options. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT Release Authorization Number. Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.

SpecialServices / SignatureRelease

FDXE

USD CAN

xs:string

10

HOMEDELIVERY HomeDelivery / Date HomeDelivery / Instructions FDXG FDXG USD USD xs:date xs:string 74 Required for home delivery shipments if delivery type is set to DATECERTAIN. Optional. Applicable only to FedEx Home Delivery shipments.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

90

XML Transaction Layouts: FDXShipRequest

Element Name
HomeDelivery / Type

Applicable Valid Carrier For


FDXG USD

Data Type
xs:string

Max Length
11

Element Requirements
Required for home delivery shipments. Valid values: DATECERTAIN EVENING APPOINTMENT 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.

HomeDelivery / PhoneNumber

FDXG

USD

xs:string

16

LABEL Label / Type ALL ALL xs:string 8 Required to receive correct label image in the FDXShipReply transaction. 2DCOMMON is the label type value that must be included in the FDXShipRequest transaction. Required to indicate label formatting. Type of data stream or bitmap to be returned Valid image types: PNG plain paper ELTRON thermal Zebra thermal UniMark thermal

Label / ImageType

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

91

XML Transaction Layouts: FDXShipRequest

Element Name
Label / LabelStockOrientation

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
8

Element Requirements
Required only for thermal labels (ImageType other than PNG). Specifies whether label stock has doc-tab on leading (LEADING) or trailing (TRAILING) end of label as it emerges from printer, or has no doc-tab (NONE) Valid label stock options: LEADING TRAILING NONE 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 / DocTabLocation

ALL

ALL

xs:string

LABEL / DOCTABCONTENT Label / DocTabContent / Type ALL ALL xs:string 8 Optional. Required only if using the doc-tab on a thermal label. Valid values: STANDARD ZONE001 BARCODED NONE Default: STANDARD

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

92

XML Transaction Layouts: FDXShipRequest

Element Name

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

LABEL / DOCTABCONTENT / ZONE001 LABEL / DOCTABCONTENT / ZONE001 / HEADERVALUEPAIR Label / DocTabContent / Zone001 / HeaderValuePair / ZoneNumber ALL ALL xs:positive Integer 12 Optional. Applicable only if using the Zone001 doc-tab type on a thermal label. Maximum of 12 occurrences of Header Value Pair. Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair. Required only if using the Zone001 doc-tab on a thermal label. Maximum of 12 occurrences of Header Value Pair. If DisplayedOrigin elements are included in the FDXShipRequest transaction, the value of these elements prints on label in the sender area. The default is for the origin address to print on label in the sender area.

Label / DocTabContent / Zone001 / HeaderValuePair / Header

ALL

ALL

xs:string

12

Label / DocTabContent / Zone001 / HeaderValuePair / Value

ALL

ALL

xs:string

12

Label / DisplayedOrigin

LABEL / DOCTABCONTENT / BARCODED Label / DocTabContent / Barcoded / Symbology ALL ALL xs:positive 12 Integer 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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

93

XML Transaction Layouts: FDXShipRequest

Element Name
Label / DocTabContent / Barcoded / Header

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
20

Element Requirements
Required only if using the bar coded doc-tab on a thermal label. Human-readable text string.

Label / DocTabContent / Barcoded / Value

ALL

ALL

xs:string

30

Required if parent element is present; can contain only characters legal for the specified symbology. String to be encoded in bar code.

LABEL / DISPLAYEDORIGIN / CONTACT Label / DisplayedOrigin / Contact / PersonName Label / DisplayedOrigin / Contact / CompanyName Label / DisplayedOrigin / Contact / PhoneNumber Label / DisplayedOrigin / Address / Line1 ALL ALL ALL ALL ALL ALL ALL ALL xs:string xs:string xs:string xs:string 35 35 16 35 Required if Label/DisplayedOrigin element is present. Required if Label/DisplayedOrigin element is present. Required if Label/DisplayedOrigin element is present. Primary address line from which the shipment is destined. Required. Optional. Secondary address line from which the shipment is destined. Required. City name from which the shipment is destined. Minimum of 3 alpha characters must be passed for shipping. Required for shipping only if Country Code is US or CA. State code from which the shipment is destined.

Label / DisplayedOrigin / Address / Line2

ALL

ALL

xs:string

35

Label / DisplayedOrigin / Address / City

ALL

ALL

xs:string

FDXE-35 FDXG-20

Label / DisplayedOrigin / Address / StateOrProvinceCode

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

94

XML Transaction Layouts: FDXShipRequest

Element Name
Label / DisplayedOrigin / Address / PostalCode

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
16

Element Requirements
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 Required. Name of the country from which the shipment is destined. Optional If false, FedEx Account Number will be displayed on label. Default: true

Label / DisplayedOrigin / Address / CountryCode

ALL

ALL

xs:string

Label / MaskAccountNumber

ALL

ALL

xs:boolean

MULTIPIECE MultiPiece / PackageCount FDXE FDXG FDXE FDXG FDXE FDXG INTL ALL INTL ALL INTL ALL xs:positive Integer xs:positive Integer xs:decimal 4 Required for multiple-piece shipping.

MultiPiece / PackageSequence Number MultiPiece / ShipmentWeight

Required for multiple-piece shipping if PackageCount value is greater than 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). Required for multiple-piece shipping if SequenceNumber value is greater than 1. Required for multiple-piece shipping if PackageSequenceNumber value is greater than 1.

6.1

MultiPiece / MasterTracking Number MultiPiece / MasterFormID

FDXE FDXG FDXE

INTL ALL ALL

xs:string

20

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

95

XML Transaction Layouts: FDXShipRequest

Element Name
FREIGHT Freight / Packaging ListEnclosed

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

FDXE

USD

xs:boolean

Optional. If = true or 1, the packaging list is enclosed, else false or 0. 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. Shippers 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. Required for International freight shipping.

Freight / Shippers LoadAnd Count

FDXE

INTL

xs:positive Integer

Freight / Booking ConfirmationNumber VARIABLEHANDLINGCHARGES VariableHandling Charges / Level

FDXE

INTL

xs:string

12

ALL

ALL

xs:string

Optional. Only applicable if valid Variable Handling Type is present. Apply fixed or variable handling charges at package or shipment level. Valid values: PACKAGE SHIPMENT SHIPMENT is applicable only on last piece of Ground or Express MPS shipment only. Note: SHIPMENT = shipment level affects the entire shipment. Anything else sent in Child will be ignored.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

96

XML Transaction Layouts: FDXShipRequest

Element Name
VariableHandling Charges / Type

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
28

Element Requirements
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 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.

VariableHandling Charges / AmountOr Percentage

ALL

ALL

xs:decimal

7.2

INTERNATIONAL International / RecipientTIN ALL INTL xs:string 15 Optional. U.S. federal Taxpayer Identification Number (ITN) of recipient. No special characters allowed. 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.

International / Broker

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

97

XML Transaction Layouts: FDXShipRequest

Element Name
International / Broker / AccountNumber

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:string

Max Length
12

Element Requirements
Optional. The FedEx assigned account number of the Broker who will be used to clear the shipment (if other than FedEx). Optional. U.S. federal TIN (taxpayer identification number) of broker. No special characters allowed.

International / Broker / TIN

FDXE

INTL

xs:string

15

INTERNATIONAL / BROKER / CONTACT International / Broker / Contact / PersonName ALL INTL xs:string 35 Required. The contact name of the Broker who will be used to clear the shipment (if other than FedEx). Minimum of 3 alpha characters must be passed. Optional. The company name of the Broker who will be used to clear the shipment (if other than FedEx). Required. The contacts 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. Optional. The contacts 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 / CompanyName

ALL

INTL

xs:string

35

International / Broker / PhoneNumber

ALL

INTL

xs:string

16

International / Broker / PagerNumber

FDXE

INTL

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

98

XML Transaction Layouts: FDXShipRequest

Element Name
International / Broker / FaxNumber

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:string

Max Length
16

Element Requirements
Optional. The contacts 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. Optional.

International / Broker / E-MailAddress

FDXE

INTL

xs:string

120

INTERNATIONAL / BROKER / ADDRESS International / Broker / Address / Line1 ALL INTL xs:string 35 Optional. The primary address of the Broker who will be used to clear the shipment (if other than FedEx). Optional. The secondary address of the Broker who will be used to clear the shipment (if other than FedEx). 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. 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 / Line2

ALL

INTL

xs:string

35

International / Broker / Address / City

ALL

INTL

xs:string

35

International / Broker / Address / StateOr ProvinceCode

ALL

INTL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

99

XML Transaction Layouts: FDXShipRequest

Element Name
International / Broker / Address / PostalCode

Applicable Valid Carrier For


ALL INTL

Data Type
xs:string

Max Length
16

Element Requirements
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 Required. Must be the same as the Recipient Country Code. 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 / Broker / Address / CountryCode International / ImporterOfRecord

ALL

INTL

xs:string

35

International / ImporterOfRecord / AccountNumber

FDXE

INTL

xs:string

12

Optional. FedEx account number for importer of shipment if other than recipient. Optional. U.S. federal TIN (taxpayer identification number) for importer of shipment if other than recipient. Importers Contact Information

International / ImporterOfRecord / TIN

ALL

INTL

xs:string

15

INTERNATIONAL / IMPORTEROFRECORD / CONTACT International / ImporterOfRecord / Contact / PersonName International / ImporterOfRecord / Contact / CompanyName ALL INTL xs:string 35

Required for Importer. Contact for importer of shipment if other than recipient. Required for Importer. Company for importer of shipment if other than recipient.

ALL

INTL

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

100

XML Transaction Layouts: FDXShipRequest

Element Name
International / ImporterOfRecord / Contact / PhoneNumber

Applicable Valid Carrier For


ALL INTL

Data Type
xs:string

Max Length
16

Element Requirements
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. Importers Address Information

INTERNATIONAL / IMPORTEROFRECORD / ADDRESS International / ImporterOfRecord / Address / Line1 ALL INTL xs:string 35

Required for Importer. The primary address for importer of shipment if other than recipient. Optional. The secondary address for importer of shipment if other than recipient. Required for Importer. The city for importer of shipment if other than recipient. Required if Importer Country Code is US or CA. The state or province code for importer of shipment if other than recipient. 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 Required for Importer. The country code for importer of shipment if other than recipient.

International / ImporterOfRecord / Address / Line 2

ALL

INTL

xs:string

35

International / ImporterOfRecord / Address / City International / ImporterOfRecord / Address / StateOrProvinceCode

ALL

INTL

xs:string

35

ALL

INTL

xs:string

International / ImporterOfRecord / Address / PostalCode

ALL

INTL

xs:string

16

International / ImporterOfRecord / Address / CountryCode

ALL

INTL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

101

XML Transaction Layouts: FDXShipRequest

Element Name

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

INTERNATIONAL / DUTIESPAYMENT INTERNATIONAL / DUTIESPAYMENT / DUTIESPAYOR Required if PayorType is THIRDPARTY. Optional if RECIPIENT. xs:string 12 Required if Duties Pay Type is THIRDPARTY. FedEx account number billed for duties/taxes. Optional. Country code where the duty/tax payor resides. Required for a dutiable International Express shipment. This element is not applicable to an International document Express shipment. Payment type for duties and taxes. Valid payment types: SENDER RECIPIENT THIRDPARTY Required for a dutiable International Express shipment. This element is not applicable to an International document Express shipment. Valid values: FOB_OR_FCA CIF_OR_CIP CFR_OR_CPT EXW DDU DDP

International / DutiesPayment / DutiesPayor / AccountNumber International / DutiesPayment / DutiesPayor / CountryCode International / DutiesPayment / PayorType

FDXE

INTL

FDXE

INTL

xs:string

FDXE

INTL

xs:string

International / TermsOfSale

ALL

INTL

xs:string

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

102

XML Transaction Layouts: FDXShipRequest

Element Name
International / PartiesToTransaction

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:boolean

Max Length

Element Requirements
Required. Value of true or 1 required if the exporter and the consignee of the transaction are related. To determine if the parties are related, the company of the exporter and the company of the consignee have a parent/child relationship or either the exporter or consignee must have at least 10% ownership in the other (e.g. subsidiaries, branches of same company, etc.).

International / Documents

FDXE

INTL

xs:boolean

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. 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).

International / TotalCustomsValue

ALL

INTL

xs:decimal

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

103

XML Transaction Layouts: FDXShipRequest

Element Name

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements
Optional. CommercialInvoice element is required for electronic upload of CI data. It will serve to create/transmit an Electronic Commercial Invoice through FedExs 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

International / CommercialInvoice / Comments International / CommercialInvoice / FreightCharge

ALL ALL

INTL INTL

xs:string xs:decimal

444 16.2

Optional. 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). 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). 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 / InsuranceCharge

ALL

INTL

xs:decimal

16.2

International / CommercialInvoice / TaxesOrMiscellaneousCharge

ALL

INTL

xs:decimal

16.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

104

XML Transaction Layouts: FDXShipRequest

Element Name
International / CommercialInvoice / Purpose

Applicable Valid Carrier For


ALL INTL

Data Type
xs:string

Max Length
17

Element Requirements
Optional. Purpose of shipment. Valid values: Sold Not Sold Gift Sample Repair and Return Personal Effects Note: Sold is not a valid Purpose for a Proforma Invoice.

International / CommercialInvoice / CustomerInvoice Number INTERNATIONAL / COMMODITY

ALL

INTL

xs:string

15

Optional.

A maximum of twenty occurrences of commodity line item information is supported in this Request transaction. For International multiple-piece shipments, the first four occurrences of commodity information must be passed in the Master and each Child transaction. FDXE INTL xs:non negative Integer 5 At least one occurrence is required for International shipments.

International / Commodity / NumberOfPieces

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

105

XML Transaction Layouts: FDXShipRequest

Element Name
International / Commodity / Description

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:string

Max Length
450

Element Requirements
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. 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.

International / Commodity / Country OfManufacture

FDXE

INTL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

106

XML Transaction Layouts: FDXShipRequest

Element Name
International / Commodity / HarmonizedCode

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:string

Max Length
14

Element Requirements
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. At least one occurrence is required for International dutiable shipments. Format: One explicit decimal position (e.g. 5.0). Optional for an International PIB (document) Express shipment. Number of units of a commodity in total number of pieces for this line item. At least one occurrence is required for International dutiable shipments. Optional for an International PIB (document) Express shipment. At least one occurrence is required for International dutiable shipments. 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). At least one occurrence is required for International dutiable shipments. It should equal the commodity unit quantity times commodity unit value.

International / Commodity / Weight

FDXE

INTL

xs:decimal

9.1

International / Commodity / Quantity

FDXE

INTL

xs:non negative integer

International / Commodity / QuantityUnits

FDXE

INTL

xs:string

International / Commodity / UnitPrice

FDXE

INTL

xs:decimal

11.6

International / Commodity / CustomsValue

FDXE

INTL

xs:decimal

11.6

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

107

XML Transaction Layouts: FDXShipRequest

Element Name
International / Commodity / ExportLicenseNumber

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:string

Max Length
12

Element Requirements
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. 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. 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 / Commodity / ExportLicense ExpirationDate

FDXE

INTL

xs:date

10

International / Commodity / CIMarksAndNumbers

FDXE

INTL

xs:string

15

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

108

XML Transaction Layouts: FDXShipRequest

Element Name
INTERNATIONAL / SED

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements
The following AES (Automated Export System) data elements are required to be submitted to FedEx by the exporter or the exporters authorized agent prior to departure of the merchandise from the U.S. if a Shippers Export Declaration (SED) is required. Applicable To U.S. Export Shipments Only. Precedence for government issued licenses or exemptions for SED: Export License International Traffic in Arms Regulations (ITAR) License Exception Symbol Foreign Trade Statistics Regulations (FTSR) Custom Value

International / SED / SenderTINOrDUNS

ALL

INTL

xs:string

15

Optional. Required for U.S. Export shipments Either the federal (United States) TIN (taxpayer identification number) or the Dun and Bradstreet (D-U-N-S) Number of Sender. Required for any International shipments. Valid values: SSN EIN DUNS Express: Required for non-document U.S. Export Shipments. Ground: Required. The full AES SED exemption legend is entered in this element. Also, when all commodities in the shipment fall under an FTSR exemption, the full FTSR exemption legend is entered in this element.

International / SED / SenderTINOrDUNS Type

FDXE

INTL

xs:string

International / SED / AESOrFTSR ExemptionNumber

ALL

INTL

xs:string

32

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

109

XML Transaction Layouts: FDXShipRequest

Element Name
INTERNATIONAL / EXPORT International / Export / B13AFilingOption

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

FDXE

INTL

xs:string

Required for any International non-document shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico or the U.S. Virgin Islands. Specifies which filing option is being exercised by the customer. Valid values: NOT_REQUIRED MANUALLY_ATTACHED FILES_ELECTRONICALLY SUMMARY_REPORTING Currently required only if B13AFilingOption is one of the following: MANUALLY_ATTACHED FILES_ELECTRONICALLY SUMMARY_REPORTING Optional. Applicable for any Canada export (International) nondocument shipment of any value to any destination: US, PR, US Virgin Islands or Rest of World other than Canada.

International / Export / StatementData

FDXE

INTL

xs:string

Min: 1 Max: 50

International / Export / PermitNumber

FDXE

INTL

xs:string

Min: 1 Max: 10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

110

XML Transaction Layouts: FDXShipRequest

Element Name
International / AdmissibilityPackageType

Applicable Valid Carrier For


ALL INTL

Data Type
Xs:string

Max Length
4

Element Requirements
Required for shipments inbound to Canada. Applicable for all origins to Canada (excluding Intra-Canada), CA to US, CA to PR, MX to US, and MX to PR. Valid values: BAG BBL BDL BOX BSK BXT CAG CAS CHS CNT CRT CTN CYL DRM ENV PAL PCL PCS PKG PLT REL ROL SAK SHW SKD TBE TBN TNK UNT

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

111

XML Transaction Layouts: FDXShipRequest

Element Name
SHIPMENTCONTENT ShipmentContent / BlockShipmentData

Applicable Valid Carrier For

Data Type

Max Length

Element Requirements

FDXE

ALL

xs:boolean

Optional. If = true or 1, means block all but sender from seeing shipment content data in Inbound Visibility/Insight. Optional. This data represents more detailed content description for the shipment. Repeated Grouping up to 50 occurrences per tracking number.

SHIPMENTCONTENT / SHIPMENTCONTENTRECORD

ShipmentContent / ShipmentContentRecord / PartNumber ShipmentContent / ShipmentContentRecord / ItemNumber ShipmentContent / ShipmentContentRecord / ReceivedQuantity ShipmentContent / ShipmentContentRecord / Description RMA RMA / Number

ALL

ALL

xs:string

20

Optional.

ALL

ALL

xs:string

15

Optional.

ALL

ALL

xs:non negative integer xs:string

Optional.

ALL

ALL

80

Optional.

Return Merchant Authorization FDXE USD xs:string 20 Return Merchant Authorization that is assigned by the sender.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

112

XML Transaction Layouts: FDXShipRequest

Example of FDXShipRequest XML Document (U.S. Domestic Express)


On Monday, January 3, 2005, your customer, ABC Widgets, requests a shipment of widget parts to be delivered. ABC Widgets delivery address is 322 Latta Woods, Roanoke VA 24012. Their phone number is 703.555.1212. You are to send the package to the attention of Bernard F. Smith. The requested shipment is one piece, weighs a total of 4 pounds, and is being shipped using a FedEx Box. It should be sent via FedEx Express using the FedEx 2Day service. Your company is Total Widget Rebuilders, 445 East Street, Dallas TX 75247. Your phone number is 214.555.8765, and your FedEx account number is 123456789. The meter number is 1234567. Your input transaction is formatted as: <?xml version="1.0" encoding="UTF-8" ?> <FDXShipRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>US Ship</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>2005-01-03</ShipDate> <ShipTime>14:20:00</ShipTime> <DropoffType>REGULARPICKUP</DropoffType> <Service>PRIORITYOVERNIGHT</Service> <Packaging>FEDEXBOC\X</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>4.0</Weight> <Origin> <Contact> <PersonName>Contact Name</PersonName> <CompanyName>Company Name</CompanyName> <Department>Department</Department> <PhoneNumber>9015551234</PhoneNumber> <PagerNumber>8001234567</PagerNumber> <FaxNumber>9012638957</FaxNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

113

XML Transaction Layouts: FDXShipRequest

<Address> <Line1>10 Fedex Parkway</Line1> <Line2>2nd fl, Vertical</Line2> <City>Collierville</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <PersonName>Recip Contact</PersonName> <CompanyName>Recip Company</CompanyName> <Department>Recip Department</Department> <PhoneNumber>8705551234</PhoneNumber> <PagerNumber>8001234567</PagerNumber> <FaxNumber>9012635624</FaxNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>123 Main St.</Line1> <Line2>Suite 300</Line2> <City>Berkeley</City> <StateOrProvinceCode>CA</StateOrProvinceCode> <PostalCode>94710</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> </Payment> <ReferenceInfo> <CustomerReference>Reference 12345</CustomerReference>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

114

XML Transaction Layouts: FDXShipRequest

</ReferenceInfo> <Label> <Type>2DCOMMON</Type> <ImageType>PNG</ImageType> </Label> </FDXShipRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

115

XML Transaction Layouts: FDXShipReply

FDXShipReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransaction Identifier ERROR Error / Code Error / Message SOFTERROR SoftError / Type ALL ALL xs:string 16 Returned only if a soft error/warning message is available. Valid values: WARNING INFORMATIONAL SHIPPING_WARNING SHIPPING_INFO URSA_HARD URSA_SOFT Returned only if a soft error/warning message is available. Returned only if a soft error/warning message is available. ALL ALL ALL ALL xs:string xs:string 4 120 Returned only if an error occurred while processing the transaction. Returned only if an error occurred while processing the transaction. ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.

Applicable Valid Carrier For

Data Type

Max Length

Element Description / Requirements

SoftError / Code SoftError / Message TRACKING Tracking / TrackingNumber

ALL ALL

ALL ALL

xs:string xs:string

8 255

ALL

ALL

xs:string

20

Contains the tracking number assigned to the shipment if successful.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

116

XML Transaction Layouts: FDXShipReply

Element Name
Tracking / FormID Tracking / CodReturnTracking Number

Applicable Valid Carrier For


FDXE FDXE ALL USD

Data Type
xs:string xs:string

Max Length
4 20

Element Description / Requirements


Label form ID returned upon successful transaction Reply. Returned only for COD Express shipments. If a multiple-piece shipment, even though it is only required for the last piece, element CodReturnTrackingNumber will be returned for each corresponding FDXShipRequest. 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. Returned if an International multiple-piece shipment, or a U.S. Domestic COD multiple-piece shipment.

Tracking / CodReturnFormID

FDXE

USD

xs:string

Tracking / MasterTracking Number

FDXE

INTL USDCOD INTL USDCOD USD USD

xs:string

20

Tracking/Master FormID

FDXE

xs:string

Returned if an International multiple-piece shipment, or a U.S. Domestic COD multiple-piece shipment.

ServiceType Description PackagingDescription ESTIMATEDCHARGES EstimatedCharges / DimWeightUsed EstimatedCharges / RateScale EstimatedCharges / RateZone EstimatedCharges / CurrencyCode

FDXE FDXE

xs:string xs:string

35 35

Textual description of the FedEx service. Textual description of the shipment packaging.

FDXE FDXE FDXE FDXE

USD USD USD ALL

xs:boolean xs:string xs:string xs:string 3 5

If = true or 1, the dimmed weight was used to derive freight charges. Rate scale used to rate package. Zone used for rate if zone applies. Currency code identifier for the rated currency.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

117

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / BilledWeight

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:decimal

Max Length
6.1

Element Description / Requirements


Required for Express. Billed weight for the shipment. Format: One explicit decimal positions (e.g. 5.0); 8 total length including decimal place. DIM 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

ESTIMATEDCHARGES / DISCOUNTEDCHARGES EstimatedCharges / DiscountedCharges / BaseCharge ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

EstimatedCharges / DiscountedCharges / TotalDiscount

ALL

ALL

xs:decimal

11.2

ESTIMATEDCHARGES / DISCOUNTEDCHARGES / SURCHARGES EstimatedCharges / DiscountedCharges / Surcharges / COD EstimatedCharges / DiscountedCharges / Surcharges / SaturdayPickup EstimatedCharges / DiscountedCharges / Surcharges / DeclaredValue EstimatedCharges / DiscountedCharges / Surcharges / AppointmentDelivery ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

ALL

xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

118

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges/Home Delivery EstimatedCharges / DiscountedCharges / Surcharges / HomeDeliveryDateCertain EstimatedCharges / DiscountedCharges / Surcharges / HomeDeliveryEvening Delivery EstimatedCharges / DiscountedCharges / Surcharges / NonStandardContainer EstimatedCharges / DiscountedCharges / Surcharges / HazardousMaterials EstimatedCharges / DiscountedCharges / Surcharges / Residential EstimatedCharges / DiscountedCharges / Surcharges / VAT EstimatedCharges / DiscountedCharges / Surcharges / HSTSurcharge EstimatedCharges / DiscountedCharges / Surcharges / GSTSurcharge

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:decimal

Max Length
11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

119

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / PSTSurcharge EstimatedCharges / DiscountedCharges / Surcharges/Saturday Delivery EstimatedCharges / DiscountedCharges / Surcharges / DangerousGoods EstimatedCharges / DiscountedCharges / Surcharges / out of PickupOrH3Area EstimatedCharges / DiscountedCharges / Surcharges / out of DeliveryOrH3Area EstimatedCharges / DiscountedCharges / Surcharges / InsidePickup EstimatedCharges / DiscountedCharges / Surcharges / InsideDelivery EstimatedCharges / DiscountedCharges / Surcharges / PriorityAlert EstimatedCharges / DiscountedCharges / Surcharges / DeliveryArea

Applicable Valid Carrier For


FDXE INTL

Data Type
xs:decimal

Max Length
11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE

ALL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

120

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / Fuel EstimatedCharges / DiscountedCharges / Surcharges / FICE EstimatedCharges / DiscountedCharges / Surcharges / Offshore EstimatedCharges / DiscountedCharges / Surcharges / Other EstimatedCharges / DiscountedCharges / Surcharges / Oversize EstimatedCharges / DiscountedCharges / Surcharges / ReturnLabel EstimatedCharges / DiscountedCharges / Surcharges / EmailLabel EstimatedCharges / DiscountedCharges / Surcharges / FedExTag EstimatedCharges / DiscountedCharges / Surcharges / FedExEuropeFirst

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:decimal

Max Length
11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE

INTL

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

FDXE

ALL

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

ALL

USD

xs:decimal

11.2

FDXE

INTL

xs:decimal

11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

121

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / DiscountedCharges / Surcharges / DeliverySignatureOptions EstimatedCharges / DiscountedCharges / TotalSurcharge EstimatedCharges / DiscountedCharges / NetCharge

Applicable Valid Carrier For


ALL ALL

Data Type
xs:decimal

Max Length
11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

ALL

xs:decimal

11.2

ALL

ALL

xs:decimal

11.2

EstimatedCharges / DiscountedCharges / ShipmentNetCharge EstimatedCharges / DiscountedCharges / TotalRebate

FDXG

ALL

xs:decimal

11.2

FDXE

USD

xs:decimal

11.2

ESTIMATEDCHARGES / LISTCHARGES EstimatedCharges / ListCharges / BaseCharge ALL ALL xs:decimal 11.2 Base rate amount for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total discount amounts applied to the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

EstimatedCharges / ListCharges / TotalDiscount

ALL

ALL

xs:decimal

11.2

ESTIMATEDCHARGES / LISTCHARGES / SURCHARGES EstimatedCharges / ListCharges / Surcharges / COD ALL ALL xs:decimal 11.2 Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

122

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / ListCharges / Surcharges / SaturdayPickup EstimatedCharges / ListCharges / Surcharges / DeclaredValue EstimatedCharges / ListCharges / Surcharges / AppointmentDelivery EstimatedCharges / ListCharges / Surcharges / HomeDelivery EstimatedCharges / ListCharges / Surcharges / HomeDeliveryDate Certain EstimatedCharges / ListCharges / Surcharges / HomeDeliveryEveningDelivery EstimatedCharges / ListCharges / Surcharges / NonStandard Container EstimatedCharges / ListCharges / Surcharges / HazardousMaterials EstimatedCharges / ListCharges / Surcharges / Residential EstimatedCharges / ListCharges / Surcharges / VAT EstimatedCharges / ListCharges / Surcharges / HSTSurcharge EstimatedCharges / ListCharges / Surcharges / GSTSurcharge

Applicable Valid Carrier For


ALL ALL FDXG FDXG FDXG ALL ALL ALL ALL ALL

Data Type
xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal

Max Length
11.2 11.2 11.2 11.2 11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXG

ALL

xs:decimal

11.2

FDXG

ALL

xs:decimal

11.2

FDXG ALL FDXE FDXE FDXE

ALL ALL ALL INTL INTL

xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal

11.2 11.2 11.2 11.2 11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

123

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / ListCharges / Surcharges / PSTSurcharge EstimatedCharges / ListCharges / Surcharges / SaturdayDelivery EstimatedCharges / ListCharges / Surcharges / DangerousGoods EstimatedCharges / ListCharges / Surcharges / out of PickupOrH3 Area EstimatedCharges / ListCharges / Surcharges / out of DeliveryOrH3 Area EstimatedCharges / ListCharges / Surcharges / InsidePickup EstimatedCharges / ListCharges / Surcharges / InsideDelivery EstimatedCharges / ListCharges / Surcharges / PriorityAlert EstimatedCharges / ListCharges / Surcharges / DeliveryArea EstimatedCharges / ListCharges / Surcharges / Fuel EstimatedCharges / ListCharges / Surcharges / FICE EstimatedCharges / ListCharges / Surcharges / Offshore

Applicable Valid Carrier For


FDXE FDXE FDXE FDXE INTL ALL ALL USD

Data Type
xs:decimal xs:decimal xs:decimal xs:decimal

Max Length
11.2 11.2 11.2 11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

FDXE

USD

xs:decimal

11.2

FDXE FDXE FDXE FDXE FDXE FDXE FDXE

USD USD USD USD ALL INTL INTL

xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal

11.2 11.2 11.2 11.2 11.2 11.2 11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

124

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / ListCharges / Surcharges / Other EstimatedCharges / ListCharges / Surcharges / Oversize EstimatedCharges / ListCharges / Surcharges / ReturnLabel EstimatedCharges / ListCharges / Surcharges / EmailLabel EstimatedCharges / ListCharges / Surcharges / FedExTag EstimatedCharges / ListCharges / Surcharges / FedExEuropeFirst EstimatedCharges / ListCharges / Surcharges / DeliverySignatureOptions EstimatedCharges / ListCharges / TotalSurcharge

Applicable Valid Carrier For


FDXE ALL ALL ALL ALL FDXE ALL ALL USD USD USD USD INTL ALL

Data Type
xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal xs:decimal Xs:decimal

Max Length
11.2 11.2 11.2 11.2 11.2 11.2 11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total surcharge amount returned for the shipment. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Net charge amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Total rebate amount returned. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ALL

ALL

xs:decimal

11.2

EstimatedCharges / ListCharges / NetCharge

ALL

ALL

xs:decimal

11.2

EstimatedCharges / ListCharges / ShipmentNetCharge EstimatedCharges / ListCharges / TotalRebate

FDXG FDXE

ALL USD

xs:decimal xs:decimal

11.2 11.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

125

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / EffectiveNetDiscount EstimatedCharges / MTWNetCharge

Applicable Valid Carrier For


ALL FDXG ALL ALL

Data Type
xs:decimal xs:decimal

Max Length
11.2 11.2

Element Description / Requirements


Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place. Format: Two explicit decimal positions (e.g. 5.00); 14 total length including decimal place.

ESTIMATEDCHARGES / VARIABLEHANDLING EstimatedCharges / VariableHandling / VariableHandling Charge ALL ALL xs:decimal 7.2 Contains the Handling Charge amount (in billing currency for the shipment) that was calculated based on Discounted freight (either Freight or Net freight as specified by Variable Handling Charge Type element) plus the value input in Variable Handling Charge. If the Variable Handling Type is FIXED_AMOUNT, this element will be equal to the Variable Charge. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal place. 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. Contains Shippers 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 / ListVariableHandling Charge

ALL

ALL

xs:decimal

7.2

EstimatedCharges / VariableHandling / TotalCustomerCharge

ALL

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

126

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / VariableHandling / ListTotalCustomer Charge

Applicable Valid Carrier For


ALL ALL

Data Type
xs:decimal

Max Length
18.2

Element Description / Requirements


Contains Shippers 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. Handling charge returned to the customer calculated with multiweight freight. Format: Two explicit decimal positions (e.g. 5.00); 10 total length including decimal. Shippers Freight charge plus Multiweight Variable Handling Charge Amount. Format: Two explicit decimal positions (e.g. 5.00); 21 total length including decimal.

EstimatedCharges / VariableHandling / MultiweightVariable HandlingCharge EstimatedCharges / VariableHandling / MultiweightTotal CustomerCharge

FDXG

ALL

xs:decimal

7.2

FDXG

ALL

xs:decimal

18.2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

127

XML Transaction Layouts: FDXShipReply

Element Name
EstimatedCharges / OversizeClass

Applicable Valid Carrier For


FDXG ALL

Data Type
xs:string

Max Length

Element Description / Requirements


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. The handling information for the COD Return package.

COD / Handling

FDXE

USD

xs:string

21

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

128

XML Transaction Layouts: FDXShipReply

Element Name
COD / Service TypeDescription

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
35

Element Description / Requirements


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. A textual description of the Packaging. The text for each type of Packaging is subject to change without notice and thus may be displayed or printed, but not relied on for automated decision-makingl. Valid values : Secured Unsecured For Express, the value of GuaranteedFunds = Secured. For all others, the value = Unsecured.

COD / Packaging Description

FDXE

USD

xs:string

35

COD / Secured Description

FDXE

USD

xs:string

32

ROUTING Routing / UrsaRouting Code FDXE ALL xs:string 8 URSA routing code returned for all U.S. Domestic shipments. Applicable to a limited number of International countries for International shipping. The code representing the service commitment. Applicable to a limited number of International countries for International shipping. Day of week on which package will be delivered. Applicable to a limited number of International countries for International shipping. Applicable to a limited number of International countries for International shipping.

Routing / Service Commitment

FDXE

ALL

xs:string

Routing / DeliveryDay

FDXE

ALL

xs:string

Routing / Destination StationID

FDXE

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

129

XML Transaction Layouts: FDXShipReply

Element Name
Routing / Delivery Date

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
7

Element Description / Requirements


Date on which package will be delivered in DDMMMYY format. Applicable to a limited number of International countries for International shipping. Service commitment code for COD return payment. Returned only for COD Express shipments. Returned only in the Reply for the last piece of a multiplepiece shipment. Applicable to a limited number of International countries for International shipping.

Routing / CODReturn ServiceCommitment

FDXE

USD

xs:string

Routing / UrsaPrefixCode LABELS Labels / OutboundLabel

FDXE

ALL

xs:string

ALL

ALL

xs:base64 Binary

The label for the package. Returned only in FDXShipReply transaction if the label was requested. Label for COD Return payment. Returned only in FDXShipReply transaction representing the final piece of a FedEx Express COD shipment. 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.

Labels / CODReturnLabel

FDXE FDXG

USD ALL

xs:base64 Binary

SignatureOption

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

130

XML Transaction Layouts: FDXShipReply

Element Name
IneligibleForMoneyBackGuarantee

Applicable Valid Carrier For


ALL CAN

Data Type
xs:boolean

Max Length

Element Description / Requirements


If true or 1, iIndicates that the origin or destination address is ineligible for the Money Back Guarantee. For Ground shipments destined for Canada. The absence of this element should not be construed to indicate that a shipment is eligible for the Money Back Guarantee.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

131

XML Transaction Layouts: FDXShipReply

Example of FDXShipReply XML Document (U.S. Domestic Express)


In response to the previous FDXShipRequest, your FDXShipReply would be formatted as follows: <?xml version="1.0" encoding="UTF-8" ?> <FDXShipReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>US Ship</CustomerTransactionIdentifier> </ReplyHeader> <Tracking> <TrackingNumber>470012923511</TrackingNumber> <FormID>0201</FormID> </Tracking> <ServiceTypeDescription>PRIORITY OVERNIGHT</ServiceTypeDescription> <EstimatedCharges> <DimWeightUsed>false</DimWeightUsed> <RateScale>00241</RateScale> <RateZone>7</RateZone> <CurrencyCode>USD</CurrencyCode> <BilledWeight>1.0</BilledWeight> <DimWeight>0.0</DimWeight> <DiscountedCharges> <BaseCharge>17.45</BaseCharge> <TotalDiscount>0.00</TotalDiscount> <Surcharges> <Fuel>0.96</Fuel> </Surcharges> <TotalSurcharge>0.96</TotalSurcharge> <NetCharge>18.41</NetCharge> <TotalRebate>0.00</TotalRebate> </DiscountedCharges> </EstimatedCharges> <Routing> <UrsaRoutingCode>XHJEMA</UrsaRoutingCode> FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

132

XML Transaction Layouts: FDXShipReply

<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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

133

XML Transaction Layouts: FDXShipDeleteRequest

FDXShipDeleteRequest
Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier ALL ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. Required. The Senders FedEx account number. Required. The meter number associated with the designated shipment to be deleted. Required. Valid values: FDXE FedEx Express FDXG FedEx Ground Required. Tracking number assigned to a package.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

RequestHeader / AccountNumber

ALL

ALL

xs:integer

12

RequestHeader / MeterNumber

ALL

ALL

xs:integer

10

RequestHeader / CarrierCode

ALL

ALL

xs:string

TrackingNumber

ALL

ALL

xs:string

20

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

134

XML Transaction Layouts: FDXShipDeleteRequest

Example of FDXShipDelete Request


After placing an order, your customer called to cancel. Since you have already processed the shipping transaction for this order, you will need to delete the package from your shipping log. To delete the shipment properly, you will create a FDXShipDeleteRequest. Your iFDXShipDeleteRequest is formatted as follows: <?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1234567</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <TrackingNumber>470012923511</TrackingNumber> </FDXShipDeleteRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

135

XML Transaction Layouts: FDXShipDeleteReply

FDXShipDeleteReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransaction Identifier ERROR Error / Code Error / Message ALL ALL ALL ALL xs:string xs:string 8 120 Returned only if an error occurred while processing the transaction. Returned only if an error occurred while processing the transaction. ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

136

XML Transaction Layouts: FDXShipDeleteReply

Example of FDXShipDeleteReply Transaction


In response to the previous FDXShipDeleteRequest, the following Reply is returned: <?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> </FDXShipDeleteReply>

If the FDXShipDeleteRequest had contained an error or a server error had occurred, an error message number and message text would have been included in the FDXShipDeleeReply. If the meter number in the example had been invalid, FedEx would respond with the following Reply: <?xml version="1.0" encoding="UTF-8" ?> <FDXShipDeleteReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXShipDeleteReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>32785</Code> <Message>Invalid meter number non-numeric in string</Message> </Error> </FDXShipDeleteReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

137

XML Transaction Layouts: FDXCloseRequest

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
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Data Type

Max Length

Element Description/Requirements

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. Required. The FedEx account number associated with the FedEx Ground shipments being closed out. Required. The meter number associated with the FedEx Ground shipments being closed out. Required. Valid carrier code is FDXG for FedEx Ground. 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.

RequestHeader / AccountNumber

xs:integer

12

RequestHeader / MeterNumber

xs:integer

10

RequestHeader / CarrierCode

xs:string

Date

xs:date

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

138

XML Transaction Layouts: FDXCloseRequest

Element Name
Time

Data Type
xs:time

Max Length
8

Element Description/Requirements
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. 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.

ReportOnly

xs:boolean

ReportIndicator

xs:string

10

This element is used only when ReportOnly is true, to indicate which report(s) from the last three days are to be returned. Only one type of report can be returned per Request. Valid values: MANIFEST Ground Manifest Report HAZMAT Ground Hazardous Materials Report COD Ground COD report MULTIWEIGHT Ground Multiweight Report

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

139

XML Transaction Layouts: FDXCloseRequest

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

140

XML Transaction Layouts: FDXCloseReply

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
REPLY ReplyHeader / CustomerTransactionIdentifier ERROR Error / Code Error / Message MultiweightReport Manifest / FileName

Data Type

Max Length

Element Description/Requirements

xs:string

40

Returned if the customer included it in the Request transaction, containing the same value.

xs:string xs:string xs:base64 Binary xs:string

8 120

Returned only if an error occurred while processing the transaction. Returned only if an error occurred while processing the transaction. This buffer will contain the multiweight report for FedEx Ground multiweight shipments.

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. Content (ASCII data) of a manifest. 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. This buffer will contain the COD report for FedEx Ground COD shipments.

Manifest / File HazMatCertificate

xs:base64 Binary xs:base64 Binary

CODReport

xs:base64 Binary

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

141

XML Transaction Layouts: FDXCloseReply

Example of FDXCloseRequest XML Document


<?xml version="1.0" encoding="UTF-8" ?> <FDXCloseReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground Close</CustomerTransactionIdentifier> </ReplyHeader> <Manifest> <FileName>010208890000067</FileName> <File>ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBGRURFWCBHUk9VTkQgUElDSy1VUCBNQU5JRkVTVCAgICAgICA gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgI CAKIEZlZEV4IFNlcnZpY2VzICAgICAgICAgICAgICAgICAgICAgICAgICBGZWRFeCBHcm91bmQgU2hpcHBlciAjOiAwMjUwMDAyICA gICAgICAgICAgICAgICAgICAgICAgRGF0ZTogMTAvMTUvMjAwNCAgIAogMzkyNSBFbWJhc3N5IFBrd3kgICAgICAgICAgICAgICAgI CAgICAgIEZlZEV4IEFjY291bnQgIzogMTI4MzY1NzQ1ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIC AgCiAybmQgRmxvb3IgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIC AgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIEFrcm9uLCBPSCA0NDMzMyAgICAgICAgICAgICAgICAgICAgI CAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBQYWdlOiAxICAgICAgI AogIAotLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tL S0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgICAgICAgICAgICAgICAgIHwgQ09EICAgICAgIHwgRGVjbC4gVmFsLiB 8IE92ZXJzaXplICB8IE92ZXJzaXplICB8IE92ZXJzaXplICB8IEFkZCdsICAgICB8ICAgICAgICB8ICAgICAgICAgICAgIAogVHJhY2tpbm cgIyAgICAgICAgfCBBbW91bnQgICAgfCAoaWY+JDEwMCkgIHwgICAgIEkgICAgIHwgICAgSUkgICAgIHwgICAgSUlJICAgIHwgSGF uZGxpbmcgIHwgQS5PLkQuIHwgUmVzaWRlbnRpYWwgCiAtLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0t LS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0KICAgICAgICAgICAgIC AgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA gICAgICAgICAgICAgICAgICAgICAgIAogLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tL S0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiAgICBUb3RhbCBQYWNrYWdlczogICAgM CAgICAgICAgICAgICAwICAgICAgICAgICAwICAgICAgICAgIDAgICAgICAgICAgICAwICAgICAgICAgIDAgICAgICAgICAgICAwICAg ICAgICAgIDAgICAgICAKICAKLS0tL</File> </Manifest> </FDXCloseReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

142

XML Transaction Layouts: FDXCloseReply

The following is an example of a Ground Close Report: <?xml version="1.0" encoding="UTF-8" ?> <FDXCloseReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCloseReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground COD Report</CustomerTransactionIdentifier> </ReplyHeader> <CODReport>ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIENPRCBSRVBPUlQgICAgICAg ICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiBDVVNUT01FUiBOQU1FICA6IFNDT1RUICAgICAgICA gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIFNISVAgREFURSA6IDEwLzE0LzI wMDQgICAKIEFERFJFU1MgMSAgICAgIDogMzkyNSBFTUJBU1NZIFBLV1kgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgI CAgICAgICAgICAgICAgIEFDQ09VTlQgTlVNQkVSIDogMTI4MzY1NzQ1ICAgIAogQUREUkVTUyAyICAgICAgOiAyTkQgRkxPT1IgICA gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAg ICAgICAgCiBDSVRZLFNUQVRFLFpJUCA6IEFLUk9OLE9ILDQ0MzMzICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIC AgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIFBIT05FIE5VTUJFUiAgIDogMzMwNjY1NDYyMiAgIC AgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA gICAgIAogLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS 0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tCiBUUkFDSyBOTyAgICAgICAgICAgICAgICBDT01QIE5NICBBRERSRVN TICAgICAgICBDSVRZICAgICAgU1QgIFpJUCAgICBQSCMgICAgICAgICAgQ09EIFRZUEUgIENPRCBSRVQgQU1UICBDSEFSR0VTIC AKIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0gIC0tLS0tLS0gIC0tLS0tLS0tLS0tLS0gIC0tLS0tLS0tICAtLSAgLS0tLS0gIC0tLS0tLS0tLS0gI CAtLS0tLS0tLSAgLS0tLS0tLS0tLS0gIC0tLS0tLS0tLQogTk8gQ09EIFBBQ0tBR0VTIFNISVBQRUQgRFVSSU5HIFRISVMgQ0xPU0Ug Q1lDTEUgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgCiAKI AogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCiAKIAogCi AKIAogCiAKIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICBQQUdFOiAxICAgICAgIC AgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKIC0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS 0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLS0tLQog</ CODReport> </FDXCloseReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

143

XML Transaction Layouts: FDXTrackRequest

FDXTrackRequest
When sending a shipment tracking Request to the FedEx servers, there is information that the server requires before it will process the Request. The following elements can be sent to the FedEx server in order to track by number or track by reference:

Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ALL

ALL

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive a tracking response. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a tracking response. Required. Valid values: FDXE FedEx Express Tracking Requests FDXG FedEx Ground Tracking Requests Any one of several kinds of identifier for which all packages will be tracked.

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

ALL ALL

xs:integer xs:integer

12 10

RequestHeader / CarrierCode

ALL

ALL

xs:string

PACKAGEIDENTIFIER PackageIdentifier / Value ALL ALL xs:string 40

Required. An identifier that relates to one or more packages (or to the shipments of which they are part).

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

144

XML Transaction Layouts: FDXTrackRequest

Element Name
PackageIdentifier / Type

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length

Element Description/Requirements
Required. The type of the identifier. Some identifiers apply to a single package, while others apply to multiple packages or shipments. Valid values: TRACKING_NUMBER_OR_DOORTAG EXPRESS_MPS_MASTER EXPRESS_REFERENCE GROUND_PO GROUND_CUSTOMER_REFERENCE GROUND_INVOICE_NUMBER GROUND_SHIPMENT_ID RMA Optional, but recommended. If provided, EndDateRange is required. Recommend entry of date range to find desired track number. If not provided, results may vary. Optional, but recommended. If provided, StartDateRange is required. Recommend entry of date range to find desired track number. If not provided, results may vary. Optional, but recommended. The date in which the package was shipped. Should not be a future date or a date that is more than 90 days in the past. Ship date +/-5 days is allowed.

ShipDateRangeBegin

ALL

ALL

xs:date

ShipDateRangeEnd

ALL

ALL

xs:date

ShipDate

ALL

ALL

xs:date

DestinationCountryCode

FDXE

ALL

xs:string

Optional, but recommended.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

145

XML Transaction Layouts: FDXTrackRequest

Element Name
DetailScans

Applicable Valid Carrier For


ALL ALL

Data Type
xs:boolean

Max Length

Element Description/Requirements
Optional. If = false or 0 returns Summary/Profile data, which includes one single scan structure with the most recent scan. If = true or 1 return Detail Scan Activity (multiple scan structure) for each package.

PagingToken

ALL

ALL

xs:string

Variable Optional. Required in order to obtain additional data on second and subsequent TrackShipmentRequest transactions when more related tracking numbers exist that exceed the capacity of any one response structure. Applicable to Track By Reference, MPS, and Door Tag. This element should be absent from any first Track Request. It is only populated if the response results are in more than one page worth of data. If paging token contains value in first Reply, more tracking data exists. You should populate this element with the value returned in the previous transaction.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

146

XML Transaction Layouts: FDXTrackRequest

Example of FDXTrackRequest XML Document


In order to track a package you have shipped via FedEx, the courier must scan the package before the package information has been entered into the FedEx database. If you have a package that has been scanned, you can track that package by formatting your tracking Request as follows: <?xml version="1.0" encoding="UTF-8" ?> <FDXTrackRequest xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xsi:noNamespaceSchemaLocation="FDXTrackRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <PackageIdentifier> <Value>String</Value> <Type>TRACKING_NUMBER_OR_DOORTAG</Type> </PackageIdentifier> <ShipDateRangeBegin>1967-08-13</ShipDateRangeBegin> <ShipDateRangeEnd>1967-08-13</ShipDateRangeEnd> <ShipDate>1967-08-13</ShipDate> <DestinationCountryCode>AA</DestinationCountryCode> <DetailScans>1</DetailScans> <PagingToken>String</PagingToken> </FDXTrackRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

147

XML Transaction Layouts: FDXTrackReply

FDXTrackReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransaction Identifier ERROR Error / Code Error / Message MoreDataFlag ALL ALL ALL ALL ALL ALL xs:string xs:string xs:boolean 8 120 Returned only if an error occurred while processing the transaction. Returned only if an error occurred while processing the transaction. Value of true or 1 indicates that more data exists. Returned when more Reply data is available. Variable Returned for Track by Reference, MPS, Door Tag only when more related tracking numbers exists that exceed the capacity of a single response. Only populated if the response results in more than one page worth of data. Client should populate paging token value in subsequent TrackShipmentRequest transactions with the value returned in the previous TrackShipmentResponse. The TrackingProfile element will contain the Requested tracking activity for one tracking number. ALL ALL xs:string 20 Tracking number provided in the Request. Note: Door tag will never be returned in the response. TrackProfile / SoftError ALL ALL xs:string 40 Returned if the customer included it in the Request transaction, containing the same value.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

PagingToken

ALL

ALL

xs:string

TRACKPROFILE TrackProfile / TrackingNumber /

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

148

XML Transaction Layouts: FDXTrackReply

Element Name
TrackProfile / SoftError / Type

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
25

Element Description/Requirements
Returned only if a soft error/warning message is available. Valid values: WARNING INFORMATIONAL Returned only if a soft error/warning message is available. Returned only if a soft error/warning message is available. Specifies the particular carrier the package was shipped. Valid values: FDXE FedEx Express FDXG FedEx Ground Optional. Count of other identifiers related to this package returned in this Reply. If not present, count is zero. Another identifier that is related to this package.

TrackProfile / SoftError / Code TrackProfile / SoftError / Message TrackProfile / CarrierCode

ALL ALL ALL

ALL ALL ALL

xs:string xs:string xs:string

8 255 4

TrackProfile / OtherIdentifierCount

ALL

ALL

xs:integer

TRACKPROFILE / OTHERIDENTIFIER TrackProfile / OtherIdentifier / Value ALL ALL xs:string 40

Required. An identifier that relates to one or more packages (or to the shipments of which they are part).

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

149

XML Transaction Layouts: FDXTrackReply

Element Name
TrackProfile / OtherIdentifier / Type

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length

Element Description/Requirements
Required. The type of the identifier. Some identifiers apply to a single package, while others apply to multiple packages or shipments. Valid values: TRACKING_NUMBER_OR_DOORTAG EXPRESS_MPS_MASTER EXPRESS_REFERENCE GROUND_PO GROUND_CUSTOMER_REFERENCE GROUND_INVOICE_NUMBER GROUND_SHIPMENT_ID IPD

TrackProfile / ShipDate TrackProfile / EstimatedDelivery Date TrackProfile / EstimatedDelivery Time

ALL ALL ALL

ALL ALL ALL

xs:date xs:date xs:time

10 10 10

Date on which package was tendered to FedEx. Projected package delivery date based on ship date, service, and destination. Projected package delivery time based on ship date, service, and destination. Destination Address Information

TRACKPROFILE / DESTINATIONADDRESS TrackProfile / DestinationAddress / City TrackProfile / DestinationAddress / StateOrProvince Code TrackProfile / DestinationAddress / PostalCode ALL ALL xs:string

FDXE-35 Name of the city to which the shipment is destined. FDXG-20 2 16 State or province code to which the shipment is destined. Returned if Recipient Country Code is US or CA.

ALL ALL

ALL ALL

xs:string xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

150

XML Transaction Layouts: FDXTrackReply

Element Name
TrackProfile / DestinationAddress / CountryCode TrackProfile / DeliveredDate

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Name of the country to which the shipment is destined.

ALL

ALL

xs:date

10

Date when the package was delivered at destination.

TrackProfile / DeliveredTime TrackProfile / SignedForBy

ALL ALL

ALL ALL

xs:time xs:string 25

Time when the package was delivered at destination. Signature of person who signed for packages, or relative location at which package was left, such as Front Desk or Back Door. Pairs with DeliveredLocation Description element. Returned upon successful Reply only. 25 Relative location at which ackage was left, such as Front Desk or Back Door. Pairs with Delivered LocationCode element. Returned upon successful Reply only. String describing services type. Gross weight of the individual package. Format: One explicit decimal position (e.g. 5.0). Valid values: KGS LBS Description of packaging type of this package. Returned upon successful Reply for only. Returned if Delivery Reattempt was made or a future delivery was scheduled.

TrackProfile / DeliveredLocation Code TrackProfile / DeliveredLocation Description

FDXE

ALL

xs:string

FDXE

ALL

xs:string

TrackProfile / Service TrackProfile / Weight

ALL ALL

ALL ALL

xs:string xs:decimal

70 6.1

TrackProfile / WeightUnits

ALL

ALL

xs:string

TrackProfile / PackagingDescription

FDXE

ALL

xs:string

20

TrackProfile / ReattemptDate

FDXE

ALL

xs:date

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

151

XML Transaction Layouts: FDXTrackReply

Element Name
TrackProfile / ReattemptTime TrackProfile / PackageSequence Number

Applicable Valid Carrier For


FDXE FDXE ALL INTL

Data Type
xs:time xs:string

Max Length
10 4

Element Description/Requirements
Returned if Delivery Reattempt was made or a future delivery was scheduled. Package sequence number of package in multiple-piece shipment. Returned upon successful Reply for FedEx Express International Only. Count of packages in multiple-piece shipment. A URL containing the tracking number that can be used to track this package via www.fedex.com. Scan Data from package movement through the FedEx system.

TrackProfile / PackageCount TrackProfile / FedExURL TRACKPROFILE / SCAN TrackProfile / Scan / Date TrackProfile / Scan / Time

ALL FDXE

ALL ALL

xs:string xs:string

ALL ALL

ALL ALL

xs:date xs:time

10 10

Date when the scan was performed on package. Time when the scan was performed on package. Local time where scan occurred. Carriers scan code pairs with the description (e.g. DEX, PUP, HAL, etc.). For FedEx Ground, a value = indicates Exception, Scan description is blank. Literal description of the scan activity. Further defines the Scan Type Codes specific type (e.g. DEX08 business closed). This element pairs with the StatusExceptionDescription. The most recent status exception is returned if applicable. This element pairs with StatusExceptionCode. Name of the city where the shipment received scan.

TrackProfile / Scan / ScanType

ALL

ALL

xs:string

TrackProfile / Scan / ScanDescription TrackProfile / Scan / StatusExceptionCode

ALL ALL

ALL ALL

xs:string xs:string

80 2

TrackProfile / Scan / StatusException Description

FDXE

ALL

xs:string

40

TrackProfile / Scan / City

ALL

ALL

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

152

XML Transaction Layouts: FDXTrackReply

Element Name
TrackProfile / Scan / StateorProvinceCode TrackProfile / Scan / CountryCode

Applicable Valid Carrier For


ALL ALL ALL ALL

Data Type
xs:string xs:string

Max Length
2 2

Element Description/Requirements
State or province code where the shipment received scan. Returned if Recipient Country Code is US or CA. Country where the shipment received scan. This element will be populated when the most recent scan activity is a HAL scan. This element will not be populated if the package has been delivered. All other data will appear in the Scan Location elements if the scan is a HAL. These elements will appear just like other scans in the package history, regardless if delivered yet or not.

TrackProfile / Scan / HoldAtLocationAddress

FDXE

ALL

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

153

XML Transaction Layouts: FDXTrackReply

Example of FDXTrackReply XML Document


In response to the previous FDXTrackRequest, your FDXTrackReply is formatted as follows: <?xml version="1.0" encoding="UTF-8"?><FDXTrackReply xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xsi:noNamespaceSchemaLocation="FDXTrackReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>FDXTrack</CustomerTransactionIdentifier> </ReplyHeader> <MoreData>false</MoreData> <TrackProfile> <TrackingNumber>643133236401</TrackingNumber> <CarrierCode>FDXE</CarrierCode> <OtherIdentifierCount>1</OtherIdentifierCount> <OtherIdentifier> <Value>V6.8 USER GUIDE AND TCR</Value> <Type>EXPRESS_REFERENCE</Type> </OtherIdentifier> <ShipDate>2004-01-21</ShipDate> <DestinationAddress> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38301</PostalCode> <CountryCode>US</CountryCode> </DestinationAddress> <DeliveredDate>2004-01-22</DeliveredDate> <DeliveredTime>09:53</DeliveredTime> <SignedForBy>A.HODGES</SignedForBy> <DeliveredLocationCode>1</DeliveredLocationCode> <DeliveredLocationDescription>Receptionist/Front Desk</DeliveredLocationDescription> <Service>Priority Pak</Service> <Weight>3.0</Weight> <WeightUnits>LBS</WeightUnits> <FedExURL>http://fedex.com/Tracking?action=track&language=english&cntry_code=us&initial=x&tracknumbers=643133236401</

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

154

XML Transaction Layouts: FDXTrackReply

FedExURL> <ScanCount>6</ScanCount> <Scan> <Date>2004-01-22</Date> <Time>09:53</Time> <ScanType>20</ScanType> <ScanDescription>Delivered</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>07:34</Time> <ScanType>11</ScanType> <ScanDescription>On FedEx vehicle for delivery</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>06:39</Time> <ScanType>02</ScanType> <ScanDescription>Arrived at FedEx Destination Location</ScanDescription> <City>JACKSON</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>03:41</Time> <ScanType>10</ScanType>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

155

XML Transaction Layouts: FDXTrackReply

<ScanDescription>Left FedEx Sort Facility</ScanDescription> <City>MEMPHIS</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-22</Date> <Time>01:34</Time> <ScanType>10</ScanType> <ScanDescription>Left FedEx Sort Facility</ScanDescription> <City>MEMPHIS</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> <Scan> <Date>2004-01-21</Date> <Time>18:44</Time> <ScanType>08</ScanType> <ScanDescription>Picked up by FedEx</ScanDescription> <City>CORDOVA</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <CountryCode>US</CountryCode> </Scan> </TrackProfile> </FDXTrackReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

156

XML Transaction Layouts: FDXSPODRequest

FDXSPODRequest
When sending a shipment Signature Proof of Delivery (SPOD) Request to the FedEx servers, there is information that the server requires before it will process the Request. The following elements can be sent to the FedEx server to obtain a Signature Proof of Delivery:

Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ALL

USD & CA

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive a SPOD response. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a SPOD response. Required. Valid values: FDXE FedEx Express FDXG FedEx Ground Optional for Ground Requests only. For all Express Requests, a ship date is required. Required. Code indicating language of SPOD letter. One of the following package types is required: EN English FR French (Canadian)

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

USD & CA USD & CA USD & CA

xs:integer xs:integer

12 10

RequestHeader / CarrierCode

ALL

xs:string

ShipDate

ALL

USD & CA USD & CA USD & CA

xs:date

10

TrackingNumber LanguageCode

ALL ALL

xs:string xs:string

20 2

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

157

XML Transaction Layouts: FDXSPODRequest

Element Name

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements
Information to be substituted for recipient information in letter.

CONFIGURABLEGROUNDCONSIGNEE ConfigurableGroundConsignee / PersonName ConfigurableGroundConsignee / CompanyName FDXG USD & CA USD & CA xs:string 35

Optional. Name to be placed as recipient in the SPOD letter. Optional. Name to be placed as recipient company name in the SPOD letter. Optional. Address to be shown as recipient address in the SPOD letter.

FDXG

xs:string

35

CONFIGURABLEGROUNDCONSIGNEE / ADDRESS /

ConfigurableGroundConsignee / Address / Line1 ConfigurableGroundConsignee / Address / Line2 ConfigurableGroundConsignee / Address / City ConfigurableGroundConsignee / Address / StateOrProvinceCode ConfigurableGroundConsignee / Address / PostalCode

FDXG FDXG FDXG

USD & CA USD & CA USD & CA USD & CA USD & CA

xs:string xs:string xs:string

35 35

Optional if Sender Country Code is US or CA. Optional if Sender Country Code is US or CA.

FDXE-35 Optional if Sender Country Code is US or CA. FDXG-20 2 16 Optional if Sender Country Code is US or CA. Optional. Must be numeric for U.S. Valid characters: A-Z; 0-9; a-z Optional if Sender Country Code is US or CA. Optional.

FDXG FDXG

xs:string xs:string

ConfigurableGroundConsignee / Address / CountryCode ConfigurableGroundConsignee / MoreInformation

FDXG FDXG

USD & CA USD & CA

xs:string xs:string

2 30

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

158

XML Transaction Layouts: FDXSPODRequest

Element Name
ReturnLetterFormat

Applicable Carrier
ALL

Valid For
USD & CA

Data Type
xs:string

Max Length
3

Element Description/Requirements
Required if FaxLetter is not selected. Format of SPOD letter to be returned in Reply. Value = PNG. Information pertaining to letter to be faxed. Presence of this element indicates the Request for a fax.

FAXLETTER FaxLetter / RecipientName ALL USD & CA USD & CA xs:string 35

Required. Name of recipient of fax. 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. Required. Name to show as sender of fax. 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. Recipient name and postal address to which letter can be sent if fax fails.

FaxLetter / RecipientFaxNumber

ALL

xs:string

16

FaxLetter / SenderName

FDXE

USD & CA USD & CA

xs:string

35

FaxLetter / SenderPhoneNumber

FDXE

xs:string

16

FAXLETTER / MAILRECIPIENT FaxLetter / MailRecipient / RecipientName FDXG USD & CA xs:string 35

Required. Name of recipient. Address of the Recipient of the SPOD.

FAXLETTER / MAILRECIPIENT / ADDRESS FaxLetter / MailRecipient / Address / Line1 FDXG USD & CA xs:string 35

Required.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

159

XML Transaction Layouts: FDXSPODRequest

Element Name
FaxLetter / MailRecipient / Address / Line2 FaxLetter / MailRecipient / Address / City FaxLetter / MailRecipient / Address / StateOrProvince FaxLetter / MailRecipient / Address / PostalCode

Applicable Carrier
FDXG FDXE

Valid For
USD & CA USD & CA USD & CA USD & CA

Data Type
xs:string xs:string

Max Length
35

Element Description/Requirements
Optional.

FDXE-35 Required. FDXG-20 2 16 Required if Sender Country Code is US or CA. Required. Must be numeric for U.S. Valid characters: A-Z; 0-9; a-z Required.

FDXE FDXG

xs:string xs:string

FaxLetter / MailRecipient / Address / CountryCode

FDXG

USD & CA

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

160

XML Transaction Layouts: FDXSPODRequest

Example of FDXSPODRequest XML Document


In order to track a package you have shipped via FedEx, the courier must scan the package before the package information has been entered into the FedEx database. If you have a package that has been scanned, you can track that package by formatting your tracking Request as follows: <?xml version="1.0" encoding="UTF-8" ?> <FDXSPODRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSPODRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>String</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <ShipDate>1967-08-13</ShipDate> <TrackingNumber>String</TrackingNumber> <LanguageCode>EN</LanguageCode> <ConfigurableGroundConsignee> <PersonName>String</PersonName> <CompanyName>String</CompanyName> <Address> <Line1>String</Line1> <Line2>String</Line2> <City>String</City> <StateOrProvinceCode>AA</StateOrProvinceCode> <PostalCode>A</PostalCode> <CountryCode>AA</CountryCode> </Address> <MoreInformation>String</MoreInformation> </ConfigurableGroundConsignee> <ReturnLetterFormat>PNG</ReturnLetterFormat> </FDXSPODRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

161

XML Transaction Layouts: FDXSPODReply

FDXSPODReply
Element Name
REPLY ReplyHeader / CustomerTransactionIdentifier xs:string 40 Optional. Returned if the customer included a unique transaction identifier in the Request transaction, containing the same value. Recipient name and postal address to which letter can be sent if fax fails. xs:string xs:string xs:base64 Binary xs:string 20 8 120 Returned only if an error occurred while processing the transaction. Returned only if an error occurred while processing the transaction. SPOD Letter in base64-encoded format. Fax confirmation number for fax.

Data Types

Max Length

Element Description/Requirements

ERROR Error / Code Error / Message Letter FaxConfirmationNumber

Example of FDXSPODReply XML Document


<?xml version="1.0" encoding="UTF-8" ?> <FDXSPODReply xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXSPODReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>SPODRequest</CustomerTransactionIdentifier> </ReplyHeader> <Letter>iVBORw0KGgoAAAANSUhEUgAABJAAAAV4BAMAAAANnjpBAAAAKlBMVEUAAAD///9jAJz/YwDWxq3OtbXGrb3OtZTWtZT WpYzGpbW1nLXGpZS9ra3hhK8gAAAgAElEQVR4nO2di9mrNta2lzqQ9lQw6SDX18JuIS1MC2nhbyEtTAtpYVpIL/+2tE4SYGxY2GA/ d7L92hhxELeFTkhUAAiA3n0A4DOASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQo BIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBEKASCAEiARCgEggBIgEQoBIIASIBIoEQIBIIASKBE P4/X18gx3reVOYAAAAASUVORK5CYII=</Letter> </FDXSPODReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

162

XML Transaction Layouts: FDXSPODReply

Sample Signature Proof of Delivery (SPOD) Letter

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

163

XML Transaction Layouts: FDXServiceAvailabilityRequest

FDXServiceAvailabilityRequest (Express Only)


The FDXServiceAvailabilityRequest is used to determine which FedEx Express services are available between a given origin and destination. To check the availability of one particular FedEx service and packaging type, include elements Service and Packaging in the Request transaction. Only information regarding that single service and packaging type will be returned in the FDXServiceAvailabilityRequest transaction. To obtain a list of all available services for a certain origin and destination, omit elements Service and Packaing from the Request. The Reply will contain information on every available service.

Element Name
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully receive a Service Availability response. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a Service Availability response. Required. Valid value: FDXE FedEx Express

RequestHeader / AccountNumber RequestHeader / MeterNumber

FDXE FDXE

ALL ALL

xs:integer xs:integer

12 10

RequestHeader / CarrierCode

FDXE

ALL

xs:string

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

164

XML Transaction Layouts: FDXServiceAvailabilityRequest

Element Name
OriginAddress / PostalCode

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
16

Element Description/Requirements
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 Required. Represents the country from which the shipment will be originating.

OriginAddress / CountryCode

FDXE

ALL

xs:string

DESTINATIONADDRESS DestinationAddress / StateOrProvinceCode FDXE ALL xs:string 2 Required only if Recipient Country Code is US or CA. Represents the state or province to which the shipment is destined. 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 Required. Represents the country code to which the shipment is destined. 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.

DestinationAddress / PostalCode

FDXE

ALL

xs:string

16

DestinationAddress / CountryCode

FDXE

ALL

xs:string

ShipDate

FDXE

ALL

xs:date

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

165

XML Transaction Layouts: FDXServiceAvailabilityRequest

Element Name
PackageCount

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:positive integer

Max Length
4

Element Description/Requirements
Required for multiple-piece shipments. For International Freight MPS shipments, this is the total number of units. Units are the skids, pallets, or boxes that make up a freight shipment. Each unit within a shipment should have its own label. For MPS shipments, 1 piece = 1 box. Valid values: 1 999 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 services estimated charges will be returned.

Service

FDXE

ALL

xs:string

28

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

166

XML Transaction Layouts: FDXServiceAvailabilityRequest

Element Name
Packaging

Applicable Valid Carrier For


FDXE ALL

Data Type
xs:string

Max Length
13

Element Description/Requirements
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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

167

XML Transaction Layouts: FDXServiceAvailabilityRequest

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

168

XML Transaction Layouts: FDXServiceAvailabilityReply

FDXServiceAvailabilityReply (Express Only)


Element Name
REPLYHEADER ReplyHeader / Customer Transaction Identifier 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. Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element. FDXE ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

Error / Message

FDXE

ALL

xs:string

120

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. 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. FedEx location identifier of the package destination.

Entry / DeliveryDay

FDXE

USD

xs:string

Entry / DestinationStationID

FDXE

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

169

XML Transaction Layouts: FDXFedExLocatorRequest

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
REQUESTHEADER RequestHeader / CustomerTransaction Identifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ALL

ALL

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive a Station Location Information. The unique meter number assigned to the Senders FedEx account number is required to successfully receive a Station Location Information. Optional. The index of first location to be returned from among all matching locations Optional. Maximum number of locations to be returned. Maximum count allowed is 25. Defaults to 10. Optional. Defaults to EN. Valid values: EN English FR French

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

ALL ALL

xs:integer xs:integer

12 10

BeginningRecordIndex

ALL

ALL

xs:integer

MaximumMatchCount

ALL

ALL

xs:positive integer

LanguageCode

ALL

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

170

XML Transaction Layouts: FDXFedExLocatorRequest

Element Name
DistanceUnits

Applicable Valid Carrier For


ALL ALL

Data Type
xs:NMTOKEN

Max Length
2

Element Description/Requirements
Optional. Units in which Distance to location is to be expressed. Valid values: MI indicates miles KM indicates kilometers Optional if an address is not provided. Phone number for which nearby FedEx locations are to be found. Required if phone number is not provided. Street address or intersection for which nearby FedEx locations are to be found. Required. The city of the address which the search is being done against. Required. The address's state or province code. Required only if Recipient Country Code is US or CA. 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 Optional. Defaults to US. The address's country code. Valid values: US for United States CA for Canada

PhoneNumber

ALL

ALL

xs:string

35

StreetAddressOrIntersection

ALL

ALL

xs:string

35

City

ALL

ALL

xs:string

35

StateOrProvinceCode

ALL

ALL

xs:string

PostalCode

ALL

ALL

xs:string

16

CountryCode

ALL

USD / xs:NMTOKEN CA

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

171

XML Transaction Layouts: FDXFedExLocatorRequest

Element Name
FedExStaffed

Applicable Valid Carrier For


ALL USD

Data Type
xs:boolean

Max Length

Element Description/Requirements
Optional. Value = true or 1 if FedEx Staffed locations should be included in the response. Optional. Value = true or 1 if FedEx self-service locations should be included in the response. Optional. Value = true or 1 if FedEx Authorized Shipping Centers should be included in the response. Optional. Value = true or 1 means that only those locations that support Hold at Location are to be included. Optional. Value = true or 1 means that only the location with the latest Express drop-off time of those fitting the supplied critera is to be returned.

FedExSelfService

FDXE

USD

xs:boolean

FedExAuthorizedShipping Center HoldAtLocation

ALL

USD

xs:boolean

FDXE

ALL

xs:boolean

LatestExpressDropoff

FDXE

USD

xs:boolean

ExpressDropOffAfterTime

FDXE

USD

xs:time

Optional. Value = true or 1 means that only those locations open after this time are to be included in the response. Optional. Value = true or 1 means that only those locations that accept Express shipments containing hazardous materials are to be included in the response. Optional. Value = true or 1 means that only those locations open on Saturdays are to be included in response.

DangerousGoods

FDXE

USD

xs:boolean

SaturdayService

FDXE

USD

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

172

XML Transaction Layouts: FDXFedExLocatorRequest

Element Name
Ground

Applicable Valid Carrier For


ALL USD

Data Type
xs:boolean

Max Length

Element Description/Requirements
Optional. Value = true or 1 means that only those locations that accept FedEx Ground shipments are to be included in response. Optional. Value = true or 1 means that only those locations that make packaging supplies available are to be included in the response. Optional. Value = true or 1 means that only those locations that provide Pack and Ship services are to be included in response. Optional. Value = true or 1 means that only those locations that support the FedEx Return System are to be included in response.

PackagingSupplies

ALL

USD

xs:boolean

PackingServices

ALL

USD

xs:boolean

ReturnSystem

ALL

USD

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

173

XML Transaction Layouts: FDXFedExLocatorRequest

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

174

XML Transaction Layouts: FDXFedExLocatorReply

FDXFedExLocatorReply
Element Name
REPLYHEADER ReplyHeader /CustomerTransaction Identifier ERROR Error / Code ALL ALL xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element. Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element. A location matching the criteria provided in the FedExLocatorRequest. Can get up to 10 different FedEx locations. ALL USD xs:string 35 Required. The name of the business at this location. Required. Identifier that can be used by IVR attendant to look up directions to location. 35 Required. A textual description of the type of business, such as "FedEx Authorized Ship Center. Optional. Either a street address (e.g. "123 S. Main St.") or an intersection (e.g. "Elm Ave. at S. Main St.). ALL ALL xs:string 40 Returned if the customer included it in the Request, containing the same value.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

Error / Message

ALL

ALL

xs:string

120

LOCATION

Location / BusinessName

Location / BusinessID

ALL

USD

xs:string

Location / BusinessType

ALL

USD

xs:string

Location / StreetAddressOrIntersection

ALL

USD

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

175

XML Transaction Layouts: FDXFedExLocatorReply

Element Name
Location / City

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length
35

Element Description/Requirements
Required. The address' city. Required. The address' state or province code. Required. The address' postal code. Valid characters: A-Z; 0-9; a-z Optional. Value = true or 1 if this location offers HAL (Hold at Location) service. Optional. Value = true or 1 if this location offers FedEx Express service. Optional. Value = true or 1 if this location offers FedEx Ground services. Optional. Value = true i or 1 f this location will accept Hazardous Materials.

Location / StateOrProvinceCode

ALL

USD

xs:string

Location / PostalCode

ALL

ALL

xs:string

16

Location / HoldAtLocation

FDXE

USD

xs:boolean

Location / ExpressService

FDXE

ALL

xs:boolean

Location / GroundService

FDXG

USD

xs:boolean

Location / DangerousGoods

FDXE

USD

xs:boolean

Location / Distance

ALL

USD

xs:string

15

Required. Distance of this location from the point indicated by the search criteria (e.g. "12.5 mi"). Required. This location's weekday hours of operation (e.g. "9:00 AM - 6:45 PM").

Location / HoursWeekdays

ALL

USD

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

176

XML Transaction Layouts: FDXFedExLocatorReply

Element Name
Location / HoursSaturdays

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length
35

Element Description/Requirements
Required. This location's weekday hours of operation (e.g. "9:00 AM - 6:45 PM" or "No Sat pickup"). 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"). 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"). 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"). 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").

Location / LastExpressDropoffTimeWeekdays

ALL

USD

xs:string

35

Location / LastExpressDropoffTimeSaturdays

ALL

USD

xs:string

35

Location / LastGroundDropoffTimeWeekdays

ALL

USD

xs:string

35

Location / LastGroundDropoffTimeSaturdays

ALL

USD

xs:string

35

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

177

XML Transaction Layouts: FDXFedExLocatorReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

178

XML Transaction Layouts: FDXFedExLocatorReply

<City>Cordova</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38018</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>9.3 miles</Distance> <HoursWeekdays>12:01 AM-11:59 PM</HoursWeekdays> <HoursSaturdays>12:01 AM-11:59 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>9:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>6</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>NQAKK</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>6165 Stage Rd</StreetAddressOrIntersection> <City>Bartlett</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38134</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>13.9 miles</Distance> <HoursWeekdays>7:00 AM-11:00 PM</HoursWeekdays> <HoursSaturdays>7:00 AM-11:00 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>9:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

179

XML Transaction Layouts: FDXFedExLocatorReply

<RecordIndex>7</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>OLVK</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>1573 Union Ave</StreetAddressOrIntersection> <City>Memphis</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38104</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>17.6 miles</Distance> <HoursWeekdays>12:01 AM-11:59 PM</HoursWeekdays> <HoursSaturdays>12:01 AM-11:59 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>8:30 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>8</RecordIndex> </Location> <Location> <BusinessName>FedEx Kinko's</BusinessName> <BusinessID>79676</BusinessID> <BusinessType>FedEx Staffed</BusinessType> <StreetAddressOrIntersection>7570 Poplar Ave</StreetAddressOrIntersection> <City>Germantown</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38138</PostalCode> <ExpressService>true</ExpressService> <GroundService>true</GroundService> <Distance>6.4 miles</Distance>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

180

XML Transaction Layouts: FDXFedExLocatorReply

<HoursWeekdays>7:00 AM-11:00 PM</HoursWeekdays> <HoursSaturdays>9:00 AM-10:00 PM</HoursSaturdays> <LastExpressDropoffTimeWeekdays>8:00 PM</LastExpressDropoffTimeWeekdays> <LastExpressDropoffTimeSaturdays>4:00 PM</LastExpressDropoffTimeSaturdays> <LastGroundDropoffTimeWeekdays>6:00 PM</LastGroundDropoffTimeWeekdays> <PackagingSupplies>true</PackagingSupplies> <ReturnSystem>true</ReturnSystem> <RecordIndex>9</RecordIndex> </Location> <AvailableRecordsCount>13</AvailableRecordsCount> </FDXFedExLocatorReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

181

XML Transaction Layouts: FDXEmailLabelRequest

FDXEmailLabelRequest
A FedEx Email/Online Label is sent directly to the return shipper without exposing the FedEx customers account information. Returns shippers print labels from their own printer using an application on fedex.com, place the label on the package, and drop-off or request pickup. Cancellations are handled via Cancel E-mail Label Request.

Element Name
REQUESTHEADER RequestHeader/CustomerTransactionI dentifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ALL

USD

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully receive an E-mail Label. The unique meter number assigned to the Senders FedEx account number is required to successfully receive an E-mail Label. Valid values: FDXE FDXG Required. Format: YYYY-MM-DD Required. Optional.

RequestHeader/AccountNumber RequestHeader/MeterNumber

ALL ALL

USD USD

xs:string xs:string

9 8

RequestHeader/CarrierCode

ALL

USD

xs:string

URLExpirationDate

ALL

USD

xs:date

10

URLNotificationE-MailAddress URLNotificationE-MailMessage

ALL ALL

USD USD

xs:string xs:string

120

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

182

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
MerchantPhoneNumber

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. Value = true or 1 only if pickup location is residential. Method by which customer tenders package, which might or might not be a drop-off. Valid values: REGULARPICKUP REQUESTCOURIER DROPBOX BUSINESSSERVICECENTER STATION

ResidentialPickup DropoffType

FDXG FDXE

USD USD

xs:boolean xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

183

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Service

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length

Element Description/Requirements
Valid values: STANDARDOVERNIGHT FIRSTOVERNIGHT FEDEX2DAY FEDEXEXPRESSSAVER INTERNATIONALPRIORITY INTERNATIONALECONOMY INTERNATIONALFIRST FEDEX1DAYFREIGHT FEDEX2DAYFREIGHT FEDEX3DAYFREIGHT FEDEXGROUND GROUNDHOMEDELIVERY INTERNATIONALPRIORITYFREIGHT INTERNATIONALECONOMYFREIGHT EUROPEFIRSTINTERNATIONALPRIORITY Valid values: FEDEXENVELOPE FEDEXPAK FEDEXBOX FEDEXTUBE FEDEX10KGBOX FEDEX25KBOX YOURPACKAGING

Packaging

ALL

USD

xs:string

WeightUnits

ALL

USD

xs:string

Valid values: LBS KGS Note: This does NOT pertain to Dry Ice.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

184

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
CurrencyCode ORIGIN ORIGIN / CONTACT Origin / Contact / PersonName

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length
3

Element Description/Requirements
Optional.

ALL

ALL

xs:string

35

Required if the sender company name is not passed in the transaction. Name of the person initiating the shipment. If included in the transaction, a minimum of 3 alpha characters must be passed. 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. Optional. Name of the department from which the shipment is originating. 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 / CompanyName

ALL

ALL

xs:string

35

Origin / Contact / Department

ALL

ALL

xs:string

10

Origin / Contact / PhoneNumber

ALL

ALL

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

185

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Origin / Contact / PagerNumber

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. 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 / FaxNumber

ALL

ALL

xs:string

16

Origin / Contact / E-MailAddress

ALL

ALL

xs:string

FDXEOptional. 120 Required element for ShipAlert. FDXG-35 The e-mail address of the person initiating the shipment.

ORIGIN / ADDRESS Origin / Address / Line1 ALL ALL xs:string 35 Required. Primary address line from which the shipment is originating. Optional. Secondary address line from which the shipment is originating.

Origin / Address / Line2

ALL

ALL

xs:string

35

Origin / Address / City

ALL

ALL

xs:string

FDXE-35 Required. FDXG-20 City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

186

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Origin / Address / StateOrProvinceCode

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Required for shipping only if Country Code is US or CA. State code from which the shipment is originating. 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 Required. Name of the country from which the shipment is originating.

Origin / Address / PostalCode

ALL

ALL

xs:string

16

Origin / Address / CountryCode

ALL

ALL

xs:string

DESTINATION DESTINATION / CONTACT Destination / Contact / PersonName ALL ALL xs:string 35 Required if Recipient Company Name was not passed in the Request transaction. Name of the person to whom the shipment is destined. If passed in the transaction, a minimum of 3 alpha characters must be passed.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

187

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Destination / Contact / CompanyName

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length
35

Element Description/Requirements
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. Optional. Name of the department to whom the shipment is destined. 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. 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. 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 / Department

ALL

ALL

xs:string

10

Destination / Contact / PhoneNumber

ALL

ALL

xs:string

16

Destination / Contact / PagerNumber

ALL

ALL

xs:string

16

Destination / Contact / FaxNumber

ALL

ALL

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

188

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Destination / Contact / E-mailAddress DESTINATION / ADDRESS Destination / Address / Line1

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length

Element Description/Requirements

FDXEOptional. 120 E-mail address for the contact person to whom the FDXG-35 shipment is destined.

ALL

ALL

xs:string

35

Required. Primary address line to which the shipment is destined. Optional. Secondary address line to which the shipment is destined.

Destination / Address / Line2

ALL

ALL

xs:string

35

Destination / Address / City

ALL

ALL

xs:string

FDXE-35 Required. FDXG-20 Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed. 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. 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 Required. Name of the country to which the shipment is destined.

Destination / Address / StateOrProvince Code

ALL

ALL

xs:string

Destination / Address / PostalCode

ALL

ALL

xs:string

16

Destination / Address / CountryCode

ALL

ALL

xs:string

PAYMENT

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

189

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Payment/PayorType

Applicable Carrier
ALL

Valid For
USD

Data Type
xs:string

Max Length

Element Description/Requirements
Required. Valid values: SENDER RECIPIENT THIRDPARTY COLLECT

PAYMENT / PAYOR Payment/Payor/AccountNumber ALL USD xs:string 9 Optional. Shipping charges payor FedEx account number. Optional.

Payment/Payor/CountryCode SPECIALSERVICES SpecialServices / HoldAtLocation / Address / Line1

FDXE

INTL

xs:string

FDXE

ALL

xs:string

16

Required only if Hold At Location. Street address for the location where the shipment is being held. Secondary street address for the location where the shipment is being held. Required only if Hold At Location. City name of the location where the shipment is being held. 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 / Line2 SpecialServices / HoldAtLocation / Address / City

FDXE FDXE

ALL ALL

xs:string xs:string

35 35

SpecialServices / HoldAtLocation / Address / StateOr ProvinceCode

FDXE

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

190

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
SpecialServices / HoldAtLocation / Address / PostalCode

Applicable Carrier
FDXE

Valid For
ALL

Data Type
xs:string

Max Length
16

Element Description/Requirements
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 [A-Z]{2} 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. If = true or 1, the shipment is originated from an inside pickup area. Applicable to freight shipping only. If = true or 1, the shipment is traveling to an inside delivery area. Applicable to freight shipping only. If = true or 1, the shipment is scheduled for Saturday pickup. If = true or 1, the shipment is scheduled for Saturday delivery.

SpecialServices/HoldAtLocation/ Address/CountryCode SpecialServices / ResidentialDelivery

ALL FDXG FDXE

ALL ALL USD

xs:sting xs:boolean

SpecialServices/ InsidePickup

FDXE

USD

xs:boolean

SpecialServices / InsideDelivery

FDXE

USD

xs:boolean

SpecialServices / SaturdayPickup SpecialServices / SaturdayDelivery

FDXE FDXE

ALL ALL

xs:boolean xs:boolean

SPECIALSERVICES / EMAILNOTIFICATION

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

191

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
SpecialServices / EMailNotification / ShipAlertFaxNumber

Applicable Carrier
FDXG

Valid For
ALL

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. Optional. Customer specified message to be included in the shipment notification.

SpecialServices / EMailNotification / ShipAlertOptional Message

ALL

ALL

xs:string

120

SPECIALSERVICES / EMAILNOTIFICATION / SHIPPER SpecialServices / EMailNotification / Shipper / ShipAlert FDXE ALL xs:boolean Required for ShipAlert Notification to the shipper. When Requesting a ShipAlert in ship Request transaction, senders e-mail address, recipients email address, brokers e-mail address, or E-mail Notification Address must be used in conjunction with the ShipAlert elements for shipment notification via email. If = true or 1, Senders E-mail Address will be emailed ShipAlert e-mail. Required for Delivery Notification to the shipper. If = true or 1, Senders E-mail Address will be emailed Delivery Notification e-mail.

SpecialServices / EMailNotification / Shipper / Delivery Notification

FDXE

ALL

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

192

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
SpecialServices / EMailNotification / Shipper / Language Code

Applicable Carrier
FDXE

Valid For
ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Optional for Delivery Notification. Applies to Delivery Alert for shipper e-mail address. Defaults to EN (English). Valid language codes: EN English FR French

SPECIALSERVICES / EMAILNOTIFICATION / RECIPIENT SpecialServices / EMailNotification / Recipient / ShipAlert FDXE ALL xs:boolean Required for ShipAlert Notification to the recipient. If = true or 1, Recipients E-mail Address will be emailed ShipAlert e-mail. Required for Delivery Notification to the recipient. If = true or 1, Recipient E-mail Address will be emailed Delivery Notification e-mail. 2 Optional for Delivery Notification. Applies to Delivery Alert for recipient e-mail address. Defaults to EN (English). Valid language codes: EN English FR French

SpecialServices / EMailNotification / Recipient / DeliveryNotification

FDXE

ALL

xs:boolean

SpecialServices / EMailNotification / Recipient / LanguageCode

FDXE

ALL

xs:string

SPECIALSERVICES / EMAILNOTIFICATION / OTHER

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

193

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
SpecialServices / EMailNotification / Other / E-mailAddress

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length

Element Description/Requirements

FDXEFor FDXE: 120 A minimum of one occurrence is required if shipment FDXG-35 notification or delivery notification is selected. A maximum of three occurrences is allowed for FedEx Express shipments for ShipAlert or Delivery Alert Notification. For FDXG: One occurrence is required if shipment notification is selected and ShipAlert fax number is not included in the Request transaction. Delivery Notification is not supported for FDXG. Shipment notification by e-mail address and fax number cannot both be selected for the same shipment Request transaction.

SpecialServices / EMailNotification / Other / ShipAlert

ALL

ALL

xs:boolean

Required for ShipAlert. If = true or 1, corresponding e-mail address will be emailed ShipAlert. For FDXE: Maximum of three occurrences allowed for FedEx Express shipments. For FDXG: One occurrence allowed for FedEx Ground shipments. Required for Delivery Notification. If = true or 1, corresponding e-mail address will be emailed delivery notification. Maximum of three occurrences allowed for FedEx Express shipments.

SpecialServices / EMailNotification / Other / Delivery Notification

FDXE

ALL

xs:boolean

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

194

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
SpecialServices / EMailNotification / Other / LanguageCode

Applicable Carrier
FDXE

Valid For
ALL

Data Type
xs:string

Max Length
2

Element Description/Requirements
Optional for Delivery Notification. Applies to Delivery Alert for corresponding e-mail address. Maximum of three occurrences allowed for FedEx Express shipments. Defaults to EN (English). Valid language codes: EN English FR French Release Authorization Number. Used only if SignatureOption is set to DELIVERWITHOUTSIGNATURE.

SpecialServices / SignatureRelease

FDXE

USD

xs:string

10

HOMEDELIVERY HomeDelivery / Instructions FDXG USD xs:string 74 Optional. Applicable only to FedEx Home Delivery shipments. If = true or 1, means block all but sender from seeing shipment content data. Return Merchant Authorization FDXE USD xs:string 20 Return Merchant Authorization that is assigned by the sender.

BlockShipmentData RMA RMA / Number PACKAGE Package / Weight

FDXE

USD

xs:boolean

ALL

USD

xs:decimal

6.1

Required. The weight of the package.

PACKAGE / DIMENSIONS

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

195

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Package / Dimensions / Length

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:non negative integer

Max Length
3

Element Description/Requirements
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. 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. 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 / Dimensions / Width

ALL

ALL

xs:non negative integer

Package / Dimensions / Height

ALL

ALL

xs:non negative integer

PACKAGE / DECLAREDVALUE Package / DeclaredValue ALL ALL xs:decimal 8.2 Optional for a U.S. Domestic, International dutiable Express, and Ground shipments. This element is not applicable to an International PIB (document) Express shipment. The declared value of package contents. This value cannot exceed the total customs value for an International shipment. For Express International MPS, Master piece should contain the total declared value/carriage value, with no declared value/carriage value in Child pieces. For example, piece 1 of n pieces will have the total declared value/carriage value of all the pieces.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

196

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
PACKAGE / DRYICE Package / DryIce / WeightUnits

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

FDXE

ALL

xs:string

Valid values: LBS KGS

Package / DryIce / Weight Package / NonStandardContainer PACKAGE / REFERENCEINFO Package / ReferenceInfo / CustomerReference

FDXE FDXG

ALL USD

xs:decimal xs:boolean

4.1

ALL

USD

xs:string

40

Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by reference. Note: In a FedEx Ground Request, the content of this element will be truncated to 30 characters.

Package / ReferenceInfo / PONumber

FDXG

USD

xs:sting

30

Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by PONumber. Optional. Customer reference information assigned to a package. If passed in the transaction, it can be used later to track by InvoiceNumber. Description of contents within package being shipped.

Package / ReferenceInfo / InvoiceNumber

FDXG

USD

xs:sting

30

Package / ItemDescription

ALL

USD

xs:string

80

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

197

XML Transaction Layouts: FDXEmailLabelRequest

Element Name
Package / SignatureOption

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:sting

Max Length

Element Description/Requirements
Optional. Specifies one of the Delivery Signature Options. Valid values: DELIVERWITHOUTSIGNATURE INDIRECT DIRECT ADULT

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

198

XML Transaction Layouts: FDXEmailLabelRequest

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

199

XML Transaction Layouts: FDXEmailLabelRequest

</Address> </Origin> <Destination> <Contact> <PersonName>FedEx Customer</PersonName> <CompanyName>Test Recipient Company</CompanyName> <PhoneNumber>8004633339</PhoneNumber> <E-MailAddress>[email protected]</E-MailAddress> </Contact> <Address> <Line1>Test Recipient Address Line 1</Line1> <Line2>Test Recipient Address Line 2</Line2> <City>Test Recipient City</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38115</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> <Payor> <AccountNumber>123456789</AccountNumber> </Payor> </Payment> <DimensionsUnits>IN</DimensionsUnits> <RMA> <Number>RMA45678901234567890</Number> </RMA> <Package> <Weight>1.0</Weight> <DeclaredValue>100.00</DeclaredValue> <ReferenceInfo> <CustomerReference>ShipAlert Test</CustomerReference>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

200

XML Transaction Layouts: FDXEmailLabelRequest

</ReferenceInfo> <ItemDescription>Books</ItemDescription> </Package> <SpecialServices> <EMailNotification> <ShipAlertOptionalMessage>This is a email Return Label Message</ShipAlertOptionalMessage> <Shipper> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Shipper> <Recipient> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Recipient> <Other> <E-MailAddress>[email protected]</E-MailAddress> <ShipAlert>true</ShipAlert> <LanguageCode>EN</LanguageCode> </Other> </EMailNotification> </SpecialServices> </FDXEmailLabelRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

201

XML Transaction Layouts: FDXEmailLabelReply

FDXEmailLabelReply
Element Name
REPLYHEADER ReplyHeader / CustomerTransaction Identifier ERROR Error / Code ALL USD xs:string 8 Passed back in response indicating failed processing. For an erroneous Request or a server failure, the error code will be placed in this element. Passed back in response transaction indicating failed processing. For an erroneous transaction, the error message will be placed in this element. URL of web page at which labels can be found. Required if Error is not returned. 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 to be used to manually access the URL of web page at which labels can be found. Required if Error is not returned. Optional. A location matching the criteria provided in the FedExLocatorRequest. Can get up to 10 different FedEx locations. ALL FDXE USD USD xs:string FormID 20 4 Package tracking number. Required if Error is not returned. Required if Error is not returned. ALL USD xs:string 40 Returned if the customer included it in the Request, containing the same value.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

Error / Message

ALL

USD

xs:string

120

URL UserID

ALL ALL

USD USD

xs:string xs:string

Password

ALL

USD

xs:string

RequestTimeStamp PACKAGE

ALL

USD

xs:Time

Package / TrackingNumber Package / FormID

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

202

XML Transaction Layouts: FDXEmailLabelReply

Element Name
SignatureOption

Applicable Carrier
ALL

Valid For
ALL

Data Type
xs:string

Max Length

Element Description/Requirements
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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

203

XML Transaction Layouts: FDXEmailLabelReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

204

XML Transaction Layouts: FDXCancelEmailLabelRequest

FDXCancelEmailLabelRequest
This transaction cancels an Email Label Request. This transaction will be invalid if customer has already generated the label.

Element Name
REQUESTHEADER RequestHeader / CustomerTrans actionIdentifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ALL

USD

xs:string

40

Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies. The FedEx account number of the Sender is required to successfully cancel the E-mail Label Request. The unique meter number assigned to the Senders FedEx account number is required to successfully cancel the Email Label Request. Valid values: FDXE FDXG Required. Tracking number of E-mail Label/shipment to be deleted.

RequestHeader / AccountNumber RequestHeader / MeterNumber

ALL ALL

USD USD

xs:string xs:string

9 8

RequestHeader / CarrierCode

ALL

USD

xs:string

TrackingNumber

ALL

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

205

XML Transaction Layouts: FDXCancelEmailLabelRequest

Example of FDXCancelEmailLabelRequest XML Document


The following is an example of the Request transaction format for the cancellation of an E-mail Label: <?xml version="1.0" encoding="UTF-8" ?> <FDXEmailLabelRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelEmailLabelRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Cancel E-Mail Label Request</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> <CarrierCode>FDXE</CarrierCode> </RequestHeader> <TrackingNumber>470026028478</TrackingNumber> </FDXEmailLabelRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

206

XML Transaction Layouts: FDXCancelEmailLabelReply

FDXCancelEmailLabelReply
Element Name
REPLYHEADER ReplyHeader/CustomerTransaction Identifier ALL USD xs:string 40 Optional. Returned containing the same value if the customer included information for this element in the Request transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ERROR Error/Code ALL USD xs:string 8 Required if error. Error code returned when a transaction fails. Required if error. Error message returned when a transaction fails.

Error/Message

ALL

USD

xs:string

120

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

207

XML Transaction Layouts: FDXCancelEmailLabelReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

208

XML Transaction Layouts: FDXExpressTagRequest

FDXExpressTagRequest
The FedEx Express Tag return label combines the delivery of the Express label with the pickup function. This transaction will dispatch a FedEx driver with a label to the location specified in the transaction. Upon arrival, the driver will pick up the parcel using the label they have with them. Service areas for this service are limited and should be checked using FDXExpressTagAvailibilityRequest. Cancellations are handled via FDXCancelExpressTagRequest.

Element Name
REQUESTHEADER RequestHeader / CustomerTransactionIdentifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully Request an Express Tag. The unique meter number assigned to the Senders FedEx account number is required to successfully Request an Express Tag. Valid value: FDXE Required. Format: YYYY-MM-DD Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS

RequestHeader / Account Number RequestHeader / MeterNumber

FDXE

USD

xs:string

FDXE

USD

xs:string

RequestHeader / Carrier Code DispatchDate

FDXE FDXE

USD USD

xs:string xs:date

LatestPickupTime

FDXE

USD

xs:time

ReadyTime

FDXE

USD

xs:time

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

209

XML Transaction Layouts: FDXExpressTagRequest

Element Name
ORIGIN ORIGIN / CONTACT Origin / Contact / PersonName

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. 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. Optional. Name of the department from which the shipment is originating. 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. 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 / CompanyName

FDXE

USD

xs:string

35

Origin / Contact / Department

FDXE

USD

xs:string

10

Origin / Contact / PhoneNumber

FDXE

USD

xs:string

16

Origin / Contact / PagerNumber

FDXE

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

210

XML Transaction Layouts: FDXExpressTagRequest

Element Name
Origin / Contact / FaxNumber

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.

Origin / Contact / E-MailAddress

FDXE

USD

xs:string

120

ORIGIN / ADDRESS Origin / Address / Line1 FDXE USD xs:string 35 Required. Primary address line from which the shipment is originating. Optional. Secondary address line from which the shipment is originating. Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping. Required. State code from which the shipment is originating. 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 / Line2

FDXE

USD

xs:string

35

Origin / Address / City

FDXE

USD

xs:string

35

Origin / Address / StateOrProvinceCode

FDXE

USD

xs:string

Origin / Address / PostalCode

FDXE

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

211

XML Transaction Layouts: FDXExpressTagRequest

Element Name
Origin / Address / CountryCode

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
2

Element Description/Requirements
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. 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. Optional. Name of the department to whom the shipment is destined. 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 / CompanyName

FDXE

USD

xs:string

35

Destination / Contact / Department

FDXE

USD

xs:string

10

Destination / Contact / PhoneNumber

FDXE

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

212

XML Transaction Layouts: FDXExpressTagRequest

Element Name
Destination / Contact / PagerNumber

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. 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. Optional. E-mail address for the contact person to whom the shipment is destined.

Destination / Contact / FaxNumber

FDXE

USD

xs:string

16

Destination / Contact / E-mailAddress DESTINATION / ADDRESS Destination / Address / Line1

FDXE

USD

xs:string

120

FDXE

USD

xs:string

35

Required. Primary address line to which the shipment is destined. Optional. Secondary address line to which the shipment is destined. Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed. Required. State or province code to which the shipment is destined.

Destination / Address / Line2

FDXE

USD

xs:string

35

Destination / Address / City

FDXE

USD

xs:string

35

Destination / Address / StateOrProvince Code

FDXE

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

213

XML Transaction Layouts: FDXExpressTagRequest

Element Name
Destination / Address / PostalCode

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
Required. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z Required. Name of the country to which the shipment is destined.

Destination / Address / CountryCode

FDXE

USD

xs:string

PAYMENT Payment / PayorType FDXE USD xs:string Required. Valid values: SENDER RECIPIENT THIRDPARTY COLLECT

PAYMENT / PAYOR Payment / Payor / AccountNumber FDXE USD xs:string 9 Optional. Shipping charges payor FedEx account number. Optional. Return Merchant Authorization Information FDXE USD xs:string 20 Required if RMA element is included. Return Merchant Authorization number provided by the sender. Optional. Instruction to courier.

Payment / Payor / CountryCode RMA RMA/Number

FDXE

USD

xs:string

CourierInstructions

FDXE

USD

xs:string

60

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

214

XML Transaction Layouts: FDXExpressTagRequest

Element Name
CustomerReference

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
30

Element Description/Requirements
Optional. Customer reference information. Optional. Required if DeclaredValue is present Required. Valid values: PRIORITYOVERNIGHT STANDARDOVERNIGHT FIRSTOVERNIGHT FEDEX2DAY FEDEXEXPRESSSAVER Valid values: FEDEXENVELOPE FEDEXPAK FEDEXBOX FEDEXTUBE YOURPACKAGING

CurrencyCode

FDXE

USD

xs:string

Service

FDXE

USD

xs:string

Packaging

FDXE

USD

xs:string

WeightUnits

FDXE

USD

xs:string

Required. Valid values: LBS KGS Required. Weight of the entire shipment. Optional. Declared value of entire shipment. Defaults to zero.

Weight

FDXE

USD

xs:integer

DeclaredValue

FDXE

USD

xs:integer

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

215

XML Transaction Layouts: FDXExpressTagRequest

Element Name
PackageCount

Applicable Valid Carrier For


FDXE USD

Data Type
xs:integer

Max Length
1

Element Description/Requirements
Required for multipiece shipment. Valid values are 1 thru 5.

SPECIALSERVICES SpecialServices/HoldAtLocation SpecialServices/ResidentialDelivery SpecialServices/SaturdayDelivery SpecialServices/NonIndirectDelivery FDXE FDXE FDXE FDXE USD USD USD USD xs:boolean xs:boolean xs:boolean xs:boolean Optional. Optional. Optional. Optional. If = true or 1, indirect delivery is not allowed. Prevents an "indirect" delivery, which will not allow for a completed delivery to an address or location other than the address on the airbill. FedEx does not offer a "restricted delivery" service and may deliver to someone other than the person named as the recipient.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

216

XML Transaction Layouts: FDXExpressTagRequest

Example of FDXExpressTagRequest XML Document


The following is an example of the Request transaction format for an Express Tag: <?xml version="1.0" encoding="UTF-8" ?> FDXExpressTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXExpressTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Express Tag Test</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>0101010</MeterNumber> </RequestHeader> <DispatchDate>2004-10-12</DispatchDate> <LatestPickupTime>16:00:00</LatestPickupTime> <ReadyTime>12:00:00</ReadyTime> <Origin> <Contact> <CompanyName>Sender Company</CompanyName> <PhoneNumber>9015559999</PhoneNumber> </Contact> <Address> <Line1>1350 Merry Circle</Line1> <City>Anytown</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38138</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <CompanyName>Recipient Company</CompanyName> <PhoneNumber>8005559999</PhoneNumber> </Contact> <Address>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

217

XML Transaction Layouts: FDXExpressTagRequest

<Line1>400 W. Arbor Ave.</Line1> <City>Ypsilanti</City> <StateOrProvinceCode>MI</StateOrProvinceCode> <PostalCode>48197</PostalCode> <CountryCode>US</CountryCode> </Address> </Destination> <Payment> <PayorType>SENDER</PayorType> </Payment> <RMA> <Number>1234567</Number> </RMA> <CourierInstructions>Do it right!</CourierInstructions> <CustomerReference>MyRef</CustomerReference> <CurrencyCode>USD</CurrencyCode> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> <WeightUnits>LBS</WeightUnits> <Weight>12</Weight> <DeclaredValue>13</DeclaredValue> <PackageCount>2</PackageCount> <SpecialServices> <HoldAtLocation>false</HoldAtLocation> <ResidentialDelivery>false</ResidentialDelivery> <SaturdayDelivery>false</SaturdayDelivery> <NoIndirectDelivery>false</NoIndirectDelivery> </SpecialServices> </FDXExpressTagRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

218

XML Transaction Layouts: FDXExpressTagReply

FDXExpressTagReply
Element Name
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.

Applicable Carrier

Valid For

Data Type

Max Length

Element Requirements

ERROR Error/Code FDXE USD xs:string 8 Optional. Returned only if an Error has occurred. Optional. Returned only if an Error has occurred. Required. Also known as Pickup Confirmation Number or Dispatch Number. Express Location Identifier. 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 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

Error/Message

FDXE

USD

xs:string

40

DispatchConfirmationNumber

FDXE

USD

xs:string

30

Location AccessTime

FDXE FDXE

USD USD

xs:string xs:time

5 10

CutoffTime

FDXE

USD

xs:time

10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

219

XML Transaction Layouts: FDXExpressTagReply

Element Name
DeliveryCommitmentDate

Applicable Carrier
FDXE

Valid For
USD

Data Type
xs:date

Max Length
10

Element Requirements
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 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 The package tracking number.

DeliveryCommitmentTime

FDXE

USD

xs:time

10

TrackingNumber

FDXE

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

220

XML Transaction Layouts: FDXExpressTagReply

Example of FDXExpressTagReply XML Document


The following is an example of the Reply transaction format for Requests regarding the creation of an Express Tag: <?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>Express Tag Test</CustomerTransactionIdentifier> </ReplyHeader> <DispatchConfirmationNumber>00001</ConfirmationNumber> <Location>HKAA</Location> <AccessTime>02:00:00</AccessTime> <CutoffTime>21:00:00</CutoffTime> <DeliveryCommitmentDate>2004-10-13</DeliveryCommitmentDate> <DeliveryCommitmentTime>15:00:00</DeliveryCommitmentTime> <TrackingNumber>301000658338</TrackingNumber> </FDXExpressTagReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

221

XML Transaction Layouts: FDXCancelExpressTagRequest

FDXCancelExpressTagRequest
This transaction cancels and Express Tag Request. This transaction is only valid until driver is dispatched. Erroneous Requests should be canceled as soon as possible.

Element Name
REQUESTHEADER RequestHeader/CustomerTransacti onIdentifier

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully receive cancel an Express Tag Request. The unique meter number assigned to the Senders FedEx account number is required to successfully cancel an Express Tag Request. Required. Otherwise known as Pickup Confirmation Number. Express Location Identifier. The date FedEx was scheduled to pick up the shipment. Format: YYYY-MM-DD

RequestHeader / AccountNumber RequestHeader / Meter Number DispatchConfirmationNumber

FDXE FDXE

ALL ALL

xs:string xs:string

9 8

FDXE

ALL

xs:string

30

Location DispatchDate

FDXE FDXE

ALL ALL

xs:string xs:date

5 10

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

222

XML Transaction Layouts: FDXCancelExpressTagRequest

Example of FDXCancelExpressTagRequest XML Document


The following is an example of the Request transaction format for the cancellation of an Express Tag: <?xml version="1.0" encoding="UTF-8" ?> <FDXCancelExpressTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelExpressTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>1001001</MeterNumber> </RequestHeader> <DispatchConfirmationNumber>00001</ConfirmationNumber> <Location>HKAA</Location> <DispatchDate>2004-10-12</DispatchDate> </FDXCancelExpressTagRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

223

XML Transaction Layouts: FDXCancelExpressTagReply

FDXCancelExpressTagReply
Element Name
REPLYHEADER ReplyHeader/CustomerTransaction Identifier FDXE ALL xs:string 40 Optional. This element allows a FedEx customer to assign a unique identifier to a transaction. It is returned in the Reply transaction to aid in matching transaction Requests to Replies.

Applicable Carrier

Valid For

Data Type

Max Length

Element Description/Requirements

ERROR Error/Code FDXE ALL xs:string 8 Optional. Returned only if an Error has occurred. Optional. Returned only if an Error has occurred.

Error/Message

FDXE

ALL

xs:string

40

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

224

XML Transaction Layouts: FDXCancelExpressTagReply

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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

225

XML Transaction Layouts: FDXGroundCallTagRequest

FDXGroundCallTagRequest
The FedEx Ground Call Tag return label combines the delivery of the Ground label with the pickup function. This transaction will dispatch a FedEx driver with a label to the location specified in the transaction. Upon arrival, the driver will pick up the parcel using the label they have with them. Cancellations are handled via FDXCancelGroundCallTagRequest.

Element Name
REQUESTHEADER RequestHeader / CustomerTransactionIdentifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully Request a Ground Call Tag. The unique meter number assigned to the Senders FedEx account number is required to successfully Request a Ground Call Tag. Valid value: FDXG Required. Format: YYYY-MM-DD Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS Required if ResidentialPickup is not true; not applicable otherwise. Format: HH:MM:SS

RequestHeader / AccountNumber RequestHeader / Meter Number RequestHeader / Carrier Code DispatchDate

FDXG FDXG

USD USD

xs:string xs:string

9 8

FDXG FDXG

USD USD

xs:string xs:date

LatestPickupTime

FDXG

USD

xs:time

ReadyTime

FDXG

USD

xs:time

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

226

XML Transaction Layouts: FDXGroundCallTagRequest

Element Name
ResidentialPickup

Applicable Valid Carrier For


FDXG USD

Data Type
xs:boolean

Max Length

Element Description/Requirements
Optional. Defaults to false; true only if pickup location is residential. Optional.

ResidentialDelivery ORIGIN ORIGIN / CONTACT Origin / Contact / PersonName

FDXG

USD

xs:boolean

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. 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. Optional. Name of the department from which the shipment is originating. 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. 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 / CompanyName

FDXG

USD

xs:string

35

Origin / Contact / Department

FDXG

USD

xs:string

10

Origin / Contact / PhoneNumber

FDXG

USD

xs:string

16

Origin / Contact / PagerNumber

FDXG

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

227

XML Transaction Layouts: FDXGroundCallTagRequest

Element Name
Origin / Contact / FaxNumber

Applicable Valid Carrier For


FDXG USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
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. Optional. Required element for ShipAlert. The e-mail address of the person initiating the shipment.

Origin / Contact / E-MailAddress

FDXG

USD

xs:string

35

ORIGIN / ADDRESS Origin / Address / Line1 FDXG USD xs:string 35 Required. Primary address line from which the shipment is originating. Optional. Secondary address line from which the shipment is originating. Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping. Required. State code from which the shipment is originating. 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 Required. Name of the country from which the shipment is originating.

Origin / Address / Line2

FDXG

USD

xs:string

35

Origin / Address / City

FDXG

USD

xs:string

20

Origin / Address / StateOrProvinceCode Origin / Address / PostalCode

FDXG

USD

xs:string

FDXG

USD

xs:string

16

Origin / Address / CountryCode

FDXG

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

228

XML Transaction Layouts: FDXGroundCallTagRequest

Element Name
DESTINATION DESTINATION / CONTACT Destination / Contact / PersonName

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. 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 / CompanyName

FDXG

USD

xs:string

35

Destination / Address Destination / Address / Line1 FDXG USD xs:string 35 Required. Primary address line to which the shipment is destined. Optional. Secondary address line to which the shipment is destined. Required. Name of the city to which the shipment is destined. A minimum of 3 alpha characters must be passed. Required. State or province code to which the shipment is destined.

Destination / Address / Line2

FDXG

USD

xs:string

35

Destination / Address / City

FDXG

USD

xs:string

20

Destination / Address / StateOrProvince Code

FDXG

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

229

XML Transaction Layouts: FDXGroundCallTagRequest

Element Name
Destination / Address / PostalCode

Applicable Valid Carrier For


FDXG USD

Data Type
xs:string

Max Length
16

Element Description/Requirements
Required. Represents the postal code to which the shipment is destined. Valid characters: A-Z; 0-9; a-z Required. Name of the country to which the shipment is destined.

Destination / Address / CountryCode

FDXG

USD

xs:string

PAYMENT Payment / PayorType FDXG USD xs:string Required. Valid values: SENDER RECIPIENT THIRDPARTY COLLECT

PAYMENT / PAYOR Payment / Payor / AccountNumber FDXG USD xs:string 9 Optional. Shipping charges payor FedEx account number. Optional. Return Merchant Authorization Information FDXG USD xs:string 20 Required if RMA element is included. Return Merchant Authorization number provided by the sender. Optional. Instruction to courier.

Payment / Payor / CountryCode RMA RMA/Number

FDXG

USD

xs:string

CourierInstructions

FDXG

USD

xs:string

40

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

230

XML Transaction Layouts: FDXGroundCallTagRequest

Element Name
CustomerReference

Applicable Valid Carrier For


FDXG USD

Data Type
xs:string

Max Length
30

Element Description/Requirements
Optional. Customer reference information. Optional. Required if DeclaredValue is present. Package Information

CurrencyCode

FDXG

USD

xs:string

PACKAGE Package / DeclaredValue FDXG USD xs:integer 10

Optional. Declared value of entire shipment. Defaults to zero. Required for multiple-piece shipment. Required per piece. Description of item being shipped. Max 20.

Package / ItemDescription

FDXG

USD

xs:integer

80

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

231

XML Transaction Layouts: FDXGroundCallTagRequest

Example of FDXGroundCallTaglRequest XML Document


The following is an example of the Request transaction format of a Ground Call Tag: <?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagRequest xmlns:api="http://www.fedex.com/fsmapi" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Ground Call Tag Request</CustomerTransactionIdentifier> <AccountNumber>1234567890</AccountNumber> <MeterNumber>9999999</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <DispatchDate>2004-09-07</DispatchDate> <LatestPickupTime>14:20:00-05:00</LatestPickupTime> <ReadyTime>10:20:00-05:00</ReadyTime> <Origin> <Contact> <PersonName>Bettie Betts</PersonName> <CompanyName>FedEx</CompanyName> <PhoneNumber>8004633339</PhoneNumber> </Contact> <Address> <Line1>3925 Embassy Pkwy</Line1> <City>Test</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38098</PostalCode> <CountryCode>US</CountryCode> </Address> </Origin> <Destination> <Contact> <PersonName>Molly Pooly</PersonName> <CompanyName>ABC Widget</CompanyName>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

232

XML Transaction Layouts: FDXGroundCallTagRequest

</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>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

233

XML Transaction Layouts: FDXGroundCallTagReply

FDXGroundCallTagReply
Element Name
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.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ERROR Error / Code FDXG USD xs:string 8 Optional. Returned only if an Error has occurred. Optional. Returned only if an Error has occurred. Required. Otherwise known as Pickup Confirmation Number. Required.

Error / Message

FDXG

USD

xs:string

40

DispatchConfirmationNumber

FDXG

USD

xs:string

16

TrackingNumber

FDXG

USD

xs:string

16

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

234

XML Transaction Layouts: FDXGroundCallTagReply

Example of FDXGroundCallTagReply XML Document


The following is an example of the Reply transaction format for Requests regarding the creation of a Ground Call Tag: <?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>Ground Call Tag Request</CustomerTransactionIdentifier> </ReplyHeader> <DispatchConfirmationNumber>997038000005630</ConfirmationNumber> <TrackingNumber>997038000005630</TrackingNumber> </FDXGroundCallTagReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

235

XML Transaction Layouts: FDXCancelGroundCallTagRequest

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
REQUESTHEADER RequestHeader / CustomerTransactionIdentifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully cancel a Ground Call Tag. The unique meter number assigned to the Senders FedEx account number is required to successfully cancel a Ground Call Tag. Valid value: FDXG Required. Otherwise known as Pickup Confirmation Number.

RequestHeader / AccountNumber RequestHeader / MeterNumber

FDXG FDXG

USD USD

xs:string xs:string

9 8

RequestHeader / CarrierCode DispatchConfirmationNumber

FDXG FDXG

USD USD

xs:string xs:string

4 16

PAYMENT

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

236

XML Transaction Layouts: FDXCancelGroundCallTagRequest

Element Name
Payment / PayorType

Applicable Valid Carrier For


ALL ALL

Data Type
xs:string

Max Length
10

Element Description/Requirements
Required. Method of payment for shipment. The credit card payment type is only supported for U.S. Domestic Express shipping. Valid payment types: SENDER RECIPIENT THIRDPARTY COLLECT For Return Manager, only SENDER and THIRDPARTY are allowed.

PAYMENT / PAYOR Payment / Payor / AccountNumber ALL ALL xs:string 12 For FedEx Express shipping, required if PayorType is RECIPIENT or THIRDPARTY. For FedEx Ground shipping, required if PayorType is THIRDPARTY. The FedEx account number for the payor of the shipment. 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.

Payment / Payor / CountryCode

ALL

ALL

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

237

XML Transaction Layouts: FDXCancelGroundCallTagRequest

Example of FDXCancelGroundCallTagRequest XML Document


The following is an example of the Request transaction format for the cancellation of a Ground Call Tag: <?xml version="1.0" encoding="UTF-8" ?> <FDXCancelGroundCallTagRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXCancelGroundCallTagRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> <AccountNumber>123456789</AccountNumber> <MeterNumber>1010101</MeterNumber> <CarrierCode>FDXG</CarrierCode> </RequestHeader> <DispatchConfirmationNumber>997038000005630</ConfirmationNumber> </FDXCancelGroundCallTagRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

238

XML Transaction Layouts: FDXCancelGroundCallTagReply

FDXCancelGroundCallTagReply
Element Name
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.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ERROR Error / Code FDXG USD xs:string 8 Optional. Returned only if an Error has occurred. Optional. Returned only if an Error has occurred.

Error / Message

FDXG

USD

xs:string

40

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

239

XML Transaction Layouts: FDXCancelGroundCallTagReply

Example of FDXCancelGroundCallTagReply XML Document


If the input transaction had contained an error, an error message number and message text would have been included in the transaction Reply. For example, if the confirmation number was not valid, the response transaction would be: <?xml version="1.0" encoding="UTF-8" ?> <FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXGroundCallTagReply.xsd"> <ReplyHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> <Error> <Code>F5CC</Code> <Message>Unable to retrieve details: confirmation number not found Additional Info:</Message> </Error> </FDXGroundCallTagReply>

The following is an example of the Reply transaction format for Requests regarding the cancellation of a Ground Call Tag: <?xml version="1.0" encoding="UTF-8" ?> < FDXGroundCallTagReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation=" FDXGroundCallTagReply.xsd "> <ReplyHeader> <CustomerTransactionIdentifier>CallTag Cancel</CustomerTransactionIdentifier> </ReplyHeader> </ FDXGroundCallTagReply >

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

240

XML Transaction Layouts: FDXExpressTagAvailabilityRequest

FDXExpressTagAvailabilityRequest
Express Tag is a premium Express service and has limited coverage. Effective applications will include this option to allow customer to see if an area has coverage. This is done to prevent a user from filling out an entire screen full of shipment information just to find out there is no coverage. This is determined using dates and ZIP codes for service areas.

Element Name
REQUESTHEADER RequestHeader / CustomerTransactionIdentifier

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

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. The FedEx account number of the Sender is required to successfully receive an Express Tag Availability response. The unique meter number assigned to the Senders FedEx account number is required to successfully receive an Express Tag Availability response. Valid value: FDXE Required. Format: YYYY-MM-DD 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

RequestHeader /AccountNumber RequestHeader / Meter Number RequestHeader / CarrierCode DispatchDate

FDXE FDXE

USD USD

xs:string xs:string

9 8

FDXE FDXE

USD USD

xs:string xs:date

4 10

ReadyTime

FDXE

USD

xs:time

10

ORIGINADDRESS

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

241

XML Transaction Layouts: FDXExpressTagAvailabilityRequest

Element Name
OriginAddress / Line1

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
35

Element Description/Requirements
Required. Primary address line from which the shipment is originating. Optional. Secondary address line from which the shipment is originating. Required. City name from which the shipment is originating. Minimum of 3 alpha characters must be passed for shipping. Required. State code from which the shipment is originating. Required.Postal code from which the shipment is origin ating. Must be numeric and no embedded dashes allowed. Valid characters: A-Z; 0-9; a-z Required. Name of the country from which the shipment is originating. Required. Valid values: PRIORITYOVERNIGHT STANDARDOVERNIGHT FIRSTOVERNIGHT FEDEX2DAY FEDEXEXPRESSSAVER

OriginAddress / Line2

FDXE

USD

xs:string

35

OriginAddress / City

FDXE

USD

xs:string

20

OriginAddress / StateOrProvinceCode

FDXE

USD

xs:string

OriginAddress / PostalCode

FDXE

USD

xs:string

16

OriginAddress / CountryCode

FDXE

USD

xs:string

Service

FDXE

USD

xs:string

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

242

XML Transaction Layouts: FDXExpressTagAvailabilityRequest

Element Name
Packaging

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length

Element Description/Requirements
Valid values: FEDEXENVELOPE FEDEXPAK FEDEXBOX FEDEXTUBE YOURPACKAGING

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

243

XML Transaction Layouts: FDXExpressTagAvailabilityRequest

Example of FDXExpressTagAvailabilityRequest XML Document


The following is an example of the Request transaction format for Express Tag Availability: <?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagAvailabilityRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FDXExpressTagAvailabilityRequest.xsd"> <RequestHeader> <CustomerTransactionIdentifier>Express Tag Availability Test</CustomerTransactionIdentifier> <AccountNumber>000000000</AccountNumber> <MeterNumber>0000000</MeterNumber> </RequestHeader> <DispatchDate>2004-10-13</DispatchDate> <ReadyTime>14:00:00</ReadyTime> <OriginAddress> <Line1>SN2000 Test Meter 8</Line1> <Line2>10 Fedex Parkway</Line2> <City>Collierville</City> <StateOrProvinceCode>TN</StateOrProvinceCode> <PostalCode>38017</PostalCode> <CountryCode>US</CountryCode> </OriginAddress> <Service>STANDARDOVERNIGHT</Service> <Packaging>YOURPACKAGING</Packaging> </FDXExpressTagAvailabilityRequest>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

244

XML Transaction Layouts: FDXExpressTagAvailabilityReply

FDXExpressTagAvailabilityReply
Element Name
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.

Applicable Valid Carrier For

Data Type

Max Length

Element Description/Requirements

ERROR Error / Code Error / Message AccessTime FDXE USD xs:string 8 Optional. Returned only if an Error has occurred. Optional. Returned only if an Error has occurred. 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 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

FDXE

USD

xs:string

40

FDXE

USD

xs:time

CutoffTime

FDXE

USD

xs:time

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

245

XML Transaction Layouts: FDXExpressTagAvailabilityReply

Element Name
AvailabilityCode

Applicable Valid Carrier For


FDXE USD

Data Type
xs:string

Max Length
1

Element Description/Requirements
Optional. Valid values: 2 3

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

246

XML Transaction Layouts: FDXExpressTagAvailabilityReply

Example of FDXExpressTagAvailabilityReply XML Document


The following is an example of the Reply transaction format for Requests regarding the Express Tag Availability: <?xml version="1.0" encoding="UTF-8" ?> <FDXExpressTagAvailabilityReply xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ReplyHeader> <CustomerTransactionIdentifier>Express Tag Availability Test</CustomerTransactionIdentifier> </ReplyHeader> <AccessTime>03:00:00</AccessTime> <CutoffTime>20:00:00</CutoffTime> <AvailabilityCode>3</AvailabilityCode> </FDXExpressTagAvailabilityReply>

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

247

Shipping Label Specifications

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

248

Shipping Label Specifications

PNG Plain Paper Label


Printing the plain paper label is different than printing the thermal label. The image orientation dimensions can be manipulated when using a print manager to print a plain paper label. Image Orientation Dimensions are determined when the label is viewed in an imaging editor applcation. Image orientations for both Shipping and Tracking Signature Proof of Delivery (SPOD) PNG plain paper shipping labels are listed in the corresponding table:

PNG Plain Paper Image Orientation Dimensions


Shipping PNG (browser and non-browser) SPOD PNG (browser and non-browser) 7.0 6.8

Print Manager Dimensions Width By


X X

Height
4.75 7.6

When the label is printed, it can either increase or decrease in size if the print manager dimensions are not properly set. If the dimensions are increased, the following will result: All human readable, bar code data and bar codes will be increased in size, and bar codes may become unable to be scanned by the Courier and Ground Operations division. Since the label will need to be folded in half and inserted into the FedEx Pouch, the ASTRA bar code will need to be fully visible. To ensure full visibility, there should be between 5/16" and " of white space from the bottom of the ASTRA bar code to the fold.

If the dimensions are decreased, the following will result: All human readable, bar code data and bar codes will be decreased in size. When the label is decreased in size, bar codes may become unable to be scanned by the Courier and Ground Operations division. Additionally, if the size is increased or decreased, this may result in the delay of switching the user's application from the validation to production environment.

For the Browser based label, the user will need to ensure the appropriate HTML wrapper is attached (reference section Creating a Shipping Label). The following represents the Page name and File path of a Browser based label: FedEx Ship Manager API Label Page file://C:/Program Files/FedEx/Fedples/vb/470004122710.html

Reference the Browser-based shipping label in the following plain paper shipping label attachments for verbiage orientation.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

249

Shipping Label Specifications

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
Windows using small fonts Windows using large fonts Macintosh

Screen resolution (typical default)


96 DPI 120 DPI 72 DPI

Examples on populating HTML tag Height and Width values: Width (pixels) = ScreenDPI * (desired image reproduced width) Height (pixels = ScreenDPI * (desired image reproduced height) Example: Sample code implementing Shipping plain paper label in Netscape Browser: <HTML> <SCRIPT LANGUAGE="JavaScript1.1"> var NS4 = (document.layers) ? true : false ; var resolution = 96; if (NS4 && navigator.javaEnabled()) { var toolkit = java.awt.Toolkit.getDefaultToolkit(); resolution = toolkit.getScreenResolution(); } </SCRIPT> <SCRIPT LANGUAGE="JavaScript"> document.write('<img WIDTH=' + (700 * resolution )/100 + '<img HEIGHT=' + (475 * resolution )/100 + ' alt="ASTRA Barcode" src="path/test.png">'); FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

250

Shipping Label Specifications

</SCRIPT> </HTML> Example for getting Screen resolution using Microsoft MFC library: DC hDC = CreateDC( DISPLAY, NULL, NULL, NULL ); int DPI = getDeviceCaps ( hDC, LOGPIXELSX); DeleteDC(hDC);

Custom Labels
FedEx does not support the creation or use of a custom label for either FedEx Ship Manager API Ground or Express shipping.

FedEx Shipping Label Preparation


To prepare your package for shipment, you need to do the following: Print the label on your printer. Fold the first printed page in half and use as the shipping label. The second page is for your records, and contains both the terms and conditions of shipping, and information useful for tracking your package. After printing the label, place it in a waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned. NOTE: When printing labels for COD shipments, you must make sure to print one label and two COD tags with each label You must print additional COD tags as needed.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

251

Shipping Label Specifications

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

252

Appendix A: Country Codes

Appendix A: Country Codes


Country
Afghanistan Albania Algeria American Samoa Andorra Angola Anguilla Antarctica Antigua Argentina Armenia Aruba Australia Austria Azerbaijan Bahamas Bahrain Bangladesh Barbados Barbuda Belarus Belgium Belize Benin

Code
AF AL DZ AS AD AO AI AQ AG AR AM AW AU AT AZ BS BH BD BB AG BY BE BZ BJ

Ship to:
Y Y N Y Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y

Country
Bermuda Bhutan Bolivia Bonaire Bosnia-Herzegovina Botswana Bouvet Island Brazil British Indian Ocean Territory British Virgin Islands Brunei Bulgaria Burkina Faso Burundi Cambodia Cameroon Canada Canary Islands Cape Verde Cayman Islands Central African Republic Chad Channel Islands Chile

Code
BM BT BO AN BA BW BV BR IO VG BN BG BF BI KH CM CA ES CV KY CF TD GB CL

Ship to:
Y Y Y Y Y Y N Y N Y Y Y Y Y Y Y Y Y Y Y N Y Y Y

Country
China Christmas Island Cocos (Keeling) Islands Colombia Comoros Congo Congo Dem. Rep. Of Cook Islands Costa Rica Croatia Cuba Curacao Cyprus Czech Republic Denmark Djibouti Dominica Dominican Republic East Timor Ecuador Egypt El Salvador England Equatorial Guinea

Code
CN CX CC CO KM CG CD CK CR HR CU AN CY CZ DK DJ DM DO TL EC EG SV GB GQ

Ship to:
Y N N Y N Y Y Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y Y

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

253

Appendix A: Country Codes

Country
Eritrea Estonia Ethiopia Faeroe Islands Falkland Islands Fiji Finland France French Guiana French Polynesia French Southern Territories Gabon Gambia Georgia Germany Ghana Gibraltar Grand Cayman Great Britain Great Thatch Island Great Tobago Islands Greece Greenland Grenada Guadeloupe Guam Guatemala Guinea Guinea Bissau

Code
ER EE ET FO FK FJ FI FR GF PF TF GA GM GE DE GH GI KY GB VG VG GR GL GD GP GU GT GN GW

Ship to:
Y Y Y Y N Y Y Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N

Country
Guyana Haiti Heard & McDonald Islands Holland Honduras Hong Kong Hungary Iceland India Indonesia Iran Iraq Ireland Israel Italy Ivory Coast Jamaica Japan Jordan Jost Van Dyke Islands Kazakhstan Kenya Kiribati Kuwait Kyrgyzstan Laos Latvia Lebanon Lesotho

Code
GY HT HM NL HN HK HU IS IN ID IR IQ IE IL IT CI JM JP JO VG KZ KE KI KW KG LA LV LB LS

Ship to:
Y Y N Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y

Country
Liberia Libya Liechtenstein Lithuania Luxembourg Macau Macedonia Madagascar Malawi Malaysia Maldives Mali Malta Marshall Islands Martinique Mauritania Mauritius Mayotte Mexico Micronesia Moldova Monaco Mongolia Montserrat Morocco Mozambique Myanmar / Burma Nambia Nauru

Code
LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN MS MA MZ MM NA NR

Ship to:
Y N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y Y Y Y N Y N

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

254

Appendix A: Country Codes

Country
Nepal Netherlands Netherlands Antilles New Caledonia New Zealand Nicaragua Niger Nigeria Niue Norfolk Island Norman Island North Korea Northern Ireland Northern Mariana Islands Norway Oman Pakistan Palau Palestine Panama Papua New Guinea Paraguay Peru Philippines Pitcairn Poland Portugal Puerto Rico

Code
NP NL AN NC NZ NI NE NG NU NF VG KP GB MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR

Ship to:
Y Y Y Y Y Y Y Y N N Y N Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y

Country
Qatar Reunion Romania Rota Russia Rwanda Saba Saipan Samoa San Marino Sao Tome & Principe Saudi Arabia Scotland Senegal Serbia & Montenegro Seychelles Sierra Leone Singapore Slovak Republic Slovenia Solomon Islands Somalia South Africa South Georgia & South Sandwich Islands South Korea Spain Sri Lanka St. Barthelemy

Code
QA RE RO MP RU RW AN MP WS IT ST SA GB SN CS SC SL SG SK SI SB SO ZA GS KR ES LK GP

Ship to:
Y Y Y Y Y Y Y Y Y Y N Y Y Y Y Y N Y Y Y N N Y N Y Y Y Y

Country
St. Christopher St. Croix Island St. Eustatius St. Helena St. John St. Kitts and Nevis St. Lucia St. Maarten St. Pierre St. Thomas St. Vincent Sudan Suriname Svalbard & Jan Mayen Is Swaziland Sweden Switzerland Syria Tahiti Taiwan Tajikistan Tanzania Thailand Tinian Togo Tokelau Tonga Tortola Island

Code
KN VI AN SH VI KN LC AN PM VI VC SD SR SJ SZ SE CH SY PF TW TJ TZ TH MP TG TK TO VG

Ship to:
Y Y Y N Y Y Y Y N Y Y N Y N Y Y N N Y Y N Y Y Y Y N Y Y

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

255

Appendix A: Country Codes

Country
Trinidad & Tobago Tunisia Turkey Turkmenistan Turks & Caicos Islands Tuvalu U.S. Minor Outlying Islands U.S. Virgin Islands Uganda Ukraine Union Island United Arab Emirates United Kingdom United States Uruguay Uzbekistan Vanuatu Vatican City Venezuela Vietnam Wales Wallis & Futuna Islands Western Sahara Yemen Zambia Zimbabwe

Code
TT TN TR TM TC TV UM VI UG UA VC AE GB US UY UZ VU IT VE VN GB WF EH YE ZM ZW

Ship to:
Y Y Y Y Y N N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y N Y Y Y

Country

Code

Ship to:

Country

Code

Ship to:

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

256

Appendix A: Country Codes

NOTE: The following South Pacific Islands (7 new destination countries) shall be allowed in the Ship, Rate, Rate Service Availability, and Tracking functions: Kiribati (country code = 'KI') Nauru (country code = 'NR') Solomon Islands (country code = 'SB') Nuie (country code = 'NU') Tonga (country code = 'TO') Tuvalu (country code = 'TV') Samoa (country code = 'WS')

However, the seven new countries shall NOT be allowed as the Shipper/Origin country in the Ship, Rate, and Rate Service Availability functions.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

257

Appendix B: Vague Commodity Descriptions

Appendix B: Vague Commodity Descriptions


The following table is a list of commodity descriptions considered vague by U.S. Customs:

Vague Commodity
"A/C Parts" "AC Parts" "Accessories" "Advertising Material"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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.

"Aircraft Parts"

"Aircraft Spare Parts"

"Aircraft spares"

"Antibodies" "Antibody"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

258

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Apparel" "Appliance" "Appliances" "Art" "As Per Attached INV"

Vague Commodity Description


"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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Water Color Painting." Clearance delays may result if the contents are not completely and accurately described. "As Per Attached INV" 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" 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 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" 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" 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" 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" 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"

"Auto Part"

"Auto Parts"

"Automotive Parts"

"Autoparts"

"Bag"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

259

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Battery" "Bearing" "Belts" "Box" "Brake Parts" "Brake" "Business Correspondence" "Cable" "Cap" "Caps" "Carton" "CD" "CDs"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Cable." Clearance delays may result if the contents are not completely and accurately described. "Cap" 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" 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" 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" 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" 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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

260

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Cell Line"

Vague Commodity Description


"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" 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" 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" 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" 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 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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described. "Clothes" 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.

"Cells"

"Chemical" "Chemicals" "Chip"

"Christmas Gifts" "CI Attached" "Civil Aircraft Parts"

"Civil Aircraft Spares"

"Clothes / Textiles"

"Clothes"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

261

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Clothing and Accessories" "Clothing" "Comat" "Commercial Invoice"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Components" "Computer Parts"

"Computer Peripherals"

"Connector" "Cosmetic Products"

"Cosmetics" "Culture"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

262

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Dangerous Good"

Vague Commodity Description


"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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described. "Data Processing Parts" 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" 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" 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" 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" 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" 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" 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.

"Dangerous Goods"

"Data Processing Part"

"Data Processing Parts"

"Defective Goods" "DESC N" "DESCRI" "DG"

"DGs"

"Disk"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

263

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Disks"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" is an incomplete description and not accepted by Customs. Please specify the name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Drugs" 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" 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" 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.

"Display"

"DNA"

"Doc" "Document" "Documentation"

"Documents" "Drug"

"Drugs"

"Dry Ice" "DVD"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

264

Appendix B: Vague Commodity Descriptions

Vague Commodity
"DVDs" "Electrical Parts" "Electronic Component" "Electronic Components" "Electronic Equipment"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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 Goods"

"Electronic Part" "Electronic Parts"

"Electronic" "Electronics"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

265

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Equipment"

Vague Commodity Description


"Equipment" is an incomplete description and not accepted by Customs. Specific Description of the Type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. "Fabric Samples" 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" 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" 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 " 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 " 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" 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" 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" 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" 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" 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.

"Fabric Samples"

"Fabric"

"Fabrics"

"FAC " "FAK " "Flooring" "Food Items" "Food" "Foodstuff" "Foodstuffs"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

266

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Freight Of All Kinds"

Vague Commodity Description


"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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Effects." Clearance delays may result if the contents are not completely and accurately described. "Hardware" 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" 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" 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" 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" 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" 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.

"General Cargo" "Gift" "Gifts"

"Goods" "Hardware" "Haz Mat"

"Haz Material"

"Haz Materials"

"Hazardous Chemical"

"Hazardous Chemicals"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

267

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Hazardous Good"

Vague Commodity Description


"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" 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" 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" 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" 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" 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 #" 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" 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#" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described. "I C" 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.

"Hazardous Goods"

"Hazardous Material"

"Hazardous Materials"

"HazMat"

"Household Goods" "HS #"

"HS NON"

"HS#"

"I C"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

268

Appendix B: Vague Commodity Descriptions

Vague Commodity
"IC"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"ILLEDG" "Illegible" "Implants" "Industrial Goods" "Integrated Circuit"

"Integrated Circuits"

"Iron" "Items" "Jeans" "Jewelry" "Laboratory Reagents"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

269

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Ladies Apparel"

Vague Commodity Description


"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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse." Clearance delays may result if the contents are not completely and accurately described. "Leather Articles" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Leather Article"

"Leather Articles"

"Leather" "letter"

"Liquid"

"Luggage" "Machine Part"

"Machine Parts"

"Machinery" "Machines"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

270

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Medical Equipment"

Vague Commodity Description


"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" 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" 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" 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" 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" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Medications" 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" 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" 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.

"Medical Parts"

"Medical Spare Parts"

"Medical Supplies"

"Medicaments"

"Medication"

"Medications"

"Medicine"

"Medicines"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

271

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Meds"

Vague Commodity Description


"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. "Mens 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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Mens Apparel"

"Metal Work" "Miscellaneous Items"

"NAFTA" "New Goods" "No CI" "NO COM" "NO DES" "NON G" "Non-Hazardous"

"NOT GI"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

272

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Packaging Supplies"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Pants" "Paper" "Paperwork" "Part" "Parts Of"

"Parts"

"PC Hardware" "PCB"

"PCBA"

"Peripheral"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

273

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Personal Effects" "Personal Item" "Personal Items" "Pharmaceuticals"

Vague Commodity Description


"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" 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" 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" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "PIB" 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" 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" 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" 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" 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" 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" 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" 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.

"PIB" "PIBs" "Pipe" "Pipes" "Plastic Good" "Plastic Goods"

"Plastic Parts" "Plastic"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

274

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Polyurethane"

Vague Commodity Description


"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" 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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manuals." Clearance delays may result if the contents are not completely and accurately described. "Printed Matter" 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" 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" 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.

"Power Supply"

"Precious Metal"

"Printed Circuit Board"

"Printed Material"

"Printed Materials"

"Printed Matter"

"Printed Matters"

"Promo Item"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

275

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Promo Items"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Promo Material"

"Promo Materials"

"Promotional Item"

"Promotional Items"

"Promotional Material"

"Promotional Materials"

"Promotional"

"Receivers" "Records"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

276

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Report"

Vague Commodity Description


"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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Fishing Rods." Clearance delays may result if the contents are not completely and accurately described. "Rods" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Rod" "Rods" "Rubber Articles"

"Rubber" "Said To Contain" "Sample" "Samples" "Scrap" "See Attached" "SEE CO" "SEE IN"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

277

Appendix B: Vague Commodity Descriptions

Vague Commodity
"See Invoice" "Shirt"

Vague Commodity Description


"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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - Used." Clearance delays may result if the contents are not completely and accurately described. "Spares" 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" 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 " 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" 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 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" 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.

"Software"

"Spare Parts for Machine"

"Spare Parts" "Spares" "Sportswear"

"STC " "Steel" "Surgical Instruments" "Swatches"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

278

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Tape" "Tapes" "Textile Samples"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Drill." Clearance delays may result if the contents are not completely and accurately described. "Toy" 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" 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.

"Textile"

"Textiles Samples"

"Textiles"

"Tile" "Tiles" "Tools" "Toy" "Training Material"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

279

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Training Materials"

Vague Commodity Description


"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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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" 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.

"Tubes" "Unlist" "Used Goods" "Various Goods" "Video Tape"

"Video Tapes"

"Video" "Videotape" "Videotapes" "VISA MDR Table" "Wafer"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

280

Appendix B: Vague Commodity Descriptions

Vague Commodity
"Waste" "Wearing Apparel"

Vague Commodity Description


"Waste" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Oil Waste for Testing." Clearance delays may result if the contents are not completely and accurately described. "Wearing Apparel" 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" 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" 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.

"Wire" "Wires"

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

281

Appendix C: Legal Terms and Conditions

Appendix C: Legal Terms and Conditions


Legal Terms
In addition to creating and printing the waybill Label, you will need to print copies of the U.S. Domestic and International Legal Terms and Conditions to accompany each Label with your International shipments. The following defines international handling instructions for the waybill labels and Legal Terms and Conditions document. If International U.S. Export: Print 2 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to the shipment so that the bar code portion of the label can be read and scanned. Place the additional consignee copy of the waybill Label in the pouch. If International Shipments originating outside of the U.S.: Print 3 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned. Place the 2 consignee copies of the waybill Label in the pouch. The following defines U.S. Domestic handling instructions for the waybill labels and Legal Terms and Conditions. If U.S. Domestic shipment: Print 1 copy of the waybill Label to your laser printer, fold the printed page in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned. NOTE: The International and U.S. Domestic waybill Legal Terms and Conditions information must be supplied with test labels when completing the certification process.

WARNING: Use only the printed original labels for shipping to ensure the timely delivery of your package.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

282

Appendix C: Legal Terms and Conditions

Conditions of Contract
CONDITIONS OF CONTRACT Definitions: On this Air Waybill, "we", "our", "us", and "FedEx" refer to Federal Express Corporation, its subsidiaries and branches and their respective employees, agents, and independent contractors. The terms "you" and "your" refer to the shipper, its employees, principals and agents. If your shipment originates outside the United States, your contract of carriage is with the FedEx subsidiary, branch or independent contractor who originally accepts the shipment from you. The term "package" means any container or envelope that is accepted by us for delivery, including any such items tendered by you utilizing our automated systems, meters, manifests or waybills. The term "shipment" means all packages which are tendered to and accepted by us on a single Air Waybill. Agreement To Terms: By processing and giving us your shipment, you agree, regardless of whether you sign the front of this Air Waybill, for yourself and as agent for and on behalf of any other person having an interest in this shipment, to all terms on this NON-NEGOTIABLE Air Waybill, and as appropriate any FedEx transportation agreement between you and FedEx covering this shipment and in any applicable tariff, and in our current applicable Service Guide, or Standard Conditions of Carriage, copies of which are available upon request. If there is a conflict between this Air Waybill and any such document then in effect, the transportation agreement, tariff, Service Guide or Standard Conditions of Carriage will control in that order of priority. No one is authorized to alter or modify the terms of our agreement. This Air Way bill shall be binding on us when the shipment is accepted: we may mark this Air Waybill with an employee number as our signature, or our printed name shall be sufficient to constitute our signature of this Waybill. Your Obligations - Printed Signature: You acknowledge that if you process shipments to locations outside the country where your shipment originates, you must enter, to print in lieu of a manual signature on the Air Waybill, the name of the person completing the Air Waybill for all such shipments tendered to FedEx by you using this application. You further acknowledge that such printed name shall be sufficient to constitute your signature on the Air Waybill and acceptance of FedEx's terms and conditions of carriage for purposes of the Warsaw Convention, an International treaty related to International carriage by air and any amendments and protocols thereto, (collectively "Warsaw Convention") and for all other purposes. You warrant that each article in each shipment will be properly described on this Air Waybill and any export documents, is acceptable for transport by FedEx, and that the shipment will be properly marked, addressed and packed to ensure safe transportation with ordinary care in handling. You are responsible for all charges, including transportation charges and all duties, customs, assessments governmental penalties and fines, taxes and FedEx legal costs related to your shipment. Air Carriage Notice: IF THE CARRIAGE OF YOUR SHIPMENT BY AIR INVOLVES AN ULTIMATE DESTINATION OR STOP IN A COUNTRY OTHER THAN THE COUNTRY OF DEPARTURE, THE WARSAW CONVENTION MAY BE APPLICABLE, WHICH TREATY WOULD THEN GOVERN AND IN MOST CASES LIMIT FEDEX'S LIABILITY FOR LOSS, DELAY OF, SHORTAGE, MISDELIVERY, MISINFORMATION, DAMAGE OR FAILURE TO PROVIDE INFORMATION REGARDING YOUR SHIPMENT. In certain countries, the Warsaw convention limits FedEx's liability to u.s. $9.07 per pound (US $20.38 per kilogram or equivalent local currency for the country of origin), unless a higher value for carriage is declared as described below and you pay any applicable supplementary charges. The interpretation and operation of the Warsaw convention's liability limits may vary in each country. There are no specific stopping places which are agreed to and FedEx reserves the right to route the shipment in any way FedEx deems appropriate. Road Transport Notice: Shipments transported partly or solely by road, be there an explicit agreement to do so or not, into or from a country which is a party to the Convention on the Contract for the International Carriage of Goods by Road (the "CMR") are subject to the terms and conditions of the CMR, notwithstanding any other provision of this Air Waybill to the contrary except that the higher limitations of liability as set forth in these conditions shall remain applicable as opposed to those set forth in the CMR. Limitation of Liability: If not governed by the Warsaw Convention, the CMR, or other International treaties, laws, other government regulations, orders, or requirements, FedEx's maximum liability for loss, damage, delay, shortage, misdelivery, or nondelivery of your shipment is limited by this Air Waybill to the greater of the amount of US $100 or US $9.07 per pound (US $20.38 per kilo) (or

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

283

Appendix C: Legal Terms and Conditions

equivalent local currency for the country of origin) (or in Canada, the amount of actual damages or CDN$100 per shipment, whichever is less) unless you declare, in advance, a higher value for carriage as described below and pay any applicable supplementary charges. FedEx does not provide cargo liability or all-risk insurance, but you may pay an additional charge for each additional US $100 (or equivalent local currency for the country of origin) of declared value for carriage. If a higher value for carriage is declared and the additional charge is paid, FedEx's maximum liability will be the lesser of the declared value for carriage or your actual damages. Declared Value Limits: The highest declared value FedEx allows for a FedEx Letter/Envelope and FedEx Pak shipment is US$100 or US$9.07 per pound (US$20.38 per kilo)(or the equivalent in local currency), whichever is greater. In Canada, the maximum declared value allowed for customs and carriage per Air Waybill for each FedEx Letter and FedEx Pak is CAN$100. For other shipments, in particular shipments of extraordinary value, including, but not limited to jewelry, artwork, antiques, precious metals, and furs and fur clothing, the declared value of carriage is limited and depends on the contents and the destination of the shipment. Please check the applicable Service Guide, contract of carriage, tariff, or Standard Conditions for an explanation of the declared value limits. If you send more than one package using a single Air Waybill, the declared value for carriage of each package will be determined by dividing the total declared value for carriage by the number of packages in the shipment. Liabilities Not Assumed. IN ANY EVENT, SUBJECT TO THE SERVICE CONDITIONS ON THIS AIR WAYBILL, OR THE APPLICABLE SERVICE GUIDE, STANDARD CONDITIONS, TARIFF OR CONTRACT OF CARRIAGE, FEDEX WON'T BE LIABLE FOR ANY DAMAGES, WHETHER DIRECT, INDIRECT, INCIDENTAL, SPECIAL OR CONSEQUENTIAL, IN EXCESS OF THE DECLARED VALUE US$100 OR US$9.07 PER LB. (US$20.38 PER KILO) (OR THE EQUIVALENT IN LOCAL CURRENCY) WHICHEVER IS GREATER (OR IN CANADA IN EXCESS OF THE DECLARED VALUE FOR CARRIAGE) (INCLUDING BUT NOT LIMITED TO LOSS OF INCOME OR PROFITS) WHETHER OR NOT FEDEX HAD ANY KNOWLEDGE THAT SUCH DAMAGES MIGHT BE INCURRED. FedEx won't be liable for your acts or omissions, including but not limited to incorrect declaration of cargo, improper or insufficient packing, securing, marking or addressing of the shipment, or for the acts or omissions of the recipient or anyone else with an interest in the shipment. Also, FedEx won't be liable if you or the recipient violate any of the terms of our Agreement. FedEx won't be liable for damage, loss, delay, shortage, misdelivery, nondelivery, misinformation or failure to provide information regarding shipments of cash, currency or other prohibited items. FedEx won't be liable for loss, damage, delay, shortage, misdelivery, nondelivery, misinformation or failure to provide information (i) in connection with shipments of cash, currency, or other prohibited items; or, (ii) caused by events FedEx cannot control, including but not limited to acts of God, perils of the air, weather conditions, mechanical delays, acts of public enemies, war, strikes, civil commotions, or acts or omissions of public authorities (including customs and health officials) with actual or apparent authority. No Warranty: We make no warranties, express or implied. Claims for Loss, Damage or Delay: ALL CLAIMS MUST BE MADE IN WRITING AND WITHIN STRICT TIME LIMITS. SEE OUR TARIFF, APPLICABLE SERVICE GUIDE, OR STANDARD CONDITIONS OF CARRIAGE FOR DETAILS. The Warsaw Convention provides that written claims for damage must be received within 14 days from the date of receipt and within twenty-one days in the event of delay. FedEx may have expanded the claims periods in certain countries and the periods may differ from country to country. Moreover, the interpretation and operation of the Warsaw Convention's claims provisions may vary in each country. Contact the FedEx representative in the country of origin to determine the claims period for your shipment. In the event of nondelivery or misdelivery, we must receive written notice of the claim within 90 days after we accept the shipment. The right to damages against us shall be extinguished unless an action is brought within two years from the date of delivery of the shipment or from the date on which the shipment should have been delivered, or from the date on which the carriage stopped. Within 90 days after notification to us of the claim, it must be documented by sending us all relevant information about it. FedEx is not obligated to act on any claim until all transportation charges have been paid. The claim amount may not be deducted from the transportation charges. If the recipient accepts the shipment without noting any damage on the delivery record, FedEx will assume the shipment was delivered in good condition. In order for us to consider a claim for damage, the contents, original shipping carton and packing must be made available to us for inspection. Right to Inspect: Your shipments may, at FedEx's option, or at the request of customs or other regulatory or government authorities, be opened and inspected by FedEx or such authorities at any time. Responsibility For Payment: Even if you give FedEx different payment FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

284

Appendix C: Legal Terms and Conditions

instructions, you will always be primarily responsible for all charges, including transportation charges, and all duties, custom assessments, governmental penalties and fines, taxes, and FedEx's attorney fees and legal costs, related to shipments tendered under this Agreement. You also will be responsible for any costs FedEx may incur in returning your shipments to you or warehousing them pending disposition. Customs Clearance: By giving us this shipment, you hereby appoint FedEx, or its independent contractor as applicable, as your agent solely for performance of customs clearance and certify FedEx as the nominal consignee for the purpose of designating a customs broker to perform customs clearance. In some instances, local authorities may require additional documentation confirming FedEx's appointment. It is your responsibility to provide proper documentation and confirmation, where required. You are responsible for and warrant your compliance with all applicable laws, rules and regulations, including but not limited to customs laws, import and export laws and government regulations of any country to, from, through or over which your shipments may be carried. You agree to furnish such information and complete and attach to the shipments such documents as are necessary to comply with such laws, rules and regulations. FedEx assumes no liability to you or any other person for any loss or expense due to your failure to comply with this provision. You are also responsible for all charges, including transportation charges, and all duties, customs assessments, governmental penalties and fines, taxes, and FedEx lawyer's fees and legal costs, related to any shipment. Letter of Instruction: You do not complete all the documents required for carriage or if the documents submitted are not appropriate for the services or destination requested, you hereby instruct FedEx, or its independent contractor, as applicable, where permitted by law to complete, correct or replace the documents for you at your expense. However, FedEx is not obligated to do so. If a substitute form of air waybill is needed to complete delivery of your shipment and FedEx completes that document, the terms of this Agreement will continue to govern. FedEx is not liable to you or any other person for FedEx's actions on your behalf under this provision. Items Not Acceptable for Transportation: FedEx does not accept transportation of money (including, but not limited to, coins (except collectible) or negotiable instruments equivalent to cash such as endorsed stocks and bonds.) FedEx excludes all liability for shipments of such items accepted by mistake. Other items may be accepted for carriage only to limited destinations or under restricted conditions. FedEx reserves the right to reject packages based upon these limitations or for reasons of safety or security. You may consult the applicable Service Guide, contract of carriage, tariff or Standard Conditions for specific details. Export Control. You authorize FedEx, and its independent contractors, as applicable, to act as forwarding agent for you for export and customs purposes. You hereby certify that all statements and information contained on all Air Waybills, SEDs and accompanying documentation relating to exportation are true and correct. You further certify that all Commercial Invoice information submitted via API is true and correct. You expressly authorize FedEx and its independent contractors, as applicable, to forward all information of any nature regarding shipments to any and all governmental or regulatory agencies which request or require such information. Furthermore, you understand that civil and criminal penalties, including forfeiture and sale, may be imposed for making false or fraudulent statements or for the violation of any country laws on exportation, including but not limited to, for shipments originating in the U.S., 13 USC. &sect;305; 22 USC. &sect;401; 18 USC. &sect;1001; and 50 USC. App. 2410, and for shipments originating in Canada, the Export and Import Permits Act, R.S.C. E-17. Consult the laws in the country of origin for similar restrictions. You acknowledge that no shipments tendered by you from the United States using API will be sent to any entity listed on the Department of Commerce's Denied Parties List 15 C.F.R. Part 764, Supp. 2, or the list of Special Designated Nationals as published by the Office of Foreign Assets Control of the U.S. Department of the Treasury and that you are neither a denied party or a specially designated national. Consult the laws of the origin country of your shipment for similar provisions. Mandatory Law: Insofar as any provision contained or referred to in the Air Waybill may be contrary to any applicable International treaties, laws, governmental regulations, orders or requirements, such provision shall remain in effect as part of our agreement to the extent that it is not overridden. The invalidity or unenforceability of any provision shall not affect any other provision contained or referred to in the Air Waybill. Unless otherwise indicated, the shipper's address indicated on the face of the Air Waybill is the place of execution and the place of departure and the recipient's address listed on the face of the Air Waybill is the place of destination. Unless otherwise indicated, the first carrier of this shipment is Federal Express Corporation, P.O. Box 727, Memphis, TN 38194.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

285

Glossary

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.

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

286

Glossary

DDU (Delivered Duty Unpaid): (Consignee door-excluding duties and taxes). Title, risk and responsibility for vessel discharge and import clearance pass to buyer when seller delivers goods on board the ship to destination port. Used for sea or inland waterway transportation. DG: Dangerous Goods DUNS: A number assigned to a firm by Duns and Bradstreet. ECI: Electronic Commercial Invoice ECOD: Electronic Collect on Delivery EIN: Employer Identification Number EXW (Ex Works): (Factory, mill, warehouse: your door) Title and risk pass to buyer including payment of all transportation and insurance cost from the seller's door. Used for any mode of transportation. FASC: FedEx Authorized Shipping Center FCA (Free Carrier): (Pick a place after your origin to start) Title and risk pass to buyer including transportation and insurance cost when the seller delivers goods cleared for export to the carrier. Seller is obligated to load the goods on the Buyer's collecting vehicle; it is the Buyer's obligation to receive the Seller's arriving vehicle unloaded. FDXE: FedEx Express FDXG: FedEx Ground FHD: FedEx Home Delivery FICE: FedEx International Controlled Export FOB (Free On Board): (Port-same as FAS) Risk pass to buyer including payment of all transportation and insurance cost once delivered on board the ship by the seller. Used for sea or inland waterway transportation. FTSR: Foreign Trade Statistics Regulations Girth: Girth is the sum of the four smallest dimensions of a package. Girth = (2 Width + 2 Height). GST: Global Sales Tax

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

287

Glossary

GST: Goods and Services (Governmental) Tax HAL: Hold at Location HazMat: Hazardous Materials HST: Harmonized Sales Tax HTTP: Hypertext Transfer Protocol IEFS: International Economy Freight Service IPFS: International Priority Freight Service ITAR: International Traffic in Arms KGS: Kilograms LBS: Pounds MBG: Money Back Guarantee MPS: Multiple-Piece Shipment NAFTA: North America Free Trade Agreement OP-950: FedEx Ground HazMat Report OS: Oversize Oversize Packages (Ground): A package whose Length plus Girth is greater than 84 inches is considered to be Oversize. Oversize packages are considered to have a minimum weight of 30 lbs. (or 50 lbs. if the Length plus the Girth is greater than 108 inches) for U.S. shipments and 50 lbs. for Canadian shipments. There is also a maximum allowable size of Length plus Girth less than or equal to 130 inches, as well as a maximum allowable single dimension of 108 inches. PNG: Portable Network Graphic PO: Priority Overnight OR Purchase Order

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

288

Glossary

POD: Proof of Delivery PST: Provincial Sales Tax QST: Quebec Provincial Sales Tax RMA: Return Merchandise Authorization SASV: Service Availability Shipment Validation SED: Shippers Export Declaration SLAC: Shippers 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

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

289

Glossary

Unit of Measure Codes:

Unit of Measure Codes


AR Carat CFT Cubic Feet CG Centigrams CM Centimeters CM3 Cubic Centimeters DOZ Dozen DPR Dozen Pair EA Each G Grams GR Gross GAL Gallon KG Kilograms KGM Kilogram L Liter LB Pound LFT Linear Foot LNM Linear Meters LTR Liters LYD Linear Yard M Meters MG Milligram ML Milliliter M2 Square Meters M3 Cubic Meters NO Number OZ Ounces PCS Pieces

ZIP: Zone Improvement Plan code

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

290

Glossary

Index
C
Country Codes table, 253

F
FDXCancelEmailLabelReply, 207 FDXCancelEmailLabelReply, example, 208 FDXCancelEmailLabelRequest, 205 FDXCancelEmailLabelRequest, example, 206 FDXCancelExpressTag Reply, example, 225 FDXCancelExpressTagReply, 224 FDXCancelExpressTagRequest, 222 FDXCancelExpressTagRequest, example, 223 FDXCancelGroundCallTagReply, 239 FDXCancelGroundCallTagReply, example, 240 FDXCancelGroundCallTagRequest, 236 FDXCancelGroundCallTagRequest, example, 238 FDXCloseReply, 141 FDXCloseRequest, 138 FDXCloseRequest, example, 140, 142 FDXEmailLabelReply, 202 FDXEmailLabelReply, example, 204 FDXEmailLabelRequest, 182 FDXEmailLabelRequest, example, 199 FDXExpressTagAvailabilityReply, 245 FDXExpressTagAvailabilityReply, example, 247 FDXExpressTagAvailabilityRequest, 241 FDXExpressTagAvailabilityRequest, example, 244 FDXExpressTagReply, 219 FDXExpressTagReply, example, 221 FDXExpressTagRequest, 209 FDXExpressTagRequest, example, 217 FDXFedExLocatorReply, 175

FDXFedExLocatorReply, example, 178 FDXFedExLocatorRequest, 170 FDXFedExLocatorRequest, example, 174 FDXGroundCallTaglRequest, example, 232 FDXGroundCallTagReply, 234 FDXGroundCallTagReply, example, 235 FDXGroundCallTagRequest, 226 FDXRateAvailableServicesReply, 53 FDXRateAvailableServicesReply, example, 61 FDXRateAvailableServicesRequest, 42 FDXRateAvailableServicesRequest, example, 52 FDXRateReply, 28 FDXRateReply, example, 41 FDXRateRequest, 16 FDXRateRequest, example, 26 FDXServiceAvailabilityReply, 169 FDXServiceAvailabilityRequest, 164 FDXServiceAvailabilityRequest, example, 168 FDXShipDelete Request, example, 135 FDXShipDeleteReply, 136 FDXShipDeleteReply, example, 137 FDXShipDeleteRequest, 134 FDXShipReply, 116 FDXShipReply, example, 132 FDXShipRequest, 66 FDXShipRequest, example, 113 FDXSPODReply, 162 FDXSPODRequest sample letter, 163 FDXSPODRequest, 157 FDXSPODRequest, example, 161, 162 FDXSubscriptionReply, 14

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

291

Glossary

FDXSubscriptionReply, example, 15 FDXSubscriptionRequest, 11 FDXSubscriptionRequest, example, 13 FDXTrackReply, 148 FDXTrackReply, example, 154 FDXTrackRequest, 144 FDXTrackRequest, example, 147

T
Transaction Layouts, 10 transactions FDXCancelEmailLabelReply, 207 FDXCancelEmailLabelRequest, 205 FDXCancelExpressTagReply, 224 FDXCancelExpressTagRequest, 222 FDXCancelGroundCallTagReply, 239 FDXCancelGroundCallTagRequest, 236 FDXCloseReply, 141 FDXCloseRequest, 138 FDXEmailLabelReply, 202 FDXEmailLabelRequest, 182 FDXExpressTagAvailabilityReply, 245 FDXExpressTagAvailabilityRequest, 241 FDXExpressTagReply, 219 FDXExpressTagRequest, 209 FDXFedExLocatorReply, 175 FDXFedExLocatorRequest, 170 FDXGroundCallTagReply, 234 FDXGroundCallTagRequest, 226 FDXRateAvailableServicesReply, 53 FDXRateAvailableServicesRequest, 42 FDXRateReply, 28 FDXRateRequest, 16 FDXServiceAvailabilityReply, 169 FDXServiceAvailabilityRequest, 164 FDXShipDeleteReply, 136 FDXShipDeleteRequest, 134 FDXShipReply, 116 FDXShipRequest, 66 FDXSPODReply, 162 FDXSPODRequest, 157

G
Glossary, 286

I
Introduction, 4

L
label specifications custom labels, 251 determining screen resolution, 250 general printing overview and methods, 248 label preparation, 251 plain paper and thermal, 248 PNG plain paper label, 249 Legal Terms and Conditions, 282

O
overview, 4

R
Referenced Documents, 9

S
Shipping Label Specifications, 248

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

292

Glossary

FDXSubscriptionReply, 14 FDXSubscriptionRequest, 11 FDXTrackReply, 148 FDXTrackRequest, 144

V
Vague Commodity Descriptions table, 258

W
Whats New, 7

U
UTIs: Universal Transaction Identifiers, 5

FedEx Ship Manager API/Direct XML Transaction Guide, Jun05.0

293

You might also like