FedEx Ship Manager® API/DIRECT
Tagged Transaction Guide
June 2006
Confidential and Proprietary
®
The information contained in this Tagged Transaction Guide is confidential and proprietary to FedEx Corporate Services, Inc. and its affiliates (collectively
"FedEx"). No part of this Tagged Transaction Guide may be distributed or disclosed in any form to any third party without written permission of FedEx. This guide
is provided to you under and its use is subject to the terms and conditions of the FedEx End User and/or Consultant License Agreement. The information in this
document may be changed at any time without notice. Any conflict between either of these guides, the FedEx End User and/or Consultant License Agreement,
and the FedEx Service Guide shall be governed by the FedEx End User and/or Consultant License Agreement and the FedEx Service Guide, in that order.
© 2006 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved. Unpublished.
Table of Contents
Table of Contents
Revision History ................................................................................................................................................................................................................................................ 4
Introduction ....................................................................................................................................................................................................................................................... 9
Tagged Transaction Set ................................................................................................................................................................................................................................ 9
Formatting a Tagged Transaction.................................................................................................................................................................................................................. 9
UTIs: Universal Transaction Identifiers........................................................................................................................................................................................................ 10
What’s New ...................................................................................................................................................................................................................................................... 12
Referenced Documents .................................................................................................................................................................................................................................. 13
Tagged Transaction Layouts ......................................................................................................................................................................................................................... 14
Transaction 211: Subscription/Registration Request................................................................................................................................................................................... 16
Example of Transaction 211: Subscription/Registration Request .......................................................................................................................................................... 18
Transaction 311: Subscription/Registration Reply ....................................................................................................................................................................................... 19
Example of Transaction 311: Subscription/Registration Reply .............................................................................................................................................................. 20
Transaction 019: Service Availability Request (For FedEx Express Only) .................................................................................................................................................. 21
Examples of Transaction 019: Service Availability Request (For FedEx Express Only) ........................................................................................................................ 23
Transaction 119: Service Availability Reply (For FedEx Express Only)....................................................................................................................................................... 25
Examples of Transaction 119: Service Availability Reply....................................................................................................................................................................... 26
Transaction 022: Rate a Package Request ................................................................................................................................................................................................. 28
Example of Transaction 022: Rate a Package Request ........................................................................................................................................................................ 33
Transaction 122: Rate a Package Reply ..................................................................................................................................................................................................... 34
Example of Transaction 122: U.S. Rate a Package Reply..................................................................................................................................................................... 40
Transaction 025: Rate Available Services Request..................................................................................................................................................................................... 41
Example of Transaction 025: Rate Available Services Request ............................................................................................................................................................ 46
Transaction 125: Rate Available Services Reply ......................................................................................................................................................................................... 47
Example of Transaction 125: Rate Available Services Reply ................................................................................................................................................................ 51
Transaction 021: Ship a Package Request ................................................................................................................................................................................................. 54
Example of Transaction 021: Ship a Package Request (U.S. FedEx Express) ..................................................................................................................................... 78
Transaction 121: Ship a Package Reply...................................................................................................................................................................................................... 80
Example of Transaction 121: Ship a Package Reply (U.S. FedEx Express).......................................................................................................................................... 88
Transaction 023: Delete a Package Request .............................................................................................................................................................................................. 90
Example of Transaction 023: Delete a Package Request...................................................................................................................................................................... 91
Transaction 123: Delete a Package Reply .................................................................................................................................................................................................. 92
Example of Transaction 123: Delete a Package Reply .......................................................................................................................................................................... 93
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
1
Table of Contents
Transaction 007: Close Request (Applicable to FedEx Ground Only) ......................................................................................................................................................... 94
Example of Transaction 007: Close Request......................................................................................................................................................................................... 96
Transaction 107: Close Reply (Applicable to FedEx Ground Only) ............................................................................................................................................................. 97
Example of Transaction 107: Close Reply ............................................................................................................................................................................................. 98
Transaction 404: Tracking Request............................................................................................................................................................................................................. 99
Example of Transaction 404: Tracking Request .................................................................................................................................................................................. 105
Transaction 504: Tracking Reply ............................................................................................................................................................................................................... 106
Example of Transaction 504: Tracking Reply ...................................................................................................................................................................................... 117
Transaction 420: Tracking Notifications Request ...................................................................................................................................................................................... 119
Example of Transaction 420: Tracking Notifications Request.............................................................................................................................................................. 127
Transaction 520: Tracking Notifications Reply........................................................................................................................................................................................... 129
Example of Transaction 520: Tracking Notifications Reply .................................................................................................................................................................. 134
Transaction 405: Signature Proof of Delivery Request.............................................................................................................................................................................. 135
Example of Transaction 405: Signature Proof of Delivery.................................................................................................................................................................... 139
Transaction 505: Signature Proof of Delivery Reply .................................................................................................................................................................................. 140
Example of Transaction 505: Signature Proof of Delivery.................................................................................................................................................................... 141
Sample FULL Signature Proof of Delivery (SPOD) Letter.................................................................................................................................................................... 142
Sample PARTIAL Signature Proof of Delivery (SPOD) Letter ............................................................................................................................................................. 143
Transaction 410: FedEx Locator Request ................................................................................................................................................................................................. 144
Example of Transaction 410: Locator Request .................................................................................................................................................................................... 148
Transaction 510: FedEx Locator Reply ..................................................................................................................................................................................................... 149
Example of Transaction 510: Locator Reply ........................................................................................................................................................................................ 151
Transaction 037: Email Label Request...................................................................................................................................................................................................... 153
Example of Transaction 037: Email Label Request ............................................................................................................................................................................. 164
Transaction 137: Email Label Reply .......................................................................................................................................................................................................... 167
Example of Transaction 137: Email Label Reply ................................................................................................................................................................................. 169
Transaction 033: Cancel Email Label Request.......................................................................................................................................................................................... 170
Example of Transaction 033: Cancel Email Label Request ................................................................................................................................................................. 171
Transaction 133: Cancel Email Label Reply .............................................................................................................................................................................................. 172
Example of Transaction 133: Cancel Email Label Reply ..................................................................................................................................................................... 173
Transaction 044: Call Tag Create Request ............................................................................................................................................................................................... 174
Example of Transaction 044: Call Tag Create Request ....................................................................................................................................................................... 178
Transaction 144: Call Tag Create Reply.................................................................................................................................................................................................... 180
Example of Transaction 144: Call Tag Create Reply ........................................................................................................................................................................... 181
Transaction 045: Call Tag Cancel Request ............................................................................................................................................................................................... 182
Example of Transaction 045: Call Tag Cancel Request....................................................................................................................................................................... 183
Transaction 145: Call Tag Cancel Reply ................................................................................................................................................................................................... 184
Example of Transaction 145: Cancel Call Tag Reply........................................................................................................................................................................... 185
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
2
Table of Contents
Transaction 046: Express Tag Dispatch Create Request.......................................................................................................................................................................... 186
Example of Transaction 046: Express Tag Dispatch Create Request ................................................................................................................................................. 190
Transaction 146: Express Tag Dispatch Create Reply .............................................................................................................................................................................. 193
Example of Transaction 146: Express Tag Create Dispatch Reply ..................................................................................................................................................... 195
Transaction 047: Express Tag Dispatch Cancel Request ......................................................................................................................................................................... 196
Example of Transaction 047: Express Tag Dispatch Cancel Request ................................................................................................................................................. 197
Transaction 147: Express Tag Dispatch Cancel Reply.............................................................................................................................................................................. 198
Example of Transaction 147: Express Tag Dispatch Cancel Reply ..................................................................................................................................................... 199
Transaction 048: Express Tag Availability Request................................................................................................................................................................................... 200
Example of Transaction 048: Express Tag Availability Request .......................................................................................................................................................... 201
Transaction 148: Express Tag Availability Reply....................................................................................................................................................................................... 202
Example of Transaction 148: Express Tag Availability Reply .............................................................................................................................................................. 203
Shipping Label Specifications ..................................................................................................................................................................................................................... 204
Plain Paper and Thermal Label Specifications .......................................................................................................................................................................................... 204
General Printing Overview and Methods ............................................................................................................................................................................................. 204
PNG Plain Paper Label........................................................................................................................................................................................................................ 205
PDF Label............................................................................................................................................................................................................................................ 206
4x6 PNG Label .................................................................................................................................................................................................................................... 206
Determining Screen Resolution ........................................................................................................................................................................................................... 207
Custom Labels ..................................................................................................................................................................................................................................... 208
Shipping Label Support ............................................................................................................................................................................................................................. 209
Label Data Buffer....................................................................................................................................................................................................................................... 210
Using Buffer Data to Print PNG, Thermal, PDF Labels and SPODs.................................................................................................................................................... 211
Appendix A: Field Descriptions by Field Tag ............................................................................................................................................................................................. 215
Appendix B: Country Codes ........................................................................................................................................................................................................................ 272
Appendix C: Vague Commodity Descriptions ............................................................................................................................................................................................ 275
Appendix D: Legal Terms and Conditions .................................................................................................................................................................................................. 292
Glossary......................................................................................................................................................................................................................................................... 293
Index............................................................................................................................................................................................................................................................... 297
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
3
Revision History
Revision History
Date
Section
Description
4/03/06
Cover, footer
Changed version from March, 2006 to June, 2006
4/03/06
Reference Documents
Changed URL link for FedEx Service Guide to current URL
4/03/06
119 transaction
Corrected header from 022 info to 119 info
4/03/06
019 transaction
Changed field numbers for service from 1273 to 1274 and packaging type from 1274 to 1273 in first
paragraph
4/03/06
Entire document
Changed all references to tag 1274 with the name of “FedEx Service Type” to “Service Type” to maintain
consistency throughout the document
4/03/06
Entire document
Changed all references to tag 1273 with the name of “FedEx Packaging Type” to “Packaging Type” to
maintain consistency throughout the document and to make inclusive of ‘your packaging’ in the tag name
4/03/06
Appendix A
Added the following values to tag 3025 (Carrier Codes):
FDXC – FedEx Cargo
FXCC – FedEx Custom Critical
FXFR – FedEx Freight
4/03/06
Entire document
Changed all references to tag 1432 with the name of “COD Customer Amount” to “Customer COD Amount”
to maintain consistency throughout the document
4/04/06
Appendix A
Added tag 1103 (Sender Fax). This was missing from the appendix.
4/04/06
Appendix A
Added tag 1700 (Available Records Count). This was missing from the appendix.
4/04/06
Appendix A
For tag 1274 (Service Type), added the following note: “Note: For freight limitations, see the FedEx Service
Guide or fedex.com for more information.”
4/10/06
021 transaction, Appendix A
Updated tag 118 (Recipient SSN/EIN) field requirements/description
Added tag 2424 (Recipient Tax ID Type) to support non-document shipments to Brazil
4/10/06
Appendix A
For tag 1274 (Service Type) added missing value: 57 – FedEx Europe First
4/10/06
021 transaction, Appendix A
Updated tag 3001 (FedEx Purchase Order), tag 3002 (FedEx Invoice), and tag 38 (Sender Department) to
indicate that these would display on the thermal label if passed in the transaction.
4/10/06
021 transaction, Appendix A
For tag 1370 (Label Media Type) added new value: 8 = PDF
4/10/06
Shipping Label Specifications
Added PDF Label section
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
4
Revision History
Date
Section
Description
4/10/06
Entire document
Added language value of es and language locale code value of US to the following tags:
1552 (Language Code)
1968 (Language Locale Code)
1972 (Reply Language Code)
1973 (Reply Language Locale Code)
4/12/06
What’s New
Added the following new features:
Brazil Tax ID Validation
Pass References to Print on Thermal Label
PDF Label
US Spanish
4/12/06
Glossary
Added “DUNS – A number assigned to a firm by Dun and Bradstreet”
Changed from “GST – Global Sales Tax” to “GST – Goods and Services Tax”
Added “HTTP: Hypertext Transfer Protocol”
Added "OP-950: FedEx Ground HazMat Report”
Added “QST: Quebec Provincial Sales Tax”
4/14/06
Appendix A
For field 1958 (Package Admissibility Type), added descriptions to the values “ENG” to “ENV”
4/17/06
510 FedEx Locator Reply
Added “-#” to tag 1699 (Record Index) for multiple occurrence
5/3/06
Entire document
Changed RMA acronym meaning to Return Materials Authorization as defined at fedex.com
5/8/06
021 Ship a Package Request
In the Canada Export Declaration B12A section, changed sentence in comment from "Canada Customs
regulations and internal business rules require that a shipper that is
exporting of non-document shipments to any country other than Canada, the United States, Puerto Rico or
the U.S. Virgin Islands and shipment has a high value ($2000 CAD or higher) must submit proof of a filed
B13A declaration prior to export."
To:
"Canada Customs regulations and internal business rules require that a shipper that is exporting nondocument shipments (or document shipments of $2000 CAD or higher) to any country other than Canada,
the United States, Puerto Rico or the U.S. Virgin Islands must submit proof of a filed B13A declaration prior
to export."
5/15/06
Entire document
In the 2399 (Signature Option) field requirements, removed "intra-Canada" from "For intra-Canada FedEx
Express shipments, the 'Deliver without Signature' option will not be allowed when …."
5/15/06
021 Ship a Package Request
Changed SED heading from "Shipper's Export Declaration (SED)" to "Shipper's Export Declaration
(SED)/Electronic Export Information (EEI)" and subheading from "SED – General Information" to SED/EEI
– General Information"
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
5
Revision History
Date
Section
Description
5/15/06
021 Ship a Package Request
Changed field 1358 name from "Automated Export System (AES)/Foreign Trade Statistics Regulations
(FTSR)" to Automated Export System (AES)/Foreign Trade Regulations (FTR)"
5/15/06
Introduction
In the list of UTIs, added "FedEx Express" to description of UTI 2017 and "FedEx Ground" to description of
UTI 3004.
5/16/06
021 Ship a Package Request
Changed description of tag 1118 (Release Authorization Number) from "Required if Signature Release flag
is Y" to "Optional. May be used if Signature Option field is set to 1 (Delivery without Signature)."
5/16/06
037 Email Label Request
Removed tag 1118 (Release Authorization Number)
5/16/06
021 Ship a Package Request
In description of tag 113 (Commercial Invoice Flag),
Deleted "Commercial invoice support consists of a maximum of 4 commodity line items."
Added "The Electronic Commercial Invoice allows up to 20 commodity line items."
5/16/06
Shipping Label Specifications
Added PDF and SPODs to the Using Buffer Data to Print PNG or Thermal Labels
5/16/06
Appendix A
Changed description of value 2 in tag 23 (Pay Type) from "Bill recipient (Collect for FedEx Express; Bill for
FedEx Ground)" to " Bill recipient (for FedEx Express); Collect (for FedEx Ground)"
5/17/06
021 Ship a Package Request
For field 2975 (Mask Account Number Flag), indicated different default values for Express and Ground
5/17/06
025 Rate Available Services Request
125 Rate Available Services Reply
Provided sample transactions for these transaction types
5/18/06
021 Ship a Package Request
For the following tags, added further explanation in description:
76 (Commodity Number of Pieces)
82 (Commodity Unit Quantity)
6/08/06
504 Tracking Reply,
Appendix A
Changed description of tag 1169 (Status Code/Tracking Status Code) to "For example, SP = split
shipment" and field length in appendix changed to 2
6/08/06
021 Ship a Package Request,
Appendix A
Changed description of value 7 for tag 1370 (Label Media Type) to "7 = 4x6 PNG Laser printer image.
Valid for domestic shipping only."
6/08/06
404 Tracking Request
Added section heading, "TRACK BY REFERENCE RELATED", before tags 1754, 50, and 17.
Clarified description of fields 50 (Recipient Country Code) and 17 (Recipient Postal Code) to indicate
required if 1754 (Shipment Related Account Number) is not included.
6/08/06
404 Tracking Request,
504 Tracking Reply
In samples of Request/Reply, corrected field descriptions:
1537 – "Search / Relationship string"
1538 – "Search / Relationship type code"
6/08/06
504 Tracking Reply
Changed the field description of tag 29 (Tracking Number) to:
"Tracking Number provided in the 404 Track Request or linked to reference track request.
If duplicate tracking numbers occur, see field 1752 (Tracking Unique ID)."
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
6
Revision History
Date
Section
Description
6/08/06
021 Ship a Package Request
Deleted Central Daylight Time (CDT) from description of field 24 (Ship Date)
6/08/06
021 Ship a Package Request
To tag 71 (Duties Payer Account Number) field description, added the following:
"Optional if Duties Pay Type is 2 (Bill Recipient)."
6/08/06
021 Ship a Package Request
Deleted tag 1337 (Package Content Information); not used by API
6/08/06
021 Ship a Package Request,
037 Email Label Request
For the valid values for the following tags, referenced Appendix A:
1552 (Language Code)
1555 (Shipper Language Code)
1558 (Recipient Language Code)
1561 (Broker Language Code)
1968 (Language Locale Code)
1969 (Shipper Language Locale Code)
1970 (Recipient Language Locale Code)
1971 (Broker Language Locale Code)
6/08/06
021 Ship a Package Request,
037 Email Label Request
Changed field description of tag 1206 (ShipAlert Notification Flag) to remove limit of 1 occurrence for
Ground. Maximum of 3 allowed for both Express and Ground.
6/08/06
021 Ship a Package Request,
037 Email Label Request,
Appendix A
In description field for the following tags, corrected references to associated email addresses:
1965 (Shipper Email Notification Format)
1966 (Broker Email Notification Format)
1967 (Recipient Email Notification Format)
6/08/06
021 Ship a Package Request,
Appendix A
For tag 1370 (Label Media Type), deleted references to Express and Ground support for values 5 and 8
since all media types apply to both.
6/08/06
021 Ship a Package Request
Indicated the following tags as required for international shipping:
1407 (Commodity Weight)
1408 (Commodity Unit Value)
6/08/06
Entire document
Changed references to PIB to document shipments.
6/09/06
Introduction
For 404/504 transaction, changed UTI code from 5003 to 5002.
6/09/06
021 Ship a Package Request
Under SED/EEI section, deleted references to International Traffic in Arms (ITAR) and License Exception
Symbol
6/13/06
022 Rate a Package Request,
Appendix A
Replaced tag 1409 (COD Collect Amount) with 1432 (Customer COD Amount)
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
7
Revision History
Date
Section
Description
6/13/06
021 Ship a Package Request,
037 Email Label Request,
Appendix A
Deleted tag 3035 (ShipAlert Fax Number) as discontinued
6/21/06
Appendix D
Removed Conditions of Contract. This is printed with the international labels.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
8
Introduction
Introduction
Tagged Transaction Set
In the following pages, we will take a closer look at the transactions that FedEx Ship Manager API and Direct support. Before that, however, we will describe the rules
governing well-formed tagged transactions.
Formatting a Tagged Transaction
The Tagged Transaction Set uses the ASCII character set. A transaction consists of a set of fields concatenated together. Each field contains a field tag, a comma, and a
value – in that order. The value must be enclosed in double-quotes. Note that the commas are not used to separate the fields within a transaction. They are used to
separate the field tag from the value within each field. The field tag in the field 955 (test) would be 955, and the value would be "test".
The first field in a transaction must be the Transaction Type, whose field tag is 0 (zero). Its value identifies the transaction as being of a certain type. For instance, Add
Shipment transactions always begin with 0,"021" and Delete Shipment transactions begin with 0,"023". The Transaction Type should not be confused with the Universal
Transaction Identifier (UTI) (see below), which uniquely defines a transaction type across all transaction sets. The Transaction Type is unique only within the Tagged
Transaction Set.
The last field in a transaction must be the Transaction Terminator, whose field tag is 99, which has a null value (""). It is the only field whose value can be empty. Thus, you
can always find the end of a transaction by searching for 99,"".
NOTE:
Except in the case of the Transaction Terminator (99,""), empty values ("") are not allowed.
Aside from the Transaction Type and Transaction Terminator, the fields in a transaction can be in any order. No meaning should be ascribed to the ordering of the fields,
and no reliance should be placed on fields in Replies appearing in any particular order.
An ordinary field tag is a decimal integer without leading zeroes. A multiple-occurrence field tag will add a dash character followed by another decimal integer (again without
leading zeroes). A field with a multiple-occurrence field tag is an instance of a field which can take an ordered set of more than one value. The integer following the dash
tells us which position in the set is occupied by this instance (see example below). If only one instance of such a field is in the transaction, the dash and integer 1 can be
omitted from its field tag, so that it looks like an ordinary field tag. However, if there are multiple occurrences of this field tag, the first field tag must include the "-1" and so
forth.
The values of all fields (except those of certain binary data fields) can contain only printable characters. Different fields have different rules governing their format. But
generally, numeric values do not have leading zeroes. Alphanumeric values should not contain leading or trailing blanks. The null (0x00) and double-quote (0x22)
characters are never allowed in values, even in binary fields, where they are replaced with special escape sequences (see discussion on label buffers in the
Shipping Label Support section of this document).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
9
Introduction
UTIs: Universal Transaction Identifiers
NOTE:
The UTI section of this guide is only applicable when the FedEx Tagged 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 tagged Transaction
Type 021 (FedEx Express global Ship a Package Request) is 2016.
UTIs are unique not just within the tagged transaction set, but across all transaction sets that have been or will be approved for transmission via the 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
Transaction Type
Applicable Carrier
1002
007 / 107
FDXG
End-of-Day Close
1005
023 / 123
FDXE
FedEx Express Delete a Package
2016
021 / 121
FDXE
FedEx Express Ship a Package
2017
022 / 122
FDXE
FedEx Express Global Rate a Package
2018
019 / 119
FDXE
Service Availability (FedEx Express Only)
2024
025 / 125
FDXE / FDXG
Rate Available Services
2025
410 / 510
FDXE / FDXG
FedEx Locator
2027
037 / 137
FDXE
FedEx Express Email Label
2028
033 / 133
FDXE
FedEx Express Email Label Cancel
2029
046 / 146
FDXE
FedEx Express Tag Dispatch Create
2030
047 / 147
FDXE
FedEx Express Tag Dispatch Cancel
2031
048 / 148
FDXE
FedEx Express Tag Availability
3000
021 / 121
FDXG
FedEx Ground Ship a Package
3001
023 / 123
FDXG
FedEx Ground Delete a Package
3003
211 / 311
FDXE / FDXG
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Description
Subscription/Registration
10
Introduction
UTI
Transaction Type
Applicable Carrier
3004
022 / 122
FDXG
FedEx Ground Global Rate a Package
3010
044 / 144
FDXG
FedEx Ground Call Tag Create
3011
045 / 145
FDXG
FedEx Ground Call Tag Cancel
3012
037 / 137
FDXG
FedEx Ground Email Label
3013
033 / 133
FDXG
FedEx Ground Email Label Cancel
5001
405 / 505
FDXE / FDXG
Signature Proof of Delivery
5002
404 / 504
FDXE / FDXG
Tracking
5004
420 / 520
FDXE / FDXG
Tracking Notifications
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Description
11
What’s New
What’s New
Feature
Benefits
Brazil Tax ID Validation
Due to the mandatory regulations governing non-document shipments to Brazil, enhancements have been made
to the 021 Ship a Package Request transaction to curb custom delays and shipment returns. The two changes
are :
•
Tag 118 (Recipient SSN/EIN) is now required for non-document shipments to Brazil.
•
Tag 2424 (Recipient Tax ID Type) has been added to identify the type of data entered in tag 118. The
valid values for this tag are:
•
1 – Passport number (If the recipient is not a Brazilian resident.)
•
2 – Individual tax ID (Brazilian resident Tax ID)
•
3 – Company tax ID (Brazilian company Tax ID)
Non-document shipments to Brazil will fail without values in both 118 and 2424.
Pass References to Print on Thermal Label
API will now pass reference fields so that thermal labels can be printed with these references. The 021 Ship a
Package Request uses the following optional tags for you to send values:
•
3001 (FedEx Purchase Order)
•
3002 (FedEx Invoice)
•
38 (Sender Department)
PDF Label
The Label Media Type tag (1370) has a new value, 8, to request Portable Document Format (PDF) for plain
paper labels. This helps to resolve the scaling (resizing) issues that affect label certification. To generate PDF
labels, you will need :
•
Adobe Reader 6.0 or higher to process requested labels in PDF
•
The printer driver configuration set to ‘none’ for print scaling
•
Tag 1368 (Label Type) set to 2 (2D common label)
•
Tag 1369 (Printer Type) set to 1 (laser printer)
US Spanish
There is a large Spanish speaking population in the United States who only speak Spanish. To embrace this
portion of the population, FedEx has enlarged the language/locale code to include Spanish in the US. This will
affect the 021 Ship a Package Request, 037 Email Label Request, and 420 Tracking Notifications Request
transactions.
The new language/locale combination value is esUS and requires entry of
•
es in tag 1552 (Language Code) with US in tag 1968 (Language Locale Code)
•
es in tag 1972 (Reply Language Code) with US in tag 1973 (Reply Language Locale Code)
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
12
Referenced Documents
Referenced Documents
Title
FedEx Service Guide
Location
To download in .pdf format: http://www.fedex.com/us/services/pdf/index.html.
To request a printed copy, please call 1.800.Go.FedEx (1.800.463.3339).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
13
Tagged Transaction Layouts
Tagged Transaction Layouts
This section introduces the FedEx Tagged Transaction fields included in each of the transactions. Each transaction will be presented in a table format. The table columns
will be:
Column
Description
Field Tag
The tag corresponding to each of the defined fields. A comma should follow this field tag, followed in turn by the actual value of the field. For
example: 32,"My Company".
Field Name
The name of the transaction field.
Applicable Carrier
This column is used for identifying if a field tag is valid for use with which Service (Carrier).
Valid values:
FDXE = FedEx Express
FDXG = FedEx Ground
FDXC – FedEx Cargo
FXCC – FedEx Custom Critical
FXFR – FedEx Freight
Valid For
This column is used to identify how the functionality (field tag) is supported.
Valid values:
ALL = Applicable to U.S. and all international shipments
INTL = Applicable to non-Intra U.S. shipments
USD = Applicable to U.S. shipments (U.S. to U.S.)
CA = Applicable to Canada (Intra/Inter-Canada)
PR = Applicable to Puerto Rico
Field Requirements
The information regarding the transaction field. Comments on the meaning of the field tag, and whether it is required, conditionally required, or
optional. "Required" means that the field tag is required in the case of the specified "Applicable Carrier" and "Valid For" values.
Appendix A offers a comprehensive listing of the field characteristics in numeric order by field tag.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
14
Tagged Transaction Layouts
Field Tag Examples
Alpha-Numeric Field – Single Occurrence
The sender company name will be included in a transaction in the following manner:
4,"FedEx Corporation"
Alpha-Numeric Field – Multiple Occurrences
The second occurrence of commodity number of pieces in the shipment response transaction will be included in the transaction in the following manner:
76-2,"5"
NOTE:
A field tag with occurrence number of 0, as in 76-0, "5", will be ignored.
Numeric Field – Whole Number
The dimmed height will be included in a Ship Request transaction in the following manner:
57,"10"
Numeric Field – Two Explicit Decimal Positions
The base rate will be included in a shipping response transaction in the following manner:
1419,"50.00"
NOTE:
The fields do not need to be in numeric order when you are formatting your transaction. The only requirement is to always begin your data string with the 0
field tag and end the data string with 99,"".
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
15
Tagged Transaction Layouts – Transaction 211: Subscription/Registration Request
Transaction 211: Subscription/Registration Request
This is a one-time Request, meaning that a customer needs to subscribe to the FedEx API service only once. The transaction data and a unique meter number specific to
the customer’s FedEx account number will be returned to the client.
Field Tag
Field Name
Field Requirements
STANDARD INFO
0
Transaction Code
Required.
1
Customer Transaction Identifier
Optional.
This field 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.
10
Sender FedEx Account Number
Required.
This field tag should represent the FedEx account number for the FedEx customer to which the unique meter
number will be assigned.
498
Meter Number
The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive
a rate quote.
Note: This field tag should only be supplied within the Request when attempting to update the meter
information.
SUBSCRIBER
4003
Subscriber Contact Name
Required.
This field tag is only required if Company Name is not provided.
4007
Subscriber Company Name
Optional.
This field tag becomes required if Person Name is not provided.
4008
Subscriber Address Line 1
Required.
4009
Subscriber Address Line 2
Optional.
4011
Subscriber City Name
Required.
4012
Subscriber State Code
Required if Sender Country Code is US or Canada.
4013
Subscriber Postal Code
Required.
Required only if Recipient Country Code is US or CA.
May be required for other postal-aware countries.
Represents the postal code of the subscriber of account.
Valid characters: A-Z; 0-9; a-z
4014
Subscriber Country Code
Required.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
16
Tagged Transaction Layouts – Transaction 211: Subscription/Registration Request
Field Tag
Field Name
Field Requirements
4015
Subscriber Phone Number
Required.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include embedded special
characters.
4017
Subscriber Pager Number
Optional.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include embedded special
characters.
4018
Subscriber Email Address
Optional.
4022
Subscriber Fax Number
Optional.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include embedded special
characters.
TRANSACTION TERMINATOR
99
End Of Record
Required.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
17
Tagged Transaction Layouts – Transaction 211: Subscription/Registration Request
Example of Transaction 211: Subscription/Registration Request
If you are a new subscriber to the FedEx Ship Manager API, the first thing you need to do is send the 211 transaction 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, and 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:
Data File
Field Description
0,"211"
Transaction Type 211 is Subscription/Registration Request.
1,"my 1st transaction to FedEx"
Customer Transaction identifier.
4003,"Jim Smith"
Your name.
4007,"Creative Widgets"
Your company’s name.
4011"Anycity"
Your city name.
4008,"123 Main Street"
Your street address.
4015,"5405559900"
Your phone number, no dashes.
4012"VA"
Your state abbreviation.
10,"123456789"
Your FedEx account number.
4013,"24060"
Your ZIP code.
4014,"US"
Your Country Code. See Appendix B for a list of FedEx Country Codes.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
18
Tagged Transaction Layouts – Transaction 311: Subscription/Registration Reply
Transaction 311: Subscription/Registration Reply
Once you submit your Request to subscribe to FedEx, you will receive a subscription Reply. The format of the Reply is as follows:
Field Tag
Field Name
Field Requirements
STANDARD INFO
0
Transaction Code
Required.
1
Customer Transaction Identifier
Optional.
Returned if the customer included it in the Request transaction, containing the same value.
ERROR HANDLING
2
Transaction Error Code
Passed back in the Reply indicating failed processing of transaction. For an erroneous transaction, the error
code will be placed in this field tag.
3
Transaction Error Message
Passed back in the Reply indicating failed processing of transaction. For an erroneous transaction, the error
message will be placed in this field tag.
Meter Number
Returned in successful Reply. Meter number assigned to the FedEx account number.
Subscription Service Name
Returns (in multiple occurrences of the field) the FedEx Services the customer is eligible for.
SUBSCRIBER
498
4021-#
TRANSACTION TERMINATOR
99
End Of Record
Returned.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
19
Tagged Transaction Layouts – Transaction 311: Subscription/Registration Reply
Example of Transaction 311: Subscription/Registration Reply
Continuing with the example on the previous page, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"311"
Transaction Type 311 is Subscribe/Register Reply.
1,"Subscribe"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
498,"1234567"
Your meter number.
4021-1,"0001"
Authorized for FedEx Express Shipping.
4021-2,"0002"
Authorized for FedEx Ground Shipping.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the ZIP code entered had only 3
digits, FedEx would respond with the following transaction:
Data File
Field Description
0,"311"
Transaction Type 311 is Subscribe/Register Reply.
1,"Subscribe"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"1235"
Error code.
3,"Bad Zip Format"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
20
Tagged Transaction Layouts – Transaction 019: Service Availability Request
Transaction 019: Service Availability Request (For FedEx Express Only)
The Service Availability Request 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 fields 1274 (service) and 1273 (packaging type) in the Request transaction. Only information regarding that single
service and packaging type will be returned in the 119 Reply transaction. To obtain a list of all available services for a certain origin and destination, omit fields 1273 and
1274 from the Request. The Reply will contain information on every available service.
Field Tag
Field Name
Field Requirements
STANDARD INFO
0
Transaction Code
Required.
1
Customer Transaction Identifier
Optional.
This field 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.
10
Sender FedEx Account Number
Required.
The FedEx account number of the Sender is required to successfully receive a Service Availability response.
Meter Number
Required.
The unique meter number assigned to the Sender’s FedEx account number is required to successfully receive a
Service Availability response.
Carrier Code
Required.
Valid value: FDXE – FedEx Express
Sender Postal Code
Required only if Sender Country Code is US or CA.
Postal code may also 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
Sender Country Code
Required.
Represents the country from which the shipment will be originating.
Recipient Postal Code
Required only if Recipient Country Code is US or CA.
Postal code may also 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
498
3025
ORIGIN
9
117
DESTINATION
17
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
21
Tagged Transaction Layouts – Transaction 019: Service Availability Request
Field Tag
50
Field Name
Recipient Country Code
Field Requirements
Required.
Represents the country code to which the shipment is destined.
SHIPMENT INFO
24
Ship Date
Recommended.
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.
Format: YYYYMMDD
Defaults to current system date if not present.
116
Package Total
(Total Number of Pieces)
Required.
For multiple-piece shipments (MPS), FDXE only applies to COD and international.
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.
Valid values: 1 to 999
1273
Packaging Type
Optional.
1274
Service Type
Optional.
TRANSACTION TERMINATOR
99
End Of Record
Required.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
22
Tagged Transaction Layouts – Transaction 019: Service Availability Request
Examples of Transaction 019: Service Availability Request (For FedEx Express Only)
You plan to ship a FedEx Express package on Monday, May 21, 2005. The origin is GA, 30052. The destination is VA, 24012. It is a single piece shipment. To determine
which FedEx Express services are available, your input transaction is formatted as follows:
Data File
Field Description
0,"019"
Transaction Type 019.
1,"Service Availability Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
498,"1234567"
Shipper meter number.
3025,"FDXE"
Carrier Code.
9,"30052"
Shipper ZIP code.
10,"123456789"
Shipper FedEx account number.
17,"24012"
Destination ZIP code.
50,"US"
Destination Country code.
117,"US"
Shipper’s country code.
24,"20050521"
Date of the shipment (May 21, 2005).
116,"1"
Package total.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
23
Tagged Transaction Layouts – Transaction 019: Service Availability Request
You plan to ship a FedEx Express package on Monday, May 21, 2005. The origin is GA, 30052. The destination is VA, 24012. It is a single piece shipment, and the
packaging is a tube. If you want to know if FedEx Priority Overnight service is available, your input transaction is formatted as follows:
Data File
Field Description
0,"019"
Transaction Type 019.
1,"Service Availability Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
498,"1234567"
Shipper meter number.
3025,"FDXE"
Carrier Code.
9,"30052"
Shipper ZIP code.
10,"123456789"
Shipper FedEx account number.
17,"24012"
Destination ZIP code.
50,"US"
Destination Country code.
117,"US"
Shipper’s country code.
24,"20050521"
Date of the shipment (May 21, 2005).
116,"1"
Package total.
1273,"04"
Packaging type (tube).
1274,"01"
Service type (Priority Overnight).
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
24
Tagged Transaction Layouts – Transaction 119: Service Availability Reply
Transaction 119: Service Availability Reply (For FedEx Express Only)
In response to the previous Service Availability Request transaction, your Reply transaction would be formatted as follows:
Field Tag
Field Name
Field Requirements
STANDARD INFO
0
Transaction Code
Required.
1
Customer Transaction Identifier
Optional.
Returned if the customer included it in the Request, containing the same value.
ERROR HANDLING
2
Transaction Error Code
Passed back in response indicating failed processing. For an erroneous Request or server failure, the error code
will be placed in this field tag.
3
Transaction Error Message
Passed back in response transaction indicating failed processing. For an erroneous transaction, the error
message will be placed in this field tag.
SERVICE INFORMATION
1133
Service Availability Service Count
FedEx service(s) available for the Requested origin/destination pairing.
There may be up to 22 occurrences of the Entry grouping representing services available.
AVAILABLE SERVICES
409-#
Delivery Date
In regards to international services, the delivery date availability is limited to some postal supported countries.
The delivery date will be returned if available.
194-#
Delivery Day
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.
195-#
Destination Station ID
FedEx location identifier of the package destination.
1274-#
Service Type
Returned.
TRANSACTION TERMINATOR
99
End Of Record
Returned.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
25
Tagged Transaction Layouts – Transaction 119: Service Availability Reply
Examples of Transaction 119: Service Availability Reply
The following is an example of the Reply transaction format for Requests that specify that all available services should be returned:
Data File
Field Description
0,"119"
Transaction Type 119.
1,"Service Availability Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
1133,"08"
Service count. Eight FedEx Express services are available.
1274-1,"01"
Service Type (Priority Overnight).
194-1,"TUE"
Delivery Day.
195-1,"ROA"
Destination Station ID.
409-1,"22MAY01"
Delivery Date.
1274-2,"03"
Service Type (Economy Two Day).
194-2,"WED"
Delivery Day.
195-2,"ROA"
Destination Station ID.
409-2,"23MAY01"
Delivery Date.
1274-3,"06"
Service Type (First Overnight).
194-3,"TUE"
Delivery Day.
195-3,"ROA"
Destination Station ID.
409-3,"22MAY01"
Delivery Date.
1274-4,"05"
Type (Standard Overnight).
194-4,"TUE"
Delivery Day.
195-4,"ROA"
Destination Station ID.
409-4,"22MAY01"
Delivery Date.
1274-5,"80"
Service Type (Two Day Freight).
194-5,"WED"
Delivery Day.
195-5,"ROA"
Destination Station ID.
409-5,"23MAY01"
Delivery Date.
1274-6,"70"
Service Type (Overnight Freight).
194-6,"TUE"
Delivery Day.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
26
Tagged Transaction Layouts – Transaction 119: Service Availability Reply
Data File
Field Description
195-6,"ROA"
Destination Station ID.
409-6,"22MAY01"
Delivery Date.
1274-7,"20"
Service Type (Express Saver).
194-7,"WED"
Delivery Day.
195-7,"ROA"
Destination Station ID.
409-7,"23MAY01"
Delivery Date.
99,""
The required transaction terminator. It must be the last pair in the transaction.
The following is an example of the Reply transaction format for Requests regarding the availability of a single service type:
Data File
Field Description
0,"119"
Transaction Type 119.
1,"Service Availability Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
1133,"01"
Service count.
1274-1,"01"
Service Type (Priority Overnight).
194-1,"TUE"
Delivery Day.
195-1,"ROA"
Destination Station ID.
409-1,"22MAY01"
Delivery Date.
99,""
The required transaction terminator. It must be the last pair in the transaction.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. For example, if the destination ZIP code were
not served by FedEx, the response transaction would be:
Data File
Field Description
0,"119"
Transaction Type 119 is Service Availability Reply.
1,"112301"
Transaction identifier.
2,"6011"
Error code.
3,"Postal code not served."
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
27
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Transaction 022: Rate a Package Request
As a courtesy to our customers, FedEx provides an estimated rate for a shipment if requested. The courtesy rates returned are estimates and may differ from the actual
amount invoiced depending upon the specific circumstances regarding the shipment. The following fields can be included in the U.S. Rate a Package Request:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
ALL
The FedEx account number of the Sender is required to successfully receive a rate
quote.
498
Meter Number
FDXE/FDXG
ALL
The unique meter number assigned to the Sender’s FedEx account number is required
to successfully receive a rate quote.
3025
Carrier Code
FDXE/FDXG
ALL
Required.
Valid values:
FDXE – FedEx Express rate quotes
FDXG – FedEx Ground rate quotes
8
Sender State
FDXE/FDXG
ALL
Required only if Sender Country Code is US or CA.
Represents the state or province from which the shipment will be originating.
9
Sender Postal Code
FDXE/FDXG
ALL
Required only if Sender Country Code is US or CA.
Postal code may also 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
Sender Country Code
FDXE/FDXG
ALL
Required.
Represents the country from which the shipment will be originating.
FDXE/FDXG
ALL
Required only if Recipient Country Code is US or CA.
Represents the state or province to which the shipment is destined.
ORIGIN
117
DESTINATION
16
Recipient State
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
28
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
17
Recipient Postal Code
FDXE/FDXG
ALL
Required only if Recipient Country Code is US or CA.
Postal code may also 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
50
Recipient Country Code
FDXE/FDXG
ALL
Required.
Represents the country code to which the shipment is destined.
Rate Indicator
FDXE/FDXG
USD
ALL
Optional.
Ship Date
FDXE/FDXG
ALL
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.
Format: YYYYMMDD
Defaults to current system date if not present.
Pay Type
FDXE/FDXG
ALL
Optional.
Defaults to bill sender.
If value other than 1 (bill sender) is used, bill sender rates will still be returned.
RATE DATA
1529
SHIPMENT DATE/TIME STAMP
24
PAYMENT
23
SHIPMENT/ PACKAGE INFORMATION
57
Dim Height
FDXE/FDXG
ALL
Optional.
Required only if a FedEx Express heavyweight service is selected for the shipment.
Only applicable if the package type (field tag 1273) is 01 (Customer Packaging).
58
Dim Width
FDXE/FDXG
ALL
Optional.
Required only if a FedEx Express heavyweight service is selected for the shipment.
Only applicable if the package type (field tag 1273) is 01 (Customer Packaging).
59
Dim Length
FDXE/FDXG
ALL
Optional.
Required only if a FedEx Express heavyweight service is selected for the shipment.
Only applicable if the package type (field tag 1273) is 01 (Customer Packaging).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
29
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
68
Customs/Declared Value Currency
Type
FDXE/FDXG
ALL
Optional.
Required if field tag 1415 (Declared Value/Carriage Value) is provided.
Must be equal to USD Only.
75
Weight Units
FDXE/FDXG
ALL
Required.
Valid weight types:
• LBS
• KGS
Must be LBS on a U.S. rate quote.
116
Package Total
(Total Number of Pieces)
FDXE/FDXG
ALL
Required.
For multiple-piece shipping, FDXE only applies to COD and international.
Total number of packages in a shipment including the master package.
May be used for international shipments if supplying shipment Total Pieces and Total
Weight.
1116
Dim Units
FDXE/FDXG
ALL
Required if dimensions are entered.
Only applicable if the package type (field tag 1273) is 01 (Customer Packaging).
U.S. FedEx Express must be in inches.
1273
Packaging Type
FDXE/FDXG
ALL
Required.
If value entered in this field is 06 (FedEx Letter), MPS rate quote is not allowed.
1274
Service Type
FDXE/FDXG
ALL
Required.
1401
Total Package Weight
FDXE/FDXG
ALL
Required.
1415
Declared Value/Carriage Value
FDXE/FDXG
ALL
Required, except FedEx Express international document shipments.
SPECIAL SERVICE
27
COD Flag
FDXE/FDXG
USD
ALL
Y if shipment is Collect on Delivery (COD).
If Flag is Y and the customer is enabled by FedEx for Electronic COD (ECOD), then
ECOD will take affect.
440
Residential Delivery Flag
FDXE/FDXG
USD
Y if shipment is Residential Delivery. If Recipient Address is in a rural area (defined by
table lookup), additional charge will be applied. This field is not applicable to the FedEx
Home Delivery service.
1120
Inside Pickup Flag
FDXE
USD
Y if shipment is Inside Pickup.
1121
Inside Delivery Flag
FDXE
USD
Y if shipment is Inside Delivery.
1174
BSO Flag
FDXE
INTL
Y if shipment is BSO (Broker Select Option).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
30
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1200
HAL Flag
FDXE
ALL
Y if shipment is Hold at Location.
1266
Saturday Delivery Flag
FDXE
ALL
Y if shipment is targeted for Saturday delivery.
1267
Saturday Pickup Flag
FDXE
ALL
Y if shipment is targeted for Saturday pickup.
1268
Dry Ice Flag
FDXE
ALL
Y if shipment contains dry ice.
1331
Dangerous Goods Type
FDXE
ALL
A if shipment contains accessible dangerous goods, else I for inaccessible dangerous
goods.
Not allowed with Return Shipments if field tag 2382 (Return Shipment Indicator) is set to
1, 2, 3 or 4.
1332
Alcohol Flag
FDXE
ALL
Y if shipment is alcohol, else N.
1333
Drop Off Type
FDXE
ALL
Required.
1432
Customer COD Amount
FDXG
ALL
Required if the COD or ECOD Flag is set to Y.
2399
Signature Option
FDXE/FDXG
ALL
Optional.
Valid values:
1 = Deliver without Signature
2 = Indirect Signature
3 = Direct Signature
4 = Adult Signature
For FedEx Express shipments, the "Deliver without Signature" option will not be allowed
when the following special services are requested:
• Alcohol
• Hold at Location
• Dangerous Goods
• Declared Value greater than $500
3000
COD Collection Type
FDXG
ALL
Required if the COD or ECOD Flag is set to Y.
Cash is only applicable with FedEx Ground.
3015
Hazardous Materials Flag
FDXG
USD
Y if shipment contains hazardous materials
Not allowed with Return Shipments if field tag 2382 (Return Shipment Indicator) is set to
1, 2, 3 or 4.
3018
Nonstandard Container Flag
FDXG
ALL
Y if nonstandard container.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
31
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3020
Home Delivery Type
FDXG
USD
Required if shipping FedEx Home Delivery (FHD).
Not allowed with Return Shipments if field tag 2382 (Return Shipment Indicator) is set to
1, 2, 3 or 4.
3231
Residential Pickup Flag
FDXG
USD
Optional.
Y = Residential
N = Commercial/Business
Indicates the type of pickup location for a FedEx Ground Email Label and/or FedEx
Ground Call Tag.
(Only applicable if field tag 2382 = 3 or 4.)
VARIABLE HANDLING
1427
Variable Handling Charge
FDXE/FDXG
ALL
Optional.
Required in conjunction with Variable Handling Type.
Allowed with Return Shipments if field tag 2382 (Return Shipment Indicator) is set to 0 or
2 only.
1588
Variable Handling Type
FDXE/FDXG
ALL
Optional.
If valid value is present, a valid Variable Handling Charge is required.
1606
Variable Handling Charge Level
FDXE/FDXG
ALL
Optional.
Only applicable if valid Variable Handling Type is present.
Returns Shipment Indicator
FDXE/FDXG
USD
Optional.
Indicates the type of return shipment:
Valid values:
2 = Print Return Label
3 = Email Label
4 = FedEx Tag (ExpressTag/CallTag – carrier code dependency)
FDXE/FDXG
ALL
Required.
RETURNS
2382
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
32
Tagged Transaction Layouts – Transaction 022: Rate a Package Request
Example of Transaction 022: Rate a Package Request
On Friday, February 6, 2005 your customer, ABC Widget, requests a shipment of parts to be delivered on Saturday, February 14. 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, and 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 Atlanta, GA 30052.
To determine your cost of shipping this package, your input transaction is formatted as follows:
Data File
Field Description
0,"022"
Transaction Type 022 is Rate a Package Request.
1,"Rate Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
498,"1234567"
Shipper meter number.
3025,"FDXE"
Carrier Code.
9,"30052"
Shipper ZIP code.
8,"GA"
Shipper state.
10,"123456789"
Shipper FedEx account number.
16,"VA"
Destination state abbreviation.
17,"24012"
Destination ZIP code.
50,"US"
Destination Country code.
117,"US"
Shipper’s country code.
1401,"2.0"
Shipment weight.
75,"LBS"
Weight units.
23,"1"
Pay type is Bill Shipper.
24,"20050206"
Date of the shipment (February 6, 2005).
116,"1"
Package total.
1415,"10.00"
Declared value.
68, "USD"
Customs/Declared Value Currency Type.
1273,"03"
Packaging type.
1274,"03"
Service type.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
33
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Transaction 122: Rate a Package Reply
In response to the previous rating Request transaction, your Reply transaction would be formatted as follows:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
Returned if the customer included it in the Request transaction, containing the same
value.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction.
3
Transaction Error Message
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction.
431
Dim Flag
FDXE/FDXG
ALL
Y if Dim applies.
1089
Rate Scale Code
FDXE
USD
Returned.
1090
Rate Currency Type
FDXE/FDXG
ALL
Rate currency type returned upon successful transaction Reply.
1092
Rate Zone
FDXE
USD
Returned.
1402
Bill Weight
FDXE/FDXG
ALL
Bill Weight = Dim if Dim applies.
1403
Dim Weight
FDXE
ALL
Returned if applicable.
1416
Base Rate Amount
FDXE/FDXG
ALL
Base rate amount returned in successful transaction Reply.
1417
Total Surcharge Amount
FDXE/FDXG
ALL
Total surcharge amount returned in successful transaction Reply.
1418
Total Discount Amount
FDXE/FDXG
ALL
Total discount amount returned upon successful transaction Reply.
1419
Net Charge Amount
FDXE/FDXG
ALL
Net charge amount returned upon successful transaction Reply.
1420
Total Rebate Amount
FDXE
ALL
Total rebate amount return upon successful transaction Reply.
1507
List Total Surcharge Amount
FDXE
FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Sum of total surcharges.
1525
Effective Net Discount
FDXE
FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List Net Charge – Net Charge Amount.
RATING
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
34
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1528
List Net Charge Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Rate + Surcharges – Discounts.
1530
List Base Rate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List base rate amount.
1531
List Total Discount Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total discount amount (will always = 0).
1532
List Total Rebate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total rebate amount (will always = 0).
2399
Signature Option
FDXE/FDXG
ALL
Optional.
2405
Ineligible for MBG
FDXG
ALL
Y if a shipment does not qualify for MBG (Money Back Guarantee).
3124
Oversize Classification
FDXG
ALL
Required.
Valid values: (Defaults to 0)
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 90lb. minimum billable weight. An additional oversize charge will be assessed on any
package measuring more than 130" in length and girth.
POSSIBLE SURCHARGES
* Indicates that the surcharge is influenced by the Rate Indicator (field tag 1529)/List Rate field.
2402
Signature Option Fee
FDXE/FDXG
ALL
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
2403
List Signature Option Fee
FDXE/FDXG
ALL
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
35
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3095
Appointment Delivery Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3096
*List Appointment Delivery Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3101
Home Delivery Date Certain
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place
3102
*List Home Delivery Date Certain
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3103
Home Delivery Evening Delivery
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3104
*List Home Delivery Evening Delivery
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3107
Additional Handling Charge (AHS) /
Non Standard Container Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
For FedEx Express, this field tag will contain any surcharges resulting from an Additional
Handling Charge (AHS).
For FedEx Ground, this field tag will contain any surcharges resulting from the use of a
Non Standard Carrier.
3108
*List Additional Handling Charge
(AHS) / Non Standard Container
Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
For FedEx Express, this field tag will contain any surcharges resulting from an Additional
Handling Charge (AHS).
For FedEx Ground, this field tag will contain any surcharges resulting from the use of a
Non Standard Carrier.
3109
Hazardous Materials Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3110
*List Hazardous Materials Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3111
Residential Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3112
*List Residential Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3053
Multiweight Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3054
Shipment Net Charge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3115
*List Shipment Net Charge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1421
COD Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place
1422
*List COD Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1423
Saturday Pickup Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1424
*List Saturday Pickup Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
36
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1425
Declared Value Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1426
*List Declared Value Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1682
Oversize Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1683
List Oversize surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1641
Return Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1643
*List Return Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
2390
Email Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
2391
*List Email Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1672
FedEx Tag Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1673
*List FedEx Tag Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place
612
Harmonized Sales Tax (HST)
Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
613
Global Sales Tax (GST) Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
614
Provincial Sales Tax (PST) Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1434
Saturday Delivery Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1435
List Saturday Delivery Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1436
Dangerous Goods Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1437
List Dangerous Goods Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1438
Out of Pickup Area / H3 Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1439
List Out of Pickup Area / H3
Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1440
Out of Delivery Area / H3 Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1441
List Out of Delivery Area / H3
Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1442
Inside Pickup Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1443
List Inside Pickup Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1444
Inside Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1445
List Inside Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
37
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1446
Residential Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1447
List Residential Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1636
Delivery Area Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1637
List Delivery Area Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1639
List Fuel Surcharge
FDXE
ALL
Returned if applicable.
1640
FedEx International Controlled Export
(FICE) Surcharge
FDXE
INTL
Returned if applicable.
1642
Value Added Tax
FDXE
ALL
Returned if applicable.
1644
Offshore Surcharge
FDXE
INTL
Returned if applicable.
1645
List Offshore Surcharge
FDXE
INTL
Returned if applicable.
1649
Other Surcharges
FDXE
ALL
Returned if applicable.
1650
List Other Surcharges
FDXE
ALL
Returned if applicable.
VARIABLE HANDLING
1428
Variable Handling Charge Amount
FDXE/FDXG
ALL
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 field) plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1429
List Variable Handling Charge
Amount
FDXE/FDXG
ALL
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 field) plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1430
Total Customer Charge
FDXE/FDXG
ALL
Contains Shipper’s discounted Net Freight Charge (in the billing currency) plus Variable
Handling Charge Amount. Will contain piece level or shipment level dependent on the
Variable Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
1431
List Total Customer Charge
FDXE/FDXG
ALL
Contains Shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling
Charge Amount. Will contain piece level or shipment level dependent on the Variable
Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
38
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3043
MTW Variable Handling
FDXG
ALL
Handling charge returned to the customer calculated with multiweight freight.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal.
3113
MTW Customer Total Charge
FDXG
ALL
Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal.
FDXE/FDXG
ALL
Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
39
Tagged Transaction Layouts – Transaction 122: Rate a Package Reply
Example of Transaction 122: U.S. Rate a Package Reply
The following is an example of the Reply transaction format:
Data File
Field Description
0,"122"
Transaction Type 122 is Rate a Package Reply.
1,"Rate Transaction"
Transaction Identifier. This field will be included in any error or Reply messages.
1419,"8.02"
Net charge amount.
1416,"10.25"
Base rate amount.
1417,"0.02"
Total surcharge amount.
1418,"2.25"
Total discount amount.
1402,"2.0"
Bill Weight.
1403,"4.0"
Dim Weight.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
40
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Transaction 025: Rate Available Services Request
Rate Available Services provides the ability to send a single Request in order to receive the FedEx service(s) available and corresponding rate quote(s) for your package,
service, and origin/destination criteria.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
ALL
The FedEx account number of the Sender is required to successfully receive a rate
quote and Service Availability response.
498
Meter Number
FDXE/FDXG
ALL
The unique meter number assigned to the Sender’s FedEx account number is required
to successfully receive a rate quote and Service Availability response.
3025
Carrier Code
FDXE/FDXG
ALL
Optional.
If FDXE indicated, Express returned in Reply data.
If FDXG indicated, Ground returned in Reply data.
If blank, Express and Ground (if applicable/available) returned in Reply data.
8
Sender State
FDXE/FDXG
ALL
Required only if Sender Country Code is US or CA.
Represents the state or province from which the shipment will be originating.
9
Sender Postal Code
FDXE/FDXG
ALL
Required only if Sender Country Code is US or CA.
Postal code may also be required for other postal-aware countries when rating an
international shipment.
Represents the postal code from which the shipment will be originating.
Valid characters: A-Z; 0-9; a-z
Sender Country Code
FDXE/FDXG
ALL
Required.
Represents the country from which the shipment will be originating.
FDXE/FDXG
ALL
Required only if Recipient Country Code is US or CA.
Represents the state or province to which the shipment is destined.
ORIGIN
117
DESTINATION
16
Recipient State
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
41
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
17
Recipient Postal Code
FDXE/FDXG
ALL
Required only if Recipient Country Code is US or CA.
Postal code may also be required for other postal-aware countries when rating an
international shipment.
Represents the postal code to which the shipment is destined.
Valid characters: A-Z; 0-9; a-z
50
Recipient Country Code
FDXE/FDXG
ALL
Required.
Represents the country code to which the shipment is destined.
FDXE/FDXG
ALL
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.
Format: YYYYMMDD
Defaults to current date if field tag is omitted.
SHIPMENT DATE/TIME STAMP
24
Ship Date
SHIPMENT/ PACKAGE INFORMATION
57
Dim Height
FDXE/FDXG
ALL
Required if field tag 1274 (Service Type) is not supplied or if FedEx Express
heavyweight service is selected.
Required if the package type (field tag 1273) is 01 (Customer Packaging) or is not
indicated.
58
Dim Width
FDXE/FDXG
ALL
Required if field tag 1274 (Service Type) is not supplied or if FedEx Express
heavyweight service is selected.
Required if the package type (field tag 1273) is 01 (Customer Packaging) or is not
indicated.
59
Dim Length
FDXE/FDXG
ALL
Required if field tag 1274 (Service Type) is not supplied or if FedEx Express
heavyweight service is selected.
Required if the package type (field tag 1273) is 01 (Customer Packaging) or is not
indicated.
68
Customs/Declared Value Currency
Type
FDXE/FDXG
INTL
ALL
Required if field tag 1415 (Declared Value/Carriage Value) is provided.
75
Weight Units
FDXE/FDXG
ALL
Optional for U.S.
Required for international.
Defaults to LBS for U.S.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
42
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
116
Package Total
FDXE/FDXG
ALL
ALL
Required.
1116
Dim Units
FDXE/FDXG
ALL
ALL
Required if dimensions are entered.
Only applicable if Dims apply, field tag 1273 (Package Type) is 01 (Customer
Packaging), or field tag 1274 (Service Type) is not indicated or indicates Heavyweight
service.
Defaults to IN for U.S.
1273
Packaging Type
FDXE/FDXG
ALL
Optional.
Defaults to 01 (Customer Packaging).
1274
Service Type
FDXE/FDXG
ALL
Optional.
If not present, all available service types apply.
1401
Total Package Weight/
Shipment total weight
FDXE/FDXG
USD
ALL
Required.
Used for MPS with field tag 116 (Package Total).
1415
Declared Value/Carriage Value
FDXE/FDXG
ALL
Optional.
Required for all shipments except FedEx Express international documents.
The declared value of package contents.
This value cannot exceed the total customs value.
RATE DATA
1427
Variable Handling Charge
FDXE/FDXG
ALL
Optional.
Required in conjunction with Variable Handling Type.
1529
Rate Indicator
FDXE/FDXG
USD
ALL
Optional.
1588
Variable Handling Type
FDXE/FDXG
ALL
Optional.
If valid value is present, a valid Variable Handling Charge is required.
1606
Variable Handling Charge Level
FDXE/FDXG
ALL
Optional.
Only applicable if valid Variable Handling Type is present.
FDXE/FDXG
USD
ALL
Y if shipment is COD.
For FedEx Ground shipments, if the flag is Y and the customer is enabled by FedEx for
Electronic COD (ECOD), then ECOD will take effect.
SPECIAL SERVICE
27
COD Flag
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
43
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1432
Customer COD Amount
FDXG
ALL
Required if COD Flag is set to Y.
3000
COD Collection Type
FDXG
ALL
Required if the COD Flag is set to Y.
440
Residential Delivery Flag
FDXE/FDXG
ALL
Y if shipment is Residential Delivery.
1120
Inside Pickup Flag
FDXE
USD
Y if shipment is Inside Pickup.
1121
Inside Delivery Flag
FDXE
USD
Y if shipment is Inside Delivery.
1174
BSO Flag
FDXE
INTL
Y if shipment is BSO.
1200
HAL Flag
FDXE
ALL
Y if shipment is Hold at Location.
1266
Saturday Delivery Flag
FDXE
ALL
Y if shipment is targeted for Saturday delivery.
1267
Saturday Pickup Flag
FDXE
ALL
Y if shipment is targeted for Saturday pickup.
1268
Dry Ice Flag
FDXE
ALL
Y if shipment contains dry ice.
1331
Dangerous Goods Type
FDXE
ALL
A if a shipment contains accessible dangerous goods, else I for inaccessible dangerous
goods.
1332
Alcohol Flag
FDXE
ALL
Y if shipment is alcohol, else optional.
1333
Drop Off Type
FDXE
ALL
Required.
2399
Signature Option
FDXE/FDXG
ALL
Optional.
Valid values:
1 = Deliver without Signature
2 = Indirect Signature
3 = Direct Signature
4 = Adult Signature
For FedEx Express shipments, the "Deliver without signature" option will not be allowed
when the following special services are requested:
• Alcohol
• Hold at Location
• Dangerous Goods
• Declared Value greater than $500
3015
Hazardous Materials Flag
FDXG
USD
Y if shipment contains hazardous materials.
3018
Nonstandard Container Flag
FDXG
ALL
Y if shipment packaging is a nonstandard container.
3020
FedEx Home Delivery Type
FDXG
USD
Optional.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
44
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Return Shipment Indicator
FDXE/FDXG
USD
Required for return shipments.
Indicates the type of return shipment.
Valid values:
2 = Print Return Label
3 = Email Label
4 = FedEx Tag (ExpressTag/CallTag – carrier code dependency)
FDXE/FDXG
ALL
Required.
Field Requirements
RETURNS
2382
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
45
Tagged Transaction Layouts – Transaction 025: Rate Available Services Request
Example of Transaction 025: Rate Available Services Request
You plan to ship a FedEx Express package on Tuesday, May 16, 2006. The origin is AR, 72704. The destination is CA, 92510. Shipment weight is 5 pounds. The sender
account number is 123456789 and the meter is 1234567. To determine which FedEx Express services are available and corresponding rates, your input transaction is
formatted as follows:
Data File
Field Description
0,"025"
Transaction Type 025.
1,"Express Rate Available Services
Request"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
Shipper FedEx account number.
117,"US"
Shipper’s country code.
1401,"5.0"
The shipment weight, in pounds, one explicit decimal.
498,"1234567"
Shipper meter number.
16,"CA"
The destination state abbreviation.
17,"92510"
Destination ZIP code.
24,"20060516"
Date of the shipment (May 16, 2006).
3025,"FDXE"
Carrier Code.
498,"123567"
Shipper’s meter number
50,"US"
Destination Country code.
68, "USD"
Customs/Declared Value Currency Type.
8,"AR"
Shipper state abbreviation.
9,"72704"
Shipper ZIP code.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
46
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Transaction 125: Rate Available Services Reply
Rate Available Services provides the ability to send a single Request in order to receive the FedEx service(s) available and corresponding rate quote(s) for your package,
service, and origin/destination criteria.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
Returned if the customer included it in the Request, containing the same value.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. For an erroneous
Request or server failure, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. Passed back in response
indicating failed processing. For an erroneous Request or server failure, the error code will
be placed in this field tag.
The errors in this section are warnings, not fatal errors. May indicate inability to rate some
services based on the specific information provided in the Request.
SOFT ERRORS
557
Message Type Code
FDXE/FDXG
ALL
Returned only if a soft error occurred while processing the transaction.
558
Message Code
FDXE/FDXG
ALL
Returned only if a soft error occurred while processing the transaction.
559
Message Text
FDXE/FDXG
ALL
Returned only if a soft error occurred while processing the transaction.
Service Availability Service Count
FDXE/FDXG
ALL
Returned if applicable.
Maximum count is 22.
Zero if none available.
431-#
Dim Flag
FDXE/FDXG
ALL
Y returned if Dim applies.
1089-#
Rate Scale Code
FDXE/FDXG
USD
Returned if applicable.
1090-#
Rate Currency Type
FDXE/FDXG
ALL
Express reflects currency of the sender’s account number (field tag 10).
Ground reflects currency of the origin country station.
SERVICE INFORMATION
1133
RATING
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
47
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1092
Rate Zone
FDXE/FDXG
USD
Returned if applicable.
1273
Packaging Type
FDXE/FDXG
ALL
Returned if applicable.
1376
Rate Weight Unit Of Measure
FDXE
INTL
For U.S. Requests, LBS will be returned.
For international Requests, the unit of measure from the Request will be returned.
1377
Dim Weight Unit Of Measure
FDXE
INTL
For U.S. Requests, LBS will be returned.
For international Requests, the unit of measure from the Request will be returned.
1402-#
Bill Weight
FDXE/FDXG
ALL
Returned if applicable.
1403-#
Dim Weight
FDXE
ALL
Returned if applicable.
1416-#
Base Rate Amount
FDXE/FDXG
ALL
Returned if applicable.
1417-#
Total Surcharge Amount
FDXE/FDXG
ALL
Returned if applicable.
1418-#
Total Discount Amount
FDXE/FDXG
ALL
Returned if applicable.
1419-#
Net Charge Amount
FDXE/FDXG
ALL
Returned if applicable.
1420-#
Total Rebate Amount
FDXE
ALL
Returned if applicable.
1507
List Total Surcharge Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Sum of total surcharges.
1525
Effective Net Discount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List Net Charge - Net Charge Amount.
1528
List Net Charge Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Rate + Surcharges - Discounts.
1530
List Base Rate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List base rate amount.
1531
List Total Discount Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total discount amount (will always = 0)
1532
List Total Rebate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total rebate amount (will always = 0)
1682
Oversize Surcharges
FDXE
ALL
Returned if applicable.
1683
List Oversize Surcharges
FDXE
ALL
Returned if applicable.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
48
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Field
Tag
3124
Field Name
Oversize Classification
Applicable
Carrier
Valid
For
FDXG
ALL
Field 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.
VARIABLE HANDLING
1428
Variable Handling Charge Amount
FDXE/FDXG
ALL
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 field), plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1429
List Variable Handling
Charge Amount
FDXE/FDXG
ALL
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 field), plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1430
Total Customer Charge
FDXE/FDXG
ALL
Contains Shipper’s discounted Net Freight Charge (in the billing currency) plus Variable
Handling Charge Amount. Will contain piece level or shipment level dependent on the
Variable Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
49
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Contains Shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling
Charge Amount. Will contain piece level or shipment level dependent on the Variable
Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
Field Requirements
1431
List Total Customer Charge
3043
MTW Variable Handling
FDXG
ALL
Handling charge returned to the customer calculated with multiweight freight.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
3113
MTW Customer Total Charge
FDXG
ALL
Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
FDXE/FDXG
USD
For some postal supported countries, delivery will be returned if available.
FDXE
USD
Returned if applicable.
AVAILABLE SERVICES
194-#
Delivery Day
195-#
Destination Station ID
409-#
Delivery Date
FDXE/FDXG
USD
For some postal supported countries, delivery will be returned if available.
1273-#
Packaging Type
FDXE/FDXG
ALL
Returned if applicable.
1274-#
Service Type
FDXE/FDXG
ALL
Returned if applicable.
2399-#
Signature Option
FDXE/FDXG
ALL
Optional.
2405-#
Ineligible for MBG
FDXG
ALL
Y if a shipment does not qualify for MBG (Money Back Guarantee).
3058-#
Time in Transit
FDXG
USD
Returned if applicable.
FDXE/FDXG
ALL
Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
50
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Example of Transaction 125: Rate Available Services Reply
The following is an example of the Reply transaction format for the Request example noted previously.
Data File
Field Description
0,"125"
Transaction Type 125.
1,"Express Rate Available Services
Request"
Transaction Identifier. This field will be included in any error or Reply messages.
1376,"LBS"
Rate Weight Unit Of Measure
1377,"LBS"
Dim Weight Unit Of Measure
1092,"6"
Rate zone (Zone 0-A).
1133,"4"
Service count. Four FedEx Express services are available.
2399-1,"0"
Signature Option (not indicated)
1273-1,"01"
Packaging Type is Your Packaging.
1274-1,"01"
Service Type (Priority Overnight).
1090-1,"USD"
Rate currency type.
1089-1,"01574"
Rate scale.
431-1,"N"
Dim weight used flag.
1402-1,"5.0"
Billed weight.
1416-1,"45.50"
Base rate amount.
1417-1,"2.64"
Total surcharge amount.
1418-1,"25.94"
Total discount amount.
1419-1,"22.20"
Net charge amount.
1420-1,"0.00"
Total Rebate Amount
194-1,"WED"
Delivery Day.
195-1,"ONT"
Destination Station ID.
409-1,"17MAY06"
Delivery Date.
2399-2,"0"
Signature Option (not indicated)
1273-2,"01"
Packaging Type is Your Packaging.
1274-2,"03"
Service Type (2Day).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
51
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Data File
Field Description
1090-2,"USD"
Rate currency type.
1089-2,"06068"
Rate scale.
431-2,"N"
Dim weight used flag.
1402-2,"5.0"
Billed weight.
1416-2,"19.50"
Base rate amount.
1417-2,"1.32"
Total surcharge amount.
1418-2,"9.75"
Total discount amount.
1419-2,"11.07"
Net charge amount.
1420-2,"0.00"
Total Rebate Amount
194-2,"THU"
Delivery Day.
195-2,"ONT"
Destination Station ID.
409-2,"18MAY06"
Delivery Date.
2399-3,"0"
Signature Option (not indicated)
1273-3,"01"
Packaging Type is Your Packaging.
1274-3,"05"
Service Type (FedEx Standard Overnight).
1090-3,"USD"
Rate currency type.
1089-3,"01371"
Rate scale.
431-3,"N"
Dim weight used flag.
1402-3,"5.0"
Billed weight.
1416-3,"39.25"
Base rate amount.
1417-3,"2.54"
Total surcharge amount.
1418-3,"20.42"
Total discount amount.
1419-3,"21.37"
Net charge amount.
1420-3,"0.00"
Total Rebate Amount
194-3,"WED"
Delivery Day.
195-3,"ONT"
Destination Station ID.
409-3,"17MAY06"
Delivery Date.
2399-4,"0"
Signature Option (not indicated)
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
52
Tagged Transaction Layouts – Transaction 125: Rate Available Services Reply
Data File
Field Description
1273-4,"01"
Packaging Type is Your Packaging.
1274-4,"20"
Service Type (FedEx Express Saver).
1090-4,"USD"
Rate currency type.
1089-4,"07175"
Rate scale.
431-4,"N"
Dim weight used flag.
1402-4,"5.0"
Billed weight.
1416-4,"14.90"
Base rate amount.
1417-4,"1.07"
Total surcharge amount.
1418-4,"7.00"
Total discount amount.
1419-4,"8.97"
Net charge amount.
1420-4,"0.00"
Total Rebate Amount
194-4,"FRI"
Delivery Day.
195-4,"ONT"
Destination Station ID.
409-4,"19MAY06"
Delivery Date.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
53
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Transaction 021: Ship a Package Request
When sending a Ship a Package Request to the FedEx server, there is information that the server requires before it will process the Request.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
This field 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.
10
Sender FedEx Account Number
FDXE/FDXG
ALL
The FedEx account number of the Sender is required to successfully process a
shipment Request.
498
Meter Number
FDXE/FDXG
ALL
The unique meter number assigned to the Sender’s FedEx account number is
required to successfully process a shipment Request.
3025
Carrier Code
FDXE/FDXG
ALL
Required.
Valid values:
FDXE – FedEx Express shipment Request
FDXG – FedEx Ground shipment Request
4
Sender Company
FDXE/FDXG
ALL
Required if the sender contact name is not passed in the transaction.
If included in the transaction, a minimum of 3 alpha characters must be passed.
5
Sender Address Line 1
FDXE/FDXG
ALL
Required.
Primary address line from which the shipment is originating.
6
Sender Address Line 2
FDXE/FDXG
ALL
Optional.
Secondary address line from which the shipment is originating.
7
Sender City
FDXE/FDXG
ALL
Required.
City name from which the shipment is originating.
Minimum of 3 alpha characters must be passed for shipping.
8
Sender State
FDXE/FDXG
ALL
Required for shipping only if Country Code is US or CA.
State code from which the shipment is originating.
ORIGIN
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
54
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
9
Sender Postal Code
FDXE/FDXG
ALL
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
32
Sender Contact Name
FDXE/FDXG
ALL
Required if the sender Company Name is not passed in the transaction.
If included in the transaction, a minimum of 3 alpha characters must be passed.
38
Sender Department
FDXE/FDXG
ALL
Optional.
Name of the department from which the shipment is originating.
Displays on the thermal label for Express.
117
Sender Country Code
FDXE/FDXG
ALL
Required.
Represents the country from which the shipment will be originating.
183
Sender Phone Number
FDXE/FDXG
ALL
Required.
The phone number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
1103
Sender Fax
FDXE/FDXG
ALL
Optional.
The fax number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
1139
Sender SSN/EIN
FDXE/FDXG
INTL
Required for any international shipment.
If SSN/EIN Identifier (1352) = S then a 9-digit SSN is required.
If SSN/EIN Identifier (1352) = E then a 9-digit plus 2-alpha EIN is required.
1201
Sender Email Address
FDXE/FDXG
ALL
Optional.
Required field for ShipAlert.
The email address of the person initiating the shipment.
1341
Sender Pager Number
FDXE/FDXG
ALL
Optional.
The pager number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
DESTINATION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
55
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
11
Recipient Company
FDXE/FDXG
ALL
Required if Recipient Contact Name was not passed in the Request transaction.
If entered, a minimum of 3 alpha characters must be passed.
12
Recipient Contact Name
FDXE/FDXG
ALL
Required if Recipient Company Name was not passed in the Request transaction and
COD service is selected.
If passed in the transaction, a minimum of 3 alpha characters must be passed.
13
Recipient Address Line 1
FDXE/FDXG
ALL
Required.
Primary address line to which the shipment is destined.
14
Recipient Address Line 2
FDXE/FDXG
ALL
Optional.
Secondary address line to which the shipment is destined.
15
Recipient City
FDXE/FDXG
ALL
Required.
Name of the city to which the shipment is destined.
A minimum of 3 alpha characters must be passed.
16
Recipient State
FDXE/FDXG
ALL
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.
17
Recipient Postal Code
FDXE/FDXG
ALL
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
18
Recipient Phone Number
FDXE/FDXG
ALL
Required.
Phone number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
50
Recipient Country Code
FDXE/FDXG
ALL
Required.
Name of the country to which the shipment is destined.
118
Recipient SSN/EIN
FDXE/FDXG
INTL
Optional for destinations other than Brazil.
Required for non-document shipments to Brazil. For these shipments, tag 118 should
contain Brazilian resident tax ID or Brazilian company tax ID or passport number of
recipient if the recipient is not a Brazilian citizen.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
56
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
2424
Recipient Tax ID Type
FDXE
INTL
Required for non-document shipments to Brazil. Optional for other destinations.
Type of Brazil Tax ID supplied in tag 118 (Recipient SSN/EIN).
Valid values:
1 – Passport number
2 – Individual Tax ID
3 – Company Tax ID
1145
Recipient Department
FDXE/FDXG
ALL
Optional.
Name of the department to whom the shipment is destined.
1202
Recipient Email Address
FDXE/FDXG
ALL
Optional.
Email address for the contact person to whom the shipment is destined.
1342
Recipient Pager Number
FDXE/FDXG
ALL
Optional.
Pager number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
2254
Recipient Fax Number
FDXE/FDXG
ALL
Optional.
Fax number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
2407
Recipient Location Number
FDXG
ALL
Optional.
Recipient location number/store number.
This value in this field is embedded in the 2D barcode.
Valid characters: [A-Z ;a-z ;0-9]
Any character other than A-Z, a-z, 0-9 will be stripped.
If the length is greater than 10, characters beyond the 10th position will be truncated.
SHIPMENT DATE/TIME STAMP
24
Ship Date
FDXE/FDXG
ALL
Required if Future Ship Date Flag is set to Y. Will be overridden by today’s date if
Future Ship Date Flag is set to N.
Should not be a past date or a date that is more than 10 days in the future.
Format: YYYYMMDD
1115
Ship Time
FDXE/FDXG
ALL
Required.
Time of shipment based on shipper's time zone.
Defaults to the current time, CDT.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
57
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Required for FDXG.
A value of N causes any passed Ship Date (field tag 24) to be overridden by today’s
date. If a value of Y is entered, the passed Ship Date will not be overridden.
For FDXE, defaults to N.
Y if shipment is scheduled for a future date.
Date must be less than ten days in advance.
Rate Indicator
FDXE/FDXG
USD
ALL
Optional.
20
Payer Account Number
FDXE/FDXG
ALL
For FedEx Express shipping, required if Pay Type is 2 (Bill Recipient) or 3 (Bill Third
Party).
For FedEx Ground shipping, required if Pay Type is 3 (Bill Third Party).
23
Pay Type
FDXE/FDXG
ALL
Required.
For Return Manager, only Bill Sender and Bill Third Party are allowed.
68
Customs/ Declared Value Currency Type
FDXE/FDXG
INTL
ALL
Required.
70
Duties Pay Type
FDXE
INTL
Required for a dutiable international FedEx Express shipment.
This field is not applicable to an international document FedEx Express shipment.
71
Duties Payer Account Number
FDXE
INTL
Required if Duties Pay Type is 3 (Bill Third Party).
Optional if Duties Pay Type is 2 (Bill Recipient).
1032
Duties Payer Country Code
FDXE
INTL
Optional.
1195
Payer Country Code
FDXE
INTL
Optional.
1119
Field Name
Future Day Shipment Flag
Field Requirements
RATE DATA
1529
PAYMENT
MULTIPLE-PIECE SHIPPING
116
Package Total
(Total Number of Pieces)
FDXE/FDXG
INTL
ALL
Required.
For multiple-piece shipping, FDXE only applies to COD and international.
1117
Package Sequence
FDXE/FDXG
INTL
ALL
Required for multiple-piece shipping if Package Total (field tag 116) value is greater
than 1.
FDXE only applies to COD and international.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
58
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
1123
Master Tracking Number
1124
Master Form ID
1400
Total Shipment Weight
Applicable
Carrier
Valid
For
FDXE/FDXG
INTL
ALL
Required for multiple-piece shipping if Package Sequence (field tag 1117) value is
greater than 1.
FDXE only applies to COD and international.
FDXE
ALL
Required for multiple-piece shipping via the Express Server if Package Sequence
(field tag 1117) value is greater than 1.
FDXE/FDXG
INTL
Required for international multiple-piece shipping.
The Total Shipment Weight is in the Master only, not the Child. For example, piece "1
of n" pieces will have the total shipment weight of all the pieces.
FDXE only applies to COD and international.
Field Requirements
SHIPMENT/ PACKAGE INFORMATION
25
Reference Information
FDXE/FDXG
ALL
Optional.
This field allows customer-defined notes to print on the shipping label. Can also be
used to Track By Reference.
This field cannot be used if shipping alcohol. If used, customer-defined notes will be
discarded.
57
Dim Height
FDXE/FDXG
ALL
Required only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) if Your Packaging is used as Packaging Type (value
01 in field tag 1273).
58
Dim Width
FDXE/FDXG
ALL
Required only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) if Your Packaging is used as Packaging Type (value
01 in field 1273).
59
Dim Length
FDXE/FDXG
ALL
Required only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) field if Your Packaging is used as Packaging Type
(value 01 in field 1273).
72
Terms Of Sale
FDXE/FDXG
INTL
Required for a dutiable international FedEx Express shipment.
This field is not applicable to an international document FedEx Express shipment.
73
Parties To Transaction
FDXE
INTL
Required.
A Y is 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.).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
59
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
75
Field Name
Weight Units
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Field Requirements
Required.
Valid values:
• LBS
• KGS
Default = LBS
190
Document Flag
FDXE
INTL
Y if the shipment type is document.
If multiple-piece shipment, this field must be set to Y in the Master transaction and all
Child transactions.
413
NAFTA Flag
FDXE
INTL
Y if NAFTA shipment, else N.
May be applicable if origin and destination countries are US, CA, or MX.
1116
Dim Units
FDXE/FDXG
ALL
Required if package dimensions are passed in the Request transaction.
Defaults to inches if a value is not passed in the transaction.
1273
Packaging Type
FDXE/FDXG
ALL
Required.
1274
Service Type
FDXE/FDXG
ALL
Required.
1300
Purchase Order Number
1401
Total Package Weight
FDXE/FDXG
ALL
Required for single and multiple-piece shipments.
This is used for actual piece weight only, not total shipment weight.
For multiple-piece shipments, this field must contain the actual piece weight for this
package.
1411
Total Customs Value
FDXE/FDXG
INTL
Required.
For FedEx Express international MPS, the Total Customs Value is in the Master
transaction and all Children transactions.
1415
Declared Value / Carriage Value
FDXE/FDXG
ALL
Optional for U.S., international dutiable FedEx Express, and FedEx Ground
shipments.
This field is not applicable to an international document FedEx Express shipment.
For FedEx Express international MPS, Master piece should contain the total declared
value/carriage value, with no declared value/carriage value in Children pieces. For
example, piece "1 of n" pieces will have the total declared value/carriage value of all
the pieces.
Customer assigned purchase order number.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
60
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3001
FedEx Purchase Order
FDXE/FDXG
ALL
Optional.
If passed in the transaction,
Purchase Order can later be used to track by reference for FedEx Ground ONLY.
Displays on the thermal label for Express. This is simply an additional reference field
when used with FedEx Express shipments.
3002
FedEx Invoice
FDXE/FDXG
ALL
Optional.
If passed in the transaction,
Invoice Number can later be used to track by reference for FedEx Ground ONLY.
Displays on the thermal label for Express. This is simply an additional reference field
when used with FedEx Express shipments.
VARIABLE HANDLING
1427
Variable Handling Charge
FDXE/FDXG
ALL
Optional.
Required in conjunction with Variable Handling Type.
1588
Variable Handling Type
FDXE/FDXG
ALL
Optional.
If valid value is present, a valid Variable Handling Charge is Required.
1606
Variable Handling Charge Level
FDXE/FDXG
ALL
Optional.
Only applicable if valid Variable Handling Type is present.
3025
Carrier Code
FDXE/FDXG
ALL
Required.
FDXE/FDXG
ALL
USD
Y if shipment is COD, else N.
If Flag is Y and the customer is enabled by FedEx for Electronic COD (ECOD), then
ECOD will take affect.
Not allowed with Return Manager shipments.
SPECIAL SERVICE – COD
27
COD Flag
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
61
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
186
COD Add Freight Flag
FDXE/FDXG
ALL
USD
Required if the COD Flag is set to Y and freight charges are to be added to the COD
amount.
Indicates that freight charges should be added to the COD collect amount.
Accumulate these charges into the COD Amount for a single package:
1 = Add discounted rate to COD Amount
2 = Add list rate to COD Amount
3 = Add discounted COD Surcharge
4 = Add list COD Surcharge
5 = Add discounted **Customer Total Charge
6 = Add list **Customer Total Charge
Accumulate these charges into the COD Amount for a shipment:
7 = Add MTW Net Charge (shipment level)
8 = Add Discount Shipment Net Charge to last package in a Shipment
9 = Add List Shipment Net Charge to last package in a shipment.
Values 2, 4, 6 are only valid when Rate Indicator (field tag 1529) = 2.
Values 1, 3, 5, are valid when Rate Indicator (field tag 1529) is not present or equals
1 or 2.
Values 7-9 are only valid options for FedEx Ground MPS and have no dependency on
the Rate Indicator.
1432
Customer COD Amount
FDXE/FDXG
USD
ALL
Required if COD Flag is set to Y.
3000
COD Collection Type
FDXE/FDXG
ALL
USD
Required if the COD Flag is set to Y.
For FedEx Express shipments, a value of 2 = secured.
All other values = non-secured.
Cash is only supported with FedEx Ground.
COD REMITTANCE
• If shipping a COD single-piece shipment, the COD remittance fields may be
passed in the 021 Request transaction.
• If shipping COD MPS, the COD remittance fields should be passed in the 021
Request transaction representing the last piece of the shipment.
• The COD Return Contact information will default to the Shipper Contact
information if not provided in the 021 Request transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
62
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
FDXE
USD
Required if the COD Flag is set to Y and the 021 Shipment Request transaction
represents the last piece in a multiple-piece shipment.
This tracking number is returned in the 121 Reply of the first 021 Request of a COD
shipment.
Not applicable for non-MPS shipments.
Field Requirements
28
COD Return Tracking Number
439
COD Return Contact Name
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and the 021 Shipment Request transaction
represents the last piece in a multiple-piece shipment.
1237
COD Return Phone
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and is different from the Sender.
Phone number of the COD remittance party.
No embedded dashes.
1238
COD Return Company
FDXE/FDXG
USD
Required only if the COD Flag is set to Y, is different from the Sender, and a COD
contact name has not been entered.
1239
COD Return Department
FDXE/FDXG
USD
Optional.
1240
COD Return Address 1
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and is different from the Sender.
1241
COD Return Address 2
FDXE/FDXG
USD
Optional.
1242
COD Return City
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and is different from the Sender.
1243
COD Return State
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and is different from the Sender.
1244
COD Return Postal Code
FDXE/FDXG
USD
Required only if the COD Flag is set to Y and is different from the Sender.
3045
COD Return Reference Indicator
FDXG
USD
Optional.
This indicator determines which reference value will prints on the FedEx Ground
shipping label.
SPECIAL SERVICE – HOME DELIVERY
3020
Home Delivery Type
FDXG
USD
Optional.
3021
FedEx Home Delivery Instructions
FDXG
USD
Optional.
3023
Home Delivery Date
FDXG
USD
Required if home delivery type is set to 1 (Date Certain).
3024
Home Delivery Phone Number
FDXG
USD
Required if home delivery type is set to 1 (Date Certain) or 3 (Appointment).
SPECIAL SERVICE – ALCOHOL (LIMITED TO AUTHORIZED SHIPPERS)
40
Alcohol Type
FDXE
ALL
Required if the Alcohol Flag is set to Y.
41
Alcohol Packaging
FDXE
ALL
Required if the Alcohol Flag is set to Y.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
63
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Applicable
Carrier
Valid
For
Alcohol Packages
FDXE
ALL
Required if the Alcohol Flag is set to Y.
1332
Alcohol Flag
FDXE
ALL
Y if shipment is alcohol, else N.
Alcohol type, packaging, volume and number of packages are concatenated together
and passed in the Reference Information (field tag 25).
1405
Alcohol Volume
FDXE
ALL
Required if the Alcohol Flag is set to Y.
52
Field Name
Field Requirements
SPECIAL SERVICE – HOLD AT LOCATION
44
HAL Address
FDXE
ALL
Required if the Hold At Location Flag is set to Y.
46
HAL City
FDXE
ALL
Required if the Hold At Location Flag is set to Y.
47
HAL State
FDXE
ALL
Required if the Hold At Location Flag is set to Y and country is US or CA.
48
HAL Postal Code
FDXE
ALL
Required if the Hold At Location Flag is set to Y and country is US or CA.
May be required for other postal-aware countries when shipping internationally.
49
HAL Phone Number
FDXE
ALL
Required if the Hold At Location Flag is set to Y.
Required for freight shipping.
1200
HAL Flag
FDXE
ALL
Y if shipment is Hold at Location, else N.
1265
HAL Contact Name
FDXE
Y if shipment is Hold at Location, else N.
SPECIAL SERVICE – DANGEROUS GOODS
1331
Dangerous Goods Type
FDXE
ALL
A if shipment contains accessible dangerous goods, else I for inaccessible dangerous
goods. If A or I sent, assumes shipment is Dangerous Goods.
SPECIAL SERVICE – HAZARDOUS MATERIALS
3015
Hazardous Materials Flag
FDXG
ALL
Y if shipment contains hazardous materials.
3066
Hazardous Materials DOT Shipping Name
of Materials
FDXG
ALL
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3085
Hazardous Materials DOT Shipping Name
of Materials
FDXG
ALL
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3086
Hazardous Materials DOT Shipping Name
of Materials
FDXG
ALL
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3067
DOT Hazard Class or Division Number
FDXG
ALL
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
64
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3068
Hazardous Materials DOT ID Number
FDXG
ALL
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3069
Hazardous Materials Packing Group
FDXG
ALL
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3072
Hazardous Materials Type DOT Label(s)
FDXG
ALL
Optional.
Type DOT Label(s) Required, Label(s) Required, Ltd., Qty., or Exemption Number.
(Can have blank or incorrect value.)
3088
Hazardous Materials Quantity
FDXG
ALL
Required if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3075
Hazardous Materials Emergency Contact
Phone Number
FDXG
ALL
Required if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3087
Hazardous Materials Emergency Contact
Name
FDXG
ALL
Required if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3089
Hazardous Materials Unit of Measure
FDXG
ALL
Optional for OP-950.
(Can have blank or incorrect value.)
SPECIAL SERVICE – DRY ICE
1268
Dry Ice Flag
FDXE
ALL
Y if shipment contains dry ice, else N.
1406
Dry Ice Weight
FDXE
ALL
Required if Dry Ice Flag is Y.
Represents cumulative dry weight for the entire shipment.
Cannot be greater than shipment weight.
Weight type is KGS only.
When requesting a ShipAlert in the 021 Ship Request transaction, sender’s email
address (field tag 1201), recipient’s email address (field tag 1220), broker’s email
address (field tag 1343), or Email Notification Address (field tag 1204) must be used
in conjunction with the fields in this section.
SPECIAL SERVICE – ALERTS
1203
1204-#
Personal Message
FDXE/FDXG
ALL
Optional.
Personal message to be included in the Notification. Applies to all email notifications:
ShipAlert, Exception Notification, and Delivery Notification.
Email Notification Address
FDXE/FDXG
ALL
For FDXE and FDXG:
• A minimum of one occurrence is required if field tag 1206 (ShipAlert Flag) or field
tag 1551 (Delivery Notification Flag) is Y or field tag 1960 (Exception Notification
Flag) is Y.
• A maximum of three occurrences is allowed.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
65
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1206-#
ShipAlert Notification Flag
FDXE/FDXG
ALL
Required for ShipAlert.
If = Y, corresponding email address in field tag 1204 (Email Notification Address) will
be emailed ShipAlert.
Not allowed with Return Manager shipments.
Maximum of three occurrences allowed (repeating, must use "-#").
1551-#
Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification.
If = Y, corresponding email address in field tag 1204 (Email Notification Address) will
be emailed delivery notification.
Maximum of three occurrences allowed.
1552-#
Language Code
FDXE/FDXG
ALL
Optional.
Determines language for email notifications.
Applies to all Email Notifications and corresponds to the occurrence of the email
address in field tag 1204 (Email Notification Address).
Maximum of three occurrences allowed.
See 1552 in Appendix A for valid values.
Defaults to en.
1968-#
Language Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1552-#) has a corresponding occurrence and
the language code requires a locale code.
If invalid combination of language/locale is input, an error will be returned.
See 1968 in Appendix A for valid values.
1553
Shipper Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed Delivery Notification
email.
1554
Shipper ShipAlert Flag
FDXE/FDXG
ALL
Required for ShipAlert Notification to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed ShipAlert email.
1555
Shipper Language Code
FDXE/FDXG
ALL
Optional for Email Notification to shipper email address.
See 1555 in Appendix A for valid values.
Defaults to en.
1969
Shipper Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1555) is populated and the language code
requires a locale code.
See 1969 in Appendix A for valid values.
1556
Recipient Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification to the recipient.
If = Y, Recipient Email Address (field tag 1202), will be emailed Delivery Notification
email.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
66
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1557
Recipient ShipAlert Flag
FDXE/FDXG
ALL
Required for ShipAlert Notification to the recipient.
If = Y, Recipient’s Email Address (field tag 1202) will be emailed ShipAlert email.
1558
Recipient Language Code
FDXE/FDXG
ALL
Optional for Email Notification to recipient email address.
See 1558 in Appendix A for valid values.
Defaults to en.
1970
Recipient Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1558) is populated and the language code
requires a locale code.
See 1970 in Appendix A for valid values.
1559
Broker Delivery Notification Flag
FDXE/FDXG
INTL
Required for Delivery Notification to the broker.
If = Y, Broker Email Address (field tag 1343) will be email Delivery Notification email.
1560
Broker ShipAlert Flag
FDXE/FDXG
FDXG
Required for Delivery Notification to the broker.
If = Y, Broker Email Address (field tag 1343) will be emailed ShipAlert email.
1561
Broker Language Code
FDXE/FDXG
INTL
Optional for Email Notification to broker email address.
See 1561 in Appendix A for valid values.
Defaults to en.
1971
Broker Locale Code
FDXE/FDXG
INTL
Applicable if Language Code (field tag 1561) is populated and the language code
requires a locale code.
See 1971 in Appendix A for valid values.
Exception Notification Flag
FDXE/FDXG
ALL
Required for Exception Notification.
If = Y, email address in field tag 1204 (Email Notification Address) will be emailed
ShipAlert.
Maximum of 3 occurrences allowed.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
Shipper Exception Notification Flag
FDXE/FDXG
ALL
Required for Exception Notifications to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed any Exception emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
SPECIAL SERVICE – NOTIFICATION
1960-#
1961
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
67
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1962
Recipient Exception Notification Flag
FDXE/FDXG
ALL
Required for Exception Notifications to the recipient.
If = Y, Recipient's Email Address (field tag 1202) will be emailed any Exception
emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
1963
Broker Exception Notification Flag
FDXE/FDXG
INTL
Required for Exception Notifications to the broker.
If = Y, Broker's Email Address (field tag 1343) will be emailed any Exception emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
Email Notification Format
FDXE/FDXG
ALL
Optional.
A unique format can be specified for each email address indicated.
The format will apply to all notification emails sent to a particular email address.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Email Notification Address (field tag
1204).
1965
Shipper Email Notification Format
FDXE/FDXG
ALL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Sender's Email Address (field tag 1201).
1966
Broker Email Notification Format
FDXE/FDXG
INTL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Broker's Email Address (field tag 1343).
1964-#
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
68
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
1967
Field Name
Recipient Email Notification Format
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Recipient 's Email Address (field tag
1202).
FDXE/FDXG
ALL
USD
Required for FedEx Home Delivery.
Y if shipment is Residential Delivery.
If Recipient Address is in a rural area (defined by table lookup), additional charge will
be applied.
Field Requirements
SPECIAL SERVICE – OTHER
440
Residential Delivery Flag
1120
Inside Pickup Flag
FDXE
USD
Applicable to freight shipping only.
Y if shipment is originated from an inside pickup area.
1121
Inside Delivery Flag
FDXE
USD
Applicable to freight shipping only.
Y if shipment is traveling to an inside delivery area.
1266
Saturday Delivery Flag
FDXE
ALL
Y if shipment is to be delivered on Saturday.
1267
Saturday Pickup Flag
FDXE
ALL
Y if shipment is to be picked up on Saturday.
1333
Drop Off Type
FDXE
ALL
Required.
2399
Signature Option
FDXE/FDXG
ALL
Optional.
Valid values:
1 = Deliver without Signature
2 = Indirect Signature
3 = Direct Signature
4 = Adult Signature
For FedEx Express shipments, the "Deliver without Signature" option will not be
allowed when the following special services are requested:
• Alcohol
• Hold at Location
• Dangerous Goods
• Declared Value greater than $500
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
69
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1118
Release Authorization Number
FDXE
USD
CAN
Optional.
May be used if Signature Option field is set to 1 (Delivery without Signature).
3018
Nonstandard Container Flag
FDXG
ALL
Y if nonstandard container.
ALTERNATE SENDER / RETURN INFO FOR LABEL
1485
Alternate Sender / Return Address
Contact Name
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y and Alternate Sender/Return
Company Name is not present.
1486
Alternate Sender / Return Address
Company Name
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y and Alternate Sender/Return
Contact Name is not present.
1487
Alternate Sender / Return Address Line 1
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y.
1488
Alternate Sender / Return Address Line 2
FDXE/FDXG
ALL
Optional.
1489
Alternate Sender / Return Address City
Name
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y.
1490
Alternate Sender / Return Address State
Code
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y and Alternate Sender/Return
Address Country Code is US or CA.
1491
Alternate Sender / Return Address Postal
Code
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y and Alternate Sender/Return
address Country Code is US or CA.
May be required for other postal-aware countries when shipping internationally.
1492
Alternate Sender / Return Address Phone
Number
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y.
1585
Alternate Sender / Return Address
Country Code
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y.
1586
Alternate Sender / Return Address Flag
FDXE/FDXG
ALL
Optional.
Valid values:
• Y
• N
If = Y, Alternate Sender/Return Address prints on label in the "sender" area.
Defaults to N, sender address prints on label in the "sender" area.
1587
Alternate Sender / Return Address
Department
FDXE/FDXG
ALL
Required if Alternate Sender/Return Address Flag = Y and Alternate Sender/Return
Contact Name is not present.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
70
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
2975
Mask Account Number Flag
FDXE/FDXG
ALL
Optional.
Valid values.
N – Print the Account Number on Label (Default for Ground)
Y – Do not print the Account Number on Label (Default for Express)
FDXE/FDXG
ALL
Required for doc-tab use on label.
Valid values:
0 or not present – Ground Default Doc Tab.
1 – Zone 001 Doc Tab Format
2 – Barcoded Doc Tab (Code 128)
Defaults to 0 (zero).
Field Requirements
CONFIGURABLE DOC TAB INFO FOR LABEL
2973
Doc Tab Type Indicator
For the Zone 001 and the Ground Doc Tab Printing:
• Header plus data combined can be up to 23 maximum length. If no header, data
can be 23. If no data, header can be 23.
• The header will be truncated (down to a minimum of 4 characters not including
colon and space) as needed to accommodate printing the maximum characters of
the associated data field.
1607
Doc Tab Header 1
FDXE/FDXG
ALL
Optional.
1608
Doc Tab Header 2
FDXE/FDXG
ALL
Optional.
1609
Doc Tab Header 3
FDXE/FDXG
ALL
Optional.
1610
Doc Tab Header 4
FDXE/FDXG
ALL
Optional.
1611
Doc Tab Header 5
FDXE/FDXG
ALL
Optional.
1612
Doc Tab Header 6
FDXE/FDXG
ALL
Optional.
1613
Doc Tab Header 7
FDXE/FDXG
ALL
Optional.
1614
Doc Tab Header 8
FDXE/FDXG
ALL
Optional.
1615
Doc Tab Header 9
FDXE/FDXG
ALL
Optional.
1616
Doc Tab Header 10
FDXE/FDXG
ALL
Optional.
1617
Doc Tab Header 11
FDXE/FDXG
ALL
Optional.
1618
Doc Tab Header 12
FDXE/FDXG
ALL
Optional.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
71
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
1621
Customer Doc Tab Barcode
FDXE/FDXG
ALL
Required field if field tag 2973 (Doc Tab Type Indicator) has a value of 2, otherwise
this is an optional field.
Maximum of 30 characters to be encoded as a bar code on the Doc Tab of supported
shipping labels.
1624
Doc Tab Data Field 1
FDXE/FDXG
ALL
Optional.
1625
Doc Tab Data Field 2
FDXE/FDXG
ALL
Optional.
1626
Doc Tab Data Field 3
FDXE/FDXG
ALL
Optional.
1627
Doc Tab Data Field 4
FDXE/FDXG
ALL
Optional.
1628
Doc Tab Data Field 5
FDXE/FDXG
ALL
Optional.
1629
Doc Tab Data Field 6
FDXE/FDXG
ALL
Optional.
1630
Doc Tab Data Field 7
FDXE/FDXG
ALL
Optional.
1631
Doc Tab Data Field 8
FDXE/FDXG
ALL
Optional.
1632
Doc Tab Data Field 9
FDXE/FDXG
ALL
Optional.
1633
Doc Tab Data Field 10
FDXE/FDXG
ALL
Optional.
1634
Doc Tab Data Field 11
FDXE/FDXG
ALL
Optional.
1635
Doc Tab Data Field 12
FDXE/FDXG
ALL
Optional.
FDXE
FDXG
USD
Required for return shipments.
Valid value:
0 = Non Return shipment
2 = Print Return Label
USD
Optional.
Return Materials Authorization (RMA).
Field Requirements
RETURN SPECIFIC
2382
Return Shipment Indicator
2210
RMA Number
FDXE/FDXG
2939
Return Reason Description
FDXE/FDXG
Optional.
Reason for return.
Applicable only if RMA Number is provided. Will be ignored if RMA Number is not
provided.
FREIGHT SPECIFIC
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
72
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1253
Packaging List Enclosed Flag
FDXE
USD
Optional.
Y if packaging list is enclosed, else N.
1271
Shipper’s Load And Count (SLAC)
FDXE
INTL
Required for a single piece or on the first piece of an MPS for international freight
shipping.
1272
Booking Confirmation Number
FDXE
INTL
Required for international freight shipping.
FORMS/ PRINTERS
1368
Label Type
FDXE/FDXG
ALL
Required to indicate label formatting.
Valid value:
2 = 2D Common
1369
Label Printer Type
FDXE/FDXG
ALL
Required to indicate label formatting.
Valid values:
1 = Laser printer
2 = Eltron Orion (EPL2)
3 = Eltron Eclipse (EPL2)
4 = Zebra ZPL
5 = Unimark
1370
Label Media Type
FDXE/FDXG
ALL
Required to indicate label formatting.
Valid values:
3 = Format 354 with doc tab information at bottom of
label (4x6 ¾ thermal label)
4 = Format 435 without doc tab information (4x6 thermal label)
5 = Plain paper (PNG)
6 = Format 354 with doc-tab information at top of label (4x6 ¾ thermal label)
7 = 4x6 PNG Laser printer image. Valid for domestic shipping only.
8 = PDF
66
Broker Name
FDXE/FDXG
INTL
Required if Broker Select Option (BSO) Flag is set to Y.
Minimum of 3 alpha characters must be passed.
67
Broker Phone Number
FDXE/FDXG
INTL
Required if Broker Select Option (BSO) Flag is set to Y.
FDXE
INTL
Y if shipment is Broker Select Option. A flag value Y indicates that the package is to
be shipped using a different broker than FedEx.
BROKER
1174
BSO Flag
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
73
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
FDXE
INTL
Optional.
Field Requirements
1179
Broker FedEx Account Number
1180
Broker Company
FDXE/FDXG
INTL
Optional.
1181
Broker Address Line 1
FDXE/FDXG
INTL
Optional.
1182
Broker Address Line 2
FDXE/FDXG
INTL
Optional.
1183
Broker City
FDXE/FDXG
INTL
Required if Broker Select Option (BSO) Flag is set to Y.
Minimum of 3 alpha characters must be passed.
1184
Broker State
FDXE/FDXG
INTL
Optional.
Required field if Broker Country Code is US, CA, or MX.
1185
Broker Postal Code
FDXE/FDXG
INTL
Required if Broker Select Option (BSO) Flag is set to Y and Broker Country Code is
US and CA.
May be required for other postal-aware countries when shipping internationally.
1186
Broker Country Code
FDXE/FDXG
INTL
Required if BSO Flag is Y. Must be the same as the Recipient Country Code (field tag
50).
1187
Broker SSN/EIN
FDXE
INTL
Optional.
1343
Broker Email Address
FDXE
INTL
Optional.
1344
Broker Fax Number
FDXE
INTL
Optional.
1345
Broker Pager Number
FDXE
INTL
Optional.
COMMODITY
A maximum of twenty occurrences of commodity line item information is supported in
this Request transaction.
For international multiple-piece shipments, this commodity information must be
passed in the Master and each Child 021 transaction.
76-#
Commodity Number Of Pieces
FDXE
INTL
Required.
The total number of packages within the shipment that contain this commodity. (Can
be greater than or equal to Package Total, field 116.)
At least one occurrence is required for international shipments.
79-#
Commodity Description of Contents
FDXE
INTL
A minimum of three characters must be passed in the field.
At least one occurrence is required for international.
Maximum number of characters is 450.
Please refer to Appendix C: Vague Commodity Descriptions for a list of appropriate
commodity descriptions.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
74
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
80-#
Commodity Country Of Manufacture
FDXE
INTL
Required.
Country code where commodity contents were produced or manufactured in their final
form.
At least one occurrence is required for international dutiable shipments.
81-#
Commodity Harmonized Code
FDXE
INTL
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.
82-#
Commodity Unit Quantity
FDXE
INTL
Required.
Total quantity of an individual commodity within this shipment. (Used in conjunction
with Commodity Unit of Measure, field 414.)
At least one occurrence is required for international dutiable shipments.
This field is optional for an international document FedEx Express shipment.
83-#
Commodity Export License Number
FDXE
INTL
Required if commodity is shipped on commerce export license, Customs Value is
greater than $2500 and Foreign Trade Regulations (FTR) are not supplied.
Applicable to U.S. Export shipping only.
84-#
Commodity Export License Expiration
Date
FDXE
INTL
Required only if commodity is shipped on commerce export license, and Export
License Number is supplied.
Applicable to U.S. Export shipping only.
120-#
CI Marks And Numbers
FDXE
INTL
Optional.
Applicable only if the commercial invoice flag is set to Y.
414-#
Commodity Unit Of Measure
FDXE
INTL
Required.
At least one occurrence is required for international dutiable shipments.
This field is optional for an international document FedEx Express shipment.
1407-#
Commodity Weight
FDXE
INTL
Required.
At least one occurrence is required for international dutiable shipments.
The weight of each unit of quantity.
1408-#
Commodity Unit Value
FDXE
INTL
Required.
At least one occurrence is required for international dutiable shipments.
The value of each unit of quantity.
1410-#
Commodity Customs Value
FDXE
INTL
At least one occurrence is required for international dutiable shipments.
The commodity customs value should equal the commodity unit quantity times
commodity unit value.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
75
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
SHIPPER'S EXPORT DECLARATION (SED)/ELECTRONIC EXPORT
INFORMATION (EEI)
Field Requirements
Applicable To U.S. Export Shipments Only.
The following AES (Automated Export System) data elements are required to be
submitted to FedEx by the exporter or the exporter’s authorized agent prior to
departure of the merchandise from the U.S. if an SED/EEI is required.
Precedence for government issued licenses or exemptions for SED/EEI:
• Export License
• Foreign Trade Regulations (FTR)
• Custom Value
SED/EEI – GENERAL INFORMATION
1352
Sender EIN/SSN Indicator
1358
Automated Export System(AES)/Foreign
Trade Regulations (FTR) Exemption
1399
AES Entry Number
FDXE
INTL
Required for any international shipments.
This field pairs with field 1139.
FDXE/FDXG
INTL
FedEx Express: Required for non-document U.S. Export Shipments.
FedEx Ground: Required.
FDXE
INTL
Only required for commodities imported into the United States for export to a thirdparty country of destination.
Applicable to Canadian originating shipments only. Canada Customs regulations and
internal business rules require that a shipper that is exporting non-document
shipments (or document shipments of $2000 CAD or higher) to any country other than
Canada, the United States, Puerto Rico or the U.S. Virgin Islands must submit proof
of a filed B13A declaration prior to export.
CANADA EXPORT DECLARATION B13A
1651
B13A Filing Option
FDXE
INTL
Required field for Canadian Export shipments, (both document and non-document)
destined to a country other than the United States, Puerto Rico or the U.S. Virgin
Islands.
Valid Values:
1 = No B13A Required
2 = Manual B13A Attached
3 = Filed Electronically
4 =Summary Reporting
1652
Export Statement Data
FDXE
INTL
Used to indicate Export required data for any country.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
76
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
1653
Field Name
Applicable
Carrier
Valid
For
FDXE
INTL
Optional.
Only applicable for any Canada export (international), both document and nondocument shipments.
If B13A filing option = 1, this field should contain a valid B13A Exception Number (2
AN).
FDXE/FDXG
INTL
Y if required for electronic upload of CI data. It will serve to create/transmit an
Electronic Commercial invoice through FedEx’s System.
Customer will print their own Commercial Invoice.
The Electronic Commercial Invoice allows up to 20 commodity line items.
Export Permit Number
Field Requirements
COMMERCIAL INVOICE (CI)
113
Commercial Invoice Flag
Applicable only if Commercial Invoice Flag (field tag 113) is set to Y.
COMMERCIAL INVOICE (CI) – GENERAL INFORMATION
418-#
CI Comments
FDXE/FDXG
INTL
Maximum of four occurrences.
120-#
CI Marks and Numbers
FDXE/FDXG
INTL
Optional.
Maximum of twenty occurrences.
Applicable only if the Commercial Invoice Flag is set to Y.
1297
Customer Invoice Number
FDXE/FDXG
INTL
Optional.
1412
Freight Charge
FDXE/FDXG
INTL
Required if Terms Of Sale is CF or CIF.
This charge should be added to the total customs value amount.
1413
Insurance Charge
FDXE/FDXG
INTL
Required if Terms Of Sale is CIF.
This charge should be added to the total customs value amount.
1414
Taxes/ Miscellaneous Charge
FDXE/FDXG
INTL
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.
1958
Admissibility Package Type
FDXE/FDXG
INTL
Required if field tag 1273 (Packaging Type) is set to 01 – Other (Express) or
Customer (Ground) packaging.
Required for all origins to Canada excluding Intra-Canada, CA to US, CA to PR, MX
to US, and MX to PR.
2397
Purpose of Shipment Code
FDXE/FDXG
INTL
Optional.
The code that represents the purpose of the shipment.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
77
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
Applicable only if Commercial Invoice Flag (field tag 113) is set to Y. If the consignee
and importer are not the same, the importer fields are required. If some importer fields
are provided in the 021 Shipment Request, the following required fields must be
provided as well.
COMMERCIAL INVOICE (CI) – IMPORTER
169
Importer Country
FDXE/FDXG
INTL
Required for Importer.
170
Importer Name
FDXE/FDXG
INTL
Required for Importer.
171
Importer Company
FDXE/FDXG
INTL
Required for Importer.
172
Importer Address Line 1
FDXE/FDXG
INTL
Required for Importer.
173
Importer Address Line 2
FDXE/FDXG
INTL
Optional.
174
Importer City
FDXE/FDXG
INTL
Required for Importer.
175
Importer State
FDXE/FDXG
INTL
Required if Importer Country Code is US or CA.
176
Importer Postal Code
FDXE/FDXG
INTL
Required if Importer Country Code is US or CA.
May be required for other postal-aware countries when shipping internationally.
177
Importer Account Number
FDXE
INTL
Optional.
178
Importer Phone Number
FDXE/FDXG
INTL
Required for Importer.
180
Importer SSN/EIN Number
FDXE/FDXG
INTL
Optional.
Shipment Content Records Total
FDXE/FDXG
ALL
Optional.
1395-#
Part Number
FDXE/FDXG
ALL
Optional.
Repeating field up to 50 times per tracking #.
1396-#
SKU/Item/UPC
FDXE/FDXG
ALL
Optional.
Repeating field up to 50 times per tracking #.
1397-#
Receive Quantity
FDXE/FDXG
ALL
Optional.
Repeating field up to 50 times per tracking #.
1398-#
Description
FDXE/FDXG
ALL
Optional.
Repeating field up to 50 times per tracking #.
FDXE
ALL
Optional.
INSIGHT CONTENT CAPTURE
1394
INBOUND VISIBILITY
1392
Inbound Visibility Block Shipment Indicator
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
78
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Field Requirements
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required.
79
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Example of Transaction 021: Ship a Package Request (U.S. FedEx Express)
On Monday January 3, 2005, your customer, ABC Widget, requests a shipment of widget parts to be delivered. ABC Widget’s 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:
Data File
Field Description
0,"021"
Transaction Type 021 is Ship a Package Request.
1,"112301"
Customer Transaction identifier. This field will be included in any error or Reply messages if you include it in the Request.
4,"Total Widget Rebuilders"
Your (sender) company name.
5,"445 East Street"
Your street address.
7,"Dallas"
Your city name. Note that field tag 6 is not needed to complete your address.
8,"TX"
Your state abbreviation.
9,"75247"
Your ZIP code.
10,"123456789"
Shipper’s account number.
498,"123567"
Shipper’s meter number
1333,"1"
Drop-off type is regular pickup
117,"US"
Shipper’s country code.
183,"2145558765"
Your phone number.
50,"US"
Destination country code.
11,"ABC Widget"
The destination company name.
12,"Bernard F. Smith"
The destination contact name.
13,"322 Latta Woods"
The destination street address.
14,"Suite 26"
The destination suite number.
15,"Roanoke"
The destination city name.
16,"VA"
The destination state abbreviation.
17,"24012"
The destination ZIP code.
18,"7035551212"
The destination phone number.
23,"1"
Payment code: 1 = Bill Sender.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
80
Tagged Transaction Layouts – Transaction 021: Ship a Package Request
Data File
Field Description
1401,"4.0"
The shipment weight, in pounds, one explicit decimal.
1273,"03"
Packaging Type is FedEx Box.
1274,"03"
Service selected is FedEx 2Day.
25,"SPECIAL CALL-IN"
Your personal reference notes.
24,"20050103"
Date of the shipment (January 3, 2005).
1115,"130555"
Time of your shipment.
1368,"2"
Standard label.
1369,"1"
Label to print on Laser Printer.
1370,"5"
Label to print on Plain Paper.
1116,"I"
Dim Measurements unit is inches.
75,"LBS"
Units of weight is LBS.
3025,"FDXE"
Carrier Code, FDXE for FedEx Express.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
81
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Transaction 121: Ship a Package Reply
The following information is returned from the FedEx server after a U.S. Ship a Package Request has been processed:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Returned.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
Returned if the customer included it in the Request transaction, containing the same value.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. For an erroneous
Request or server failure, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or server failure, the error
code will be placed in this field tag.
557
Message Type Code
FDXG
ALL
Returned only if a soft error/warning message is available.
558
Message Code
FDXG
ALL
Returned only if a soft error/warning message is available.
559
Message Text
FDXG
ALL
Returned only if a soft error/warning message is available.
FDXE
USD
Returned only for COD FedEx Express shipments.
FDXE/FDXG
ALL
Contains the tracking number assigned to the shipment if successful.
TRACKING INFO
28
COD Return Tracking Number
29
Tracking Number
526
Form ID
FDXE
ALL
Label form ID returned upon successful transaction Reply.
527
COD Return Form ID
FDXE
USD
Returned only for COD and the first piece of a FedEx Express multiple-piece shipment.
1123
Master Tracking Number
FDXE
INTL
USDCOD
Returned if an international multiple-piece shipment or a U.S. COD multiple-piece shipment.
1124
Master Tracking Form ID
FDXE
INTL
USDCOD
Returned if an international multiple-piece shipment or a U.S. COD multiple-piece shipment.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
82
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
RATING INFO
The rating information is only returned in the Reply for the last piece of a multiple-piece shipment. Only List Rates are returned in the Reply when field tag 1529 = 2 in
the Request.
FDXE/FDXG
ALL
Y if the dimmed weight was used to derive freight charges.
431
Dim Weight Used Flag
543
COD Return Collect Plus Freight
Amount
1089
Rate Scale
FDXE
USD
Returned.
1090
Currency Type
FDXE
ALL
Returned.
1092
Rate Zone
FDXE
USD
Returned.
2399
Signature Option
FDXE/FDXG
ALL
Optional.
2405
MBG Ineligible
FDXG
ALL
Y if a shipment is ineligible for MBG (Money Back Guarantee).
1402
Bill Weight
FDXE/FDXG
ALL
Billed weight for the shipment.
1403
Dim Weight
FDXE
USD
DIM weight for the shipment.
1433
COD Collect Amount
FDXE/FDXG
USD
ALL
Returns the final COD Amount when processing COD shipments.
1416
Base Rate Amount
FDXE/FDXG
ALL
Base rate amount for the shipment.
1418
Total Discount Amount
FDXE/FDXG
ALL
Total discount amounts applied to the shipment.
1417
Total Surcharge Amount
FDXE/FDXG
ALL
Total surcharge amount returned for the shipment.
1419
Net Charge Amount
FDXE/FDXG
ALL
Net charge amount returned.
1420
Total Rebate Amount
FDXE
USD
Total rebate amount returned.
1507
List Total Surcharge Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Sum of total surcharges.
1525
Effective Net Discount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List Net Charge - Net Charge Amount
1528
List Net Charge Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
Rate + Surcharges - Discounts
1530
List Base Rate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List base rate amount.
The total amount printed on the COD return label for COD service when field 186 is set to Y.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
83
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1531
List Total Discount Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total discount amount (will always = 0).
1532
List Total Rebate Amount
FDXE/FDXG
USD
ALL
Returned when field tag 1529 (Rate Indicator) = 2.
List total rebate amount (will always = 0).
3124
Oversize Classification
FDXG
ALL
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.
SURCHARGE INFO
612
Harmonized Sales Tax (HST)
Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
613
Global Sales Tax (GST) Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
614
Provincial Sales Tax (PST) Surcharge
FDXE/FDXG
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1421
COD Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1422
*List COD Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1423
Saturday Pickup Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1424
*List Saturday Pickup Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1425
Declared Value Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1426
*List Declared Value Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
84
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1434
Saturday Delivery Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1435
List Saturday Delivery Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1436
Dangerous Goods Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1437
List Dangerous Goods Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1438
Out of Pickup Area / H3 Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1439
List Out of Pickup Area / H3
Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1440
Out of Delivery Area / H3 Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1441
List Out of Delivery Area / H3
Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1442
Inside Pickup Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1443
List Inside Pickup Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1444
Inside Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1445
List Inside Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1446
Residential Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1447
List Residential Delivery Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1448
Priority Alert Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00).
1449
List Priority Alert Surcharge
FDXE
USD
Format: Two explicit decimal positions (e.g. 5.00).
1636
Delivery Area Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00).
1637
List Delivery Area Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00).
1638
Fuel Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00).
1639
List Fuel Surcharge
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00).
1640
FedEx International Controlled Export
(FICE) Surcharge
FDXE
INTL
FedEx International Controlled Export Surcharge Amount.
Format: Two explicit decimal places
1641
Return Label
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1642
Value Added Tax
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1643
List Return Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1644
Offshore Surcharge
FDXE
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
85
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1645
List Offshore Surcharge
FDXE
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1648
Europe First Surcharge
FDXE
INTL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
Applicable to FedEx Express only.
1649
Other Surcharges
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1650
List Other Surcharges
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1672
FedEx Tag Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1673
*List FedEx Tag Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1682
Oversize Surcharges
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
1683
List Oversize Surcharges
FDXE
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
2390
Email Label surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
2391
*List Email Label Surcharge
FDXE/FDXG
USD
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
2402
Signature Option Fee
FDXE/FDXG
ALL
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
2403
List Signature Option Fee
FDXE/FDXG
ALL
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
3095
Appointment Delivery Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3096
*List Appointment Delivery Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3101
Home Delivery Date Certain
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3102
*List Home Delivery Date Certain
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3103
Home Delivery Evening Delivery
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3104
*List Home Delivery Evening Delivery
Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3107
Additional Handling Charge (AHS) /
Non Standard Container Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
For FedEx Express, this field tag will contain any surcharge resulting from an Additional
Handling Charge (AHS).
For FedEx Ground, this field tag will contain any surcharge resulting from the use of a Non
Standard Container.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
86
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3108
*List Additional Handling Charge
(AHS) / Non Standard Container
Surcharge
FDXE/FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
For FedEx Express, this field tag will contain any surcharge resulting from an Additional
Handling Charge (AHS).
For FedEx Ground, this field tag will contain any surcharge resulting from the use of a Non
Standard Container.
3109
Hazardous Materials Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3110
*List Hazardous Materials Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3111
Residential Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3112
*List Residential Surcharge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3053
Multiweight Net Charge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3054
Shipment Net Charge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
3115
*List Shipment Net Charge
FDXG
ALL
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including decimal place.
VARIABLE HANDLING
1428
Variable Handling Charge Amount
FDXE/FDXG
ALL
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 field) plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1429
List Variable Handling Charge Amount
FDXE/FDXG
ALL
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 field) plus the value input in Variable Handling Charge.
If Variable Handling Type is FIXED_AMOUNT, field will be equal to the Variable Charge.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal place.
1430
Total Customer Charge
FDXE/FDXG
ALL
Contains shipper’s discounted Net Freight Charge (in the billing currency) plus Variable
Handling Charge Amount. Will contain piece level or shipment level dependent on the
Variable Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
1431
List Total Customer Charge
FDXE/FDXG
ALL
Contains shipper’s list Net Freight Charge (in the billing currency) plus Variable Handling
Charge Amount. Will contain piece level or shipment level dependent on the Variable
Handling Charge Level field.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal place.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
87
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
3043
MTW Variable Handling
FDXG
ALL
Handling charge returned to the customer calculated with multiweight freight.
Format: Two explicit decimal positions (e.g. 5.00). 10 total length including decimal.
3113
MTW Customer Total Charge
FDXG
ALL
Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including decimal.
ROUTING / ASTRA
30
URSA Routing Code
FDXE
ALL
Applicable to a limited number of international countries for international shipping.
Universal Routing and Sorting Aid (URSA) routing code returned for all U.S. shipments.
33
Service Commitment
FDXE
ALL
Applicable to a limited number of international countries for international shipping.
65
Astra Barcode
FDXE
ALL
Returned in a successful Reply.
194
Delivery Day
FDXE/FDXG
ALL
Applicable to a limited number of international countries for international shipping.
195
Destination Station ID
FDXE
ALL
Applicable to a limited number of international countries for international shipping.
198
Destination Location ID
FDXE
409
Delivery Date
496
Freight Service Commitment
FDXE
535
COD Return ASTRA Barcode
536
FDXE/FDXG
FedEx location identifier of the package destination.
ALL
Applicable to a limited number of international countries for international shipping.
FDXE
USD
Returned only for COD FedEx Express shipments.
Returned only in the Reply for the last piece of a multiple-piece shipment.
COD Return Service Commitment
FDXE
USD
Returned only for COD FedEx Express shipments.
Returned only in the Reply for the last piece of a multiple-piece shipment.
1136
URSA Prefix Code
FDXE
USD
1137
URSA Uned Prefix
FDXE
1359
SED Legend Number
FDXE
INTL
Returned only if SED applies.
LABEL BUFFER
188
Label Buffer Data Stream
FDXE/FDXG
ALL
Returned only if field tags 1368, 1369, and 1370 were passed in the Ship Request
transaction.
411
COD Return Label Buffer Data Stream
FDXE/FDXG
USD
ALL
Returned for COD FedEx Express U.S. and FedEx Ground shipments.
1359
SED Legend Number
FDXE
INTL
Returned if SED is filed for international shipments.
2917
2D Barcode Data
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required to indicate legacy ’96 FedEx Ground label.
88
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
FDXE/FDXG
ALL
Field Requirements
SHIPPING
1193
Ship Delete Message
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Returned.
89
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
Example of Transaction 121: Ship a Package Reply (U.S. FedEx Express)
In response to the previous shipping Request transaction, your Reply transaction would be formatted as follows:
Data File
Field Description
0,"121"
Transaction Type 121.
1,"112301"
Transaction Identifier. This filed will be included in any error or Reply messages.
33,"A1"
Service Commitment.
431,"N"
Dim weight used flag.
30,"SE ROAA"
URSA Code.
29,"470026455325"
Tracking number.
526,"0201"
Tracking form ID.
1402,"4.0"
Billed weight.
1419,"4.94"
Net charge amount.
1416,"14.50"
Base rate amount.
1417,".19"
Total surcharge amount.
1418,"9.75"
Total discount amount.
1090,"USD"
Rate currency type.
1089,"00001"
Rate scale.
1092,"3"
Rate zone (Zone 0 A).
65,"32401265110000014700264553582016"
ASTRA bar code data.
194,"WED"
Delivery day.
195,"ROA"
Destination station ID.
409,"05JAN00"
Date to deliver package by (found on shipping label).
188,"(PNG Binary Data)"
PNG label data buffer.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
90
Tagged Transaction Layouts – Transaction 121: Ship a Package Reply
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If the destination state abbreviation in the
example had been invalid, FedEx would respond with the following transaction:
Data File
Field Description
0,"121"
Transaction Type 121 is Ship a Package Reply.
1,"112301"
Transaction identifier.
2,"4058"
Error code.
3,"Invalid State Code"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
91
Tagged Transaction Layouts – Transaction 023: Delete a Package Request
Transaction 023: Delete a Package Request
If you need to delete a package, you should send FedEx a delete Request. Your delete Request is formatted as follows:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
ALL
The FedEx account number of the Sender is required to successfully process a shipment
deletion Request.
498
Meter Number
FDXE/FDXG
ALL
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully process a shipment deletion Request.
3025
Carrier Code
FDXE/FDXG
ALL
Required.
Valid values:
FDXE – FedEx Express
FDXG – FedEx Ground
FDXE/FDXG
ALL
Required.
Tracking number assigned to a package.
FDXE/FDXG
ALL
Required.
TRACKING
29
Tracking Number
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
92
Tagged Transaction Layouts – Transaction 023: Delete a Package Request
Example of Transaction 023: Delete a Package Request
After placing an order, your customer called to cancel the order. 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 transaction type 023 Delete a Package Request. Your input transaction is formatted as
follows:
Data File
Field Description
0,"023"
Transaction Type 023.
1,"PO # 1234"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
Shipper FedEx account number.
29,"470012345678"
Tracking number.
3025,"FDXE"
Carrier Code, FDXE for FedEx Express.
498,"1234567"
Meter number of the FedEx system.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
93
Tagged Transaction Layouts – Transaction 123: Delete a Package Reply
Transaction 123: Delete a Package Reply
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 day.
When you Request FedEx to delete a package, your delete Reply is formatted as follows:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Returned.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
Returned if the customer included it in the Request transaction, containing the same value.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. For an erroneous
Request or server failure, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or server failure, the error
code will be placed in this field tag.
FDXE/FDXG
ALL
Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
94
Tagged Transaction Layouts – Transaction 123: Delete a Package Reply
Example of Transaction 123: Delete a Package Reply
In response to the previous delete Request transaction, the following transaction is returned:
Data File
Field Description
0,"123"
Transaction Type 123 is Delete a Package Reply.
1,"PO # 1234"
Transaction Identifier. This field will be included in any error or Reply messages.
99,""
The required transaction terminator. It must be the last pair in the transaction.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If the destination state abbreviation in the
example had been invalid, FedEx would respond with the following transaction:
Data File
Field Description
0,"123"
Transaction Type 123 is Delete a Package Reply.
1,"PO # 1234"
Transaction identifier.
2,"7099"
Error code.
3,"No "Tracking Number"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
95
Tagged Transaction Layouts – Transaction 007: Close Request
Transaction 007: Close Request (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 Reply transaction (107) includes the text buffer to produce the FedEx Ground
Close Manifest.
Field
Tag
Field Name
Applicable
Carrier
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
Required.
1
Customer Transaction Identifier
FDXE/FDXG
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
The FedEx account number of the Sender is required to successfully process a Close shipments
Request.
498
Meter Number
FDXE/FDXG
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully process a Close shipments Request.
3025
Carrier Code
FDXE/FDXG
Required.
Valid value:
FDXG – FedEx Ground Close Request
CLOSE
1007
Close/Manifest Date
FDXG
Required for Closing out a FedEx Ground shipping cycle.
1366
Close/Manifest Time
FDXG
Required for Closing out a FedEx Ground shipping cycle.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
96
Tagged Transaction Layouts – Transaction 007: Close Request
Field
Tag
Field Name
1371
Report Only Request Flag
Applicable
Carrier
FDXG
Field Requirements
Optional.
Y if requesting a manifest from the last 3 days’ Closes. For example if you failed to print your Close
Manifest, and you need the Manifest Data re-sent to you.
N if Closing out a shipment cycle and creating the manifest.
A default value of N is assumed if this field is not passed in the Request transaction.
N or blank is the default. Indicates Close out current shipment cycle and create the manifest, MTW,
HazMat Report.
Y = Requesting a report generated from a previous Close. – Must indicate report in field tag 3014.
Note: Legacy behavior: Y = requesting a manifest from previous Close.
N + 3014 = return report indicated for current Close (If N, operationally required reports 1, 2 and
MTW are always returned.)
Y + 3014 = return only the single report indicated for the previous Close cycle.
3014
Report Indicator
FDXG
Valid values:
1 = Ground Manifest report
2 = Ground HazMat report
3 = Ground COD report
29
Tracking Number
FDXG
Contains the tracking number assigned to a shipment associated to a manifest.
TRANSACTION TERMINATOR
99
End Of Record
FDXE/FDXG
Required.
Example: 99,""
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
97
Tagged Transaction Layouts – Transaction 007: Close Request
Example of Transaction 007: Close Request
By Closing, you send all the pertinent package information for this particular day to FedEx Ground. Closing will return to you the Shipping Manifest for that day. The FedEx
Ground Server will keep track of all your shipments processed since your last Close transaction.
NOTE:
You CANNOT delete a package after it has been included in a Close transaction. However, you can Close many times in one day, as long as you are sure that
you all the shipments since your last Close are final.
On Monday January 3, 2005, at 5:30 p.m., you have completed the processing of your outbound shipments and you are ready to Close your shipping activity with FedEx
Ground. Your FedEx account number is 123456789. The meter number is 1234567. This is a Request to Close and get a Manifest. Your input transaction should be
formatted as follows:
Data File
Field Description
0,"007"
Transaction Type 007 is Close Request.
1,"Daily Close"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
Your account number.
498,"1234567"
Your meter number.
3025,"FDXG"
Carrier is FDXG, i.e., FedEx Ground.
1007,"20050103"
Day of Close.
1366,"173000"
Time of Close. This is a 24-hour clock.
1371,"N"
N for Closing AND Requesting a Manifest.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
98
Tagged Transaction Layouts – Transaction 107: Close Reply
Transaction 107: Close Reply (Applicable to FedEx Ground Only)
Reply to the Close Request Transaction. The Close Reply brings back the ASCII Data Buffer which is used by the customer to print the Close Manifest. The Manifest is
essential at time of pickup.
Field Tag
Field Name
Field Requirements
STANDARD INFO
0
Transaction Code
Required.
1
Customer Transaction Identifier
Optional.
Returned if the customer included it in the Request transaction, containing the same value.
ERROR HANDLING
2
Transaction Error Code
Returned only if an error occurred while processing the transaction. For an erroneous Request or server
failure, the error code will be placed in this field tag.
3
Transaction Error Message
Returned only if an error occurred while processing the transaction. Passed back in response indicating
failed processing. For an erroneous Request or server failure, the error code will be placed in this field tag.
1005-#
Manifest/Invoice File Name
Returned in successful Reply.
The number of field occurrences is dependent upon the value passed in Manifest Total (field 1372).
File names of the Manifest(s) to be printed by the customer. (ASCII files)
1367-#
Manifest Data Buffer
Returned in successful Reply.
The number of field occurrences is dependent upon the value passed in Manifest Total (field 1372).
1372
Manifest Total
Returned in successful Reply.
Number of Manifests to be printed, to be used in number of occurrences of fields 1005 and 1367.
1594
COD Report Buffer
Ground COD Report Buffer.
Format: Base 64 encoded ASCII
3048
Multiweight Report Content Buffer
This buffer will contain the multiweight report for FedEx Ground shipments.
Format: Base 64 encoded ASCII
3114
Hazardous Materials Report Buffer
Contains the Hazardous Materials certification report.
Format: Base 64 encoded ASCII
CLOSE
TRANSACTION TERMINATOR
99
End Of Record
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
99
Tagged Transaction Layouts – Transaction 107: Close Reply
Example of Transaction 107: Close Reply
In response to the previous Closing Request transaction, and assuming that the previous was the second Closing transaction for that day, your Reply transaction would be
formatted as follows:
Data File
Field Description
0,"107"
Transaction Type 107 is Close Reply.
1,"112301"
Transaction Identifier. This filed will be included in any error or Reply messages.
1372,"2"
Number of Manifest(s) for this customer/day.
1005-1,"Manifest1.txt"
File name of the first manifest.
1005-2,"Manifest2.txt"
File name of the second manifest.
1367-1,"(Data Buffer1)"
Data buffer of the first manifest (text format contained within the buffer).
1367-2,"(Data Buffer2)"
Data buffer of the second manifest (text format contained within the buffer).
99,""
The required transaction terminator. It must be the last pair in the transaction.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If meter number were omitted in the example,
FedEx would respond with the following transaction:
Data File
Field Description
0,"107"
Transaction Type 107 is Close Reply.
1,"112301"
Transaction identifier.
2,"8029"
Error code.
3,"Meter Number is required"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
100
Tagged Transaction Layouts – Transaction 404: Tracking Request
Transaction 404: Tracking Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD HEADER
0
Transaction Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
1
Customer Transaction Identifier
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
10
Sender FedEx Account Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
498
Meter Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
These fields in this section are applicable to ALL Tracking Requests (Number and
Reference).
Exception Tracking Number UID is n/a for Reference searches.
TRACKING CONTROL FIELDS
3025
Carrier Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended to ensure the desired results for your request.
Valid values:
• FDXE – FedEx Express
• FDXG – FedEx Ground
• FDXC – FedEx Cargo
• FXCC – FedEx Custom Critical
• FXFR – FedEx Freight
Note: Some text may refer to "carrier" as "service."
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
101
Tagged Transaction Layouts – Transaction 404: Tracking Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1534
Detail Scan indicator
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional field.
N or not present – defaults to Summary/Profile data including current status.
Y – returns Profile + Detail Scan activity (multiple Scan Detail Structures) for each
package.
1537
Search / Relationship String
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Contains the value to be tracked (e.g., Track Number or a Reference Value).
1538
Search / Relationship Type Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Specifies the type of track desired on the "Search String" field.
Values:
0 or not present – defaults to Tracking Number / Door Tag
1 = Express MPS (Applicable to FDXE Only)
7 = Ground Shipment ID (Applicable to FDXG Only)
14 = TCN (becomes SHR, CUR) (Valid for Request only)
15 = BOL (bill of lading) (multi)
16 = PARTNERCARNBR (Applicable to FXFR Only)
*17 = FREEFORMREF (Valid for Request only)
25 = INV (Applicable for FDXG, FXFR)
26 = PO (Applicable for FDXG, FXFR)
27 = CUSTAUTHNUM (Applicable to FXFR Only)
28 = CUR (Applicable for FDXG, FXFR)
29 = DEPARTMENT (Applicable to FDXG Only)
30 = PARTNUM (Applicable to FXCC Only)
31 = SHR (Applicable for FDXE, FDXC, FXFR)
36 = RAERMA (Applicable for FDXE, FDXG)
* FREEFORMREF value 17 is non-carrier specific and allows a search by Reference
across all available Carrier Codes.
Some Search Types limit the search to a carrier (e.g., Ground Shipment ID, Express
MPS).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
102
Tagged Transaction Layouts – Transaction 404: Tracking Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1752
Tracking Number Unique ID
FDXE
FDXG
FDXC
FXCC
ALL
Required if a previous Track By Number response indicated that duplicates exist. The
Previous response will return summary information about the available choices along
with this field.
Duplicates:
If it is desired to fully track one of the items returned in the duplicate summary reply,
then the subsequent request must contain the Tracking Number (search value) and the
paired unmodified unique ID.
1582
Begin Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended.
Required entry of date range to find desired results for reference tracking number. If not
provided, FedEx will default to a range that may not refine the search as needed.
If provided, End Date (field tag 1583) is required.
Format: YYYYMMDD
• Begin must be < 730 days from system (2 yrs for Freight)
• Begin must be < = End date
• End cannot be > system + 1
• Range (End–Begin) must be < 31 days
• Range (End–Begin) must be < = 90 (nbr)
(30 day range is applicable to Ref Trk only)
• Special rule for an Express Track by number request with a begin date > 90 days.
The Begin–End range is limited to 10 days.
1583
End Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended.
If provided, Begin Date (field tag 1582) is required.
Required entry of date range to find desired results for reference tracking number. If not
provided, results may vary.
Format: YYYYMMDD
• Begin must be < 730 days from system (2 yrs for Freight)
• Begin must be < = End date
• End cannot be > system + 1
• Range (End–Begin) must be < 31 days
• Range (End–Begin) must be < = 90 (nbr)
(30 day range is applicable to Ref Trk only)
• Special rule for an Express Track by number request with a begin date > 90 days.
The Begin–End range is limited to 10 days.
TRACK BY REFERENCE RELATED
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
103
Tagged Transaction Layouts – Transaction 404: Tracking Request
Field
Tag
Applicable
Carrier
Valid
For
Shipment Related Account Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended.
Providing the Account Number will return all packages matching the search value and
associated with this account
If account Is not specified, then the Destination country and postal (applicable
countries) is required.
The Reply data may be restricted if account is not provided.
50
Recipient Country Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional when 1754 (Shipment Related Account Number) is provided.
Required for Reference Track when Account number is NOT provided.
17
Recipient Postal Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional when 1754 (Shipment Related Account Number) is provided and Recipient
Country is provided and is not postal aware.
Required for Reference Track when Account Number is NOT provided and the
Recipient Country is postal aware.
1754
Field Name
LANGUAGE LOCALE SELECTION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Requirements
Combined use of Language Code and Locale controls the response language and
many error conditions.
Some error conditions will result in English only Replies (e.g., Poorly constructed
request, internal server failure).
Some Language Codes require Locale Code to be provided or an error will be returned.
104
Tagged Transaction Layouts – Transaction 404: Tracking Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1972
Reply Language Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Determines language of the response (e.g., Error message text).
Valid values:
ar = Arabic
da = Danish
de = German
en = English
es = Spanish
es with language code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
he = Hebrew
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
1973
Reply Language Locale Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional (for some languages).
Pairs with Language Code (field tag 1972) and may be required to obtain a specific
dialect of the language selected in field 1972.
Required to obtain a specific dialect of the language selected in field tag 1972.
Valid values:
ES
CA
CN = Chinese Simple
HK = Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
US = pairs with es for US Spanish
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
105
Tagged Transaction Layouts – Transaction 404: Tracking Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Track by Reference, Door Tag or MPS.
Master track number may result in multiple pages of data. A paging technique is used
to request the additional pages of data.
PAGING/ MULTIPLE REQUESTS & RESPONSES
1535
Paging Token
Field Requirements
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Required in order to obtain the additional data on second and subsequent 404
Requests when more related tracking numbers exist that exceed the capacity of any
one response structure.
Should be absent from any first Track request.
Populate Token value with the contents returned in the previous 504 Reply Paging
Token field.
Populate value of "Search String" with original 404 Request.
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
TRANSACTION TERMINATOR
99
End of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
106
Tagged Transaction Layouts – Transaction 404: Tracking Request
Example of Transaction 404: Tracking Request
Data File
Field Description
0,"404"
Transaction Type 404 is Tracking Request.
1,"Tracking"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
Your account number.
498,"1234567"
Your meter number.
3025,"FDXE"
Carrier is FedEx Express.
1534,"N"
Detail scan indicator.
1537,"Test"
Search / Relationship string.
1538,"28"
Search / Relationship type code.
1582,"20060110"
Date range begin.
1583,"20060120"
Date range end.
1754,"987654321"
Related account number.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
107
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Transaction 504: Tracking Reply
Note: Reply Fields are returned UTF-8 encoded to support multiple languages
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
Returned in ALL responses including Errors if server is able to respond.
STANDARD INFO
0
Transaction Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
1
Customer Transaction Identifier
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This transaction ID allows the customer to link the transaction replies back to the
transaction requests.
Returned only if the entire request transaction failed.
ERROR HANDLING
2
Transaction Error Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Passed back in response indicating failed processing. For an erroneous Request or
server failure, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Passed back in response transaction indicating failed processing. For an erroneous
transaction, the error message will be placed in this field tag.
(English only)
1755
Local Language Error Text
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This field will be returned with the error text in the language requested except when
English is selected (explicitly or by default).
See field tag 3.
SOFT ERROR/WARNING MESSAGE
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Soft Error fields can repeat on a Track Reply. The sequence number corresponds to the
tracking number it pairs with.
e.g., 29-1 corresponds to 557-1
108
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
557-#
Message Type Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
558-#
Message Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
559-#
Message Text
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
(English only)
1756-#
Local Language Message Text.
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This field will be returned with the message text in the language requested except when
English is selected (explicitly or by default).
See field tag 559.
A Profile represents a single tracking number. Some requests may result in multiple
profiles. (e.g., Reference Tracking)
TRACKING PROFILE
1584
Tracking Groups
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Number of Tracking Profile groups returned (1 per track #).
Returned if a Track By Number results in Duplicates.
1714
Duplicate Waybill Flag
FDXE
FDXG
FDXC
FXCC
ALL
Y if Duplicates exist that requires further request detail to qualify the specific shipment.
Returned if a Track By Number results in Duplicates.
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Tracking Number provided in the 404 Track Request or linked to reference track
request.
If duplicate tracking numbers occur, see field 1752 (Tracking Unique ID).
(Freight N/A )
29-#
Tracking Number
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
109
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
1752-#
Field Name
Tracking Unique ID
(Freight n/a)
Applicable
Carrier
Valid
For
FDXE
FDXG
FDXC
FXCC
ALL
Further identifies a Tracking Number in case Duplicates exist.
Returned if a Track By Number results in Duplicates.
Field Requirements
1169-#
Status Code /
Tracking Status Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
For example, SP = split shipment.
Pairs with field tag 1701.
1701-#
Status Description /
Tracking Status Description
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Status description pairs with field tag 1169.
Field is returned UTF-8 encoded to support multiple languages.
1974-#
Service Commit Message
FDXE
ALL
Only applicable to H3 Express freight areas inbound to U.S. to FedEx location only.
Additional days may be required for final delivery. Please call Customer Service for
details.
Field is returned UTF-8 encoded to support multiple languages.
3025-#
Carrier Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Carrier associated with tracking number
Returned if a Track By Number results in Duplicates.
Considered part of the Profile Summary.
Reflects Shipper data for Freight Origin Data for Custom Critical.
SHIPPER OR ORIGIN
7-#
Shipper City
FXFR/FXCC
ALL
City name from which the shipment is originating.
8-#
Shipper State
FXFR/FXCC
ALL
State code from which the shipment is originating.
9-#
Shipper Postal
FXCC
ALL
Postal code from which the shipment is originating. Must be numeric for U.S. Special
characters allowed.
FXFR/FXCC
ALL
Represents the country from which the shipment will be originating.
117-#
Shipper Country Code
RECIPIENT OR DELIVERY LOCATION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Considered part of the Profile Summary.
Reflect Shipped data for Freight Origin Data for Custom Critical.
110
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
15-#
16-#
Field Name
Recipient City
Recipient State
Applicable
Carrier
Valid
For
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Field Requirements
Name of the city to which the shipment is destined.
Returned if a Track By Number results in Duplicates.
State or province code to which the shipment is destined.
Returned if a Track By Number results in Duplicates.
17-#
Recipient Postal
FXCC
ALL
Postal Code returned if Recipient Country Code is US or CA.
50-#
Recipient Country
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if Recipient Country Code is US or CA
Returned if a Track By Number results in Duplicates.
Considered part of the Profile Summary.
Carrier Facility locations:
ORIGIN/DESTINATION CARRIER FACILITY INFORMATION
Freight ->Terminal
Cargo -> Airport
1738-#
Origin Location City
FXFR/FDXC
ALL
Name of the city of the carrier facility for the package origin.
1739-#
Origin Location State
FXFR/FDXC
ALL
State or province of the carrier facility for the package origin
1740-#
Origin Location Country
FXFR/FDXC
ALL
Name of the country of the carrier facility for the package origin.
1741-#
Destination Location City
FXFR/FDXC
ALL
Name of the city of the carrier facility for the package destination.
1742-#
Destination Location State
FXFR/FDXC
ALL
State or province of the carrier facility for the package destination
1743-#
Destination Location Country
FXFR/FDXC
ALL
Name of the country of the carrier facility for the package destination.
1744-#
Total Transit Distance
FXCC
ALL
Returned in Miles only at this time.
1745-#
Distance to Destination
FXCC
ALL
Returned in Miles only at this time.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
111
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
1696-#
24-#
Applicable
Carrier
Valid
For
Distance Unit Of Measure (UOM)
FXCC
ALL
Defines units of the Total Transit distance & Distance to Destination Fields.
Valid values:
• KM
• MI
Ship Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Date Package shipped/tendered over to FedEx
Field Name
Field Requirements
Format: YYYYMMDD
Returned if a Track By Number results in Duplicates.
1736-#
Estimated Pickup Date
FXCC
ALL
Format: YYYYMMDD
1737-#
Estimated Pickup Time
FXCC
ALL
Format: HHMMSS
1166-#
Deliver To Code /
Deliver To Location code
FDXE
ALL
Pairs with field tag 1705 (Deliver To Description).
1705-#
Deliver To Description /
Deliver To location Desc
FDXE
ALL
Pairs with field tag 1166 (Deliver To Code).
Field is returned UTF-8 encoded to support multiple languages.
1975-#
Signature Proof of Delivery Available
FDXE/FDXG
USD
ALL
Y if Signed For signature image is available.
1551-#
Delivery Notification Flag
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Contains Y if Delivery email updates are available for this tracking number.
Valid values: Y/N
1960-#
Exception Notification Flag
FDXE
FDXG
FXFR
ALL
Contains Y if Exception email updates are available for this tracking number.
Exception Notifications include: General Delivery Exception, Incorrect Address,
Clearance Delay, and International Shipment Release.
Exception notifications are not available after shipment delivery.
Valid values: Y/N
1704-#
Service Type Description
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Service Type.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
112
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
1718-#
Package Type Description
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Packaging Type (e.g., "FedEx Envelope").
1706-#
Signed For
FDXE/FDXG
ALL
Name on Delivery Record or Release number.
Field is returned UTF-8 encoded to support multiple languages.
1117-#
Package Sequence
FDXE
ALL
The sequence of the package for FedEx Express international MPS (1 of X).
116-#
Total Pieces
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Number of pieces in a shipment.
FDXG will be 1.
75-#
Weight Type
.
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Valid values:
• KGS
• LBS
Field Requirements
1401-#
Total Package Weight
FDXE/FDXG
ALL
Package weight of the individual piece.
1400-#
Shipment Total Weight
FXFR
FXCC
FDXC
FDXE
ALL
Shipment weight.
Considered part of the Profile Summary.
DELIVERY COMMITS
1339-#
Estimated Delivery Date
FDXE
FDXG
FXCC
FXFR
ALL
Projected package delivery date based on Ship Date, service and destination.
Format: YYYYMMDD
Not populated if Delivery has already occurred.
1340-#
Estimated Delivery Time
FDXG
FDXE
FXCC
FXFR
ALL
Projected package delivery time based on Ship Date, Service and Destination.
Format: HHMMSS
Apples to certain FedEx Home Delivery services.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
113
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1720-#
Delivery Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Date package was delivered.
1707-#
Delivery Time
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Time package was delivered.
Considered part of the Profile Summary.
Relationship Group fields may occur zero to many times for each Tracking Number.
RELATIONSHIP GROUP
1536-#
1537-#-#
Number of Relationships
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Number of relationships that this specific Track Number Profile participates in.
Search / Relationship String
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Relationship actual value corresponds to the Relationship Type Code returned.
UTF-8 encoded for language support.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
114
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
1538-#-#
Field Name
Search / Relationship Type Code
Applicable
Carrier
Valid
For
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Field Requirements
Relationship identifier.
Corresponds to the Relationship String.
Valid values:
Not present = no relationships identified for this track number
1 = ExpressMPS Master
7 = Ground – Ship ID
36 = RAERMA
15 = BOL
16 = PARTNERCARNBR
24 = RETURNTOSHIPPER
25 = INV
26 = PO
27 = CUSTAUTHNUM
28 = CUR
29 = DEPARTMENT
30 = PARTNUM
31 = SHR
35 = COD (Exp trk Nbr)
Considered part of the Profile Summary.
Returned for Cargo shipments only when they are currently split across vehicles.
SPLIT SHIPMENT STATUS SECTION
1746-#
Split Shipment Groups
FDXC
ALL
Contains number of Split shipment repeating information groups (e.g., value = 3 means
to expect 3 iterations of the split shipment fields (excluding this field).
1747-#-#
Split Shipment Pieces
FDXC
ALL
Number of pieces/skids traveling together.
1748-#-#
Split Shipment Date
FDXC
ALL
Format: YYYYMMDD
1749-#-#
Split Shipment Time
FDXC
ALL
Format: HHMMSS
1750-#-#
Split Shipment Status code
FDXC
ALL
The most recent status code for a specific split.
This field repeats for the number of iterations indicated in field tag 1746 (Split Shipment
Groups).
1751-#-#
Split Shipment Status Description
FDXC
ALL
The most recent status description for a specific split.
This field repeats for the number of iterations indicated in field tag 1746 (Split Shipment
Groups).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
115
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Returned only if Tracking Detail Indicator = Y.
Scan Detail fields repeat one to many times for each Tracking Number (except field tag
1715 – Number of Track Activities).
See Repeating Tag Note below.
Scan order of appearance is determined by GMT time of the scan. The scan date/times
are local to the time zone of the event.
SCAN DETAIL
1715-#
Field Requirements
Number Of Track Activities
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Number of Scan Detail lines for this specific track number.
Appears once per tracking number.
1159-#-#
Scan Description
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Literal description of the Scan activity.
1171-#-#
Scan Type Code
FDXE
FDXG
FDXC
FXCC
ALL
Carrier’s Scan code. Pairs with the scan description.
1168-#-#
Status Exception Code
FXFR
ALL
Further defines the Scan Type code’s specific type (e.g., DEX08 business closed).
Pairs with field tag 1711.
1711-#-#
Status Exception Description
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Literal description that pairs with the Scan Status Code.
Pairs with field tag 1168.
1160-#-#
Scan Location City
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
City name hosting the Station that is responsible for the scan.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
116
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1161-#-#
Scan Location State Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
1248-#-#
Scan Location Postal Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
1164-#-#
Scan Location Country Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Country where the scan occurred.
1162-#-#
Scan Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Local Date when the scan occurred.
Format: YYYYMMDD
1163-#-#
Scan Time
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Local time zone when the scan occurred.
Format: HHMMSS
Possibly returned for Track by Reference, MPS, & Door Tag only when more related
tracking numbers exist that exceed the capacity of one response structure.
PAGING FIELDS
1450
More Data Indicator
State Abbreviation hosting the Station that is responsible for the scan.
FDXE
FDXG
FDXC
FXCC
FXFR
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
ALL
Y = more data exists.
Returned if a Track By Number results in Duplicates.
117
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Field
Tag
1535
Field Name
Paging Token
Applicable
Carrier
Valid
For
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Field Requirements
Populated in the response results when more related tracking information exist that
exceed the capacity of any one response structure.
Client should populate Paging Token value in subsequent 404 Request with the value
returned in the previous 504 Reply.
Do not modify the field value.
Returned if a Track By Number results in Duplicates.
TRANSACTION TERMINATOR
99
End Of Record
FDXE
FDXG
FDXC
FXCC
FXFR
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required.
118
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Example of Transaction 504: Tracking Reply
Data File
Field Description
0,"504"
Transaction Type 504 is Tracking Reply.
1,"Tracking"
Transaction Identifier. This field will be included in any error or Reply messages.
15,"Saint Louis"
Destination city.
16,"MO"
Destination state.
24,"20060118"
Ship date.
29,"123456789123456"
Tracking number.
50,"US"
Destination country.
75,"LBS"
Weight units.
116,"1"
Package count.
1117,"1"
Package sequence number.
1169,"DL"
Package status code.
1401,"2.0"
Package weight.
1536,"2"
Number of relationships.
1537,"Test"
Search / Relationship string.
1538,"28"
Search / Relationship type code.
1551,"Y"
Delivery notification flag.
1584,"1"
Tracking groups.
1701,"Delivered"
Tracking Status Description
1704,"Ground-Domestic"
Service type.
1706,"SNOCE"
Name of person signed by.
1707,"114302"
Delivery time.
1718,"Package"
Package type description.
1720,"20060119"
Delivery date.
1752,"120060118155211505000~123456789123456"
Tracking number unique ID.
1960,"N"
Exception notification flag.
1975,"Y"
Signature Proof of Delivery available.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
119
Tagged Transaction Layouts – Transaction 504: Tracking Reply
Data File
Field Description
3025,"FDXG"
Carrier code.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
120
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
1
Customer Transaction Identifier
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
10
Sender FedEx Account Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
498
Meter Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
REQUEST CONTROL FIELDS
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
121
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1582
Begin Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended.
Required entry of date range to find desired results for reference tracking number. If not
provided, FedEx will default to a range that may not refine the search as needed.
If provided, End Date (field tag 1583) is required.
Format: YYYYMMDD
• Begin must be < 730 days from system
(2 yrs for Freight)
• Begin must be < = End date
• End cannot be > system + 1
• Special rule for an Express Track by number request with a begin date > 90 days. The
Begin to End range is limited to 10 days.
1583
End Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended.
If provided, Begin Date (field tag 1582) is required.
Required entry of date range to find desired results for reference tracking number. If not
provided, results may vary.
Format: YYYYMMDD
• Begin must be < 730 days from system
(2 yrs for Freight)
• Begin must be < = End date
• End cannot be > system + 1
• Special rule for an Express Track by number request with a begin date > 90 days. The
Begin to End range is limited to 10 days.
3025
Carrier Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional, but recommended to ensure the desired results for your request, else FedEx will
make an attempt to determine the desired results.
Valid values:
• FDXE
• FDXG
• FDXC
• FXCC
• FXFR
Note: Some text may refer to "carrier" as "service."
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
122
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
29
1752
Applicable
Carrier
Valid
For
Tracking Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Door Tag is not applicable for this request.
Tracking Number Unique ID
FDXE
FDXG
FDXC
FXCC
ALL
Optional.
Populate only if the UID is known from a previous Tracking request or an Email
notifications request that resulted in a duplicate reply.
Field Name
Field Requirements
Note: IT IS NOT NECESSARY to Track prior to issuing this Notify request. The
Notifications transaction will return the needed information to uniquely identify a shipment
in the event that a non-unique condition is found.
DUPLICATES:
If it is desired to continue the notifications request for one of the items returned in the
duplicate summary reply, then the subsequent request must contain the Tracking number
and the paired unmodified unique ID.
LANGUAGE LOCALE SELECTION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Combined use of Language Code and Locale controls the response language and many
error conditions.
Some Error conditions will result in English only replies. (e.g., Poorly constructed request,
internal server failure).
Some Language Codes require Locale Code to be provided or an error will be returned.
123
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1972
Reply Language Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Specifies the Transaction Reply language (e.g., Error message Text).
Valid values:
ar = Arabic
da = Danish
de = German
en = English
es = Spanish
es with language locale code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
he = Hebrew
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
1973
Reply Language Locale Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional (for some languages).
Pairs with Language Code and may be required to obtain a specific dialect of the language
selected in field tag 1972.
Valid values:
ES
CA
CN = Chinese Simple
HK = Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
US = pairs with es for US Spanish
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
124
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
Up to a maximum of 6 email combinations are supported.
For each supplied email address, the notification type and format fields are required.
Language selection is optional.
If an email address is provided but notification flags are not specified, then an error will be
returned.
EMAIL NOTIFICATION
1201
Sender Email Address
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Included in the notification identifying the requestor of this notification.
32
Sender Contact Name
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Included in the notification identifying the requestor of this notification.
Personal Message
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Personal messages are not applicable with wireless formatted notifications.
UTF-8 encoded message.
1204-#
Email Notification Address
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Must contain one "@" and then at least one "."
A minimum of one occurrence is required.
1551-#
Delivery Notification Flag
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required if Delivery Notification is desired.
If = Y, corresponding email address in field tag 1204 will be emailed delivery notification.
Valid values: Y/N
Default = N
One or more of the notification Flags must be = Y.
1203
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
125
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1960-#
Exception Notification Flag
FDXE
FDXG
FXFR
ALL
Required if Exception Notifications is desired.
If = Y, corresponding email address in field tag 1204-# will be emailed any applicable
Exception notifications.
Exception Notifications include: General Delivery Exception, Incorrect Address, Clearance
Delay, and International Shipment Release.
Exception notifications are not available after shipment delivery.
Valid values: Y/N
Default = N
One or more of the Notification Flags must be = Y.
1964-#
Email Notification Format
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
Corresponds to each occurrence of field 1204-#. A different format can be specified for
each email address. This format will apply to all notifications sent to the email address.
Valid values:
H = HTML
T = Text
W = Wireless
Note: Text format is not supported for languages zh, ja, ko.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
126
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1552-#
Language Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional.
Determines the language of the email content for the address specified in field tag 1204-#.
Valid values:
da = Danish
de = German
en = English
es = Spanish
es with language code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
1968-#
Language Locale Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Optional (for some languages).
Pairs with Language Code and may be required to obtain a specific dialect of the language
selected in field tag 1552.
Valid values:
ES
CA
US
CN =Chinese Simple
HK =Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
PAGING / MULTIPLE REQUESTS & RESPONSES
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
The Request may result in multiple pages of data. A paging technique is used to request
the additional pages of data.
127
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Field
Tag
1535
Field Name
Paging Token
Applicable
Carrier
Valid
For
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Field Requirements
Optional.
Required in order to obtain the additional data on second and subsequent 420 Requests
when more related tracking numbers exist that exceed the capacity of any one response
structure.
Should be absent from any first Request.
Populate the Paging Token value with the contents returned in the previous 520 Reply
Paging Token field.
Populate value of "Tracking number" with same value contained in the original 420
Request.
TRANSACTION TERMINATOR
99
End Of Record
FDXE
FDXG
FDXC
FXCC
FXFR
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required.
128
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Example of Transaction 420: Tracking Notifications Request
Data File
Field Description
0,"420"
Transaction Type 420 is Tracking Notifications Request.
1,"TR test"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
Your account number.
498,"1234"
Your meter number.
50,"US"
Recipient country.
29,"647882549880"
Your tracking number.
1972,"fr"
Reply language code.
1973,"CA"
Reply language locale code.
32,"TULIP"
Your name.
1201,"1201sender email"
Your email address.
1203,"Message goes here"
Optional message.
1204-1,"[email protected]"
Additional email address.
1551-1,"y"
Delivery notification flag.
1960-1,"Y"
Exception notification flag.
1964-1,"T"
Email format.
1552-1,"en"
Language code.
1968-1,""
Language locale code.
1204-2,"[email protected]"
Additional email address.
1551-2,"y"
Delivery notification flag.
1960-2,"y"
Exception notification flag.
1964-2,"T"
Email notification format.
1552-2,"en"
Language code.
1968-2,""
Language locale code.
1204-3,"[email protected]"
Additional email address.
1551-3,"Y"
Delivery notification flag.
1960-3,"y"
Exception notification flag.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
129
Tagged Transaction Layouts – Transaction 420: Tracking Notifications Request
Data File
Field Description
1964-3,"w"
Email notification format.
1552-3,"fr"
Language code.
1968-3,""
Language locale code.
1204-4,"[email protected]"
Additional email address.
1551-4,"Y"
Delivery notification flag.
1960-4,"y"
Exception notification flag.
1964-4,"w"
Email notification format.
1552-4,"fr"
Language code.
1968-4,""
Language locale code.
1204-5,"[email protected]"
Additional email address.
1551-5,"Y"
Delivery notification flag.
1960-5,"y"
Exception notification flag.
1964-5,"w"
Email notification format.
1552-5,"fr"
Language code.
1968-5,""
Language locale code.
1204-6,[email protected]
Additional email address.
1551-6,"y"
Delivery notification flag.
1960-6,"y"
Exception notification flag.
1964-6,"w
Email notification format.
1552-6,"fr"
Language code.
1968-6,""
Language locale code.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
130
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Transaction 520: Tracking Notifications Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
Returned in ALL responses including Errors if server is able to respond.
STANDARD INFO
0
Transaction Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Required.
1
Customer Transaction Identifier
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This transaction ID allows the customer to link the transaction replies back to the
transaction requests.
Returned only if the entire Request transaction failed.
ERROR HANDLING
2
Transaction Error Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Passed back in the Reply indicating failed processing of transaction. For an erroneous
transaction, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
(English only version of error text )
1755
Local Language Error Text
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This field will be returned with the error text in the language requested except when
English is selected (explicitly or by default).
See field tag 3.
SOFT ERROR / WARNING MESSAGE
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field returned as UTF-* encoded to support multiple languages
Soft Error fields can repeat on a track reply. The sequence number corresponds to the
tracking number it pairs with.
e.g., 29-1 corresponds to 557-1
131
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
557-#
Message Type Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
558-#
Message Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
559-#
Message Text
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Returned if tracking number level error occurred.
(English only version of error text )
1756-#
Local Language Message Text
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
This field will be returned with the message text in the language requested except when
English is selected (explicitly or by default).
See field tag 559.
A Profile represents a single tracking number. Some requests may result in multiple
profiles. (e.g., Duplicates found or Door Tag).
PACKAGE PROFILE
1584
Tracking Groups
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Number of Tracking Profile groups returned (1 per track #).
Returned if duplicates of a Tracking number are detected.
1714
Duplicate Waybill Flag
FDXE
FDXG
FDXC
FXCC
ALL
Y if duplicates exist that requires further request detail to qualify the specific shipment.
Returned if duplicates of a Tracking number are detected.
29-#
Tracking Number
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Tracking number assigned to a package.
Returned if duplicates of a Tracking number are detected.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
132
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1752-#
Tracking Unique ID
FDXE
FDXG
FDXC
FXCC
ALL
Further identifies a Tracking number in case Duplicates exist.
Returned if duplicates of a Tracking number are detected.
3025-#
Carrier Code
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Valid values :
• FDXE
• FDXG
• FXFR
• FXCC
• FDXC
• Returned if duplicates of a Tracking number are detected.
Ship Date
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Format: YYYYMMDD
Returned if duplicates of a Tracking number are detected.
Delivery Notification Flag
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Contains Y only if the corresponding email (1204-#) requested delivery notification and
FedEx was able to apply the notification to the tracking number.
Valid values: Y/N
FDXE
FDXG
FXFR
ALL
24-#
1551-#-#
1960-#-#
Exception Notification Flag
Note: This field matches the sequence of the 420 Request Email Notification Address
(field tag 1204-#). The notify flags may differ for each email occurrence, and thus the
applied notifications can change.
Contains Y only if the corresponding email (1204-#) requested exception notification and
FedEx was able to apply the notification to the tracking number.
Exception Notifications include: General Delivery Exception, Incorrect Address,
Clearance Delay, and International Shipment Release.
Exception notifications are not available after shipment delivery.
Valid values: Y/N
Note: This field matches the sequence of the 420 Request Email Notification Address
(field tag 1204-#). The notify flags may differ for each email occurrence, and thus the
applied notifications can change.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
133
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
Considered part of the Profile Summary.
Reflects Recipient for Freight.
Delivery location for FedEx Express, FedEx Ground, FedEx Custom Critical, FedEx
Cargo.
RECIPIENT OR DELIVERY LOCATION
Duplicates:
Always returned but most helpful in duplicate conditions. This information may help
determine the specific tracking number to select for a notification request.
15-#
Recipient City
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
City name of the person receiving the shipment.
Returned if duplicates of a Tracking number are detected.
16-#
Recipient State
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
State code of the person receiving the shipment.
Returned if duplicates of a Tracking number are detected.
50-#
Recipient Country
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Country name of the person receiving the shipment.
Returned if duplicates of a Tracking number are detected.
Possibly returned when Duplicates exist that exceed the capacity of one response
structure.
PAGING FIELDS
1450
More Data Indicator
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Y = more data exists.
Returned if duplicates of a Tracking number are detected.
1535
Paging Token
FDXE
FDXG
FDXC
FXCC
FXFR
ALL
Populated if the response results in more than one page of data.
Populate Paging Token value in subsequent 420 with the value returned in the previous
520 Reply.
Do not modify the field value
Returned if duplicates of a Tracking number are detected.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
134
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
TRANSACTION TERMINATOR
99
End Of Record
FDXE
FDXG
FDXC
FXCC
FXFR
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required.
135
Tagged Transaction Layouts – Transaction 520: Tracking Notifications Reply
Example of Transaction 520: Tracking Notifications Reply
Data File
Field Description
0,"520"
Transaction Type 520 is Tracking Notifications Reply.
1,"TR test"
Transaction Identifier. This field will be included in any error or Reply messages.
1584,"1"
Tracking groups.
29-1,"647882549880"
Tracking number.
1752-1,"2453601000~647882549880"
Tracking unique ID.
3025-1,"FDXE"
Carrier code.
15-1,"FAYETTEVILLE"
Recipient city.
16-1,"NC"
Recipient state.
50-1,"US"
Recipient country.
24-1,"20050818"
Ship date.
1551-1-1,"Y"
Delivery notification flag.
1960-1-1,"N"
Exception notification flag.
1551-1-2,"Y"
Delivery notification flag.
1960-1-2,"N"
Exception notification flag.
1551-1-3,"Y"
Delivery notification flag.
1960-1-3,"N"
Exception notification flag.
1551-1-4,"Y"
Delivery notification flag.
1960-1-4,"N"
Exception notification flag.
1551-1-5,"Y
Delivery notification flag.
1960-1-5,"N"
Exception notification flag.
1551-1-6,"Y"
Delivery notification flag.
1960-1-6,"N"
Exception notification flag.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
136
Tagged Transaction Layouts – Transaction 405: Signature Proof of Delivery Request
Transaction 405: Signature Proof of Delivery Request
The Signature Proof of Delivery (SPOD) offers you the ability to request proof of shipment delivery and the signature of the party which accepted the package in the form of
a Letter or Fax. Based on the information you provide in the 405 transaction, you will receive a full or partial SPOD Letter or Fax.
A full SPOD displays the full shipper and recipient information on the document. To receive a full SPOD, you must provide an account number associated with the
shipment tracking number.
A partial SPOD will not display the confidential shipper nor recipient information on the SPOD document. A partial SPOD is returned if the account number specified in the
SPOD Request is not related to the shipment tracking number.
Note: The PDF formatted SPOD Letters are supported with Adobe Reader 4.0 or higher.
The following fields can be sent to the FedEx server to obtain a Signature Proof of Delivery:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
ALL
The FedEx account number of the Sender is required to successfully receive a
Signature Proof of Delivery (SPOD) documentation.
498
Meter Number
FDXE/FDXG
ALL
The unique meter number assigned to the Sender’s FedEx account number is
required to successfully receive a SPOD document.
3025
Carrier Code
FDXE/FDXG
ALL
Optional.
Valid values:
FDXE – FedEx Express
FDXG – FedEx Ground
TRACKING
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
137
Tagged Transaction Layouts – Transaction 405: Signature Proof of Delivery Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
24
Ship Date
FDXE/FDXG
ALL
Required for FDXE.
Optional for FDXG.
The date on which package was shipped.
For FDXE, +/- 5 days are allowed.
Format: YYYYMMDD
29
Tracking Number
FDXE/FDXG
ALL
Required.
Shipment Related Account Number
FDXE/FDXG
ALL
Optional, but recommended.
Specific account number associated with a shipment (as opposed to account number
in tag 10, which is that of party sending request). This account number is not
necessarily the same as the "sender" or "bill to" account number for a shipment, but it
could contain either.
1456
SPOD Request Type
FDXE/FDXG
U.S. &
Canada
only
Required.
The type of SPOD being Requested to be provided.
Valid values:
L = Letter
F = Fax
1457
SPOD Letter Format
FDXE/FDXG
U.S. &
Canada
only
Required if SPOD Request Type = L (Letter).
Valid value:
2 = PDF
1754
SPOD
SPOD FAX
1458
SPOD Fax Recipient Name
FDXE/FDXG
U.S. &
Canada
only
Required if SPOD Request Type = F (Fax).
1459
SPOD Fax Recipient Number
FDXE/FDXG
U.S. &
Canada
only
Required if SPOD Request Type = F (Fax).
1460
SPOD Fax Sender Name
FDXE
U.S. &
Canada
only
Required if SPOD Request Type = F (Fax).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
138
Tagged Transaction Layouts – Transaction 405: Signature Proof of Delivery Request
Field
Tag
Field Name
1461
SPOD Fax Sender Phone Number
1462
Language Indicator
Applicable
Carrier
Valid
For
FDXE
U.S. &
Canada
only
Required if SPOD Request Type = F (Fax).
FDXE/FDXG
U.S. &
Canada
only
Optional.
Defaults to EN if not present and Request type = L (Letter).
Field Requirements
SPOD MAILING ADDRESS
1463
SPOD Fax Mail Recipient
Name/Company Name
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
1464
SPOD Fax Mail Recipient Address Line 1
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
1465
SPOD Fax Mail Recipient Address Line 2
FDXG
U.S. &
Canada
only
Optional.
Applicable if SPOD Request type = F (Fax).
1466
SPOD Fax Mail Recipient City
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
1467
SPOD Fax Mail Recipient State
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
1468
SPOD Fax Mail Recipient Postal Code
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
1469
SPOD Fax Mail Recipient Country
FDXG
U.S. &
Canada
only
Required if SPOD Request type = F (Fax).
FDXG
U.S. &
Canada
only
Optional.
SPOD GROUND CONFIGURABLE CONSIGNEE DATA
1472
SPOD Ground Recipient Name
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
139
Tagged Transaction Layouts – Transaction 405: Signature Proof of Delivery Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
1473
SPOD Ground Recipient Company Name
FDXG
U.S. &
Canada
only
Optional.
1474
SPOD Ground Recipient Address Line 1
FDXG
U.S. &
Canada
only
Optional.
1475
SPOD Ground Recipient Address Line 2
FDXG
U.S. &
Canada
only
Optional.
1476
SPOD Ground Recipient City
FDXG
U.S. &
Canada
only
Optional.
1477
SPOD Ground Recipient State / Province
FDXG
U.S. &
Canada
only
Optional.
1478
SPOD Ground Recipient Postal Code
FDXG
U.S. &
Canada
only
Optional.
1479
SPOD Ground Recipient Country
FDXG
U.S. &
Canada
only
Optional.
1480
More Information
FDXG
U.S. &
Canada
only
Optional.
FDXE/FDXG
ALL
Required.
Field Requirements
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
140
Tagged Transaction Layouts – Transaction 405: Signature Proof of Delivery Request
Example of Transaction 405: Signature Proof of Delivery
In order to obtain a signature for a package that has been shipped via FedEx, the courier must have delivered the package and obtained a signature before the package
information has been entered into the FedEx database. If you have a package that has been delivered and signed for, you can obtain the signature for that package by
formatting your tracking Request as follows:
Data File
Field Description
0,"405"
Transaction Type 405.
1,"SPOD"
Transaction Identifier. This field will be included in any error or Reply messages.
10,"123456789"
FedEx account number.
24,"20051012"
Date of the shipment (October 12, 2005).
29,"000000000000"
Tracking number.
1754,"123456789"
Shipment related account number.
1456,"L"
SPOD Request type of letter.
1472,"John Smith"
SPOD recipient consignee name.
1473,"Smith Industries"
SPOD recipient company name.
1474,"1003 Public Buelevard"
SPOD recipient address line 1.
1475,"Suite 62"
SPOD recipient address line 2.
1476,"Anytown"
SPOD recipient city.
1477,"TN"
SPOD recipient state.
1478,"38116"
SPOD recipient postal code.
1479,"US"
SPOD recipient country.
1480,"Signature"
More information.
1457,"2"
SPOD Letter Format, PDF
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
141
Tagged Transaction Layouts – Transaction 505: Signature Proof of Delivery Reply
Transaction 505: Signature Proof of Delivery Reply
In response to the previous Signature Proof of Delivery Request transaction, your Reply transaction would be formatted as follows:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
ALL
Required.
1
Customer Transaction Identifier
FDXE/FDXG
ALL
Optional.
Returned if the customer included a Unique Transaction Identifier in the Request
transaction, containing the same value.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. For an erroneous
Request or server failure, the error code will be placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
ALL
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or server failure, the
error code will be placed in this field tag.
1457
SPOD Letter Format
FDXE/FDXG
U.S. &
Canada
only
Returned from SPOD Request Type that was entered.
1470
SPOD Fax Confirmation Number
FDXE
U.S. &
Canada
only
Returned upon successful fax Request.
1471
SPOD Letter
FDXE/FDXG
U.S. &
Canada
only
Returned if letter is selected.
Note: The Data Buffer that the PDF image returns is in Binary format.
FDXE/FDXG
ALL
SPOD
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Transaction Returned.
142
Tagged Transaction Layouts – Transaction 505: Signature Proof of Delivery Reply
Example of Transaction 505: Signature Proof of Delivery
In response to the previous Signature Proof of Delivery Request transaction, your Reply transaction would be formatted as follows:
Data File
Field Description
0,"505"
Transaction Type 505.
1,"SPOD"
Transaction Identifier. This field will be included in any error or Reply messages.
1457,"2"
SPOD letter format of PDF.
1471"%25PDF-1.4%25…"
SPOD letter contents (PDF image).
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
143
Tagged Transaction Layouts – Transaction 505: Signature Proof of Delivery Reply
Sample FULL Signature Proof of Delivery (SPOD) Letter
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
144
Tagged Transaction Layouts – Transaction 505: Signature Proof of Delivery Reply
Sample PARTIAL Signature Proof of Delivery (SPOD) Letter
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
145
Tagged Transaction Layouts – Transaction 410: FedEx Locator Request
Transaction 410: FedEx Locator Request
FedEx Locator allows a search to be performed for the nearest FedEx location through the API Gateway Server. FedEx Locator is limited to a maximum of ten locations
returned within a 50-mile radius.
A search criterion higher in the following list will, when provided, override any criteria below it:
• Postal Code (plus optional street address or intersection)
• City and State (plus optional street address or intersection)
• Phone Number
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
1
Customer Transaction Identifier
FDXE/FDXG
USD
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE/FDXG
USD
The FedEx account number of the Sender is required to successfully receive FedEx
Location information.
498
Meter Number
FDXE/FDXG
USD
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully receive FedEx Location information.
3025
Carrier Code
FDXE/FDXG
USD
Optional.
If FDXE indicated, Express returned in Reply data.
If FDXG indicated, Ground returned in Reply data.
If blank, Express and Ground (if applicable/available) returned in Reply data.
1697
Maximum Location Count
FDXE/FDXG
ALL
Optional.
Defaults to 10 if not specified.
This allows the user to specify the maximum number of locations to be returned in the
corresponding Reply transactions.
1698
Beginning Record Index
FDXE/FDXG
ALL
Optional.
Defaults to 1 if not specified.
This allows the user to specify the beginning record # to be returned in a single Reply
transaction.
Valid values: 0 - 500
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
146
Tagged Transaction Layouts – Transaction 410: FedEx Locator Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Search will be based on phone number search criteria if Search Criteria two is NOT
provided.
SEARCH CRITERIA 1
183
Sender Phone
Field Requirements
FDXE/FDXG
USD
Optional.
Search will be based on address/city/state/postal code search criteria if Search Criteria one
is NOT provided.
Search criteria two is not limited to sender address. Other addresses (e.g., Recipient) may
be used in field tags 5, 7, 8, and 9 for the FedEx Locator transaction only.
SEARCH CRITERIA 2
5
Sender Address
FDXE/FDXG
USD
Optional.
Field tag 1584 (Postal Code) OR field tag 7 (Sender City) and field tag 8 (Sender State)
required with this field tag.
Address (e.g., 5550 Main St.) or intersection (e.g., Main at Second) can be entered for
FedEx Locator only.
7
Sender City
FDXE/FDXG
USD
Required if field tag 8 (Sender State) is populated and field tag 1584 (FedEx Location
Postal Code) is not present.
8
Sender State
FDXE/FDXG
USD
Required if field tag 7 (Sender City) is populated and field tag 1584 (FedEx Location Postal
Code) is not present.
9
Sender Postal Code
FDXE/FDXG
USD
Required if either field tag 7 (Sender City) or field tag 8 (Sender State) is not present.
117
Sender Country Code
FDXE/FDXG
ALL
Optional.
Defaults to US if not populated.
Valid values:
• US
• CA
1555
Sender Language Code
FDXE/FDXG
ALL
Optional.
Valid values:
EN – English
FR – French
Defaults to EN if not populated.
1696
Distance Unit of Measure
FDXE/FDXG
ALL
Optional.
The Unit of measure for the distance returned.
Valid values:
• MI
• KM
Defaults to MI if not populated.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
147
Tagged Transaction Layouts – Transaction 410: FedEx Locator Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
FEDEX LOCATOR DATA
Field tag 1562 (FedEx Staffed Location Flag), field tag 1563 (FedEx Self-Service Location Flag), and field tag 1564 (FASC Location Flag) are not mutually exclusive in
one Request.
1562
FedEx Staffed Location Flag
FDXE/FDXG
USD
Required if field tag 1563 (FedEx Self-Service Location Flag) or field tag 1564 (FASC
Location Flag) is not present.
1563
FedEx Self -Service Location Flag
FDXE
USD
Required if field tag 1562 (FedEx Staffed Location Flag) or field tag 1564 (FASC Location
Flag) is not present.
1564
FASC (FedEx Authorized Shipping
Center) Location Flag
FDXE/FDXG
USD
Required if field tag 1562 (FedEx Staffed Location Flag) or field tag 1564 FedEx SelfService Location Flag) is not present.
1200
Hold At Location Flag
FDXE
USD
Optional.
1565
Latest Express Drop-off Flag
FDXE
USD
Optional.
1566
Express Drop-off after time
FDXE
USD
Optional.
1580
Dangerous Goods Flag
FDXE
USD
Optional.
1581
Saturday Service Flag
FDXE
USD
Optional.
1693
Packaging Supplies Flag
FDXE/FDXG
USD
Optional with sender country code set to US only.
Packaging Supplies must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
1694
Packaging Services Flag
FDXE/FDXG
USD
Optional with sender country code set to US only.
Packaging Services must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
1695
FedEx Return System Flag
FDXE/FDXG
USD
Optional with sender country code set to US only.
Return Systems must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
TRANSACTION TERMINATOR
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
148
Tagged Transaction Layouts – Transaction 410: FedEx Locator Request
Field
Tag
99
Field Name
End Of Record
Applicable
Carrier
Valid
For
FDXE/FDXG
USD
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Requirements
Required.
149
Tagged Transaction Layouts – Transaction 410: FedEx Locator Request
Example of Transaction 410: Locator Request
In order to locate a drop-off location for your FedEx package, format your Locator Request as follows:
Data File
Field Description
0,"410"
Transaction Type 410.
1,"DropOff"
Transaction Identifier. This field will be included in any error or Reply messages.
498,"1234567"
Meter number.
10,"123456789"
FedEx account number.
183,"9011234567"
Sender phone number entered to search for nearest drop-off locations.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
150
Tagged Transaction Layouts – Transaction 510: FedEx Locator Reply
Transaction 510: FedEx Locator Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
Required.
1
Customer Transaction Identifier
FDXE/FDXG
USD
Optional.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction.
3
Transaction Error Message
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction.
FDXE/FDXG
USD
Returned in successful Reply.
FDXE
USD
Y returned if FedEx Location supports hold at location.
FEDEX LOCATOR DATA
(Max of 25 occurrences.)
1574
Location Count
1200-#
Hold at Location Flag
1567-#
FedEx Location Intersection/Street
Address
FDXE/FDXG
USD
Returned in successful Reply.
1568-#
Distance
FDXE/FDXG
USD
Returned in successful Reply.
1569-#
Hours of Operation
Mon-Fri
FDXE/FDXG
USD
Returned in successful Reply.
1570-#
Hours of Operation
Sat
FDXE/FDXG
USD
Returned in successful Reply.
1571-#
Last Express Drop-off Time
Mon-Fri
FDXE
USD
Returned in successful Reply.
1572-#
Last Express Drop-off Time
Sat
FDXE
USD
Returned in successful Reply.
1573-#
Express Service Flag
FDXE
USD
Y returned if Express Service if available.
1575-#
FedEx Location Business Name
FDXE/FDXG
USD
Returned in successful Reply.
1576-#
FedEx Location Business type
FDXE/FDXG
USD
Returned in successful Reply.
1577-#
FedEx Location City
FDXE/FDXG
USD
Returned in successful Reply.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
151
Tagged Transaction Layouts – Transaction 510: FedEx Locator Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1578-#
FedEx Location State
FDXE/FDXG
USD
Returned in successful Reply.
1579-#
FedEx Location Postal Code
FDXE/FDXG
USD
Returned in successful Reply.
1580-#
Dangerous Goods Flag
FDXE
USD
Y returned if FedEx Location supports dangerous goods.
1693-#
Packaging Supplies Flag
FDXE/FDXG
USD
Y returned if FedEx Location supports Packaging Supplies.
1694-#
Packaging Services Flag
FDXE/FDXG
USD
Y returned if FedEx Location supports Packaging Supplies.
1695-#
FedEx Return System Flag
FDXE/FDXG
USD
Y returned if FedEx Location supports FedEx Returns.
1699-#
Record Index
FDXE/FDXG
ALL
This is the individual records identifier of the "Total locations available".
Available Records Count
FDXE/FDXG
ALL
The total number of locations that matched the input criteria.
1700
3090-#
Last Ground Drop-off Time
Mon-Fri
FDXG
USD
Returned in successful Reply.
3091-#
Last Ground Drop-off Time
Sat
FDXG
USD
Returned in successful Reply.
3092-#
Ground Service Flag
FDXG
USD
Y returned if Ground Service if available.
FDXE/FDXG
ALL
Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
152
Tagged Transaction Layouts – Transaction 510: FedEx Locator Reply
Example of Transaction 510: Locator Reply
Data File
Field Description
0,"510"
Transaction Type 510.
1,"DropOff"
Transaction Identifier. This field will be included in any error or Reply messages.
1574,"2"
Location Count.
1575-1,"Pak Mail"
FedEx Location Business Name for first drop-off location.
1576-1,"FedEx Authorized Ship Center"
FedEx Location Business Type for first drop-off location.
1567-1,"1016 W Poplar"
FedEx Location Intersection/Street Address for first drop-off location.
1577-1,"Collierville"
FedEx Location City Name for first drop-off location.
1578-1,"TN"
FedEx Location State Code for first drop-off location.
1579-1,"38017"
FedEx Location Postal Code for first drop-off location.
1568-1,"1.5"
Distance to first drop-off location.
1569-1,"9:00 AM-6:00 PM"
Hours of Operation for Mon-Fri at first drop-off location.
1570-1,"10:00 AM-2:00 PM"
Hours of Operation on Saturday at first drop-off location.
1571-1,"4:00 PM"
Last FedEx Express Drop-off Time for Mon-Fri at first drop-off location.
1572-1,"12:00 PM"
Last FedEx Express Drop-off Time for Saturday at first drop-off location.
3090-1,"3:00 PM"
Last FedEx Ground Drop-off Time for Mon-Fri at first drop-off location.
3091-1,"none"
Last FedEx Ground Drop-off Time for Saturday at first drop-off location.
3092-1,"Y"
FedEx Ground Service is available at first drop-off location.
1573-1,"Y"
FedEx Express Service is available at first drop-off location.
1200-1,"N"
FedEx Express Hold At Location service is supported at first drop-off location.
1580-1,"N"
FedEx Express Dangerous Goods service is supported at first drop-off location.
1575-2,"FedEx staffed"
FedEx Location Business Name for second drop-off location.
1576-2,"FedEx World Service Center"
FedEx Location Business Type for second drop-off location.
1567-2,"1016 W Poplar Ste 105"
FedEx Location Intersection/Street Address for second drop-off location.
1577-2,"Collierville"
FedEx Location City Name for second drop-off location.
1578-2,"TN"
FedEx Location State Code for second drop-off location.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
153
Tagged Transaction Layouts – Transaction 510: FedEx Locator Reply
Data File
Field Description
1579-2,"38017"
FedEx Location Postal Code for second drop-off location.
1568-2,"1.5"
Distance to second drop-off location.
1569-2,"8:00 AM-10:00 PM"
Hours of Operation for Mon-Fri at second drop-off location.
1570-2,"10:00 AM-5:00 PM"
Hours of Operation on Saturday at second drop-off location.
1571-2,"10:00 PM"
Last Express Drop-off Time for Mon-Fri at second drop-off location.
1572-2,"5:00 PM"
Last Express Drop-off Time for Saturday at second drop-off location.
3090-2,"5:00 PM"
Last FedEx Ground Drop-off Time for Mon-Fri at second drop-off location.
3091-2,"none"
Last FedEx Ground Drop-off Time for Saturday at second drop-off location.
3092-2,"Y"
FedEx Ground Service is available at second drop-off location.
1573-2,"Y"
FedEx Express Service is available at second drop-off location.
1200-2,"Y"
FedEx Express Hold At Location service is supported at second drop-off location.
1580-2,"N"
FedEx Express Dangerous Goods service is supported at second drop-off location.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
154
Tagged Transaction Layouts – Transaction 037: Email Label Request
Transaction 037: Email Label Request
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 Email Label Request.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
Required.
1
Customer Transaction Identifier
FDXE/FDXG
USD
Optional.
This field 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.
10
Sender FedEx Account Number
FDXE/FDXG
USD
Required.
The FedEx account number of the Sender is required to successfully receive an Email
Label response.
498
Meter Number
FDXE/FDXG
USD
Required.
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully receive an Email Label response.
3025
Carrier Code
FDXE/FDXG
USD
Required.
Valid values:
FDXE – FedEx Express
FDXG – FedEx Ground
RETURN SHIPPER / SENDER
4
Sender Company
FDXE/FDXG
USD
Required if interfacing with remote FedEx Express or FedEx Ground Server and the
Sender contact name is not passed in the transaction.
Company from which the shipment is originating.
A minimum of 3 alpha characters must be passed.
5
Sender Address Line 1
FDXE/FDXG
USD
Required.
Primary address line from which the shipment is originating.
6
Sender Address Line 2
FDXE/FDXG
USD
Optional.
Secondary address line from which the shipment is originating.
7
Sender City
FDXE/FDXG
USD
Required.
City name from which the shipment is originating.
Minimum of 3 alpha characters must be passed for shipping.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
155
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
8
Sender State
FDXE/FDXG
USD
Required for shipping only if Country Code is US or CA.
State code from which the shipment is originating.
9
Sender Postal Code
FDXE/FDXG
USD
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 US. No embedded
dashes allowed.
Valid characters: A-Z; 0-9; a-z
32
Sender Contact Name
FDXE/FDXG
USD
Required if the sender Company Name is not passed in the transaction. If included in the
transaction, a minimum of 3 alpha characters must be passed.
Name of the person initiating the shipment.
117
Sender Country Code
FDXE/FDXG
USD
Required.
Name of the country from which the shipment is originating.
Only US is allowed.
183
Sender Phone Number
FDXE/FDXG
USD
Required.
The phone number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
1103
Sender Fax
FDXE/FDXG
USD
Optional.
The fax number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
1201
Sender’s Email Address
FDXE/FDXG
USD
Optional.
Required field for ShipAlert.
The email address of the person initiating the shipment.
ShipAlert and Delivery Notifications (if requested via use of field tags 1553 and 1554) are
sent to this address.
2392
URL Email Address
FDXE/FDXG
USD
Required.
The email label URL is sent to this email address.
The optional return shipper email message (field tag 2388) is also sent to this
email address.
1341
Sender Pager Number
FDXE/FDXG
USD
Optional.
The pager number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
156
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
MERCHANT / DESTINATION
11
Recipient Company
FDXE/FDXG
USD
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.
12
Recipient Contact Name
FDXE/FDXG
USD
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.
13
Recipient Address Line 1
FDXE/FDXG
USD
Required.
Primary address line to which the shipment is destined.
14
Recipient Address Line 2
FDXE/FDXG
USD
Optional.
Secondary address line to which the shipment is destined.
15
Recipient City
FDXE/FDXG
USD
Required.
Name of the city to which the shipment is destined.
A minimum of 3 alpha characters must be passed.
16
Recipient State
FDXE/FDXG
USD
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.
17
Recipient Postal Code
FDXE/FDXG
USD
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
18
Recipient Phone Number
FDXE/FDXG
USD
Required.
Phone number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
50
Recipient Country Code
FDXE/FDXG
USD
Required.
Name of the country to which the shipment is destined.
1202
Recipient Email Address
FDXE/FDXG
USD
Optional.
Email address for the contact person to whom the shipment is destined.
1342
Recipient Pager Number
FDXE/FDXG
USD
Optional.
Pager number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
157
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
2254
Recipient Fax Number
2407
Recipient Location Number
Applicable
Carrier
Valid
For
FDXE/FDXG
USD
Optional.
Fax number for the contact person to whom the shipment is destined.
The maximum length is 10 for US and CA, 16 for all other countries. Do not include
embedded special characters.
FDXG
ALL
Optional.
Recipient location number/store number.
This value in this field is embedded in the 2D barcode.
Valid characters: [A-Z ;a-z ;0-9]
Any character other than A-Z, a-z, 0-9 will be stripped.
If the length is greater than 10, characters beyond the 10th position will be truncated.
Field Requirements
PAYMENT
20
Payer Account Number
FDXE/FDXG
USD
Required field if Pay Type is 3 (Bill Third Party).
23
Pay Type
FDXE/FDXG
USD
Required.
Only Bill Sender and Bill Third Party are allowed.
EMAIL LABEL DATA
2387
URL Expiration date
FDXE/FDXG
USD
Required.
Date entered can be current date through current date plus thirty calendar days,
(inclusive), from the date the email label is requested.
Format: YYYYMMDD
2388
URL Email Message
FDXE/FDXG
USD
Optional.
Contains a customized message from the merchant to the return shipper. Corresponds
with field tag 2392.
2389
Merchant Contact Phone
FDXE/FDXG
USD
Required.
This phone number can differ from the merchant phone number for the shipment. This
phone number is specific to the email label and will be used in case the return shipper
needs to contact the merchant/recipient
3231
Residential Pickup Flag
FDXG
USD
Optional for FedEx Ground email label Requests.
Y pickup location is residential
Default is N, pickup location is a business/commercial location.
Field will be ignored on FedEx Express email label Requests.
SHIPMENT INFORMATION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
158
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1273
Packaging Type
FDXE/FDXG
USD
Required.
1274
Service Type
FDXE/FDXG
USD
Required.
3021
Home Delivery Instructions
FDXG
USD
Optional with Home Delivery service.
2210
RMA Number
FDXE/FDXG
USD
Optional.
75
Weight Units
FDXE/FDXG
USD
Required.
This field defines the unit for the value declared in field tag 1401 (Package Weight).
Must be LBS.
Dim Units
FDXE/FDXG
USD
Required if package dimensions are passed in the Request transaction.
Defaults to inches if a value is not passed in the transaction.
68
Declared Value Currency Type
FDXE/FDXG
USD
Required.
Must be USD.
116
Package Total
(Total Number of Pieces)
FDXE/FDXG
USD
Required.
Can contain 1-10 inclusive.
For multiple-piece shipping, FDXE only applies to COD and international.
1116
PACKAGE INFORMATION
(Can occur 1 – 10 times based on the value of field 116.)
25-#
Reference Information
FDXE/FDXG
USD
Optional.
This field allows customer-defined notes to print on the shipping label.
If passed in the transaction, can later be used to track by reference.
57-#
Dim Height
FDXE/FDXG
USD
Required field only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) field if Your Packaging is used as Packaging Type (value
01 in field tag 1273).
58-#
Dim Width
FDXE/FDXG
USD
Required only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) field if Your Packaging is used as Packaging Type (value
01 in field tag 1273).
59-#
Dim Length
FDXE/FDXG
USD
Required only if a FedEx Express heavyweight service is selected for the shipment.
Recommended (but still optional) field if Your Packaging is used as Packaging Type (value
01 in field tag 1273).
Item Description
FDXE/FDXG
USD
Required per piece.
For Freight services, required per skid/label.
For non-Freight services, required package/label.
1398-#
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
159
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1401-#
Package Weight
FDXE/FDXG
USD
Required.
This field is used for piece weight only, not total shipment weight.
Package weight must be in LBS as indicated by field tag 75 (Weight Units).
1415-#
Declared Value / Carriage Value
FDXE/FDXG
USD
Optional for U.S. and FedEx Ground shipments.
Field should contain the declared value per package.
Signature Option
FDXE/FDXG
ALL
Optional.
Valid values:
1 = Deliver without Signature
2 = Indirect Signature
3 = Direct Signature
4 = Adult Signature
2399
For FedEx Express shipments, the "Deliver without signature" option will not be allowed
when the following special services are requested:
• Alcohol
• Hold at Location
• Dangerous Goods
• Declared Value greater than $500
3001-#
FedEx Purchase Order
FDXE/FDXG
USD
Optional.
If passed in the transaction, Purchase Order can later be used to track by reference for
FedEx Ground only. This is simply an additional reference field when used with FedEx
Express shipments.
3002-#
FedEx Invoice
FDXE/FDXG
USD
Optional.
If passed in the transaction, Invoice Number can later be used to track by reference for
FedEx Ground only. This is simply an additional reference field when used with FedEx
Express shipments.
1398-#
Item Description
FDXE/FDXG
USD
Required per piece.
For Freight services, required per skid/label.
For non-freight services, required package/label.
3018-#
Nonstandard Container Flag
FDXG
USD
Y if shipment packaging is a nonstandard container.
FDXE
USD
Y if package / Item contains dry ice, else N.
SPECIAL SERVICE – DRY ICE
1268-#
Dry Ice Flag
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
160
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
1406-#
Field Name
Dry Ice Weight
Applicable
Carrier
Valid
For
FDXE
USD
Required FOR EVERY PIECE if Dry Ice flag is Y.
Represents dry weight for the package.
Cannot be greater than package weight.
Dry Ice weight type must be in KGS.
Field Requirements
SPECIAL SERVICE – HOLD AT LOCATION
44
Hold At Location Address
FDXE
USD
Required if the Hold At Location Flag is set to Y.
46
Hold at Location (HAL) City
FDXE
USD
Required if the Hold At Location Flag is set to Y.
47
Hold at Location (HAL) State
FDXE
USD
Required if the Hold At Location Flag is set to Y.
48
Hold at Location (HAL) Postal Code
FDXE
USD
Required if the Hold At Location Flag is set to Y.
Hold at Location (HAL) Flag
FDXE
USD
Y if shipment is Hold at Location, else N.
1200
When requesting an email notification sender’s email address (field tag 1201), recipient’s
email address (field tag 1202), broker’s email address (field tag 1343), Email Notification
Address (field tag 1204) must be used in conjunction with the fields in the "Special Service
– ShipAlert" section.
SPECIAL SERVICE – ALERTS
1203
Personal Message
FDXE/FDXG
ALL
Optional.
Personal message to be included in the Notification.
Applies to all email notifications: ShipAlert, Exception Notification, and Delivery
Notification.
1204-#
Email Notification Address
FDXE/FDXG
ALL
For FDXE & FDXG:
A minimum of one occurrence is required if field tag 1206 (ShipAlert Flag) or field tag 1551
(Delivery Notification Flag) or field tag 1960 (Exception Notification Flag) is Y.
Maximum of three occurrences allowed.
1206-#
ShipAlert Flag
FDXE/FDXG
ALL
Required for ShipAlert.
If = Y, corresponding email address in field tag 1204 (Email Notification Address) will be
emailed ShipAlert.
Maximum of three occurrences allowed (repeating, must use "-#").
1551-#
Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification.
If = Y, corresponding email address in field 1204 will be emailed delivery notification.
Maximum of three occurrences allowed for FedEx Express shipments.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
161
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Applicable
Carrier
Valid
For
Language Code
FDXE/FDXG
ALL
Optional.
Determines language for email notifications.
Applies to all Email Notifications and corresponds to the occurrence of the email address
in field tag 1204 (Email Notification Address).
Maximum of three occurrences allowed.
See 1552 in Appendix A for valid values.
Defaults to en.
1553
Shipper Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed Delivery Notification email.
1554
Shipper ShipAlert Flag
FDXE/FDXG
ALL
Required for ShipAlert Notification to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed ShipAlert email.
1555
Shipper Language Code
FDXE/FDXG
ALL
Optional for Email Notification to Shipper email address.
See 1555 in Appendix A for valid values.
Defaults to en.
1556
Recipient Delivery Notification Flag
FDXE/FDXG
ALL
Required for Delivery Notification to the recipient.
If = Y, Recipient Email Address (field tag 1202) will be emailed Delivery Notification email.
1557
Recipient ShipAlert Flag
FDXE/FDXG
ALL
Required for ShipAlert Notification to the recipient.
If = Y, Recipient’s Email Address (field tag 1202) will be emailed ShipAlert email.
1558
Recipient Language Code
FDXE/FDXG
ALL
Optional for Email Notification to recipient email address.
See 1558 in Appendix A for valid values.
Defaults to en.
1559
Broker Delivery Notification Flag
FDXE/FDXG
INTL
Required for Delivery Notification to the broker.
If = Y, Broker Email Address (field tag 1343) will be email Delivery Notification email.
1560
Broker ShipAlert Flag
FDXE/FDXG
FDXG
Required for Delivery Notification to the broker.
If = Y, Broker Email Address (field tag 1343) will be emailed ShipAlert email.
1561
Broker Language Code
FDXE/FDXG
INTL
Optional for Email Notification to broker email address.
See 1561 in Appendix A for valid values.
Defaults to en.
1552-#
Field Name
Field Requirements
SPECIAL SERVICE – NOTIFICATION
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
162
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Applicable
Carrier
Valid
For
Exception Notification Flag
FDXE/FDXG
INTL
Required for Exception Notification.
If = Y, email address in field tag 1204 (Email Notification Address) will be emailed
ShipAlert.
Maximum of three occurrences allowed.
Exception notifications include: general delivery exceptions, incorrect address, clearance
delay, international shipment release.
1961
Shipper Exception Notification Flag
FDXE/FDXG
ALL
Required for Exception Notifications to the shipper.
If = Y, Sender's Email Address (field tag 1201) will be emailed any Exception emails.
Exception notifications include: general delivery exceptions, incorrect address, clearance
delay, international shipment release.
1962
Recipient Exception Notification
Flag
FDXE/FDXG
ALL
Required for Exception Notifications to the recipient.
If = Y, Recipient's Email Address (field tag 1202) will be emailed any Exception emails.
Exception notifications include: general delivery exceptions, incorrect address, clearance
delay, international shipment release.
1963
Broker Exception Notification Flag
FDXE/FDXG
INTL
Required for Exception Notifications to the broker.
If = Y, Broker's Email Address (field tag 1343) will be emailed any Exception emails.
Exception notifications include: general delivery exceptions, incorrect address, clearance
delay, international shipment release.
Email Notification Format
FDXE/FDXG
ALL
Optional.
A unique format can be specified for each email address indicated.
The format will apply to all notification emails sent to a particular email address.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Email Notification Address (field tag 1204).
Shipper Email Notification Format
FDXE/FDXG
ALL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Sender's Email Address (field tag 1201).
1960-#
1964-#
1965
Field Name
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Requirements
163
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1966
Broker Email Notification Format
FDXE/FDXG
INTL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Broker's Email Address (field tag 1343).
1967
Recipient Email Notification Format
FDXE/FDXG
ALL
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Recipient's Email Address (field tag 1202).
Language Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1552-#) has a corresponding occurrence and the
language code requires a locale code.
If invalid combination of language/locale is input, an error will be returned.
See 1968 in Appendix A for valid values.
1969
Shipper Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1555) is populated and the language code requires
a locale code.
See 1969 in Appendix A for valid values.
1970
Recipient Locale Code
FDXE/FDXG
ALL
Applicable if Language Code (field tag 1558) is populated and the language code requires
a locale code.
See 1970 in Appendix A for valid values.
1971
Broker Locale Code
FDXE/FDXG
INTL
Applicable if Language Code (field tag 1561) is populated and the language code requires
a locale code.
See 1971 in Appendix A for valid values.
1968-#
SPECIAL SERVICE – OTHER
440
Residential Delivery Flag
FDXE/FDXG
USD
Y if shipment is Residential Delivery, else N.
1120
Inside Pickup Flag
FDXE/FDXG
USD
Y if shipment is Inside Pickup, else N.
Applicable to freight shipping only.
1121
Inside Delivery Flag
FDXE
USD
Y if shipment is Inside Delivery, else N.
Applicable to freight shipping only.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
164
Tagged Transaction Layouts – Transaction 037: Email Label Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1690
Saturday Delivery Allowed Flag
FDXE
USD
If set = Y, this field indicates that the merchant has agreed to allow the return shipment to
be delivered back to him (or a repair/return center) on Saturday, and the merchant agrees
to pay the Saturday delivery surcharge.
If = Y and it is Friday when the return shipper generates their label, and service type is
overnight, Saturday Delivery will be assumed.
If it is Thursday when the return shipper generates their label, and the service type is two
day, then Saturday Delivery will be assumed.
1646
Saturday Pickup Allowed Flag
FDXE
USD
If set = Y, this field indicates that the merchant has agreed to allow the return shipment to
be picked up on Saturday, and the merchant agrees to pay the Saturday pickup surcharge.
If the return shipper generates the label on a Friday and this field = Y, Saturday pickup is
assumed and is the only option. If = N, pickup date is assumed to be the next FedEx
business day.
1333
Drop Off Type
FDXE
USD
Required.
1392
Inbound Visibility Block Shipment
Indicator
FDXE
USD
Optional.
FDXE/FDXG
ALL
Required.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
165
Tagged Transaction Layouts – Transaction 037: Email Label Request
Example of Transaction 037: Email Label Request
In order to create an Email Label in which another party can retrieve the label online for their FedEx package, format your Email Label Request as follows:
Data File
Field Description
0,"037"
Transaction Type 037 is Email Label Request.
1,"Email Label"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
10, "000000000"
Sender Account Number.
498, "0000000"
Meter Number.
3025, "FDXG"
Carrier Code.
4, "WAPI"
Sender Company Name.
5, "5767 E Shelby Dr"
Sender Address 1.
7, "Memphis"
Sender City.
8, "TN"
Sender State/Province.
9, "38141"
Sender Postal Code.
8, "TN"
Sender State/Province.
9, "38141"
Sender Postal Code.
117, "US"
Sender Country.
32, "WAPI-TEST-CL"
Sender Contact Name.
38, "WAPI"
Sender Department.
183, "8004633339"
Sender Phone Number.
1201, "[email protected]"
Sender's Email Address.
11, "WAPI"
Recipient Company Name.
12, "WAPI-TEST-CL"
Recipient Contact Name.
13, "80 FEDEX PRKWY"
Recipient Address 1.
15, "DETROIT"
Recipient City.
16, "MI"
Recipient State/Province.
17, "48204"
Recipient Postal Code.
18, "8004633339"
Recipient Phone Number.
50, "US"
Recipient Country Code.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
166
Tagged Transaction Layouts – Transaction 037: Email Label Request
Data File
Field Description
20, "1010101010"
Payer Account Number.
23, "1"
Payment Code.
1116, "I"
Dim Units.
1117, "1"
Package Sequence.
1119, "N"
Future Day Flag.
116, "1"
Total Number of Packages.
1273, "01"
Packaging Type.
1274,"90"
Service Type.
1333, "1"
Drop Off Type.
1368, "2"
Label Type.
1369, "1"
Label Printer Type.
1370, "5"
Label Orientation.
1398, "Books"
Item Description.
1400, "0.0"
Total Shipment Weight.
1401, "70.0"
Total Package Weight.
1415, "40.00"
Declared Value/Carriage Value.
2382, "3"
Return Shipment Indicator.
2387, "20051030"
URL Expiration Date.
2389, "8004633339"
Merchant Contact Phone Number.
2392, "[email protected]"
URL Email Address.
3018, "Y"
Non-Standard Packaging Flag.
3024, "8004633339"
Home Delivery Phone Number.
440, "Y"
Residential Delivery Flag.
57, "2"
Dim Package Height.
58, "2"
Dim Package Width.
59, "62"
Dim Package Length.
68, "USD"
Customs/Declared Value Currency Type.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
167
Tagged Transaction Layouts – Transaction 037: Email Label Request
Data File
Field Description
75, "LBS"
Weight Type/Unit of Measure.
24, "20051012"
Ship Date.
25, "D-ANY-F42953GRD12"
Reference Info.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
168
Tagged Transaction Layouts – Transaction 137: Email Label Reply
Transaction 137: Email Label Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
Required.
1
Customer Transaction Identifier
FDXE/FDXG
USD
Optional.
Returned containing the same value if the customer included information for this field tag in
the Request transaction. It is returned in the Reply transaction to aid in matching
transaction Requests to Replies.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or a server failure, the
error code will be placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response transaction indicating failed processing. For an erroneous transaction, the error
message will be placed in this field.
SHIPMENT LEVEL
2393
Email Label URL
FDXE/FDXG
USD
Required if Error is not returned.
URL for each label.
Can contain not single or double quotes URL of web page at which labels can be found.
2394
Email Label Request Date Time
FDXE/FDXG
USD
Date the Email Label was requested.
Format: YYYYMMDDTHHMMSSYYYYMMDDTHHMMSS
2208
Email Label User ID
FDXE/FDXG
USD
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.
10 Alpha/Numeric characters.
1040
Email Label Password
FDXE/FDXG
USD
Required if Error is not returned.
Password to be used to manually access the URL of web page at which labels can be
found.
6 Alpha/Numeric characters.
FDXE/FDXG
USD
Contains the tracking number assigned to the shipment if successful.
1-10 occurrences of the following fields:
29-#
Tracking Number
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
169
Tagged Transaction Layouts – Transaction 137: Email Label Reply
Field
Tag
Field Name
526-#
Form ID
2399-#
Signature Option
Applicable
Carrier
Valid
For
FDXE
USD
Label form ID returned upon successful transaction Reply.
FDXE/FDXG
ALL
Optional.
FDXE/FDXG
ALL
Transaction Returned.
Field Requirements
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
170
Tagged Transaction Layouts – Transaction 137: Email Label Reply
Example of Transaction 137: Email Label Reply
Continuing with the example on the previous page, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"137"
Transaction Type 137 is Email Label Reply.
1,"Email Label"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
1040, "0685ac"
Email Label Password.
2208, "WAPI"
Email Label User ID.
2393,
"https://wwwtest.fedex.com/OnlineLabel/pLogin.jsp?labelUserCdDesc=
WAPI&labelPasswordDesc=0685ac"
Email Label URL.
2394, "20051012T081931"
Email Label Request Date/Time.
29-1, "176077215000233"
Tracking Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
171
Tagged Transaction Layouts – Transaction 033: Cancel Email Label Request
Transaction 033: Cancel Email Label Request
This transaction cancels an Email Label Request. This transaction will be invalid if customer has already generated the label.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
Required.
1
Customer Transaction Identifier
FDXE/FDXG
USD
Optional.
This field 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.
10
Sender FedEx Account Number
FDXE/FDXG
USD
Required.
The FedEx account number of the Sender is required to successfully cancel the Email Label
Request.
498
Meter Number
FDXE/FDXG
USD
Required.
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully cancel the Email Label Request.
3025
Carrier Code
FDXE/FDXG
USD
Required.
Valid values:
FDXE – FedEx Express
FDXG – FedEx Ground
FDXE/FDXG
USD
Required.
Tracking number of Email Label/shipment to be deleted.
FDXE/FDXG
ALL
Transaction Returned.
TRACKING
29
Tracking Number
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
172
Tagged Transaction Layouts – Transaction 033: Cancel Email Label Request
Example of Transaction 033: Cancel Email Label Request
If a customer wishes to cancel an Email Label, the customer needs to send the 033 transaction to FedEx. For example, you created an Email Label for a FedEx Ground
shipment and your FedEx Account Number is 123456789. The Tracking Number provided to you for this shipment was 176077215000233. The input transaction should be
formatted as follows:
Data File
Field Description
0,"033"
Transaction Type 033 is Cancel Email Label Reply.
1,"Cancel Email Label "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
498,"1234567"
Your meter number.
10, "123456789"
Sender Account Number.
29, "176077215000233"
Tracking Number.
3025, "FDXG"
Carrier Code.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
173
Tagged Transaction Layouts – Transaction 133: Cancel Email Label Reply
Transaction 133: Cancel Email Label Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE/FDXG
USD
Required.
1
Customer Transaction
Identifier
FDXE/FDXG
USD
Optional.
Returned containing the same value if the customer included information for this field tag in the
Request transaction. It is returned in the Reply transaction to aid in matching transaction
Requests to Replies.
ERROR HANDLING
2
Transaction Error Code
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in response
indicating failed processing. For an erroneous Request or a server failure, the error code will be
placed in this field tag.
3
Transaction Error Message
FDXE/FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in response
transaction indicating failed processing. For an erroneous transaction, the error message will be
placed in this field.
FDXE/FDXG
ALL
Transaction Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
174
Tagged Transaction Layouts – Transaction 133: Cancel Email Label Reply
Example of Transaction 133: Cancel Email Label Reply
Continuing with the example on the previous page, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"133"
Transaction Type 133 is Cancel Email Label Reply.
1,"Cancel Email Label"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the tracking number for the
email label entered was not valid, FedEx would respond with the following transaction:
Data File
Field Description
0,"133"
Transaction Type 133 is Cancel Email Label Reply.
1,"Cancel Email Label "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"111E"
Error code.
3,"Tracking number is not in the database"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
175
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Transaction 044: Call Tag Create Request
The FedEx Ground Call Tag return label combines the delivery of the FedEx Ground label with the pickup function. This transaction will dispatch a FedEx driver with a label
to the location specified in the transaction. The driver will pick up the parcel using the label they have with them. Cancellations are handled via Ground Call Tag Cancel
Request.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXG
USD
Required.
1
Customer Transaction Identifier
FDXG
USD
Optional.
This field 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.
10
Sender FedEx Account Number
FDXG
USD
Required.
The FedEx account number of the Sender is required to successfully Request a Ground
Call Tag.
498
Meter Number
FDXG
USD
Required.
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully Request a Ground Call Tag.
SENDER ORIGIN
4
Sender Company
FDXG
USD
Required.
Company from which the shipment is originating.
A minimum of 3 alpha characters must be passed.
5
Sender Address Line 1
FDXG
USD
Required.
Primary address line from which the shipment is originating.
6
Sender Address Line 2
FDXG
USD
Optional.
Secondary address line from which the shipment is originating.
7
Sender City
FDXG
USD
Required.
City name from which the shipment is originating.
Minimum of 3 alpha characters must be passed for shipping.
8
Sender State
FDXG
USD
Required.
State code from which the shipment is originating.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
176
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
9
Sender Postal Code
FDXG
USD
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
32
Sender Contact Name
FDXG
USD
Required if the Sender Company Name is not passed in the transaction.
117
Sender Country Code
FDXG
USD
Required.
Name of the country from which the shipment is originating.
Must = US.
183
Sender Phone Number
FDXG
USD
Required if interfacing with remote FedEx Express or FedEx Ground Server.
The phone number of the person initiating the shipment.
The maximum length is 10 for US and CA.
Do not include embedded special characters.
MERCHANT / DESTINATION
11
Recipient Company
FDXG
USD
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.
12
Recipient Contact Name
FDXG
USD
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.
13
Recipient Address Line 1
FDXG
USD
Required.
Primary address line to which the shipment is destined.
14
Recipient Address Line 2
FDXG
USD
Optional.
Secondary address line to which the shipment is destined.
15
Recipient City
FDXG
USD
Required.
Name of the city to which the shipment is destined.
A minimum of 3 alpha characters must be passed.
16
Recipient State
FDXG
USD
Required.
State or province code to which the shipment is destined.
17
Recipient Postal Code
FDXG
USD
Required.
Represents the postal code to which the shipment is destined.
Valid characters: A-Z; 0-9; a-z
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
177
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Field
Tag
Applicable
Carrier
Valid
For
Recipient Country Code
FDXG
USD
Required.
Name of the country to which the shipment is destined.
20
Payer Account Number
FDXG
USD
For FedEx Express shipping, required field if Pay 3 (Bill Third Party).
For FedEx Ground shipping, required field if Pay Type is 3 (Bill Third Party).
23
Pay Type
FDXG
USD
Required.
Only Bill Sender and Bill Third Party are allowed.
50
Field Name
Field Requirements
PAYMENT
CALL TAG SPECIFIC DATA
1009
Business Close Time / Latest
Pickup Time
FDXG
USD
Required for Commercial/Business pickup locations.
Field not applicable for Residential pickup locations.
This field should contain the latest time the package can be picked up for the pickup date
requested.
Format: HHMMSS
Entry must be between 080000 and 180000.
1008
Package Ready Time
FDXG
USD
Required for Commercial/Business pickup locations. Not applicable for residential.
This field should contain the earliest time the package will be ready for pickup on the
pickup date requested.
Format: HHMMSS
Entry must be between 080000 and 180000.
1365
Dispatch Date
FDXG
USD
Required.
This field contains the desired pickup date.
Entry can contain the date for the next day through next day + 13 calendar days.
FedEx Ground holidays and weekends may not be accepted.
If accepted, the first pickup attempt will be made on this date. If the pickup is not
successful, up to three pickup attempts will be made.
Format: YYYYMMDD
1010
Courier Remarks/Pickup
Instructions
FDXG
USD
Optional.
This field contains any pickup instructions for the courier/driver.
FDXG
USD
Optional.
Return Materials Authorization number provided by the sender.
SHIPMENT INFORMATION
2210
RMA Number
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
178
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
25
Reference Information
FDXG
USD
Optional.
68
Declared Value Currency Type
FDXG
USD
Required.
Must be USD.
116
Package Total
(Total Number of Pieces)
FDXG
USD
Required.
Can contain 1-10 inclusive.
PER PIECE FIELDS
-# denotes recurring.
These fields can recur for value indicated in field tag 116.
1415-#
Declared Value
FDXG
USD
Optional for U.S. and FedEx Ground shipments.
Should contain the declared value for each individual Call Tag package.
1398-#
Item Description
FDXG
USD
Required per piece.
Description of item being shipped.
Max 20.
SPECIAL SERVICE – OTHER
440
Residential Delivery Flag
FDXG
USD
Y if shipment is Residential Delivery, else N.
3231
Residential Pickup Flag
FDXG
USD
Optional.
Defaults to N.
FDXG
USD
Required.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
179
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Example of Transaction 044: Call Tag Create Request
In order to create a Call Tag to dispatch a carrier to a location with pre-generated label and retrieve a FedEx package, format your Call Tag Request as follows:
Data File
Field Description
0,"044"
Transaction Type 044 is Call Tag Request.
1,"CallTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
10,"000000000"
Sender Account Number.
498,"0000000"
Meter Number.
3025,"FDXG"
Carrier Code.
4,"WAPI"
Sender Company Name.
5,"5767 E Shelby Dr"
Sender Address 1.
7,"Memphis"
Sender City.
8,"TN"
Sender State/Province.
9,"38141"
Sender Postal Code.
8,"TN"
Sender State/Province.
9,"38141"
Sender Postal Code.
117,"US"
Sender Country.
32,"WAPI-TEST-CL"
Sender Contact Name.
38,"WAPI"
Sender Department.
183,"8004633339"
Sender Phone Number.
1201,"[email protected]"
Sender's Email Address.
11,"WAPI"
Recipient Company Name.
12,"WAPI-TEST-CL"
Recipient Contact Name.
13,"80 FEDEX PKWY"
Recipient Address 1.
15,"DETROIT"
Recipient City.
16,"MI"
Recipient State/Province.
17,"48204"
Recipient Postal Code.
18,"8004633339"
Recipient Phone Number.
50,"US"
Recipient Country Code.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
180
Tagged Transaction Layouts – Transaction 044: Call Tag Create Request
Data File
Field Description
20,"1010101010"
Payer Account Number.
23,"1"
Payment Code.
1116,"I"
Dim Units.
116,"1"
Total Number of Packages.
117,"US"
Sender Country.
1145,"EDI0479"
Recipient Department Name.
1008,"080010"
Package Ready Time.
1009,"170030"
Business Close Time/Last Pickup Time.
1273,"01"
Packaging Type.
1274,"90"
Service Type.
1365,"20051008"
Dispatch Date.
1398,"Books"
Item Description.
1415,"40.00"
Declared Value/Carriage Value.
2382,"3"
Return Shipment Indicator.
3231,"N"
Residential Pickup Flag.
440,"Y"
Residential Delivery Flag.
57,"2"
Dim Package Height.
58,"2"
Dim Package Width.
59,"62"
Dim Package Length.
68,"USD"
Customs/Declared Value Currency Type.
25,"D-ANY-F42953GRD12"
Reference Info.
1010,"Schedule my package for pickup"
Courier Remarks/Pickup Instructions.
2210,"RMA_TEST"
RMA Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
181
Tagged Transaction Layouts – Transaction 144: Call Tag Create Reply
Transaction 144: Call Tag Create Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXG
USD
Required.
1
Customer Transaction Identifier
FDXG
USD
Optional.
Returned containing the same value if the customer included information for this field
tag in the Request transaction.
It is returned in the Reply transaction to aid in matching transaction Requests to
Replies.
ERROR HANDLING
2
Transaction Error Code
FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or a server failure,
the error code will be placed in this field tag.
3
Transaction Error Message
FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response transaction indicating failed processing. For an erroneous transaction, the
error message will be placed in this field.
FDXG
USD
Pickup Confirmation Number.
CALL TAG DATA
1011
Dispatch Confirmation Number
Note: This is the first tracking number for FedEx Ground. N/20 max length/number.
1-N TRACKING NUMBERS
29-#
Tracking Number
FDXG
USD
The tracking number assigned to a package.
FDXG
USD
Transaction Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
182
Tagged Transaction Layouts – Transaction 144: Call Tag Create Reply
Example of Transaction 144: Call Tag Create Reply
Continuing with the example of a Call Tag Create Request, the Call Tag Reply transaction would be formatted as follows:
Data File
Field Description
0,"144"
Transaction Type 144 is Call Tag Reply.
1,"CallTag "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
1011,"997015600007813"
Dispatch Confirmation Number.
29-1,"997015600007813"
Tracking Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
183
Tagged Transaction Layouts – Transaction 045: Call Tag Cancel Request
Transaction 045: Call Tag Cancel Request
This transaction cancels a Call Tag Request. This transaction is only valid until field tags are generated at the terminal (generally next day). Erroneous Requests should be
canceled as soon as possible.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXG
USD
Required.
1
Customer Transaction Identifier
FDXG
USD
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXG
USD
Required.
The FedEx account number of the Sender is required to successfully cancel a Ground
Call Tag.
498
Meter Number
FDXG
USD
Required.
The unique meter number assigned to the Sender’s FedEx account number is required
to successfully cancel a Ground Call Tag.
FDXG
USD
Pickup Confirmation Number.
CALL TAG DATA
1011
Dispatch Confirmation Number
Note: This is the first tracking number for FedEx Ground. N/20 max length/number.
TRANSACTION TERMINATOR
99
End Of Record
FDXG
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
USD
Transaction Returned.
184
Tagged Transaction Layouts – Transaction 045: Call Tag Cancel Request
Example of Transaction 045: Call Tag Cancel Request
If a customer wishes to cancel a Call Tag previously scheduled, the customer needs to send the 045 transaction to FedEx to cancel the Call Tag. For example, you
scheduled a Dispatch for a Call Tag on October 13, 2005, and your FedEx Account Number is 123456789. The Dispatch Confirmation Number provided to you was
997015600007813. The input transaction should be formatted as follows:
Data File
Field Description
0,"045"
Transaction Type 045.
1,"Cancel CallTag "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
10, "123456789"
Account number.
1011, "997015600007813"
Dispatch Confirmation Number.
20, "000000000"
Payer Account Number.
23, "3"
Payment Code.
498, "1010101"
Meter Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
185
Tagged Transaction Layouts – Transaction 145: Call Tag Cancel Reply
Transaction 145: Call Tag Cancel Reply
The following codes are used in the Applicable Carrier and Valid for columns below:
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXG
USD
Required.
1
Customer Transaction Identifier
FDXG
USD
Optional.
Returned containing the same value if the customer included information for this field tag in
the Request transaction.
It is returned in the Reply transaction to aid in matching transaction Requests to Replies.
ERROR HANDLING
2
Transaction Error Code
FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or a server failure, the
error code will be placed in this field tag.
3
Transaction Error Message
FDXG
USD
Returned only if an error occurred while processing the transaction. Passed back in
response transaction indicating failed processing. For an erroneous transaction, the error
message will be placed in this field.
FDXG
USD
Required.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
186
Tagged Transaction Layouts – Transaction 145: Call Tag Cancel Reply
Example of Transaction 145: Cancel Call Tag Reply
Continuing with the example on the previous page, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"145"
Transaction Type 145 is Cancel Call Tag Reply.
1,"Cancel CallTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the account number entered is
not the account number used to create the Call Tag, FedEx would respond with the following transaction:
Data File
Field Description
0,"311"
Transaction Type 145 is Cancel Call Tag Reply.
1,"Cancel CallTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"F5CD"
Error code.
3,"A call tag may only be cancelled by the shipper
who originally requested it."
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
187
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Transaction 046: Express Tag Dispatch Create Request
The FedEx Express Tag return label combines the delivery of the FedEx Express label with the pickup function. This transaction will dispatch a FedEx driver with a label to
the location specified in the transaction. 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 the FedEx Express Tag Availability Request. Cancellations are handled using the FedEx Express Tag Dispatch Cancel Request.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction Identifier
FDXE
USD
Optional.
This field tag 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.
10
Sender FedEx Account Number
FDXE
USD
Required.
The FedEx account number of the Sender is required to successfully Request an Express
Tag Dispatch.
498
Meter Number
FDXE
USD
Required.
The unique meter number assigned to the Sender’s FedEx account number is required to
successfully Request an Express Tag Dispatch.
SENDER ORIGIN
4
Sender Company
FDXE
USD
Required if the Sender contact name is not passed in the transaction.
5
Sender Address Line 1
FDXE
USD
Required.
Primary address line from which the shipment is originating.
7
Sender City
FDXE
USD
Optional.
Required Secondary address line from which the shipment is originating.
8
Sender State
FDXE
USD
Required.
City name from which the shipment is originating.
Minimum of 3 alpha characters must be passed for shipping.
9
Sender Postal Code
FDXE
USD
Required.
State code from which the shipment is originating.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
188
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
32
Sender Contact Name
FDXE
USD
Required if the Sender Company Name is not passed in the transaction.
Postal code from which the shipment is originating.
Must be numeric and no embedded dashes allowed.
Valid characters: A-Z; 0-9; a-z
117
Sender Country Code
FDXE
USD
Required.
Must = US if the Sender Company Name is not passed in the transaction.
183
Sender Phone Number
FDXE
USD
Required if interfacing with remote FedEx Express or FedEx Ground Server.
MERCHANT / DESTINATION
11
Recipient Company
FDXE
USD
Required if Recipient Contact Name was not passed in the Request transaction.
If entered, a minimum of 3 alpha characters must be passed.
12
Recipient Contact Name
FDXE
USD
Required if Recipient Company Name was not passed in the Request transaction.
If passed in the transaction, a minimum of 3 alpha characters must be passed.
13
Recipient Address Line 1
FDXE
USD
Required.
14
Recipient Address Line 2
FDXE
USD
Optional.
15
Recipient City
FDXE
USD
Required.
A minimum of 3 alpha characters must be passed.
16
Recipient State
FDXE
USD
Required.
17
Recipient Postal Code
FDXE
USD
Required.
18
Recipient Phone Number
FDXE
USD
Required.
50
Recipient Country Code
FDXE
USD
Required.
Must be US.
20
Payer Account Number
FDXE
USD
Required if Pay Type is 3 (Bill Third Party).
23
Pay Type
FDXE
USD
Required.
Only Bill Sender and Bill Third Party are allowed.
PAYMENT
EXPRESS TAG SPECIFIC DATA
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
189
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
1009
Business Close Time
FDXE
USD
Required.
This field should contain the shipper’s latest package pickup time for the pickup date
requested.
The time entered must be earlier than the FedEx location cutoff time, or an error will be
returned.
There must be enough access window between the Package Ready Time and the Business
Close Time, or an error will be returned.
1008
Package Ready Time
FDXE
USD
Required.
This field should contain the shipper’s earliest package pickup time for the pickup date
requested.
The time entered cannot be later than the Business Close Time.
The Package Ready Time must be earlier than the Business Close Time (or the location’s
cutoff time if it is earlier) minus the location’s Access Time, or an error will be returned.
1365
Dispatch Date
FDXE
USD
Required.
This field contains the desired pickup date.
Requested date can be same business day or next business day,
Monday-Saturday only.
1010
Courier Remarks/Pickup
Instructions
FDXE
USD
Optional.
This field contains any pickup instructions for the courier/driver.
SHIPMENT INFORMATION
1273
Packaging Type
FDXE
USD
Required.
1274
Service Type
FDXE
USD
Required.
2210
RMA Number
FDXE
USD
Optional.
75
Weight Units
FDXE
USD
Required.
Must be LBS.
Total Shipment Weight
FDXE
USD
Required.
68
Declared Value Currency Type
FDXE
USD
Optional.
Required if declared value is indicated.
Must be USD.
116
Package Total
(Total Number of Pieces)
FDXE
USD
Required.
Can contain 1-5 inclusive.
For multiple-piece shipping, FDXE only applies to COD and international.
1400
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
190
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Field
Tag
Field Name
Applicable
Carrier
Valid
For
1415
Declared Value / Carriage Value
FDXE
USD
Optional for U.S. FedEx Express Requests.
Should contain the total declared value for the entire FedEx Express Tag pickup/shipment.
Must be equal to or less than $50,000 USD.
If not entered, will default to $0 USD.
FDXE
USD
Optional.
A maximum of 30 characters is accepted in this field in this transaction.
This field allows customer-defined notes to print on the shipping label.
FDXE
USD
Y if shipment is Hold at Location, else N.
Shipment will be held at the destination FedEx Station location.
Field Requirements
REFERENCE INFORMATION
25
Reference Information
SPECIAL SERVICE – HOLD AT LOCATION
1200
Hold at Location (HAL) Flag
SPECIAL SERVICE – OTHER
440
Residential Delivery Flag
FDXE
USD
Y if shipment is Residential Delivery, else N.
1266
Saturday Delivery Flag
FDXE
USD
Y if shipment is targeted for Saturday delivery, else N.
FDXE
USD
Required.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
191
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Example of Transaction 046: Express Tag Dispatch Create Request
In order to create a FedEx Express Tag to dispatch a carrier to a location with pre-generated label and retrieve a FedEx package, format your FedEx Express Tag Request
as follows:
Data File
Field Description
0,"046"
Transaction Type 046 is Express Tag Request.
1,"ExpressTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
10,"000000000"
Sender Account Number.
498,"0000000"
Meter Number.
3025,"FDXE"
Carrier Code.
4,"WAPI"
Sender Company Name.
5,"5767 E Shelby Dr"
Sender Address 1.
7,"Memphis"
Sender City.
8,"TN"
Sender State/Province.
9,"38141"
Sender Postal Code.
8,"TN"
Sender State/Province.
9,"38141"
Sender Postal Code.
117,"US"
Sender Country.
32,"WAPI-TEST-CL"
Sender Contact Name.
38,"WAPI"
Sender Department.
183,"8004633339"
Sender Phone Number.
1201,"[email protected]"
Sender's Email Address.
11,"WAPI"
Recipient Company Name.
12,"WAPI-TEST-CL"
Recipient Contact Name.
13,"80 FEDEX PKWY"
Recipient Address 1.
15,"DETROIT"
Recipient City.
16,"MI"
Recipient State/Province.
17,"48204"
Recipient Postal Code.
18,"8004633339"
Recipient Phone Number.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
192
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Data File
Field Description
50,"US"
Recipient Country Code.
20,"1010101010"
Payer Account Number.
23,"1"
Payment Code.
1116,"I"
Dim Units.
116,"1"
Total Number of Packages.
117,"US"
Sender Country.
1145,"EDI0479"
Recipient Department Name.
1008,"080010"
Package Ready Time.
1009,"170030"
Business Close Time/Last Pickup Time.
1273,"01"
Packaging Type.
1274,"01"
Service Type.
1365,"20051008"
Dispatch Date.
1398,"Books"
Item Description.
1400,"0.0"
Total Shipment Weight.
75,"LBS"
Weight Type/Unit of Measure.
2382,"3"
Return Shipment Indicator.
1200,"N"
Hold at Location (HAL) Flag.
58,"2"
Dim Package Width.
59,"62"
Dim Package Length.
1266,"N"
Saturday Delivery Flag.
440,"Y"
Residential Delivery Flag.
57,"2"
Dim Package Height.
58,"2"
Dim Package Width.
59,"62"
Dim Package Length.
68,"USD"
Customs/Declared Value Currency Type.
25,"D-ANY-F42953XPRS12"
Reference Info.
1010,"Schedule my package for pickup"
Courier Remarks/Pickup Instructions.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
193
Tagged Transaction Layouts – Transaction 046: Express Tag Dispatch Create Request
Data File
Field Description
2210,"RMA_TEST"
RMA Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
194
Tagged Transaction Layouts – Transaction 146: Express Tag Dispatch Create Reply
Transaction 146: Express Tag Dispatch Create Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction Identifier
FDXE
USD
Optional.
Returned containing the same value if the customer included information for this field tag in
the Request transaction. It is returned in the Reply transaction to aid in matching transaction
Requests to Replies.
ERROR HANDLING
2
Transaction Error Code
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or a server failure, the
error code will be placed in this field tag.
3
Transaction Error Message
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in
response transaction indicating failed processing. For an erroneous transaction, the error
message will be placed in this field.
EXPRESS TAG DISPATCH
1011
Dispatch Confirmation Number
FDXE
USD
Dispatch Confirmation Number.
1012
Dispatch Location ID
FDXE
USD
Express Location Identifier.
2268
Access Time
FDXE
USD
Access times vary by postal code.
Format: HHMMSS
This is the minimum time window that must be allocated for the FedEx courier to make the
pickup. This is a length of time. The difference between the Business Close Time (or the
local "cutoff time" if it is earlier than the Business Close Time) and the Package Ready Time
must be equal to or exceed the access time.
2267
Cutoff Time
FDXE
USD
Latest time a FedEx courier will be available to pick up the package from the Sender.
Format: HHMMSS
FedEx cutoff times vary by postal code.
2238
Delivery Commitment Date
FDXE
USD
The date by which FedEx commits to deliver the shipment to the merchant if the shipment is
tendered to FedEx on the scheduled pickup date.
Format: YYYYMMDD
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
195
Tagged Transaction Layouts – Transaction 146: Express Tag Dispatch Create Reply
Field
Tag
2239
29
Applicable
Carrier
Valid
For
Delivery Commitment Time
FDXE
USD
Tracking Number
FDXE
USD
FDXE
USD
Field Name
Field Requirements
The time by which FedEx commits to deliver the shipment to the merchant if the shipment is
tendered to FedEx on the scheduled pickup date.
Format: HHMMSS
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Transaction Returned.
196
Tagged Transaction Layouts – Transaction 146: Express Tag Dispatch Create Reply
Example of Transaction 146: Express Tag Create Dispatch Reply
Continuing with the example of the FedEx Express Tag Request on the previous page, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"146"
Transaction Type 146 is Express Tag Create Dispatch Reply.
1,"ExpressTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
1011,"00008"
Dispatch Confirmation Number.
1012,"TSSA"
Dispatch Location.
2238,"20051014"
Commitment Date.
2239,"103000"
Commitment Time.
2267,"193000"
Cutoff Time.
2268,"023000"
Access Time.
29,"301000658419"
Tracking Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
197
Tagged Transaction Layouts – Transaction 047: Express Tag Dispatch Cancel Request
Transaction 047: Express Tag Dispatch Cancel Request
This transaction cancels a FedEx Express Tag Request. This transaction is only valid until driver is dispatched. Erroneous Requests should be canceled as soon as
possible.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction Identifier
FDXE
USD
Optional.
10
Sender FedEx Account Number
FDXE
USD
Required
498
Meter Number
FDXE
USD
Required.
EXPRESS TAG DISPATCH DATA
1011
Dispatch Confirmation Number
FDXE
USD
Dispatch confirmation number.
1012
Dispatch Location ID
FDXE
USD
Express Location Identifier.
1365
Dispatch Date
FDXE
USD
Dispatch Date.
The date FedEx will attempt to pick up the shipment from the Sender.
FDXE
USD
Transaction Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
198
Tagged Transaction Layouts – Transaction 047: Express Tag Dispatch Cancel Request
Example of Transaction 047: Express Tag Dispatch Cancel Request
If a customer wishes to cancel a FedEx Express Tag previously scheduled, the customer needs to send the 047 transaction to FedEx to cancel the FedEx Express Tag. For
example, you scheduled a Dispatch for a FedEx Express Tag on October 13, 2005, and your FedEx Account Number is 987654321. The Dispatch Confirmation Number
provided to you was 00008, and the Dispatch Location which will handle your FedEx Express Tag Request is TSSA. The input transaction should be formatted as follows:
Data File
Field Description
0,"047"
Transaction Type 047 is Express Tag Dispatch Cancel Request.
1,"Cancel ExpressTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
10,"987654321"
Sender Account Number.
1011,"00008"
Dispatch Confirmation Number.
1012,"TSSA"
Dispatch Location.
1365,"20051013"
Dispatch Date.
498,"1234567"
Meter Number.
99,""
Transaction terminator.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
199
Tagged Transaction Layouts – Transaction 147: Express Tag Dispatch Cancel Reply
Transaction 147: Express Tag Dispatch Cancel Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction Identifier
FDXE
USD
Optional.
Returned containing the same value if the customer included information for this field tag in
the Request transaction. It is returned in the Reply transaction to aid in matching transaction
Requests to Replies.
ERROR HANDLING
2
Transaction Error Code
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in
response indicating failed processing. For an erroneous Request or a server failure, the
error code will be placed in this field tag.
3
Transaction Error Message
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in
response transaction indicating failed processing. For an erroneous transaction, the error
message will be placed in this field.
FDXE
USD
Transaction Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
200
Tagged Transaction Layouts – Transaction 147: Express Tag Dispatch Cancel Reply
Example of Transaction 147: Express Tag Dispatch Cancel Reply
Continuing with the example in the Request, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"147"
Transaction Type 147 is Express Tag Dispatch Cancel Reply.
1,"Cancel ExpressTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the dispatch/confirmation
number entered was not valid, FedEx would respond with the following transaction:
Data File
Field Description
0,"147"
Transaction Type 147 is Cancel Express Tag Dispatch Reply.
1,"Cancel ExpressTag"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"5049"
Error code.
3,"No dispatch found for this account."
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
201
Tagged Transaction Layouts – Transaction 048: Express Tag Availability Request
Transaction 048: Express Tag Availability Request
Express Tag is a premium FedEx Express service and has limited coverage. Effective applications will include this option to allow customers 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.
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction Identifier
FDXE
USD
Optional.
10
Sender FedEx Account Number
FDXE
USD
Required.
498
Meter Number
FDXE
USD
Required.
Sender Postal Code
FDXE
USD
Required.
117
Sender Country
FDXE
USD
Required.
Must be US.
1365
Dispatch Date
FDXE
USD
Required.
1008
Package Ready Time
FDXE
USD
Required.
1273
Packaging Type
FDXE
USD
Required.
1274
Service Type
FDXE
USD
Required.
FDXE
USD
Transaction Returned.
EXPRESS TAG DISPATCH DATA
9
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
202
Tagged Transaction Layouts – Transaction 048: Express Tag Availability Request
Example of Transaction 048: Express Tag Availability Request
If a customer wants to determine if the availability of a FedEx Express Tag for a particular area within the U.S., the customer needs to send the 048 transaction to FedEx to
find out the availability of a FedEx Express Tag. For example, you wish to determine if you can schedule a FedEx Express Tag on October 13, 2005, and the package will
be ready at 8:10p.m. Your FedEx Account Number is 987654321, and you are shipping from ZIP code 10001. The input transaction should be formatted as follows:
Data File
Field Description
0,"048"
Transaction Type 048 is Express Tag Availability Request.
1,"ExpressTagAvailability"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
498,"1234567"
Your meter number.
10,"100100101"
Sender Account Number.
1008,"080010"
Package Ready Time.
117,"US"
Sender Country.
1273,"02"
Packaging Type.
1274,"01"
Service Type.
1365,"20051013"
Dispatch Date.
498,"1033934"
Meter Number.
9,"10001"
Sender Postal Code.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the ZIP code entered had only 3
digits, FedEx would respond with the following transaction:
Data File
Field Description
0,"311"
Transaction Type 311 is Subscribe/Register Reply.
1,"Subscribe "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"1235"
Error code.
3,"Bad Zip Format"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
203
Tagged Transaction Layouts – Transaction 148: Express Tag Availability Reply
Transaction 148: Express Tag Availability Reply
Field
Tag
Field Name
Applicable
Carrier
Valid
For
Field Requirements
STANDARD INFO
0
Transaction Code
FDXE
USD
Required.
1
Customer Transaction
Identifier
FDXE
USD
Optional.
Returned containing the same value if the customer included information for this field tag in the
Request transaction. It is returned in the Reply transaction to aid in matching transaction Requests to
Replies.
ERROR HANDLING
2
Transaction Error Code
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in response
indicating failed processing. For an erroneous Request or a server failure, the error code will be
placed in this field tag.
3
Transaction Error Message
FDXE
USD
Returned only if an error occurred while processing the transaction. Passed back in response
transaction indicating failed processing. For an erroneous transaction, the error message will be
placed in this field.
EXPRESS TAG DISPATCH DATA
2269
Express Tag Availability
Code
FDXE
USD
Indicates the FedEx Express Tag Service availability at the sender postal code indicated in the
Request:
2 = FedEx Express Tag service next day available
3 = FedEx Express Tag service same day and Next Day available
2268
Access Time
FDXE
USD
Access times vary by postal code.
Format is: HHMMSS
This is the minimum time window that must be allocated for the FedEx courier to make the pickup.
This is a length of time. The difference between the Business Close Time (or the local "cutoff time" if it
is earlier than the Business Close Time) and the Package Ready Time must be equal to or exceed the
access time.
2267
Cutoff Time
FDXE
USD
Latest time a FedEx courier will be available to pick up the package from the Sender.
FedEx cutoff times vary by postal code.
Format: HHMMSS
FDXE
USD
Transaction Returned.
TRANSACTION TERMINATOR
99
End Of Record
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
204
Tagged Transaction Layouts – Transaction 148: Express Tag Availability Reply
Example of Transaction 148: Express Tag Availability Reply
Continuing with the example in the Request, the Reply transaction would be formatted as follows:
Data File
Field Description
0,"311"
Transaction Type 148 is Express Tag Availability Reply.
1,"Subscribe"
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
498,"1234567"
Your meter number.
4021-1,"0001"
Authorized for FedEx Express Shipping.
4021-2,"0002"
Authorized for FedEx Ground Shipping.
99,""
Transaction terminator.
If the input transaction contains an error, an error message number and message text are included in the transaction Reply. If, for example, the ZIP code entered had only 3
digits, FedEx would respond with the following transaction:
Data File
Field Description
0,"311"
Transaction Type 148 is Express Tag Availability Reply.
1,"Subscribe "
Customer Transaction identifier. FedEx will return to you the same identifier you send in.
2,"1235"
Error code.
3,"Bad Zip Format"
Error message.
99,""
The required transaction terminator. It must be the last pair in the transaction.
NOTE:
The error code and error messages are returned only when an error occurred or invalid data was sent with the original Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
205
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 customerproduced 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.
NOTE:
While FedEx Ship Manager API will support the printing of both plain paper and thermal labels, FedEx does not provide the hardware with which to produce
either type label.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
206
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 application. Image orientations for both Shipping and Tracking
Signature Proof of Delivery (SPOD) PNG plain paper shipping labels are listed in the corresponding table:
Print Manager Dimensions
PNG Plain Paper Image
Orientation Dimensions
Width
By
Height
Shipping PNG (browser and non-browser)
7.0
X
4.75
SPOD PNG (browser and non-browser)
6.8
X
7.6
When the label is printed, it can either increase or decrease in size if the print manager dimensions are not properly set.
If the dimensions are increased, the following will result:
• All human readable, bar code data and bar codes will be increased in size, and bar codes may become unable to be scanned by the Courier and FedEx Ground
Operations division.
• Since the label will need to be folded in half and inserted into the FedEx Pouch, the ASTRA bar code (field 35 in the table below) will need to be fully visible. To ensure
full visibility, there should be between 5/16" and ¾" of white space from the bottom of the ASTRA bar code to the fold.
If the dimensions are decreased, the following will result:
• All human readable, bar code data and bar codes will be decreased in size.
• When the label is decreased in size, bar codes may become unable to be scanned by the Courier and FedEx Ground Operations division. Additionally, if the size is
increased or decreased, this may result in the delay of switching the user's application from the validation to production environment.
For the Browser based label, the user will need to ensure the appropriate HTML wrapper is attached. The following represents the Page name and File path of a Browser
based label:
• FedEx Ship Manager API Label Page file://C:/Program Files/FedEx/Fed…ples/vb/470004122710.html
Reference the Browser-based shipping label in the following plain paper shipping label attachments for verbiage orientation.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
207
Shipping Label Specifications
PDF Label
Plain paper labels can be generated in PDF (Portable Document Format) which will alleviate scaling problems for different size paper or label stock. The PDF is produced
when tag 1370 (Label Media Type) is set to 8.
The following requirements apply to PDF labels:
• Tag 1368 (Label Type) must be set to 2 (2D common label).
• Tag 1369 (Printer Type) must be set to 1 (laser printer).
• Adobe Reader 6.0 or higher is needed to process the labels.
• Printer driver configuration must have print scaling set to ‘none’.
4x6 PNG Label
FedEx Ship Manager API allows users to request a 4" x 6" PNG graphic of the current FedEx thermal label. These label images can then be embedded into your shipping
documentation to alleviate the need for a custom label.
The following requirements apply when using the 4"x 6" PNG graphic embedded into your shipping document:
• 4"x 6" PNG labels should only be used with peel & stick label stock. 4"x 6" PNG labels that are not on peel & stick label stock will be rejected by the FedEx Ground and
FedEx Express label certification teams.
• Laserjet printers are recommended for printing labels. Inkjet printers should not be used. Most labels created with inkjet printers have been rejected by the label
certification teams due to poor print quality.
• 4"x 6" PNG format should NOT be used on plain paper and will be rejected automatically if submitted for certification on plain paper.
• 4"x 6" PNG labels should not be printed with a color printer. Most labels created with a color printer have been rejected by the label certification teams due to poor print
quality.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
208
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
Screen resolution (typical default)
Windows using small fonts
96 DPI
Windows using large fonts
120 DPI
Macintosh
72 DPI
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
209
Shipping Label Specifications
Examples of Populating HTML Tag Height and Width Values:
Width (pixels) = ScreenDPI * (desired image reproduced width)
Height (pixels = ScreenDPI * (desired image reproduced height)
Example: Sample code implementing Shipping plain paper label in Netscape Browser:
<HTML>
<SCRIPT LANGUAGE="JavaScript1.1">
var NS4 = (document.layers) ? true : false ;
var resolution = 96;
if (NS4 && navigator.javaEnabled())
{
var toolkit = java.awt.Toolkit.getDefaultToolkit();
resolution = toolkit.getScreenResolution();
}
</SCRIPT>
<SCRIPT LANGUAGE="JavaScript">
document.write('<img WIDTH=' + (700 * resolution )/100 + '<img HEIGHT=' +
(475 * resolution )/100 + ' alt="ASTRA Barcode" src="path/test.png">');
</SCRIPT>
</HTML>
Example for getting Screen resolution using Microsoft MFC library:
DC hDC = CreateDC( "DISPLAY", NULL, NULL, NULL );
int DPI = getDeviceCaps ( hDC, LOGPIXELSX);
DeleteDC(hDC);
Custom Labels
FedEx does not support the creation or use of a custom label for either FedEx Ship Manager API FedEx Ground or FedEx Express shipping.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
210
Shipping Label Specifications
Shipping Label Support
Labels can be categorized by three attributes:
• label type
• printer type
• format
The label type (2 = 2D Common) is specified with field 1368 in the Ship transaction.
The printer type (1 = laser printer, 2 = Eltron Orion, 3 = Eltron Eclipse, 4 = Zebra ZPL, or 5 = Unimark) is specified with field 1369.
The format type (3 = 4x6¾ thermal with doc-tab at the bottom, 4 = 4x6 without doc-tab, 5 = plain paper PNG, 6 = 4x6¾ thermal with doc-tab at the top, 7 = 4x6 PNG Laser
printer image, and 8 = PDF) is specified with field 1370.
The shipping label data will be found in field 188 in the response transaction. If there is a COD return label, it will be found in field 411. If you requested a PNG label, the
data returned will be a PNG file. If you requested a thermal label, the data returned will be a series of command codes that can be serially transmitted to a thermal printer to
cause a label to be printed.
To ensure fast, reliable parsing of tagged transactions, certain characters are not allowed in the data values of fields. Any occurrences of those characters within a field will
have been encoded with other legal characters. Thus, after you extract the bytes of data from the label fields (188 and 411), they must be decoded to get the PNG or
thermal label image.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
211
Shipping Label Specifications
Label Data Buffer
NOTE:
The following example does NOT include all possible fields of the Ship Reply transaction. The label type generated by this example data string is a PNG
label.
Upon a successful Ship a Package Request Transaction, the following buffer is returned:
Send to FedEx:
0,"021"4,"ABC Company"5,"1234 Main Street"7,"Memphis"8,"TN"9,"38101"11,"XYZ Company"13,"9876 Southwest Street"15,"New
York"16,"NY"17,"10042"18,"7035551212"23,"1"50,"US"74,"US"75,"LBS"117,"US"183,"901555121
2"1115,"123456"1116,"I"1273,"02"1274,"01"1368,"2"1369,"1"1370,"5"1401,"2.0"3025,"FDXE"10,"123456789"498,"123456
7"24,"20050531"99,""
Received from FedEx:
0,"121"33,"AA"1136,"XY"30,"XY AYZA"29,"470001338040"526,"0201"1402,"2.0"1419,"25.22"1416,"24.25"1417,".97"1090,"USD"1
089,"01552"1092,"5"65,"40048946120000014700013380402018"194,"THU"195,"EWR"409,"01JUN00" 431,"N"188,"<Label Binary Data
Stored Here>"99,""
NOTE:
That field 188 will contain the label data. In the next section, we will look into how to use this data buffer to print the FedEx Shipping Label.
When a Ship a Package transaction is performed, the data necessary for producing a shipping label (and possibly a COD return label) is returned in one or more fields. The
kind of label data returned depends on the printer type and format specified in your Ship Request.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
212
Shipping Label Specifications
Using Buffer Data to Print PNG, Thermal, PDF Labels and SPODs
The rule for encoding the PNG, thermal, PDF, and SPOD image in the returned label buffer was designed to eliminate certain illegal characters (byte values) by replacing
them with an escape sequence. Those values that are not allowed include:
• NULL
(0x00 hex)
• Double Quote (0x22 hex)
The percent character ‘%’ (0x25 hex) is used as the escape character, and therefore must be replaced where it occurs naturally. Whenever a disallowed character or the
escape character '%' is encountered, it is replaced by the escape character ‘%’ (0x25 hex), followed by two characters comprising the hexadecimal numeral representing
the value of the character. For example, the NULL character (0x00 hex) is replaced by three characters:
• '%'
(0x25)
• '0'
(0x30)
• '0'
(0x30)
The percent character 0x25 is replaced by three characters:
• '%'
(0x25)
• '2’
(0x32)
• '5'
(0x35)
The algorithm for decoding the PNG image in the returned label buffer is as follows. Read bytes from the label field one at a time. When a byte read is not equal to the ‘%’
character (0x25 hex), pass it through unchanged. When a byte is read that is equal to the ‘%’ character (0x25 hex), read an additional two bytes, which will each take a
value from ‘0’ (0x30 hex) through ‘9’ (0x39 hex) or ‘A’ (0x41 hex) through ‘F’ (0x46 hex). These two bytes are interpreted as a character representation of a two-digit
hexadecimal numeral ranging from 0x00 through 0xFF. The single byte having the integral value represented by that numeral is appended to your output. For example,
when the 3-byte string '%22' is encountered, ‘ " ’ (0x22) – the double quote character is passed out. When the 3 bytes '%00' are read, the null character is written.
In essence, the developer will need to take the data received from FedEx and store it in a buffer that has sufficient memory to hold the entire data stream. Once the data
has been stored, the program might use a function similar to the one described below in order to parse the data in the buffer and extract only the PNG image data. From
that point, the developers program must be able to call a print function to send the image to the laser printer. The following sample "C" function illustrates how this is
accomplished.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
213
Shipping Label Specifications
Sample C
int create_fedex_ship_label(char *receive_buffer)
{
FILE *fedex_label;
int c;
int data_decoded = 0;
int temp_label_counter;
int label_data_found = 0;
int result = 1;
int load_label_data = 0;
char data;
char temp_label_buffer[20];
char label_file_name[20]= {"FedEx Label.png"};
char data_field_buffer[6]= {"188,"};
if((fedex_label = fopen(label_file_name, "wb")) == NULL)
{
return(1);
}
c = 0;
while(data_decoded != 1)
{
data = receive_buffer[c];
if(data == '1')
{
temp_label_buffer[temp_label_counter] = data;
temp_label_counter++;
c++;
data = receive_buffer[c];
if((data == '8') && (temp_label_buffer[0] == '1'))
{
temp_label_buffer[temp_label_counter] = data;
temp_label_counter++;
c++;
data = receive_buffer[c];
}
else
{
temp_label_counter = 0;
}
if((data == '8') && (temp_label_buffer[1] == '8'))
{
temp_label_buffer[temp_label_counter] = data;
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
214
Shipping Label Specifications
temp_label_counter++;
c++;
data = receive_buffer[c];
}
else
{
temp_label_counter = 0;
}
if((data == ',') && (temp_label_buffer[2] == '8'))
{
temp_label_buffer[temp_label_counter] = data;
temp_label_counter++;
c++;
temp_label_buffer[temp_label_counter] = 0x00;
label_data_found = 1;
}
else
{
temp_label_counter = 0;
}
}
else
c++;
if(label_data_found)
{
result = strcmp(temp_label_buffer, data_field_buffer);
if(result == 0)
load_label_data = 1;
data = receive_buffer[c];
}
if(load_label_data)
{
data = '0';
c++;
while(data != 0x22)
{
data = receive_buffer[c];
c++;
if(data != '%')
fprintf(fedex_label, "%c", data);
if(data == '%')
{
for(e=0; e<2; e++)
{
data = receive_buffer[c];
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
215
Shipping Label Specifications
c++;
if(((data >= 0x30) && (data <= 0x39)) || ((data >= 0x41)
&& (data <= 0x46)))
{
if(e == 1)
{
d = data;
d = d & 0x0f;
if((data >= 0x41) && (data <= 0x46))
d += 9;
store = store | d;
}
else
{
d = data;
d = d & 0x0f;
if((data >= 0x41) && (data <= 0x46))
d += 9;
store = d << 4;
}
}
}
fprintf(fedex_label, "%c", store);
}
}
data_decoded = 1;
}
}
fclose(fedex_label);
return(0);
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
216
Appendix A: Field Descriptions by Field Tag
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
0
Transaction Code
4
Numeric
1
Customer Transaction Identifier
40
Alpha
This field 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.
2
Transaction Error Code
8
Alpha
Passed back in response transaction indicating failed processing. For an
erroneous transaction, the error code will be placed in this field.
3
Transaction Error Message
120
Alpha
Passed back in response transaction indicating failed processing. For an
erroneous transaction, the error message will be placed in this field.
4
Sender Company
35
Alpha
Company from which the shipment is originating.
5
Sender Address Line 1
35
Alpha
Primary address line from which the shipment is originating.
6
Sender Address Line 2
35
Alpha
Secondary address line from which the shipment is originating.
7
Sender City
FDXE-35
FDXG-20
Alpha
City name from which the shipment is originating.
8
Sender State
22
Alpha
State code from which the shipment is originating.
9
Sender Postal Code
16
Alpha
Postal code from which the shipment is originating. Must be numeric for U.S.
Special characters allowed.
10
Sender FedEx Account Number
12
Numeric
The FedEx account number assigned to the FedEx customer from which the
shipment is originating.
11
Recipient Company
35
Alpha
Name of the company that is receiving the shipment.
12
Recipient Contact Name
35
Alpha
Name of the person that is receiving the shipment.
13
Recipient Address Line 1
35
Alpha
Primary address line of the person receiving the shipment.
14
Recipient Address Line 2
35
Alpha
Secondary address line of the person receiving the shipment.
15
Recipient City
FDXE-35
FDXG-20
Alpha
City name of the person receiving the shipment.
16
Recipient State
2
Alpha
State code of the person receiving the shipment.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Identifies the type of transaction.
217
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
17
Recipient Postal Code
16
Alpha
Postal code of the person receiving the shipment.
Must be numeric for U.S. Special characters allowed.
18
Recipient Phone Number
15
Alpha
The phone number of the person receiving the shipment. The maximum length
is 10 for US and CA, 15 for all other countries. Do not include embedded
special characters.
20
Payer Account Number
12
Numeric
Account number of company or person to be billed for payment of the
shipment.
23
Pay Type
2
Numeric
Method of payment for shipment.
Valid payment types are:
1 = Bill sender (Prepaid)
2 = Bill recipient (for FedEx Express); Collect (for FedEx Ground)
3 = Bill third party
5 = Bill recipient for FedEx Ground
24
Ship Date
8
Numeric
Date of shipment.
Format: YYYYMMDD
25
Reference Information
FDXE-40
FDXG-30
Alpha
Customer reference information assigned to a package.
This field CANNOT be used with Alcohol Shipping.
27
COD Flag
1
Alpha
Must be Y for COD (Collect on Delivery) service, else defaulted to N.
28
COD Return Tracking Number
20
Alpha
Tracking number assigned to a COD remittance shipment.
Required if the COD Flag is set to Y and the 021 Shipment Request
transaction represents the last piece in a multiple-piece shipment.
This tracking number is returned in the 121 Reply of the first 021 Request of a
COD shipment.
Not applicable for non-MPS shipments.
29
Tracking Number
20
Alpha
Tracking number assigned to a package.
30
URSA Code
7
Alpha
FedEx routing code.
32
Sender Contact Name
35
Alpha
Name of the person from which the shipment is originating.
33
Service Commitment
2
Alpha
Service commitment available for this area and service code. See the FedEx
Service Guide for returned values.
38
Sender Department
10
Alpha
Name of the department from which the shipment is originating.
Displays on the thermal label for Express.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
218
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
40
Alcohol Type
1
Alpha
The type of alcohol being shipped.
Valid values:
B = Beer
W = Wine
S = Distilled Spirits
A = Ale
L = Light Wine
41
Alcohol Packaging
2
Alpha
The packaging of the alcohol being shipped.
Valid values:
BL = Barrel
BT = Bottle
CS = Case
CN = Carton
OT = Other
44
HAL Address
35
Alpha
Primary address where a package will be held for pickup when shipping with
the Hold At Location special service.
46
HAL City
35
Alpha
City name where a package will be held for pickup when shipping with the
Hold At Location special service.
47
HAL State
14
Alpha
State code where a package will be held for pickup when shipping with the
Hold At Location special service.
48
HAL Postal Code
16
Alpha
Postal code where a package will be held for pickup when shipping with the
Hold At Location special service. Must be numeric for U.S. Special characters
allowed.
49
HAL Phone Number
15
Alpha
The phone number where a package will be held for pickup when shipping
with the Hold At Location special service. The maximum length is 10 for US
and CA, 15 for all other countries.
50
Recipient Country
2
Alpha
Country name of the person receiving the shipment.
52
Alcohol Packages
3
Numeric
Number of units (bottles, cases, etc.) of alcohol included in the package being
shipped.
57
Dim Height
3
Numeric
The height of a package.
58
Dim Width
3
Numeric
The width of a package.
59
Dim Length
3
Numeric
The length of a package.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
219
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
65
ASTRA Barcode
32
Numeric
66
Broker Name
35
Alpha
Minimum field length is 3.
67
Broker Phone Number
15
Alpha
The maximum length is 10 for US and CA, 15 for all other countries. Do not
include embedded special characters.
68
Customs/Declared Value Currency Type
3
Alpha
Currency type used for customs value and declared/carriage value fields.
The declared value currency indicated must be the same as the declared
value currency of the origin country for FedEx Ground shipments.
70
Duties Pay Type
2
Numeric
Payment type for duties and taxes.
Valid values:
1 = Bill Sender
2 = Bill Recipient
3 = Bill Third Party
71
Duties Payer Account Number
12
Numeric
FedEx account number billed for duties/taxes.
72
Terms Of Sale
1
Numeric
Valid values:
1 = FOB/FCA (Free or Freight On Board/Free Carrier)
2 = CIF/CIP (Cost-Insurance-Freight/Carriage Insurance
Paid
3 = C&F/CPT (Cost and Freight, aka CFR/Carrier
Paid To
4 = EXW (Ex Works)
5 = DDU (Delivered Duty Unpaid)
6 = DDP (Delivered Duty Paid)
73
Parties To Transaction
1
Alpha
A Y is entered and 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.).
SED Default: N
75
Weight Units
3
Alpha
Valid units:
• LBS
• KGS
U.S. FedEx Express must be LBS on a U.S. rate quote.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Returned in a successful Reply.
220
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
5
Numeric
Required for all international shipments.
The total number of packages within the shipment that contain this commodity.
(Can be greater than or equal to Package Total, field 116.)
Field Description
76
Commodity Number Of Pieces
79
Description Of Contents
Min: 31
Max: 450
Alpha
Only a portion of this field will print on the label.
Refer to Appendix C: Vague Commodity Descriptions for a list of inappropriate
commodity descriptions.
80
Country Of Manufacture
2
Alpha
Country code where commodity contents were produced or manufactured in
their final form. See Appendix B: Country Codes.
81
Harmonized Code
14
Alpha
Unique alpha/numeric representing commodity item.
Currently 10 digits, no decimals.
82
Unit Quantity
9
Alpha
Number of units of a commodity in total number of pieces for this line item.
83
Export License Number
12
Alpha
License number (A999999).
84
Export License Expiration Date
8
Numeric
99
End Of Record Indicator
113
Commercial Invoice Flag
1
Alpha
116
Total Package/Piece Count
4
Numeric
117
Sender Country Code
2
Alpha
Puerto Rico customers use US as Sender Country Code.
118
Recipient SSN/ EIN
15
Alpha
No special characters allowed.
Required for non-document shipments to Brazil. For these shipments, tag 118
should contain Brazilian resident tax ID, Brazilian company tax ID, or passport
number of recipient if the recipient is not a Brazilian citizen.
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.
Format: YYYYMMDD
Example: 99,""
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Must be Y if "shipment" contains Commercial Invoice information in separate
transaction
Total packages in a shipment include master transaction.
For MPS shipments, 1 piece = 1 box.
For multiple-piece shipping, FDXE only applies to COD and international.
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.
Valid values: 1 to 999
221
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
120
CI Marks And Numbers
15
Alpha
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.
169
Importer Country
2
Alpha
Country code for importer of shipment if other than recipient.
170
Importer Name
35
Alpha
Contact name for importer of shipment if other than recipient.
171
Importer Company
35
Alpha
Company Name for importer of shipment if other than recipient.
172
Importer Address Line 1
35
Alpha
Address Line 1 for importer of shipment if other than recipient.
173
Importer Address Line 2
35
Alpha
Address Line 2 for importer of shipment if other than recipient.
174
Importer City
35
Alpha
City name for importer of shipment if other than recipient.
175
Importer State
14
Alpha
State code for importer of shipment if other than recipient.
The maximum length is 2 for US and CA, 14 for all other countries.
176
Importer Postal Code
16
Alpha
Postal code for importer of shipment if other than recipient. Must be numeric
for U.S.; special characters allowed.
177
Importer Account Number
12
Numeric
178
Importer Phone Number
15
Alpha
Phone number for importer of shipment if other than recipient. The maximum
length is 10 for US and CA, 15 for all other countries. No embedded dashes
allowed.
180
Importer SSN/EIN
18
Alpha
SSN/EIN for importer of shipment if other than recipient.
183
Sender Phone Number
10 for
FedEx
Locator /
15 for other
transactions
Alpha
For shipping, the maximum length is 10 for US and CA, 15 for all other
countries.
For FedEx Locator, the length must be 10 digits with valid area code and
prefix.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Account number for importer of shipment if other than recipient.
222
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
186
COD Add Freight Charges Flag
188
Max Field
Length
Alphanumeric/
Numeric
Field Description
1
Alpha/
Numeric
Required if the COD Flag is set to Y and freight charges are to be added to the
COD amount.
Accumulate these charges into the COD Amount for a single package:
1 = Add discounted rate to COD Amount
2 = Add list rate to COD Amount
3 = Add discounted COD Surcharge
4 = Add list COD Surcharge
5 = Add discounted **Customer Total Charge
6 = Add list **Customer Total Charge
Accumulate these charges into the COD Amount for a shipment:
7 = Add MTW Net Charge (shipment level)
8 = Add Discount Shipment Net Charge to last package
in a Shipment
9 = Add List Shipment Net Charge to last package
in a shipment.
Values 2, 4, 6 are only valid when Rate Indicator (field tag 1529)
= 2.
Values 1, 3, 5, are valid when Rate Indicator (field tag 1529) is not present or
equals 1 or 2.
Values 7-9 are only valid options for FedEx Ground MPS and have no
dependency on the Rate Indicator.
Label Buffer Data Stream
Variable
Length
Alpha
Returned only if field tags 1368, 1369, and 1370 were passed in the Ship
Request transaction.
190
Document Shipment Flag
1
Alpha
Y if document shipment, else N.
194
Delivery Day
3
Alpha
Day of week – SUN, MON, TUE, WED, THU, FRI, SAT.
195
Destination Station ID
4
Alpha
FedEx location identifier of the destination ramp.
Not available for all origin-destination combinations.
Puerto Rico to US and Canada destinations are populated.
198
Destination Location ID
5
Alpha
FedEx location identifier of the package destination.
409
Delivery Date
8
Alpha
The above date format is the required format for printing on a label to current
ASTRA specifications.
Date Format: DDMMMYY (e.g., 29NOV05)
Note: The standard date format for all dates (except delivery date) will be
passed in the YYYYMMDD format.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
223
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
51200
Alpha
Returned for COD FedEx Express U.S. and FedEx Ground shipments.
Field Description
411
COD Return Label Buffer Data Stream
413
NAFTA Flag
1
Alpha
Y if NAFTA shipment, else N.
414
Commodity Unit Of Measure
3
Alpha
The following volume/dimensions of a commodity are valid for this field tag:
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
PR – Pair
PRS – Pairs
SFT – Square Feet
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
224
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
SQI – Square Inches
SYD – Square Yard
YD – Yard
418-#
CI Comments
444
Alpha
Maximum of 4 occurrences with a maximum field length of 111.
Sum of field lengths of all occurrences must not exceed 444 characters.
431
Dim Weight Used Flag
1
Alpha
Y if dim-weighted, else N.
439
COD Return Contact Name
35
Alpha
Required only if the COD Flag is set to Y and the 021 Shipment Request
transaction represents the last piece in a multiple-piece shipment.
440
Residential Delivery Flag
1
Alpha
Y if shipment is residential delivery, else N.
496
Freight Service Commitment
2
Alpha
498
Meter Number
10
Numeric
The unique meter number assigned to the Sender’s FedEx account number is
required to successfully receive a rate quote.
Note: This field tag should only be supplied within the Request when
attempting to update the meter information.
526
Form ID
4
Numeric
FedEx assigned Form ID for labeling.
527
COD Return Form ID
4
Numeric
FedEx assigned Form ID for COD return labeling.
535
COD Return ASTRA Bar Code
32
Alpha
FedEx assigned bar code string for COD return labeling.
536
COD Return Service Commitment
2
Alpha
Service commitment for a COD return shipment.
See the FedEx Service Guide for a valid list of service commitments.
543
COD Return Collect Plus Freight Amount
8.2
Numeric
Two explicit decimal positions.
The total amount printed on the COD return label for COD service when field
186 is set to Y.
557
Message Type Code
2
Alpha/
Numeric
Optional.
Valid codes include:
01 – Warning (any transaction)
02 – Informational (any transaction)
03 – Shipping Warning
04 – Shipping Info
05 – URSA Hard
06 – URSA Soft
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
225
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
558
Message Code
8
Alpha/
Numeric
Optional Message Code.
559
Message Text
255
Alpha/
Numeric
Optional Message Text.
612
HST Surcharge
18.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Harmonized Sales Tax.
613
GST Surcharge
18.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Global Sales Tax.
614
PST Surcharge
18.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Provincial Sales Tax.
1005
Manifest/Invoice File Name
255
Alpha
1007
Close/Manifest Date
8
Numeric
Date format: YYYYMMDD
1008
Package Ready Time
6
Numeric
Time format: HHMMSS
1009
Company Close Time
6
Numeric
Time format: HHMMSS
1010
Courier Remarks/Pickup Instructions
60
Alpha
Optional.
This field contains any pickup instructions for the courier/driver.
1011
Dispatch Confirmation Number
20
Alpha
Pickup Confirmation Number.
Name of the invoice/manifest file.
Note: This is the first tracking number for FedEx Ground. N/20 max
length/number.
1012
Dispatch Location ID
5
Alpha
Express Location Identifier.
1032
Duties Payer Country Code
2
Alpha
Country code associated with duties account number.
(Returned in the 1301 transaction.)
1040
Email Label Password
6
Alpha/
Numeric
1089
Rate Scale
5
Alpha
Rate scale used to rate package.
1090
Rate Currency Type
3
Alpha
Currency code identifier for the rated currency.
1092
Rate Zone
1
Alpha
Zone used for rate if zone applies.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required if Error is not returned.
Password to be used to manually access the URL of web page at which labels
can be found.
6 Alpha/Numeric characters.
226
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
10/16
Numeric
Optional.
The fax number of the person initiating the shipment.
The maximum length is 10 for US and CA, 16 for all other countries. Do not
include embedded special characters.
Time format: HHMMSS
Field Description
1103
Sender Fax
1115
Ship Time
6
Numeric
1116
Dim Units
1
Alpha
1117
Package Sequence
4
Numeric
1118
Release Authorization Number
10
Alpha
FedEx assigned release number on file.
1119
Future Day Shipment
1
Alpha
Y if shipment is future day.
1120
Inside Pickup Flag
1
Alpha
Y if shipment is inside pickup.
Applicable to U.S. freight service only.
1121
Inside Delivery Flag
1
Alpha
Y if shipment is inside delivery.
Applicable to U.S. freight service only.
1123
Master Tracking Number
20
Numeric
Tracking number of the first package in a multiple-piece shipment.
FDXE only applies to COD and international.
1124
Master Form ID
4
Numeric
Form ID of the first package in a multiple-piece shipment.
1133
Service Availability Service Count
2
1136
URSA Prefix Code
2
Alpha
1137
URSA Uned Prefix
2
Alpha
1139
Sender SSN/ EIN
15
Numeric
Required when Client Revision Indicator (field tag 1391) = 2.
1145
Recipient Department
10
Alpha
Name of the department to whom the shipment is destined.
1159
Scan Description
80
Alpha
Literal description of the Scan activity.
1160
Scan Location City
40
Alpha
City name hosting the Station that is responsible for the scan.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Valid values:
C = Centimeters
I = Inches
U.S. FedEx Express must be in inches.
Sequence of package in the multiple-piece shipment.
Multiple-piece shipments supported for all FedEx Ground, FedEx Express
international and U.S. COD only.
FedEx service(s) available for the Requested origin/destination pairing.
There may be up to 22 occurrences of the Entry grouping representing
services available.
Prefix found from lookup; no rules applied.
227
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1161
Scan Location State
2
Alpha
1162
Scan Date
8
Numeric
Format: YYYYMMDD
1163
Scan Time
6
Numeric
Format: HHMMSS
1164
Scan Location Country
2
Alpha
1166
Deliver To Code
2
Alpha/
Numeric
1168
Status Exception CD
2
Alpha
1169
Status Code / Tracking Status Code
2
Alpha/
Numeric
1171
Scan Type Code
3
Alpha
Carrier’s scan code.
1174
BSO Flag
1
Alpha
Y if Broker Select Option information included.
1179
Broker FDX Account Number
12
Numeric
1180
Broker Company
35
Alpha
The company name of the Broker who will be used to clear the shipment (if
other than FedEx).
1181
Broker Address Line 1
35
Alpha
The address line 1 of the Broker who will be used to clear the shipment (if
other than FedEx).
1182
Broker Address Line 2
35
Alpha
The address line 2 of the Broker who will be used to clear the shipment (if
other than FedEx).
1183
Broker City
35
Alpha
The city name of the Broker who will be used to clear the shipment (if other
than FedEx).
1184
Broker State
14
Alpha
The state code of the Broker who will be used to clear the shipment (if other
than FedEx).
The maximum field length for US and CA is 2, 14 for all other countries.
1185
Broker Postal Code
16
Alpha
The postal code of the Broker who will be used to clear the shipment (if other
than FedEx).
Must be numeric for U.S.; special characters allowed.
1186
Broker Country Code
2
Alpha
The country code of the Broker who will be used to clear the shipment (if other
than FedEx).
1187
Broker SSN/EIN
18
Alpha
The SSN/EIN of the Broker who will be used to clear the shipment (if other
than FedEx).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
State abbreviation hosting the Station that is responsible for the scan.
Country code for where the scan occurred.
Pairs with field tag 1705 (Deliver To Description).
Extended definition of the scan type code’s specific type.
For example, SP = split shipment. Pairs with field tag 1701.
The FedEx assigned account number of the Broker who will be used to clear
the shipment (if other than FedEx).
228
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1089
Rate Scale
5
Alpha
Rate scale used to rate package.
1092
Rate Zone
1
Alpha
Zone 0 – A.
1193
Ship Delete Message
50
Alpha
1195
Payer Country Code
2
Alpha
Country Code associated with bill to account number.
(Returned in transaction 1301.)
1200
Hold At Location (HAL) Flag
1
Alpha
Y if shipment is Hold At FedEx Location.
1201
Sender’s Email Address
FDXE-120
FDXG-35
Alpha
The email address of the sender.
1202
Recipient’s Email Address
FDXE-120
FDXG-35
Alpha
The email address of the recipient.
1203
Personal Message
120
Alpha
Customer-specified personal message to be included in the shipment
notification.
Applies to all email notifications: ShipAlert, Exception Notification, and Delivery
Notification.
1204
Email Notification Address
FDXE-120
FDXG-35
Alpha
For FDXE and FDXG:
A minimum of one occurrence is required if field tag 1206 (ShipAlert Flag) or
field tag 1551 (Delivery Notification Flag) is Y or field tag 1960 (Exception
Notification Flag) is Y.
A maximum of three occurrences is allowed.
1206
ShipAlert Notification Flag
1
Alpha
Valid values:
• Y
• N
Defaults to N.
1237
COD Return Phone
15
Numeric
Required if the COD Flag is set to Y.
Phone number of the COD remittance party.
No embedded dashes.
1238
COD Return Company
35
Alpha/
Numeric
Company Name of the COD remittance party.
1239
COD Return Department
10
Alpha/
Numeric
Department code of the COD remittance party.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
229
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1240
COD Return Address 1
35
Alpha/
Numeric
Required if the COD Flag is set to Y.
Address 1 of the COD remittance party.
1241
COD Return Address 2
35
Alpha
Address 2 of the COD remittance party.
1242
COD Return City
35
Alpha
City name of the COD remittance party.
1243
COD Return State
14
Alpha
State code of the COD remittance party.
1244
COD Return Postal Code
9
Alpha/
Numeric
Required if the COD Flag is set to Y.
Postal code of the COD remittance party.
1248
Scan Location Postal Code
1253
Packaging List Enclosed Flag
1
Alpha
1265
Hold At Location Contact Name
35
Alpha
1266
Saturday Delivery Flag
1
Alpha
Y if shipment is Saturday delivery.
1267
Saturday Pickup Flag
1
Alpha
Y is shipment is Saturday pickup.
1268
Dry Ice Flag
1
Alpha
Y if shipment contains Dry Ice.
1271
Shipper’s Load And Count (SLAC)
5
Numeric
Applicable to International Priority Freight (IPFS) and International Economy
Freight (IEFS) only.
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.
1272
Booking Number
12
Numeric
Applicable to IPFS/IEFS only.
The booking number for international Freight shipments.
Values must be 8-12 characters in length.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Y if packaging list is enclosed.
230
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1273
Packaging Type
2
Numeric
FedEx Express shipping packaging types are:
01 – Other packaging
02 – FedEx Pak
03 – FedEx Box
04 – FedEx Tube
06 – FedEx Envelope
15* – FedEx 10kg Box (international only)
25* – FedEx 25kg Box (international only)
FedEx Ground shipping packaging types are:
01 – Customer packaging
Defaults to 01 if not specified.
*Not allowed with MPS shipments
1274
Service Type
2
Numeric
FedEx Express U.S. shipping service types are:
01 – FedEx Priority
03 – FedEx 2day
05 – FedEx Standard Overnight
06 – FedEx First Overnight
20 – FedEx Express Saver
70 – FedEx 1day Freight
80 – FedEx 2day Freight
83 – FedEx 3dayFreight
FedEx Express international shipping service types are:
01 – FedEx International Priority
03 – FedEx International Economy
06 – FedEx International First
57 – FedEx Europe First
70 – FedEx International Priority Freight
86 – FedEx International Economy Freight
FedEx Ground U.S. shipping service types are:
90 – FedEx Home Delivery
92 – FedEx Ground Service
FedEx Ground international shipping service types are:
92 – FedEx Ground Service
Note: For freight limitations, see the FedEx Service Guide or fedex.com for
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
231
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
more information.
1297
Customer Invoice Number
15
Alpha
Customer reference number.
1300
Purchase Order Number
16
Alpha
Customer assigned purchase order number.
1331
Dangerous Goods Type
1
Alpha
I if inaccessible dangerous goods.
A if accessible dangerous goods.
1332
Alcohol Flag
1
Alpha
Y if shipment contains alcohol, else N.
Alcohol type, packaging, volume and number of packages are concatenated
together and passed in the Reference Information (field tag 25).
1333
Drop Off Type
1
Alpha
Valid values:
1 if regular pickup
2 if request courier
3 if drop box
4 if drop at BSC
5 if drop at station
Only 1 (regular pickup), 2 (request courier), or 5 (drop at station) are allowed
with international freight shipping.
This field does not dispatch a courier.
1337
Package Content Information
40
Alpha
Description of package contents.
1339
Estimated Delivery Date
8
Numeric
Format: YYYYMMDD
1340
Estimated Delivery Time
6
Numeric
Format: HHMMSS
1341
Sender Pager Number
15
Alpha
The pager number of the sender.
1342
Recipient Pager Number
15
Alpha
The pager number of the recipient.
1343
Broker Email Address
120
Alpha
The email address of the broker.
1344
Broker Fax Number
15
Alpha
The fax number of the broker.
1345
Broker Pager Number
1352
Sender
EIN/SSN Indicator
Optional.
1
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Alpha
This identifier identifies value in field tag 1139.
Valid values:
S = SSN
E = EIN
D = DUNS
232
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1358
AES / FTR Exemption Number
32
Alpha /
Numeric
1359
SED Legend Number
37
Alpha
1365
Dispatch Date
8
Numeric
Required.
This field contains the desired pickup date.
Entry can contain the date for the next day through next day + 13 calendar
days.
Requested date can be same business day or next business day,
Monday-Saturday only.
FedEx Ground holidays and weekends may not be accepted.
If accepted, the first pickup attempt will be made on this date. If the pickup is
not successful, up to three pickup attempts will be made.
Format: YYYYMMDD
1366
Close/Manifest Time
6
Numeric
Time format: HHMMSS
1367
Close/Manifest Data Buffer
Variable
Length
Alpha
1368
Label Type
4
Numeric
Valid value:
2 = 2D Common
1369
Label Printer Type
4
Numeric
Valid values:
1 = Laser printer
2 = Eltron Orion (EPL2)
3 = Eltron Eclipse (EPL2)
4 = Zebra ZPL
5 = Unimark
1370
Label Media Type
4
Numeric
Valid values:
3 = Format 354 with doc tab information at bottom of
label (4x6 ¾ thermal label)
4 = Format 435 without doc tab information (4x6 thermal label)
5 = Plain paper (PNG)
6 = Format 354 with doc-tab information at top of label (4x6 ¾ thermal label)
7 = 4x6 PNG Laser printer image. Valid for domestic shipping only.
8 = PDF
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
The full AES SED exemption legend is entered in this field.
When all commodities in the shipment fall under an FTR exemption, the full
FTR exemption legend is entered in this field.
Optional.
This buffer will contain the manifest report(s) for FedEx Ground shipments.
Data/Manifest format: ASCII
233
Appendix A: Field Descriptions by Field Tag
Max Field
Length
Alphanumeric/
Numeric
Manifest Only Request Flag
1
Alpha
1372
Manifest Total
4
Numeric
1376
Rate Weight Unit Of Measure
3
Alpha
Valid units:
• LBS
• KGS
1377
Dim Weight Unit Of Measure
3
Alpha
Valid units:
• LBS
• KGS
1392
Inbound Visibility Block Shipment Data
Indicator
1
Alpha/
Numeric
Valid values:
1 = No – Do not block ship data.
2 = Yes – Block ship data
1394
Shipment Content Records Total
3
Numeric
Zero or not present = No IV Receive Detail Data sets.
1 or more = indicates the Number of IV Receive Detail Data Sets.
Maximum value = 50.
1395
Part Number
20
Alpha/
Numeric
Optional.
Repeating field up to 50 times per tracking number.
1396
SKU/Item/UPC#
15
Alpha/
Numeric
Optional.
Repeating field up to 50 times per tracking number.
1397
Receive Quantity
6
Alpha/
Numeric
Optional.
Repeating field up to 50 times per tracking number.
1398
Description
80
Alpha/
Numeric
Description of item being shipped.
1399
AES Entry Number
15
Alpha/
Numeric
Applicable for FICE shipments Only.
Only required for Commodities imported into the U.S. for Export to a third-party
country of destination.
Field
Tag
Field Name
1371
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Description
N or blank (default) = Close out current shipment cycle and create the
manifest, MTW, Hazardous Materials Report.
Y = Requesting a report generated from a previous Close. Must indicate report
in field tag 3014.
The number of manifest reports returned in a manifest data buffer.
234
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1400
Total Shipment Weight
6.1
Numeric
Required for international multiple-piece shipping.
FDXE only applies to COD and international.
The Total Shipment Weight is in the Master only, not the Child. For example,
piece "1 of n" pieces will have the total shipment weight of all the pieces.
One explicit decimal position.
1401
Total Package Weight
6.1
Numeric
One explicit decimal position.
1402
Billed Weight
6.1
Numeric
One explicit decimal position.
This is the weight used to render freight charges.
1403
Dim Weight
9.1
Numeric
Dimensional weight calculated based on the height, width, and length of a
package.
One explicit decimal position.
1405
Alcohol Volume
3.3
Numeric
The quantity of alcohol being shipped.
Unit of measurement is liters.
Three explicit decimal positions.
1406
Dry Ice Weight
4.1
Numeric
Required only if Dry Ice is selected.
One explicit decimal position.
1407
Commodity Weight
9.1
Numeric
One explicit decimal position.
1408
Commodity Unit Value
11.6
Numeric
Value of each ‘Unit’ in Unit quantity.
Six explicit decimal positions.
1410
Commodity Customs Value
8.6
Numeric
Total customs of commodity line item (all pieces).
Six explicit decimal positions.
1411
Total Customs Value
14.2
Numeric
Two explicit decimal positions.
This value includes the total value of the shipment along with freight,
insurance, and miscellaneous charges.
For FedEx Express international MPS, the Total Customs Value is in the
Master transaction and all Child transactions.
1412
Freight Charge
16.2
Numeric
Two explicit decimal positions.
1413
Insurance Charge
16.2
Numeric
Two explicit decimal positions.
1414
Taxes/
Miscellaneous Charge
16.2
Numeric
Two explicit decimal positions.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
235
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1415
Declared Value/Carriage Value
8.2
Numeric
Two explicit decimal positions.
The declared value of package contents.
This value cannot exceed the total customs value.
1416
Base Rate Amount
11.2
Numeric
Two explicit decimal positions.
1417
Total Surcharge Amount
11.2
Numeric
Two explicit decimal positions.
1418
Total Discount Amount
11.2
Numeric
Two explicit decimal positions.
1419
Net Charge Amount
11.2
Numeric
Two explicit decimal positions.
1420
Total Rebate Amount
11.2
Numeric
Two explicit decimal positions.
1421
COD Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1422
List COD Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1423
Saturday Pickup Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1424
List Saturday Pickup Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1425
Declared Value Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1426
List Declared Value Surcharge
11.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1427
Variable Handling Charge
7.2
Numeric
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 = 1.
Interpreted as a percentage if Variable Handling Type = 2, 3, or 4.
Format: 9999999.99 explicit decimal. 10 total length including decimal place.
1428
Variable Handling Charge Amount
7.2
Numeric
Format: 9999999.99 explicit decimal. 10 total length including decimal place.
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 field) plus the value input in
Variable Handling Charge.
If the Variable Handling Type = 1, this field will be equal to the Variable
Charge.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
236
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1429
List Variable Handling Charge Amount
7.2
Numeric
Format: 9999999.99 explicit decimal. 10 total length including decimal place.
Contains 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 field) plus the Variable Handling Charge.
If the Variable Handling Type = 1, this field will be equal to the Variable
Charge.
1430
Total Customer Charge
18.2
Numeric
Format: 999999999999999999.99. 21 total length including decimal place.
Includes 2 explicit decimal places.
Contain 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 field.
1431
List Total Customer Charge
18.2
Numeric
Format: 999999999999999999.99. 21 total length including decimal place.
Includes 2 explicit decimal places.
Contains Shippers list Net Charge (in the billing currency) plus List Variable
Handling Charge Amount. Will contain piece level or shipment level dependent
on the Variable Handling Charge Level field.
1432
Customer COD Amount
10.2
Numeric
The Customer input COD amount (prior to any accumulations).
Two explicit decimals.
1433
COD Collect Amount
10.2
Numeric
Two explicit decimals.
The COD cash amount (after any accumulations) that must be collected upon
delivery of a package shipped using the COD special service.
1434
Saturday Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1435
List Saturday Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
1436
Dangerous Goods Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express Accessible and Inaccessible Dangerous Goods
only.
1437
List Dangerous Goods Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express Accessible and Inaccessible Dangerous Goods
only.
1438
Out of Pickup Area / H3 Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to U.S. FedEx Express Freight only.
1439
List Out of Pickup Area / H3 Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to U.S. FedEx Express Freight only.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
237
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1440
Out of Delivery Area / H3 Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to U.S. FedEx Express Freight only.
1441
List Out of Delivery Area / H3 Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to U.S. FedEx Express Freight only.
1442
Inside Pickup Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1443
List Inside Pickup Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1444
Inside Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1445
List Inside Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1446
Residential Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1447
List Residential Delivery Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1448
Priority Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1449
List Priority Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1450
More Data Indicator
1
Alpha
1451
Sequence Number
4
Numeric
Optional.
Should be incremented and populated for subsequent result set requests.
Value will default to 1 if blank.
1452
Last Tracking Number
20
Numeric
Optional/
Required for subsequent result set requests.
Provide last returned tracking number to Request subsequent sets of track by
reference data.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Y = more data available
N = no more data available
238
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
1453
Track Reference Type
1454
Track Reference
1456
Max Field
Length
Alphanumeric/
Numeric
Field Description
2
Alpha/
Numeric
Required for Track by Reference.
Valid values:
1 = Shipper/Customer Reference
2 = Ground PO
3 = Ground Invoice Number
FDXE: Only value allowed is 1.
FDXG: Values 2 and 3 allowed.
35 – FDXE
30 – FDXG
Alpha/
Numeric
Required for Track by Reference.
Track by Reference qualifier string.
SPOD Request Type
1
Alpha/
Numeric
Required.
The type of SPOD being requested to be provided.
Valid values:
F = SPOD Fax Letter
L = SPOD Letter file
1457
SPOD Letter Format
1
Numeric
Required if SPOD Request Type = L (Letter).
Valid value:
2 = PDF
1458
SPOD Fax Recipient Name
35
Alpha/
Numeric
Required if SPOD Request Type = F (Fax).
1459
SPOD Fax Recipient Number
15
Numeric
Limit to 10 digit (U.S.) fax numbers only.
1460
SPOD Fax Sender Name
35
Alpha/
Numeric
Required for fax.
1461
SPOD Fax Sender Phone Number
15
Numeric
Required for fax.
1462
Language Indicator
3
Alpha
1463
SPOD Fax Mail Recipient Company
Name
35
Alpha/
Numeric
Optional.
1464
SPOD Fax Mail Recipient Address Line 1
35
Alpha/
Numeric
Required for fax.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Valid values:
EN = English
FR = Canadian French
Case sensitive.
239
Appendix A: Field Descriptions by Field Tag
Alphanumeric/
Numeric
Field
Tag
Field Name
Max Field
Length
1465
SPOD Fax Mail Recipient Address Line 2
35
Alpha/
Numeric
1466
SPOD Fax Mail Recipient City
30
Alpha
Required for fax.
1467
SPOD Fax Mail Recipient State
2
Alpha
Required for fax.
1468
SPOD Fax Mail Recipient Postal Code
9
Alpha
Required for fax.
1469
SPOD Fax Mail Recipient Country
2
Alpha/
Numeric
US or CA only.
1470
SPOD Fax Confirmation
20
Alpha/
Numeric
Returned upon successful fax request.
1471
SPOD Letter
Alpha/
Numeric
Encoded PNG returned upon successful letter Request.
1472
SPOD Ground Recipient Name
35
Alpha/
Numeric
Optional.
SPOD Ground Configurable Consignee Recipient Name.
1473
SPOD Ground Recipient Company Name
35
Alpha/
Numeric
Optional.
SPOD Ground Configurable Consignee Recipient Company.
1474
SPOD Ground Recipient Address Line 1
35
Alpha/
Numeric
Optional.
SPOD Ground Configurable Consignee Recipient Address line 1.
1475
SPOD Ground Recipient Address Line 2
35
Alpha/
Numeric
Optional.
SPOD Ground Configurable Consignee Recipient Address line2.
1476
SPOD Ground Recipient City
30
Alpha
Optional.
SPOD Ground Configurable Consignee Recipient City.
1477
SPOD Ground Recipient State/Province
2
Alpha
Optional.
SPOD Ground Configurable Consignee Recipient State Province.
1478
SPOD Ground Recipient Postal Code
9
Numeric
1479
SPOD Ground Recipient Country
2
Alpha
1480
More Information
30
Alpha/
Numeric
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Description
Optional.
SPOD Ground Configurable Consignee Recipient ZIP/postal.
Valid values:
• US
• CA
Optional.
SPOD Ground Configurable Consignee More Information.
240
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1485
Alternate Sender / Return Address
Contact Name
35
Alpha/
Numeric
Contact name for an Alternate Sender which prints on label in the "sender"
area.
1486
Alternate Sender / Return Address
Company Name
35
Alpha/
Numeric
Company Name for an Alternate Sender which prints on label in the "sender"
area.
1487
Alternate Sender / Return Address Line 1
35
Alpha/
Numeric
Address line 1 for an Alternate Sender which prints on label in the "sender"
area.
1488
Alternate Sender / Return Address Line 2
35
Alpha/
Numeric
Address line 2 for an Alternate Sender which prints on label in the "sender"
area.
1489
Alternate Sender / Return Address City
Name
FDXE-35
FDXG-20
Alpha
City name for an Alternate Sender which prints on label in the "sender" area.
1490
Alternate Sender / Return Address State
Code
2
Alpha
State code for an Alternate Sender which prints on label in the "sender" area.
1491
Alternate Sender / Return Address Postal
Code
16
Alpha/
Numeric
Postal code for an Alternate Sender which prints on label in the "sender" area.
Special characters allowed.
1492
Alternate Sender / Return Address Phone
Number
15
Alpha/
Numeric
Phone number for an Alternate Sender which prints on label in the "sender"
area.
1507
List Total Surcharge Amount
11.2
Numeric
Sum of total list surcharges
1525
Effective Net Discount
11.2
Numeric
Courtesy Effective Discount = List Net Charge - Courtesy Net Charge
Two implied decimal positions (e.g., "100" = $1.00)
(Only applicable if system is configured to use list rates.)
1528
List Net Charge Amount
11.2
Numeric
List net charge amount.
1529
Rate Indicator
1
Numeric
Valid values:
1 = Discount Rate
2 = List and discounted rates
If field tag 1529 is invalid or not present, discount FedEx Express rates and list
FedEx Ground rates (pre-October ’02 behavior) will be returned.
1530
List Base Rate Amount
11.2
Numeric
List base rate amount.
1531
List Total Discount Amount
11.2
Numeric
List total discount amount (will always be 0).
1532
List total Rebate Amount
11.2
Numeric
List total rebate amount (will always be 0).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
241
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
1
Alpha
Variable
Alpha/
Numeric
Indicator for availability of additional tracking data.
Field Description
1534
Detail Scan Indicator
1535
Paging Token
1536
Number of Relationships
3
Numeric
Number of relationships the "Search String" that was input into the Request
transaction participates in.
1537
Search / Relationship String
40
Alpha/
Numeric
The value to be tracked.
Possible values:
• Express MPS Master Tracking Number
• Express Customer Reference
• Ground PO
• Ground Customer Reference
• Ground Invoice
• Ground Shipment ID
1538
Search / Relationship Type Code
3
Alpha/
Numeric
Identifies all relationships that the corresponding tracking number participates
in. This field will correspond to the relationship string (field tag 1537).
Valid values:
0 or not present – defaults to Tracking Number/Door Tag
1 – Express MPS Master Number
2 – Express Track By Reference
3 – Ground Track By Reference – PO
4 – Ground Track By Reference – Customer Reference
5 – Ground Track By Reference – Invoice
7 – Ground Track By Reference – Shipment ID
10 – Return Materials Authorization
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
N or not present – defaults to Summary/Profile data, which includes one single
scan structure with the most recent scan.
Y – returns Detail Scan Activity (multiple scan structure) for each package.
Profile will return the last package status (most recent scan) and data
elements other than the detail scan activity.
242
Appendix A: Field Descriptions by Field Tag
Field
Tag
1551
Field Name
Delivery Notification Flag
Max Field
Length
Alphanumeric/
Numeric
1
Alpha
Field Description
Valid values:
N for No, do not send a notification of delivery
Y for Yes, send a notification of delivery
Defaults to N.
If = Y, corresponding email address in field tag 1204 will be emailed delivery
notification.
Maximum of three occurrences allowed.
Note: This field matches the sequence of the 420 Request Email Notification
Address (field tag 1204-#). It is possible that email and notify pair differ for
each email occurrence, and thus the applied notifications can change.
1552
Language Code
2
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Alpha
Determines language for email notifications.
Applies to all Email Notifications and corresponds to the occurrence of the
email address in field tag 1204.
Maximum of three occurrences allowed.
Must be in lower case.
Valid values:
da = Danish
de = German
en = English
es = Spanish
es with language locale code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
243
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1553
Shipper Delivery Notification Flag
1
Alpha
Required for Delivery Notification to the shipper.
Valid values:
N for No, do not send shipper a notification of delivery
Y for Yes, send shipper a notification of delivery
Defaults to N.
If = Y, Sender’s Email Address (field tag 1201) will be emailed Delivery
Notification email.
1554
Shipper ShipAlert Flag
1
Alpha
Required for ShipAlert Notification to the shipper.
Valid values:
N for No, do not send shipper a notification of shipment
Y for Yes, send shipper a notification of shipment
Defaults to N.
If = Y, Sender’s Email Address (field tag 1201) will be emailed ShipAlert email.
1555
Shipper Language Code
2
Alpha
Optional for Email Notification to shipper email address.
Valid values:
da = Danish
de = German
en = English
es = Spanish
es with language locale code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
Must be in lower case.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
244
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1556
Recipient Delivery Notification Flag
1
Alpha
Required for Delivery Notification to the recipient.
Valid values:
N for No, do not send recipient a notification of delivery
Y for Yes, send recipient a notification of delivery
Defaults to N.
If = Y, Recipient Email Address (field tag 1202), will be emailed Delivery
Notification email.
1557
Recipient ShipAlert Flag
1
Alpha
Required for ShipAlert Notification to the recipient.
Valid values:
N for No, do not send recipient a notification of shipment
Y for Yes, send recipient a notification of shipment
Defaults to N.
If = Y, Recipient’s Email Address (field tag 1202) will be emailed ShipAlert
email.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
245
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1558
Recipient Language Code
2
Alpha
Optional for Email Notification to recipient email address.
Valid values:
da = Danish
de = German
en = English
es = Spanish
es with language locale code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
Must be in lower case.
1559
Broker Delivery Notification Flag
1
Alpha
Required for Delivery Notification to the broker.
Valid values:
N for No, do not send broker a notification of delivery
Y for Yes, send broker a notification of delivery
Defaults to N.
If = Y, Broker Email Address (field tag 1343) will be email Delivery Notification
email.
1560
Broker ShipAlert Flag
1
Alpha
Required for Delivery Notification to the broker.
Valid values:
N for No, do not send broker a notification of shipment
Y for Yes, send broker a notification of shipment
Defaults to N.
If = Y, Broker Email Address (field tag 1343) will be emailed ShipAlert email.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
246
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1561
Broker Language Code
2
Alpha
Optional for Email Notification to broker email address.
Valid values:
da = Danish
de = German
en = English
es = Spanish
es with language locale code US = US Spanish
es with language locale code ES = Spain
fr = French
fr with language local code CA = Canadian French
it = Italian
ja = Kanji
ko = Korean
nl = Dutch
pt = Portuguese
sv = Swedish
zh with local code CN = Chinese Simple
zh with locale code HK = Chinese Traditional Hong Kong
zh with locale code TW = Chinese Traditional Taiwan
Defaults to en if no value entered.
Must be in lower case.
1562
FedEx Staffed Location Flag
1
Alpha
Valid values:
• N
• Y
1563
FedEx Self-Service Location Indicator
1
Alpha
Valid values:
• N
• Y
1564
FASC (FedEx Authorized Shipping
Center) Location Flag
1
Alpha
Valid values:
• N
• Y
1565
Latest Express Drop-off Flag
1
Alpha
Valid values:
• N
• Y
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
247
Appendix A: Field Descriptions by Field Tag
Max Field
Length
Alphanumeric/
Numeric
Field
Tag
Field Name
1566
Express Drop-off After Time
35
Alpha/
Numeric
Format: HH:MMPM/AM
1567
FedEx Location Intersection/Street
Address
35
Alpha/
Numeric
Free Form Field.
Can contain street address or intersection.
E.g., ‘5550 Main St.’ (street address)
‘Main and 22nd St.’ (intersection)
1568
Distance
15
Alpha/
Numeric
The distance from the search criteria to the FedEx location.
E.g., 40 miles, 12.5 miles
Free form field.
1569
Hours of Operation
Mon-Fri
35
Alpha/
Numeric
Free form field.
E.g., "9:00 AM – 6:45 PM"
1570
Hours of Operation Sat
35
Alpha/
Numeric
Free form field.
E.g., "Sat 9:00 AM – 6:45" or "No Sat Pickup"
1571
Last Express Drop-off Time Mon-Fri
35
Alpha/
Numeric
Free form field.
E.g., "5:00 PM"
1572
Last Express Drop-off Time Sat
35
Alpha/
Numeric
Free form field.
Format may be returned in HH:MM PM/AM
OR
Free form text "No Sat pickup"
1573
Express Service Flag
1
Alpha
1574
Location Count
2
Numeric
Number of locations returned.
Valid values: 1-10
1575
FedEx Location Business Name
35
Alpha/
Numeric
Free form text field.
Examples: "Kinko’s", "Business Edge", "The Mail Center", "Copymax",
"Postoffice", "FedEx World Service Center", "FedEx Drop Box", "Self Service
Location".
1576
FedEx Location Business Type
35
Alpha/
Numeric
Free form text field
Examples: "FedEx Authorized Ship Center", "Self-Service Location", "FedEx
Staffed".
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Description
Valid values:
• N
• Y
Y = Express Available
248
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1577
FedEx Location City
35
Alpha/
Numeric
1578
FedEx Location State
2
Alpha/
Numeric
1579
FedEx Location Postal Code
9
Alpha/
Numeric
1580
Dangerous Goods Flag
1
Alpha
Valid values:
• N
• Y
1581
Saturday Service Flag
1
Alpha
Valid values:
• N
• Y
1582
Begin Date
8
Numeric
Optional, but recommended.
Begin date of shipments being tracked.
If provided, End Date (field tag 1583) is required.
Required entry of date range to find desired results for reference tracking
number. If not provided, results may vary.
Format: YYYYMMDD
1583
End Date
8
Numeric
Optional, but recommended.
End date of shipments being tracked.
If provided, Begin Date (field tag 1582) is required.
Required entry of date range to find desired results for reference tracking
number. If not provided, results may vary.
Format: YYYYMMDD
1584
Tracking Groups
99
Numeric
Number of Tracking Groups.
1585
Alternate Sender / Return Address
Country Code
2
Alpha
Required if Alternate Sender / Return Address Flag = Y.
1586
Alternate Sender / Return Address Flag
1
Alpha
Valid values:
• N
• Y
If = Y Alternate Sender/Return Address prints on label in the "sender" area.
Defaults to N, sender address prints on label in the "sender" area.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
249
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1587
Alternate Sender / Return Address
Department
10
Alpha/
Numeric
Required if Alternate Sender / Return Address Flag = Y.
1588
Variable Handling Type
1
Alpha/
Numeric
Specifies what type of Variable Handling charges to assess and on which
amount.
Valid values:
0 – None (Default)
1 – add Fixed Amount to Net Freight Charges
2 – add variable % of Freight* Charges
3 – add variable % of Net Freight Charges
4** – add Variable % of Net Freight charges minus CA Taxes. (If 4 is
requested by a non-Canadian origin customer, it will behave like value 3.)
For FedEx Ground, it is the freight charge.
For FedEx Express, it is the freight charge minus any discounts.
**Net Freight = (freight – discount + surcharges + taxes) Taxes will be
included in the Net Charge where applicable for "CA" origin shipments.
1594
COD Report Buffer
Alpha/
Numeric
Ground COD Report Buffer.
Format: Base 64 encoded ASCII
1606
Variable Handling Charge Level
Alpha/
Numeric
Apply fixed or variable handling charges at package or shipment level.
0 or not present – per package (default)
1 – per shipment
***Value 1 is applicable only on last piece of FedEx Ground or FedEx Express
MPS shipment only.
1
Note: Value 1 = Shipment level affects the entire shipment. Anything else sent
in Child will be ignored.
1607
Doc Tab Header 1
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1608
Doc Tab Header 2
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1609
Doc Tab Header 3
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
250
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1610
Doc Tab Header 4
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1611
Doc Tab Header 5
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1612
Doc Tab Header 6
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1613
Doc Tab Header 7
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1614
Doc Tab Header 8
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1615
Doc Tab Header 9
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1616
Doc Tab Header 10
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1617
Doc Tab Header 11
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1618
Doc Tab Header 12
23
(Refer to
tag 2973)
Alpha/
Numeric
Free form text for doc-tab header on the shipping label.
1621
Customer Doc Tab Barcode
30
Alpha/
Numeric
Optional.
Required if field tag 2973 (DocTab Type Indicator) has a value of 2.
Maximum of 30 characters to be encoded as a bar code on the Doc Tab of
supported shipping labels.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
251
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1624
Doc Tab Field 1
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1625
Doc Tab Field 2
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1626
Doc Tab Field 3
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1627
Doc Tab Field 4
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1628
Doc Tab Field 5
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1629
Doc Tab Field 6
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1630
Doc Tab Field 7
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1631
Doc Tab Field 8
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1632
Doc Tab Field 9
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1633
Doc Tab Field 10
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
1634
Doc Tab Field 11
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
252
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
1635
Doc Tab Field 12
1636
Max Field
Length
Alphanumeric/
Numeric
Field Description
23
(Refer to
tag 2973)
Alpha/
Numeric
This field will contain the CTS tag number of the data field to be printed in the
designated doc-tab area on the shipping label.
Delivery Area Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1637
List Delivery Area Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1638
Fuel Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1639
List Fuel Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1640
FICE Surcharge
18.2
Numeric
FedEx International Controlled Export.
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1641
Return Label Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1642
Value Added Tax
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1643
List Return Label Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1644
Offshore Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1645
List Offshore Surcharge
18.2
Numeric
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1646
Saturday Pickup Allowed Flag
1
Alpha
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
If set = Y, this field indicates that the merchant has agreed to allow the return
shipment to be picked up on Saturday, and the merchant agrees to pay the
Saturday pickup surcharge.
If the return shipper generates the label on a Friday and this field = Y,
Saturday pickup is assumed and is the only option. If = N, pickup date is
assumed to be the next FedEx business day.
253
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1648
Europe First Surcharge
18.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
Applicable to FedEx Express only.
1649
Other Surcharges
18.2
Numeric
Accumulation of any FedEx Express surcharges that do not have a defined
field.
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1650
List Other Surcharges
18.2
Numeric
Accumulation of any FedEx Express surcharges that do not have a defined
field.
Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Express only.
1651
B13A Filing Option
1
Numeric
Required field for Canadian Export document and non-document shipments
destined to a country other than the U.S., Puerto Rico or the U.S. Virgin
Islands.
Valid values:
1 = No B13A Required
2 = Manual B13A Attached
3 = Filed Electronically
4 = Summary Reporting
1652
Export Statement Data
50
Alpha/
Numeric
This field is used to indicate Export required data for any country.
If B13A filing option = 2, this field should contain the B13A Transaction
Number.
If B13A filing option = 3, this field should contain the B13A Authorization Code
Number.
If B13A filing option = 4, this field should contain the B13A Summary ID
Number.
For B13A Transaction Number, must be exactly 21 alpha/numeric characters.
For Authorization Code Number, must be exactly 17 or 23 alpha/numeric
characters. The Authorization Code Number is comprised of the B13A
Authorization ID Number and the B13A Form ID Number.
For Summary Reporting Number, must be exactly 7 alphanumeric characters.
For Canada Export Declaration B13A, only alpha A-Z and numeric 0-9
characters are allowed.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
254
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1653
Export Permit Number
10
Alpha/
Numeric
Optional.
Applicable for any Canada export (international) document and non-document
shipments of any value to any destination: US, PR, US Virgin Islands or Rest
of World other than Canada.
No special characters allowed.
If B13A filing option = 1, this field should contain a valid B13A Exception
Number (2 AN).
1672
FedEx Tag Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1673
List FedEx Tag Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1682
Oversize Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1683
List Oversize surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g. 5.00). 14 total length including
decimal place.
1690
Saturday Delivery Allowed Flag
1
Alpha
If set = Y, this field indicates that the merchant has agreed to allow the return
shipment to be delivered back to him (or a repair/return center) on Saturday,
and the merchant agrees to pay the Saturday delivery surcharge.
If = Y and it is Friday when the return shipper generates their label, and
service type is overnight, Saturday Delivery will be assumed.
If it is Thursday when the return shipper generates their label, and the service
type is two day, then Saturday Delivery will be assumed.
1693
Packaging Supplies Flag
1
Alpha
Optional with sender country code set to US only.
Packaging Supplies must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
1694
Packaging Services Flag
ALL
USD
Optional with sender country code set to US only.
Packaging Services must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
255
Appendix A: Field Descriptions by Field Tag
Max Field
Length
Alphanumeric/
Numeric
FedEx Return System Flag
1
Alpha
Optional with sender country code set to US only.
Return Systems must be available at the location returned.
Valid values:
Y for Yes, set this criteria
N for No, don’t set this criteria
1696
Distance Unit Of Measure (UOM)
2
Alpha
Defines units of the Total Transit distance & Distance to Destination fields.
Valid values:
• MI
• KM
Defaults to MI if not populated.
1697
Maximum Location Count
2
Numeric
Optional.
Defaults to 10 if not specified.
This allows the user to specify the maximum number of locations to be
returned in the corresponding Reply transactions.
1698
Beginning Record Index
3
Numeric
Optional.
Defaults to 1 if not specified.
This allows the user to specify the beginning record # to be returned in a single
Reply transaction.
Valid values: 0 – 500
1699
Record Index
3
Numeric
This is the individual records identifier of the "Total locations available."
1700
Available Records Count
2
Numeric
The total number of locations that matched the input criteria.
1701
Status Description/Tracking Status
Description
25
Alpha/
Numeric
Status description pairs with field tag 1169.
1704
Service Type Description
70
Alpha
A description of what service was selected for the delivery of the package is
returned.
1705
Deliver To Description
25
Alpha
A description of where the package was delivered (Front Desk, Back Door,
etc.) is returned.
1706
Signed For
25
Alpha
If signature is required, the name of the person who signed for the package
will be returned
If signature is not required, the place the package was delivered (Front Desk,
Back Door, etc.) is returned.
1707
Delivery Time
6
Alpha
Time format: HHMMSS
Field
Tag
Field Name
1695
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Description
256
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1711
Status Exception Description
40
Alpha
1714
Duplicate Waybill Flag
1
Numeric
Y if duplicates exist that requires further request detail to qualify the specific
shipment.
1715
Number Of Track Activities
2
Numeric
The number of track activities included in the Reply to a track Request.
1716
Delivery Reattempt Date
8
Alpha/
Numeric
Format: YYYYMMDD
1717
Delivery Reattempt Time
6
Alpha/
Numeric
Format: HHMMSS
1718
Package Type Description
40
Alpha/
Numeric
Packaging type (e.g., Pak, Box, Tube, etc.).
1720
Delivery Date
8
Numeric
Format: YYYYMMDD
1721
thru
1735
Tracking Activity Line 1 thru Line 15
130
Alpha
1736
Estimated Pickup Date
8
Alpha/
Numeric
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Most recent scan description.
Format is as follows:
- Scan Type/Exception Description 40
- Filler 1
- Scan Type Code 2
- Filler 1
- Scan City 30
- Filler 1
- Scan State 2
- Filler 1
- Scan Country Code 2
- Filler 1
- Scan Date 8
- Filler 3
- Scan Time 4
- Filler 3
- Scan Cage Comment 30
- Filler 1
Total characters: 130
Format: YYYYMMDD
257
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
Format: HHMMSS
1737
Estimated Pickup Time
6
Alpha/
Numeric
1738
Origin Location City
40
Alpha/
Numeric
1739
Origin Location State
2
Alpha/
Numeric
1740
Origin Location Country
2
Alpha/
Numeric
1741
Destination Location City
40
Alpha/
Numeric
1742
Destination Location State
2
Alpha/
Numeric
1743
Destination Location Country
2
Alpha/
Numeric
1744
Total Transit Distance
Numeric
Returned in Miles only at this time.
1745
Distance to Destination
Numeric
Returned in Miles only at this time.
1746
Split Shipment Groups
Numeric
Contains number of Splits shipment repeating information groups (e.g., value
= 3 means to expect 3 iterations of the split shipment fields (excluding this
field).
1747
Split Shipment Pieces
Numeric
Number of pieces/skids traveling together.
1748
Split Shipment Date
8
Numeric
Format: YYYYMMDD
1749
Split Shipment Time
6
N
1750
Split Shipment Status Code
Numeric
The most recent status code for a specific split.
This field repeats for the number of iterations indicated in field tag 1746 (Split
Shipment Groups).
1751
Split Shipment Status Description
Numeric
The most recent status description for a specific split.
This field repeats for the number of iterations indicated in field tag 1746 (Split
Shipment Groups).
3
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Format: HHMMSS
258
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
1752
Tracking Number Unique ID
Max Field
Length
Alphanumeric/
Numeric
29
Numeric
Field Description
404:
Required if a previous Track By Number response indicated that duplicates
exist. The Previous response will return summary information about the
available choices along with this field.
If it is desired to fully track one of the items returned in the duplicate summary
reply, then the subsequent Track request must contain the Tracking Number
(search value) and the paired unmodified ID.
504:
Further identifies a Tracking Number in case Duplicates exist.
Returned if a Track By Number results in Duplicates.
Reply Fields are returned UTF-8 encoded to support multiple languages.
1754
Shipment Related Account Number
12
Alpha/
Numeric
Optional, but recommended.
Providing the Account Number will return all packages matching the search
value and associated with this account
If account Is not specified, then the Destination country and postal (applicable
countries) is required.
The Reply data may be restricted if account is not provided.
1755
Local Language Error Text
255
Alpha/
Numeric
This field will be returned with the error text in the language requested except
when English is selected (explicitly or by default).
See field tag 3.
Local Language Message Text
255
Alpha/
Numeric
This field will be returned with the message text in the language requested
except when English is selected (explicitly or by default).
See field tag 559.
1756-#
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
259
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
1958
Admissibility Package Type
Max Field
Length
3
Alphanumeric/
Numeric
Alpha/
Numeric
Field Description
Required if field tag 1273 (Packaging Type) is set to 01 – Other (Express) or
Customer (Ground) packaging. Applicable for all origins to Canada (excluding
Intra-Canada), CA to US, CA to PR, MX to US, and MX to PR.
Admissibility Package Types:
• BAG = bag
• PKG = package
• BBL = barrel
• PAL = pail
• BSK = basket or hamper
• PLT = pallet
• BOX = box
• PCL = parcel
• BXT = bucket
• PCS = pieces
• BDL = bundle
• REL = reel
• CAG = cage
• ROL = roll
• CTN = carton
• SAK = sack
• CAS = case
• SHW = shrink wrapped
• CHS = chest
• SKD = skid
• CNT = container
• TNK = tank
• CRT = crate
• TBN = tote bin
• CYL = cylinder
• TBE = tube
• DRM = drum
• UNT = unit
• ENV = envelope
• BOX = other packaging
1960
Exception Notification Flag
1
Alpha/
Numeric
Required for Exception Notification.
Exception notifications are not available after shipment delivery.
Exception Notifications include: General Delivery Exception, Incorrect
Address, Clearance Delay, and International Shipment Release.
Valid values: Y/N
Default = N
1961
Shipper Exception Notification Flag
1
Alpha/
Numeric
Required for Exception Notifications to the shipper.
If = Y, Sender’s Email Address (field tag 1201) will be emailed any Exception
emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
260
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1962
Recipient Exception Notification Flag
1
Alpha/
Numeric
Required for Exception Notifications to the recipient.
If = Y, Recipient's Email Address (field tag 1202) will be emailed any Exception
emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
1963
Broker Exception Notification Flag
1
Alpha/
Numeric
Required for Exception Notifications to the broker.
If = Y, Broker's Email Address (field tag 1343) will be emailed any Exception
emails.
Exception notifications include: general delivery exceptions, incorrect address,
clearance delay, international shipment release.
1964
Email Notification Format
1
Alpha
A unique format can be specified for each email address indicated.
The format will apply to all notification emails sent to a particular email
address.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Email Notification Address (field
tag 1204).
1965
Shipper Email Notification Format
1
Alpha
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Sender's Email Address (field tag
1201).
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
261
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1966
Broker Email Notification Format
1
Alpha
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Broker's Email Address (field tag
1343).
1967
Recipient Email Notification Format
1
Alpha
Optional.
Valid values:
H = HTML
T = Text
W = Wireless
Defaults to T (Text) if not specified.
Corresponds to all email notifications to the Recipient's Email Address (field
tag 1202).
1968
Language Locale Code
2
Alpha
Applicable if Language Code (field tag 1552-#) has a corresponding
occurrence and the language code requires a locale code.
If invalid combination of language/locale is input, an error will be returned.
Optional (for some languages).
Pairs with Language Code and may be required to obtain a specific dialect of
the language selected in field tag 1552.
Valid values:
ES pairs with language code es for Spain
CA pairs with language code fr for Canadian French
US pairs with language code es for U.S. Spanish
CN =Chinese Simple
HK =Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
262
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
1969
Shipper Locale Code
2
Alpha
Applicable if Language Code (field tag 1555) is populated and the language
code requires a locale code.
Valid values:
ES pairs with language code es for Spain
CA pairs with language code fr for Canadian French
US pairs with language code es for U.S. Spanish
CN =Chinese Simple
HK =Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
1970
Recipient Locale Code
2
Alpha
Applicable if Language Code (field tag 1558) is populated and the language
code requires a locale code.
Valid values:
ES pairs with language code es for Spain
CA pairs with language code fr for Canadian French
US pairs with language code es for U.S. Spanish
CN =Chinese Simple
HK =Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
1971
Broker Locale Code
2
Alpha
Applicable if Language Code (field tag 1561) is populated and the language
code requires a locale code.
Valid values:
ES pairs with language code es for Spain
CA pairs with language code fr for Canadian French
US pairs with language code es for U.S. Spanish
CN =Chinese Simple
HK =Chinese Traditional Hong Kong
TW = Chinese Traditional Taiwan
1972
Reply Language Code
2
Alpha/
Numeric
Optional.
Specifies the Transaction Reply language.
(Applies to any reply data that is available in local language and any error
message text.)
1973
Reply Language Locale Code
2
Alpha/
Numeric
Pairs with Reply Language Code (field tag 1972).
Required to obtain a specific dialect of the language selected in field tag 1972.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
263
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
1974
Service Commit Message
1975
Max Field
Length
Alphanumeric/
Numeric
Field Description
Variable
Alpha/
Numeric
Only applicable to H3 Express freight areas inbound to U.S. to FedEx location
only. Additional days may be required for final delivery. Please call Customer
Service for details.
Signature Proof of Delivery Available
1
Alpha/
Numeric
Y if Signed For signature image is available.
2208
Email Label User ID
10
Alpha/
Numeric
2210
RMA Number
20
Alpha/
Numeric
Optional.
Unique Identifier for the return order.
2254
Recipient Fax Number
15
Numeric
The recipient fax number for a specific shipment.
The maximum length is 10 for US and CA, 15 for all other countries.
2238
Delivery Commitment Date
8
Numeric
The date by which FedEx commits to deliver the shipment to the merchant if
the shipment is tendered to FedEx on the scheduled pickup date.
Format: YYYYMMDD
2239
Delivery Commitment Time
6
Numeric
The time by which FedEx commits to deliver the shipment to the merchant if
the shipment is tendered to FedEx on the scheduled pickup date.
Format: HHMMSS
2267
Cutoff Time
6
Numeric
Latest time a FedEx courier will be available to pick up the package from the
Sender.
Format: HHMMSS
FedEx cutoff times vary by postal code.
2268
Access Time
6
Numeric
Access times vary by postal code.
Format: HHMMSS
This is the minimum time window that must be allocated for the FedEx courier
to make the pickup. This is a length of time. The difference between the
Business Close Time (or the local "cutoff time" if it is earlier than the Business
Close Time) and the Package Ready Time must be equal to or exceed the
access time.
2269
Express Tag Availability Code
1
Numeric
Indicates the Express Tag Service availability at the sender postal code
indicated in the Request:
2 = FedEx Express Tag service next day available
3 = FedEx Express Tag service same day and Next Day available
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
264
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
2382
Return Shipment Indicator
1
Alpha/
Numeric
Indicates the type of return shipment.
Using field tag 2382 with FedEx Ground return shipments allows packages to
be shipped from anywhere to anywhere. If field tag 2382 is not used, the
system assumes that the package is coming from the account origin
destination and not any other location.
If field tag 2382 is not used with FedEx Ground return shipments, routing,
tracking, rating and service will be incorrect for these shipments.
Valid values for a Ship transaction:
0 or not present = Not a return shipment
2 = Return Shipment, Return Manager
Valid values for a Rate transaction:
2 = Print Return Label
3 = Email Label
4 = FedEx Tag (ExpressTag/CallTag – carrier code dependency)
2387
URL Expiration date
8
Numeric
Required.
Date entered can be current date through current date plus thirty calendar
days (inclusive) from the date the email label is requested.
Format: YYYYMMDD
2388
URL Email Message
200
Alpha/
Numeric
Optional.
Goes with field 2392.
Contains a customized message from the merchant to the return shipper.
2389
Merchant Contact Phone
10
Numeric
Required.
This phone number can differ from the merchant phone number for the
shipment. This phone number is specific to the email label and will be used in
case the return shipper needs to contact the merchant/recipient.
2390
Email Label surcharge
21
Numeric
The discounted surcharge amount output for email label rate quotes.
2391
*List Email Label Surcharge
21
Numeric
The list surcharge amount output for email label rate quotes.
2392
URL Email Address
120
Alpha/
Numeric
URL for each label.
Cannot contain single or double quotes
2393
Email Label URL
190
Alpha/
Numeric
URL for each label.
Cannot contain single or double quotes
2394
Email Label Request Date Time
15
Numeric
Date the Email Label was requested.
Format: YYYYMMDDTHHMMSS
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
265
Appendix A: Field Descriptions by Field Tag
Max Field
Length
Alphanumeric/
Numeric
Field
Tag
Field Name
2397
Purpose of Shipment Code
38
Alpha/
Numeric
Valid values:
01 – Sold
02 – Not Sold
03 – Gift
04 – Sample
05 – Repair and Return
06 – Personal Effects
2399
Signature Option
1
Alpha/
Numeric
Optional.
Valid values:
0 = Signature Service not selected or not applicable for shipment
1 = Deliver without Signature
2 = Indirect Signature
3 = Direct Signature
4 = Adult Signature
Field Description
For FedEx Express shipments, the "Deliver without signature" option will not
be allowed when the following special services are requested:
• Alcohol
• Hold at Location
• Dangerous Goods
• Declared Value greater than $500
Note:
• Alcohol shipments always require an Adult Signature and a surcharge is
applied. No other signature option is available for alcohol shipments.
• No signature option is available for Hold at Location shipments.
• COD, Dangerous Goods, FedEx Ground HazMat, FedEx Home Delivery
with Appointment Delivery and shipments with an insurance value greater
than $499 USD require a Direct Signature, and a surcharge is not applied.
Adult Signature is available as an upgrade for U.S. FedEx Ground and
FedEx Express shipments, and a surcharge is applied if Adult Signature is
selected. Indirect Signature and Deliver without Signature are not available
for these types of shipments.
• All other non-residential U.S. FedEx Express and FedEx Ground shipments
and all international shipments require an Indirect Signature. Direct
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
266
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
Signature and Adult Signature are available as an upgrade for U.S. FedEx
Express shipments. Direct Signature is available as an upgrade for U.S.
and international FedEx Ground shipments. A surcharge will be applied if
an upgrade is selected. Deliver without Signature is also available for U.S.
FedEx Express shipments only.
• All other residential U.S. FedEx Express and FedEx Ground shipments are
handled as Deliver without Signature. Indirect Signature, Direct Signature,
and Adult Signature are available as an upgrade for U.S. FedEx Express
shipments, and a surcharge will be applied if an upgrade is selected.
Indirect Signature and Direct Signature are available as an upgrade for U.S.
FedEx Ground shipments, and a surcharge will be applied if an upgrade is
selected.
• Direct Signature is the only signature option available for FedEx 1Day,
2Day and 3Day Freight Services (U.S. FedEx Express Freight services).
2402
Signature Option Fee
11.2
Numeric
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
2403
List Signature Option Fee
11.2
Numeric
Returned when field tag 2399 (Signature Option) has a value of 2, 3, or 4.
2405
MBG Ineligible
1
Alpha
2407
Recipient Location Number
10
Alpha/
Numeric
Recipient location number/store number.
This value in this field is embedded in the 2D barcode.
Valid characters: [A-Z ;a-z ;0-9]
Any character other than A-Z, a-z, 0-9 will be stripped.
If the length is greater than 10, characters beyond the 10th position will be
truncated.
FedEx Ground only.
2424
Recipient Tax ID Type
1
Alpha/
Numeric
Required for non-document shipments to Brazil. Optional for other
destinations.
Type of Brazil Tax ID supplied in tag 118 (Recipient SSN/EIN).
Valid values:
1 – Passport number
2 – Individual Tax ID
3 – Company Tax ID
2917
2D Barcode Data
300
Alpha/
Numeric
Required to indicate legacy ’96 FedEx Ground label.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Y if a shipment does not qualify for MBG (Money Back Guarantee).
267
Appendix A: Field Descriptions by Field Tag
Max Field
Length
Alphanumeric/
Numeric
Field
Tag
Field Name
2939
Return Reason Description
60
Alpha/
Numeric
Optional.
Reason for return.
Applicable only if RMA Number is provided. Will be ignored if RMA Number is
not provided.
2973
Doc Tab Type Indicator
1
Alpha/
Numeric
Valid values:
0 or not present – Ground Default Doc Tab
1 – Zone 001 Doc Tab Format
2 – Barcoded Doc Tab (Code 128)
Defaults to 0 (zero)
For the Zone 001 and the Ground Doc Tab Printing:
Header plus data combined can be up to 23 maximum length. If no header,
data can be 23. If no data, header can be 23.
The header will be truncated (down to a minimum of 4 characters not including
colon and space) as needed to accommodate printing the maximum
characters of the associated data field.
2975
Mask Account Number Flag
1
Alpha/
Numeric
Optional.
Valid values:
N – print the Account Number on label
Y – do not print the Account Number on label (default)
3000
COD Collection Type
2
Numeric
Valid values:
1 = Any payment type
2 = Guaranteed funds
3 = Currency
For FedEx Express shipments, a value of 2 = secured.
All other values = non-secured.
Cash is only applicable with FedEx Ground.
3001
FedEx Purchase Order
30
Alpha
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Field Description
Optional.
If passed in the transaction,
• Purchase Order can later be used to track by reference for FedEx Ground
ONLY.
• Displays on the thermal label for Express.
268
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
3002
FedEx Invoice
30
Alpha
Optional.
If passed in the transaction,
• Invoice Number can later be used to track by reference for FedEx Ground
ONLY.
• Displays on the thermal label for Express.
3014
Report Indicator
1
Alpha
Valid values:
1 = Ground Manifest report
2 = Ground HazMat report
3 = Ground COD report
3015
Hazardous Materials Flag
1
Alpha
Y if shipment contains hazardous materials.
Not allowed if Return Shipment Indicator = 1, 2, 3, or 4.
3018
Nonstandard Container Flag
1
Alpha
Y if nonstandard container.
3020
FedEx Home Delivery Type
1
Alpha
Valid values:
1 = Date Certain
2 = Evening
3 = Appointment
3021
FedEx Home Delivery Instructions
74
Alpha
Specific Instructions for the delivery of package.
3023
FedEx Home Delivery Date
8
Numeric
3024
FedEx Home Delivery Phone Number
15
Alpha
The maximum length is 10 for US and CA, 15 for all other countries.
3025
Carrier Code
4
Alpha
Valid carriers codes/names:
FDXG – FedEx Ground
FDXE – FedEx Express
FDXC – FedEx Cargo
FXCC - FedEx Custom Critical
FXFR – FedEx Freight
3043
Multiweight Variable Handling
9
Numeric
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Date format: YYYYMMDD
Explicit. Format: 9999999.99 explicit decimal. 9 total length.
Handling charge returned to the customer calculated with multiweight freight.
269
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
3045
COD Return Reference Indicator
1
Alpha
Indicator for what FedEx Ground COD Reference should print on the label.
0 or not present = GSE defaults to Tracking Number
1 = Reference
2 = PO#
3 = Invoice#
3048
Multiweight Report Content Buffer
Base 64
encoded
binary
Alpha/
Numeric
This buffer will contain the Multiweight report for FedEx Ground Shipments.
Data/Manifest format: ASCII
3053
Multiweight Net Charge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3054
Shipment Net Charge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3058
Time in Transit
1
Alpha/
Numeric
The number of days a FedEx Ground or FedEx Home Delivery package will
spend in transit from a given origin ZIP to a given Destination ZIP.
Valid values:
1 = one day
2 = two days
3 = three days, etc.
3066
Hazardous Materials – DOT Shipping
Name of Material
50
Alpha/
Numeric
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3067
D.O.T. Hazard class. OR Division
Number
25
Alpha/
Numeric
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3068
Hazardous Materials – DOT ID Number
11
Alpha/
Numeric
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3069
Hazardous Materials – Packing Group
3
Alpha
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
Valid values:
• i
• ii
• iii
3072
Hazardous Materials Type DOT Labels
50
Alpha/
Numeric
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Optional.
Type DOT Label(s) Required, Label(s) Required, Ltd., Qty., or Exemption
Number.
(Can have blank or incorrect value.)
270
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
3075
Hazardous Materials – Emergency
Contact Phone Number
15
Numeric
Required if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3085
Hazardous Materials – DOT Shipping
Name of Material
50
Alpha/
Numeric
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3086
Hazardous Materials – DOT Shipping
Name of Material
50
Alpha/
Numeric
Required for OP-950.
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3087
Hazardous Materials – Emergency
Contact Name
50
Numeric
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3088
Hazardous Materials Quantity
6.2
Numeric
Optional if Hazardous Materials Flag is Y. (Can have blank or incorrect value.)
3089
Hazardous Materials Unit of Measure
4
Alpha
3090
Last Ground Drop-off Time Mon-Fri
35
Alpha/
Numeric
Free form text field.
E.g., "M-F 5:00 PM" or "N/A"
3091
Last Ground Drop-off Time Sat
35
Alpha/
Numeric
Free form text field.
E.g., "Sat 3:00 PM" "N/A" "No Sat pickup"
3092
Ground Service Flag
1
Alpha/
Numeric
Valid values:
• N
• Y
Y = Ground Available
3095
Appointment Delivery Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3096
List Appointment Delivery Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Required for OP-950.
Optional if Hazardous Materials Flag is Y.
Valid values:
• oz
• gal
• lb
• L
• g
• qt
• kg
• pt
271
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
3101
Home Delivery Date Certain Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3102
List Home Delivery Date Certain
Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3103
Home Delivery Evening Delivery
Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3104
List Home Delivery Evening Delivery
Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3107
Additional Handling Charge (AHS) / Non
Standard Container Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3108
List Additional Handling Charge (AHS) /
Non Standard Container Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3109
Hazardous Materials Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3110
List Hazardous Materials Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3111
Residential Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3112
List Residential Surcharge
11.2
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
3113
MTW Customer Total Charge
18.2
Numeric
Shipper’s Freight charge plus Multiweight Variable Handling Charge Amount.
Format: Two explicit decimal positions (e.g. 5.00). 21 total length including
decimal.
3114
Hazardous Materials Report Buffer
Alpha/
Numeric
Contains the Hazardous Materials certification report.
Format: Base 64 encoded ASCII
3115
List Shipment Net Charge
Numeric
Format: Two explicit decimal positions (e.g., 5.00).
Applicable to FedEx Ground only.
11.2
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
272
Appendix A: Field Descriptions by Field Tag
Field
Tag
Field Name
Max Field
Length
Alphanumeric/
Numeric
Field Description
3124
Oversize Classification
1
Alpha
3231
Residential Pickup Flag
1
Alpha/
Numeric
4003
Subscriber Contact Name
35
Alpha
Name of the person subscribing for services.
4007
Subscriber Company Name
35
Alpha
Name of the company subscribing for the services.
4008
Subscriber Address Line 1
35
Alpha
Primary address line of the person subscribing for services.
4009
Subscriber Address Line 2
35
Alpha
Secondary address line of the person subscribing for services.
4011
Subscriber City Name
35
Alpha
City name of the person receiving the shipment.
4012
Subscriber State Code
14
Alpha
State code of the subscriber's location. The maximum field length for US and
CA is 2, 14 for all other countries.
4013
Subscriber Postal Code
16
Alpha
Postal code of the subscriber's location. Must be numeric for U.S. Special
characters allowed.
4014
Subscriber Country Code
2
Alpha
Country code of the subscriber's location.
4015
Subscriber Phone Number
15
Alpha
Phone number of the person subscribing for services. The maximum length is
10 for US and CA, 15 for all other countries.
4017
Subscriber Pager Number
15
Alpha
Pager number of the person subscribing for services. The maximum length is
10 for US and CA, 15 for all other countries.
4018
Subscriber Email Address
120
Alpha
Email address of the person subscribing for services.
4021
Subscription Service Name
21
Alpha
Valid values:
• FedEx Express Shipping
• FedEx Ground Shipping
4022
Subscriber Fax Number
15
Alpha
Fax number of the person subscribing for services. The maximum length is 10
for US and CA, 15 for all other countries.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
Classifications of Oversize shipment:
1 = Oversize 1
2 = Oversize 2
3 = Oversize 3
Optional.
Y = Residential
N = Commercial/Business
Indicates the type of pickup location for a FedEx Ground Email Label and/or
FedEx Ground Call Tag.
(Only applicable if field tag 2382 = 3 or 4.)
273
Appendix B: Country Codes
Appendix B: Country Codes
Country
Code
Ship
to:
Country
Code
Ship
to:
Country
Code
Ship
to:
Afghanistan
AF
Y
Bermuda
BM
Y
China
CN
Y
Albania
AL
Y
Bhutan
BT
Y
Christmas Island
CX
N
Algeria
DZ
N
Bolivia
BO
Y
Cocos (Keeling) Islands
CC
N
American Samoa
AS
Y
Bonaire
AN
Y
Colombia
CO
Y
Andorra
AD
Y
Bosnia-Herzegovina
BA
Y
Comoros
KM
N
Angola
AO
Y
Botswana
BW
Y
Congo
CG
Y
Anguilla
AI
Y
Bouvet Island
BV
N
Congo Dem. Rep. Of
CD
Y
Antarctica
AQ
N
Brazil
BR
Y
Cook Islands
CK
Y
Antigua
AG
Y
British Indian Ocean Territory
IO
N
Costa Rica
CR
Y
Argentina
AR
Y
British Virgin Islands
VG
Y
Croatia
HR
Y
Armenia
AM
Y
Brunei
BN
Y
Cuba
CU
N
Aruba
AW
Y
Bulgaria
BG
Y
Curacao
AN
Y
Australia
AU
Y
Burkina Faso
BF
Y
Cyprus
CY
Y
Austria
AT
Y
Burundi
BI
Y
Czech Republic
CZ
Y
Azerbaijan
AZ
Y
Cambodia
KH
Y
Denmark
DK
Y
Bahamas
BS
Y
Cameroon
CM
Y
Djibouti
DJ
Y
Bahrain
BH
Y
Canada
CA
Y
Dominica
DM
Y
Bangladesh
BD
Y
Canary Islands
ES
Y
Dominican Republic
DO
Y
Barbados
BB
Y
Cape Verde
CV
Y
East Timor
TL
Y
Barbuda
AG
Y
Cayman Islands
KY
Y
Ecuador
EC
Y
Belarus
BY
Y
Central African Republic
CF
N
Egypt
EG
Y
Belgium
BE
Y
Chad
TD
Y
El Salvador
SV
Y
Belize
BZ
Y
Channel Islands
GB
Y
England
GB
Y
Benin
BJ
Y
Chile
CL
Y
Equatorial Guinea
GQ
Y
Eritrea
ER
Y
Guyana
GY
Y
Liberia
LR
Y
Estonia
EE
Y
Haiti
HT
Y
Libya
LY
N
Ethiopia
ET
Y
Heard & McDonald Islands
HM
N
Liechtenstein
LI
Y
Faeroe Islands
FO
Y
Holland
NL
Y
Lithuania
LT
Y
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
274
Appendix B: Country Codes
Country
Code
Ship
to:
Country
Code
Ship
to:
Country
Code
Ship
to:
Falkland Islands
FK
N
Honduras
HN
Y
Luxembourg
LU
Y
Fiji
FJ
Y
Hong Kong
HK
Y
Macau
MO
Y
Finland
FI
Y
Hungary
HU
Y
Macedonia
MK
Y
France
FR
Y
Iceland
IS
Y
Madagascar
MG
Y
French Guiana
GF
Y
India
IN
Y
Malawi
MW
Y
French Polynesia
PF
Y
Indonesia
ID
Y
Malaysia
MY
Y
French Southern Territories
TF
N
Iran
IR
N
Maldives
MV
Y
Gabon
GA
Y
Iraq
IQ
Y
Mali
ML
Y
Gambia
GM
Y
Ireland
IE
Y
Malta
MT
Y
Georgia
GE
Y
Israel
IL
Y
Marshall Islands
MH
Y
Germany
DE
Y
Italy
IT
Y
Martinique
MQ
Y
Ghana
GH
Y
Ivory Coast
CI
Y
Mauritania
MR
Y
Gibraltar
GI
Y
Jamaica
JM
Y
Mauritius
MU
Y
Grand Cayman
KY
Y
Japan
JP
Y
Mayotte
YT
N
Great Britain
GB
Y
Jordan
JO
Y
Mexico
MX
Y
Great Thatch Island
VG
Y
Jost Van Dyke Islands
VG
Y
Micronesia
FM
Y
Great Tobago Islands
VG
Y
Kazakhstan
KZ
Y
Moldova
MD
Y
Greece
GR
Y
Kenya
KE
Y
Monaco
MC
Y
Greenland
GL
Y
Kiribati
KI
N
Mongolia
MN
Y
Grenada
GD
Y
Kuwait
KW
Y
Montserrat
MS
Y
Guadeloupe
GP
Y
Kyrgyzstan
KG
Y
Morocco
MA
Y
Guam
GU
Y
Laos
LA
Y
Mozambique
MZ
Y
Guatemala
GT
Y
Latvia
LV
Y
Myanmar / Burma
MM
N
Guinea
GN
Y
Lebanon
LB
Y
Namibia
NA
Y
Guinea Bissau
GW
N
Lesotho
LS
Y
Nauru
NR
N
Nepal
NP
Y
Qatar
QA
Y
St. Christopher
KN
Y
Netherlands
NL
Y
Reunion
RE
Y
St. Croix Island
VI
Y
Netherlands Antilles
AN
Y
Romania
RO
Y
St. Eustatius
AN
Y
New Caledonia
NC
Y
Rota
MP
Y
St. Helena
SH
N
New Zealand
NZ
Y
Russia
RU
Y
St. John
VI
Y
Nicaragua
NI
Y
Rwanda
RW
Y
St. Kitts and Nevis
KN
Y
Niger
NE
Y
Saba
AN
Y
St. Lucia
LC
Y
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
275
Appendix B: Country Codes
Country
Code
Ship
to:
Country
Code
Ship
to:
Country
Code
Ship
to:
Nigeria
NG
Y
Saipan
MP
Y
St. Maarten
AN
Y
Niue
NU
N
Samoa
WS
Y
St. Pierre
PM
N
Norfolk Island
NF
N
San Marino
IT
Y
St. Thomas
VI
Y
Norman Island
VG
Y
Sao Tome & Principe
ST
N
St. Vincent
VC
Y
North Korea
KP
N
Saudi Arabia
SA
Y
Sudan
SD
N
Northern Ireland
GB
Y
Scotland
GB
Y
Suriname
SR
Y
Northern Mariana Islands
MP
Y
Senegal
SN
Y
Svalbard & Jan Mayen Is
SJ
N
Norway
NO
Y
Serbia & Montenegro
CS
Y
Swaziland
SZ
Y
Oman
OM
Y
Seychelles
SC
Y
Sweden
SE
Y
Pakistan
PK
Y
Sierra Leone
SL
N
Switzerland
CH
Y
Palau
PW
Y
Singapore
SG
Y
Syria
SY
N
Palestine
PS
Y
Slovak Republic
SK
Y
Tahiti
PF
Y
Panama
PA
Y
Slovenia
SI
Y
Taiwan
TW
Y
Papua New Guinea
PG
Y
Solomon Islands
SB
N
Tajikistan
TJ
N
Paraguay
PY
Y
Somalia
SO
N
Tanzania
TZ
Y
Peru
PE
Y
South Africa
ZA
Y
Thailand
TH
Y
Philippines
PH
Y
South Georgia & South Sandwich Is
GS
N
Tinian
MP
Y
Pitcairn
PN
N
South Korea
KR
Y
Togo
TG
Y
Poland
PL
Y
Spain
ES
Y
Tokelau
TK
N
Portugal
PT
Y
Sri Lanka
LK
Y
Tonga
TO
Y
Puerto Rico
PR
Y
St. Barthelemy
GP
Y
Tortola Island
VG
Y
Trinidad & Tobago
TT
Y
Ukraine
UA
Y
Venezuela
VE
Y
Tunisia
TN
Y
Union Island
VC
Y
Vietnam
VN
Y
Turkey
TR
Y
United Arab Emirates
AE
Y
Wales
GB
Y
Turkmenistan
TM
Y
United Kingdom
GB
Y
Wallis & Futuna Islands
WF
Y
Turks & Caicos Islands
TC
Y
United States
US
Y
Western Sahara
EH
N
Tuvalu
TV
N
Uruguay
UY
Y
Yemen
YE
Y
U.S. Minor Outlying Islands
UM
N
Uzbekistan
UZ
Y
Zambia
ZM
Y
U.S. Virgin Islands
VI
Y
Vanuatu
VU
Y
Zimbabwe
ZW
Y
Uganda
UG
Y
Vatican City
IT
Y
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
276
Appendix C: Vague Commodity Descriptions
Appendix C: Vague Commodity Descriptions
The following table is a list of commodity descriptions considered vague by U.S. Customs:
Vague Commodity
Vague Commodity Description
"A/C Parts"
"A/C Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Break Caliper for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"AC Parts"
"AC Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Break Caliper for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Accessories"
"Accessories" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Advertising Material"
"Advertising Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic
Advertising Signs." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft Parts"
"Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft Spare Parts"
"Aircraft Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake
Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Aircraft spares"
"Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Antibodies"
"Antibodies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibodies."
Clearance delays may result if the contents are not completely and accurately described.
"Antibody"
"Antibody" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibody."
Clearance delays may result if the contents are not completely and accurately described.
"Apparel"
"Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirt."
Clearance delays may result if the contents are not completely and accurately described.
"Appliance"
"Appliance" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial
Dishwasher." Clearance delays may result if the contents are not completely and accurately described.
"Appliances"
"Appliances" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial
Dishwasher." Clearance delays may result if the contents are not completely and accurately described.
"Art"
"Art" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Water Color Painting."
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
277
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"As Per Attached INV"
"As Per Attached INV" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Assorted Merchandise"
"Assorted Merchandise" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Auto Part"
"Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts:
Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Auto Parts"
"Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts:
Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Automotive Parts"
"Automotive Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto
Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Autoparts"
"Autoparts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts:
Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described.
"Bag"
"Bag" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance
delays may result if the contents are not completely and accurately described.
"Battery"
"Battery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Car Battery." Clearance
delays may result if the contents are not completely and accurately described.
"Bearing"
"Bearing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ball Bearing."
Clearance delays may result if the contents are not completely and accurately described.
"Belts"
"Belts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts." Clearance
delays may result if the contents are not completely and accurately described.
"Box"
"Box" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance
delays may result if the contents are not completely and accurately described.
"Brake Parts"
"Brake Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper."
Clearance delays may result if the contents are not completely and accurately described.
"Brake"
"Brake" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Automobile Brake."
Clearance delays may result if the contents are not completely and accurately described.
"Business Correspondence"
"Business Correspondence" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Legal Contract." Clearance delays may result if the contents are not completely and accurately described.
"Cable"
"Cable" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Cable."
Clearance delays may result if the contents are not completely and accurately described.
"Cap"
"Cap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps." Clearance
delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
278
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Caps"
"Caps" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps."
Clearance delays may result if the contents are not completely and accurately described.
"Carton"
"Carton" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"CD"
"CD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CD." Clearance
delays may result if the contents are not completely and accurately described.
"CDs"
"CDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CDs."
Clearance delays may result if the contents are not completely and accurately described.
"Cell Line"
"Cell Line" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its
origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Cells"
"Cells" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its
origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Chemical"
"Chemical" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #.
Clearance delays may result if the contents are not completely and accurately described.
"Chemicals"
"Chemicals" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #.
Clearance delays may result if the contents are not completely and accurately described.
"Chip"
"Chip" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Integrated
Circuit." Clearance delays may result if the contents are not completely and accurately described.
"Christmas Gifts"
"Christmas Gift" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"CI Attached"
"CI Attached" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Civil Aircraft Parts"
"Civil Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper
for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Civil Aircraft Spares"
"Civil Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake
Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Clothes / Textiles"
"Clothes / Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Tshirts." Clearance delays may result if the contents are not completely and accurately described.
"Clothes"
"Clothes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts."
Clearance delays may result if the contents are not completely and accurately described.
"Clothing and Accessories"
"Clothing and Accessories" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's
T-shirts." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
279
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Clothing"
"Clothing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts."
Clearance delays may result if the contents are not completely and accurately described.
"Comat"
"Comat" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence."
Clearance delays may result if the contents are not completely and accurately described.
"Commercial Invoice"
"Commercial Invoice" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Components"
"Components" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Computer Parts"
"Computer Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling
Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Computer Peripherals"
"Computer Peripherals" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer
CD Players." Clearance delays may result if the contents are not completely and accurately described.
"Connector"
"Connector" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Cosmetic Products"
"Cosmetic Products" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's
Fragrance." Clearance delays may result if the contents are not completely and accurately described.
"Cosmetics"
"Cosmetics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's
Fragrance." Clearance delays may result if the contents are not completely and accurately described.
"Culture"
"Culture" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its
origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Dangerous Good"
"Dangerous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and
the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Dangerous Goods"
"Dangerous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and
the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Data Processing Part"
"Data Processing Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC
Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Data Processing Parts"
"Data Processing Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC
Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described.
"Defective Goods"
"Defective Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"DESC N"
"DESC N" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
280
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"DESCRI"
"DESCRI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"DG"
"DG" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN
HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"DGs"
"DGs" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN
HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Disk"
"Disk" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence
on a Floppy Disk." Clearance delays may result if the contents are not completely and accurately described.
"Disks"
"Disks" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business
Correspondence on Floppy Disks." Clearance delays may result if the contents are not completely and accurately described.
"Display"
"Display" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Liquid Crystal Display
(LCD) - Desktop Projector ." Clearance delays may result if the contents are not completely and accurately described.
"DNA"
"DNA" is an incomplete description and not accepted by Customs. Please specify the name of the material, reason for import and its
origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described.
"Doc"
"Doc" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence."
Clearance delays may result if the contents are not completely and accurately described.
"Document"
"Document" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate."
Clearance delays may result if the contents are not completely and accurately described.
"Documentation"
"Documentation" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office
Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Documents"
"Documents" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate."
Clearance delays may result if the contents are not completely and accurately described.
"Drug"
"Drug" is an incomplete description and not accepted by Customs. Please specify the name of the medication or product being shipped
and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Drugs"
"Drugs" is an incomplete description and not accepted by Customs. Please specify the name of the medication or product being shipped
and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Dry Ice"
"Dry Ice" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Pork Ribs in Dry Ice."
Clearance delays may result if the contents are not completely and accurately described.
"DVD"
"DVD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance
delays may result if the contents are not completely and accurately described.
"DVDs"
"DVDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Movies." Clearance
delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
281
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Electrical Parts"
"Electrical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor."
Clearance delays may result if the contents are not completely and accurately described.
"Electronic Component"
"Electronic Component" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Transistor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Components"
"Electronic Components" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Capacitor." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Equipment"
"Electronic Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD
Player." Clearance delays may result if the contents are not completely and accurately described.
"Electronic Good"
"Electronic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players."
Clearance delays may result if the contents are not completely and accurately described.
"Electronic Goods"
"Electronic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players."
Clearance delays may result if the contents are not completely and accurately described.
"Electronic Part"
"Electronic Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor."
Clearance delays may result if the contents are not completely and accurately described.
"Electronic Parts"
"Electronic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistors."
Clearance delays may result if the contents are not completely and accurately described.
"Electronic"
"Electronic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player."
Clearance delays may result if the contents are not completely and accurately described.
"Electronics"
"Electronics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player."
Clearance delays may result if the contents are not completely and accurately described.
"Equipment"
"Equipment" is an incomplete description and not accepted by Customs. Specific Description of the Type of equipment and its intended
use is required. Clearance delays may result if the contents are not completely and accurately described.
"Fabric Samples"
"Fabric Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric
for Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"Fabric"
"Fabric" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for
Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"Fabrics"
"Fabrics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for
Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described.
"FAC "
"FAC " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"FAK "
"FAK " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
282
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Flooring"
"Flooring" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles."
Clearance delays may result if the contents are not completely and accurately described.
"Food Items"
"Food Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Canned Pasta."
Clearance delays may result if the contents are not completely and accurately described.
"Food"
"Food" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Homemade Cookies."
Clearance delays may result if the contents are not completely and accurately described.
"Foodstuff"
"Foodstuff" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars."
Clearance delays may result if the contents are not completely and accurately described.
"Foodstuffs"
"Foodstuffs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars."
Clearance delays may result if the contents are not completely and accurately described.
"Freight Of All Kinds"
"Freight Of All Kinds" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"General Cargo"
"General Cargo" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Gift"
"Gift" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Book sent as a Christmas
Gift." Clearance delays may result if the contents are not completely and accurately described.
"Gifts"
"Gifts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Books sent as a Christmas
Gift." Clearance delays may result if the contents are not completely and accurately described.
"Goods"
"Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Effects."
Clearance delays may result if the contents are not completely and accurately described.
"Hardware"
"Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "CD Player."
Clearance delays may result if the contents are not completely and accurately described.
"Haz Mat"
"Haz Mat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN
HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Haz Material"
"Haz Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the
UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Haz Materials"
"Haz Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the
UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Chemical"
"Hazardous Chemical" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or
product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Chemicals"
"Hazardous Chemicals" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or
product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
283
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Hazardous Good"
"Hazardous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and
the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Goods"
"Hazardous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and
the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Material"
"Hazardous Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and
the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Hazardous Materials"
"Hazardous Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name
and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"HazMat"
"HazMat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN
HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Household Goods"
"Household Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"HS #"
"HS #" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the
description of the product. Clearance delays may result if the contents are not completely and accurately described.
"HS NON"
"HS NON" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the
description of the product. Clearance delays may result if the contents are not completely and accurately described.
"HS#"
"HS#" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the
description of the product. Clearance delays may result if the contents are not completely and accurately described.
"I C"
"I C" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"IC"
"IC" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"ILLEDG"
"ILLEDG" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Illegible"
"Illegible" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Implants"
"Implants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Dental Implants."
Clearance delays may result if the contents are not completely and accurately described.
"Industrial Goods"
"Industrial Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Integrated Circuit"
"Integrated Circuit" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated
Circuit - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
284
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Integrated Circuits"
"Integrated Circuits" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated
Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described.
"Iron"
"Iron" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steam Iron." Clearance
delays may result if the contents are not completely and accurately described.
"Items"
"Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Jeans"
"Jeans" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ladies Denim Jeans."
Clearance delays may result if the contents are not completely and accurately described.
"Jewelry"
"Jewelry" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold
Necklace." Clearance delays may result if the contents are not completely and accurately described.
"Laboratory Reagents"
"Laboratory Reagents" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name
and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Ladies Apparel"
"Ladies Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's leather
shoes." Clearance delays may result if the contents are not completely and accurately described.
"Leather Article"
"Leather Article" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse."
Clearance delays may result if the contents are not completely and accurately described.
"Leather Articles"
"Leather Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse."
Clearance delays may result if the contents are not completely and accurately described.
"Leather"
"Leather" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts."
Clearance delays may result if the contents are not completely and accurately described.
"Letter"
"Letter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal
Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Liquid"
"Liquid" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN
HAZMAT #. Clearance delays may result if the contents are not completely and accurately described.
"Luggage"
"Luggage" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Machine Part"
"Machine Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured
Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described.
"Machine Parts"
"Machine Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured
Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described.
"Machinery"
"Machinery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting
Machine." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
285
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Machines"
"Machines" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting
Machine." Clearance delays may result if the contents are not completely and accurately described.
"Medical Equipment"
"Medical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Defibrillator." Clearance delays may result if the contents are not completely and accurately described.
"Medical Parts"
"Medical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric Wire for
Medical Equipment." Clearance delays may result if the contents are not completely and accurately described.
"Medical Spare Parts"
"Medical Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric
Wire for Medical Equipment." Clearance delays may result if the contents are not completely and accurately described.
"Medical Supplies"
"Medical Supplies" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or
product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicaments"
"Medicaments" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product
being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medication"
"Medication" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product
being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medications"
"Medications" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product
being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicine"
"Medicine" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product
being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Medicines"
"Medicines" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product
being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Meds"
"Meds" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being
shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"Men’s Apparel"
"Men’s Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Summer
T-Shirt." Clearance delays may result if the contents are not completely and accurately described.
"Metal Work"
"Metal Work" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Pipe."
Clearance delays may result if the contents are not completely and accurately described.
"Miscellaneous Items"
"Miscellaneous Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"NAFTA"
"NAFTA" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"New Goods"
"New Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
286
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"No CI"
"No CI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"NO COM"
"NO COM" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"NO DES"
"NO DES" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"NON G"
"NON G" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Non-Hazardous"
"Non-Hazardous" is an incomplete description and not accepted by Customs. Please provide the proper name of the goods, if chemical,
proper name and the UN #. Clearance delays may result if the contents are not completely and accurately described.
"NOT GI"
"NOT GI" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Packaging Supplies"
"Packaging Supplies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Bubble
Plastic Wrap." Clearance delays may result if the contents are not completely and accurately described.
"Pants"
"Pants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Boy's Cotton Twill Pants."
Clearance delays may result if the contents are not completely and accurately described.
"Paper"
"Paper" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract."
Clearance delays may result if the contents are not completely and accurately described.
"Paperwork"
"Paperwork" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract."
Clearance delays may result if the contents are not completely and accurately described.
"Part"
"Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft."
Clearance delays may result if the contents are not completely and accurately described.
"Parts Of"
"Parts Of" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"Parts"
"Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for
Aircraft." Clearance delays may result if the contents are not completely and accurately described.
"PC Hardware"
"PC Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer CD
Player." Clearance delays may result if the contents are not completely and accurately described.
"PCB"
"PCB" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board with
Components for Television Set." Clearance delays may result if the contents are not completely and accurately described.
"PCBA"
"PCBA" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board
Assembly for Computer." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
287
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Peripheral"
"Peripheral" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Printer."
Clearance delays may result if the contents are not completely and accurately described.
"Personal Effects"
"Personal Effects" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Personal Item"
"Personal Item" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Personal Items"
"Personal Items" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Pharmaceuticals"
"Pharmaceuticals" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or
product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described.
"PIB"
"PIB" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance
delays may result if the contents are not completely and accurately described.
"PIBs"
"PIBs" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped. Clearance
delays may result if the contents are not completely and accurately described.
"Pipe"
"Pipe" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipe." Clearance
delays may result if the contents are not completely and accurately described.
"Pipes"
"Pipes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipes." Clearance
delays may result if the contents are not completely and accurately described.
"Plastic Good"
"Plastic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knive."
Clearance delays may result if the contents are not completely and accurately described.
"Plastic Goods"
"Plastic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives."
Clearance delays may result if the contents are not completely and accurately described.
"Plastic Parts"
"Plastic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives."
Clearance delays may result if the contents are not completely and accurately described.
"Plastic"
"Plastic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Plastic Shoes."
Clearance delays may result if the contents are not completely and accurately described.
"Polyurethane"
"Polyurethane" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Polyurethane
Medical Gloves." Clearance delays may result if the contents are not completely and accurately described.
"Power Supply"
"Power Supply" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Supply
Module for ADP Machines." Clearance delays may result if the contents are not completely and accurately described.
"Precious Metal"
"Precious Metal" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold
Necklace." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
288
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Printed Circuit Board"
"Printed Circuit Board" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed
Circuit Board with Components for Television Set." Clearance delays may result if the contents are not completely and accurately
described.
"Printed Material"
"Printed Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's
Manual." Clearance delays may result if the contents are not completely and accurately described.
"Printed Materials"
"Printed Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's
Manuals." Clearance delays may result if the contents are not completely and accurately described.
"Printed Matter"
"Printed Matter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's
Manual" Clearance delays may result if the contents are not completely and accurately described.
"Printed Matters"
"Printed Matters" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's
Manuals" Clearance delays may result if the contents are not completely and accurately described.
"Promo Item"
"Promo Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promo Items"
"Promo Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promo Material"
"Promo Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promo Materials"
"Promo Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Item"
"Promotional Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Items"
"Promotional Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Material"
"Promotional Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional Materials"
"Promotional Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Promotional"
"Promotional" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional
Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described.
"Receivers"
"Receivers" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stereo Receiver."
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
289
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Records"
"Records" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office
Correspondence." Clearance delays may result if the contents are not completely and accurately described.
"Report"
"Report" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business
Correspondence - Annual Report." Clearance delays may result if the contents are not completely and accurately described.
"Rod"
"Rod" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Fishing Rods." Clearance
delays may result if the contents are not completely and accurately described.
"Rods"
"Rods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Aluminum Rods."
Clearance delays may result if the contents are not completely and accurately described.
"Rubber Articles"
"Rubber Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Hoses."
Clearance delays may result if the contents are not completely and accurately described.
"Rubber"
"Rubber" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Tires."
Clearance delays may result if the contents are not completely and accurately described.
"Said To Contain"
"Said To Contain" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Sample"
"Sample" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Samples"
"Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Scrap"
"Scrap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Scrap Billets."
Clearance delays may result if the contents are not completely and accurately described.
"See Attached"
"See Attached" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"SEE CO"
"SEE CO" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"SEE IN"
"SEE IN" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"See Invoice"
"See Invoice" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Shirt"
"Shirt" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's 100% Cotton Long
Sleeve Shirt." Clearance delays may result if the contents are not completely and accurately described.
"Software"
"Software" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Software Game on
CD-ROM - "Halo 2"." Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
290
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Spare Parts for Machine"
"Spare Parts for Machine" is an incomplete description and not accepted by Customs. An example of an acceptable description is
"Alternator - New." Clearance delays may result if the contents are not completely and accurately described.
"Spare Parts"
"Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - Used."
Clearance delays may result if the contents are not completely and accurately described.
"Spares"
"Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - New."
Clearance delays may result if the contents are not completely and accurately described.
"Sportswear"
"Sportswear" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Men's
Running Shorts." Clearance delays may result if the contents are not completely and accurately described.
"STC "
"STC " is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Steel"
"Steel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stainless Steel Pots."
Clearance delays may result if the contents are not completely and accurately described.
"Surgical Instruments"
"Surgical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Scalpels."
Clearance delays may result if the contents are not completely and accurately described.
"Swatches"
"Swatches" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Fabric
Sample Swatches." Clearance delays may result if the contents are not completely and accurately described.
"Tape"
"Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape."
Clearance delays may result if the contents are not completely and accurately described.
"Tapes"
"Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video
Tapes." Clearance delays may result if the contents are not completely and accurately described.
"Textile Samples"
"Textile Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt
100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textile"
"Textile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Dress - 100%
Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textiles Samples"
"Textiles Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt
100% Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Textiles"
"Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100%
Cotton - SAMPLE." Clearance delays may result if the contents are not completely and accurately described.
"Tile"
"Tile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance
delays may result if the contents are not completely and accurately described.
"Tiles"
"Tiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance
delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
291
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Tools"
"Tools" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Drill." Clearance
delays may result if the contents are not completely and accurately described.
"Toy"
"Toy" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Doll House."
Clearance delays may result if the contents are not completely and accurately described.
"Training Material"
"Training Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training
Material for Basketball." Clearance delays may result if the contents are not completely and accurately described.
"Training Materials"
"Training Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training
Materials for Basketball." Clearance delays may result if the contents are not completely and accurately described.
"Tubes"
"Tubes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Glass Tubes." Clearance
delays may result if the contents are not completely and accurately described.
"Unlist"
"Unlist" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Used Goods"
"Used Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Various Goods"
"Various Goods" is an incomplete description and not accepted by Customs. Please specify the description of the contents being shipped.
Clearance delays may result if the contents are not completely and accurately described.
"Video Tape"
"Video Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video
Tape." Clearance delays may result if the contents are not completely and accurately described.
"Video Tapes"
"Video Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video
Tapes." Clearance delays may result if the contents are not completely and accurately described.
"Video"
"Video" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes."
Clearance delays may result if the contents are not completely and accurately described.
"Videotape"
"Videotape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video
Tape." Clearance delays may result if the contents are not completely and accurately described.
"Videotapes"
"Videotapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video
Tapes." Clearance delays may result if the contents are not completely and accurately described.
"VISA MDR Table"
"VISA MDR Table" is an incomplete description and not accepted by Customs. Please specify the description of the contents being
shipped. Clearance delays may result if the contents are not completely and accurately described.
"Wafer"
"Wafer" is an incomplete description and not accepted by Customs. An example of an acceptable description is "semiconductor wafers."
Clearance delays may result if the contents are not completely and accurately described.
"Waste"
"Waste" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Oil Waste for Testing."
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
292
Appendix C: Vague Commodity Descriptions
Vague Commodity
Vague Commodity Description
"Wearing Apparel"
"Wearing Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's
Leather Sandals." Clearance delays may result if the contents are not completely and accurately described.
"Wire"
"Wire" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire."
Clearance delays may result if the contents are not completely and accurately described.
"Wires"
"Wires" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire."
Clearance delays may result if the contents are not completely and accurately described.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
293
Appendix D: Legal Terms and Conditions
Appendix D: Legal Terms and Conditions
In addition to creating and printing the waybill Label, you will need to print copies of the International Legal Terms and Conditions to accompany each Label with your
international shipments. The following defines international handling instructions for the waybill labels and Legal Terms and Conditions document.
If international – U.S. export: Print 2 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and
affix it to the shipment so that the bar code portion of the label can be read and scanned. Place the additional consignee copy of the waybill Label in the pouch.
If international – shipments originating outside of the U.S.: Print 3 copies of the waybill Label to your laser printer, fold 1 copy in half and use as the shipping label.
Place it in the waybill pouch and affix it to your shipment so that the bar code portion of the label can be read and scanned. Place the 2 consignee copies of the waybill
Label in the pouch.
The following defines U.S. handling instructions for the waybill labels and Legal Terms and Conditions.
If U.S. shipment: Print 1 copy of the waybill Label to your laser printer, fold the printed page in half and use as the shipping label. Place it in the waybill pouch and affix it to
your shipment so that the bar code portion of the label can be read and scanned.
NOTE:
The International and U.S. 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 Tagged Transaction Guide, June 2006
294
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.
CTS: Common Transaction Set (Tagged Transaction Fields)
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.
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.
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
295
Glossary
DG: Dangerous Goods
DUNS: A number assigned to a firm by Dun and Bradstreet
ECI: Electronic Commercial Invoice
ECOD: Electronic Collect on Delivery
EEI: Electronic Export Information (EEI)
EIN: Employer Identification Number
EXW (Ex Works): (Factory, mill, warehouse: your door) Title and risk pass to buyer including payment of all transportation and insurance cost from the seller's door. Used
for any mode of transportation.
FASC: FedEx Authorized Shipping Center
FCA (Free Carrier): (Pick a place after your origin to start) Title and risk pass to buyer including transportation and insurance cost when the seller delivers goods cleared
for export to the carrier. Seller is obligated to load the goods on the Buyer's collecting vehicle; it is the Buyer's obligation to receive the Seller's arriving vehicle unloaded.
FDXC: FedEx Cargo
FDXE: FedEx Express
FDXG: FedEx Ground
FHD: FedEx Home Delivery
FICE: FedEx International Controlled Export
FOB (Free On Board): (Port-same as FAS) Risk pass to buyer including payment of all transportation and insurance cost once delivered on board the ship by the seller.
Used for sea or inland waterway transportation.
FTR: Foreign Trade Regulations
FXCC: FedEx Custom Critical
FXFR: FedEx Freight
Girth: Girth is the sum of the four smallest dimensions of a package. Girth = (2" Width + 2" Height).
GST: Goods and Services Tax
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
296
Glossary
HAL: Hold at Location
HazMat: Hazardous Materials
HST: Harmonized Sales Tax
HTTP: Hypertext Transfer Protocol
IEFS: International Economy Freight Service
IPFS: International Priority Freight Service
ITAR: International Traffic in Arms
KGS: Kilograms
LBS: Pounds
MBG: Money Back Guarantee
MPS: Multiple-Piece Shipment
MTW: Multiweight
NAFTA: North America Free Trade Agreement
OP-950: FedEx Ground HazMat Report
OS: Oversize
Oversize Packages (FedEx Ground): A package whose Length plus Girth is greater than 84 inches is considered to be Oversize. Oversize packages are considered to
have a minimum weight of 30 lbs. (or 50 lbs. if the Length plus the Girth is greater than 108 inches) for U.S. shipments and 50 lbs. for Canadian shipments. There is also a
maximum allowable size of "Length plus Girth less than or equal to 130 inches," as well as a maximum allowable single dimension of 108 inches.
PNG: Portable Network Graphic
PO: Priority Overnight OR Purchase Order
POD: Proof of Delivery
PST: Provincial Sales Tax
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
297
Glossary
QST: Quebec Provincial Sales Tax
RMA: Return Materials Authorization
SED: Shipper’s Export Declaration
SLAC: Shipper’s Load And Count
SPOD: Signature Proof of Delivery
SSN: Social Security Number
URSA: Universal Routing and Sorting Aid
USD: U.S. Dollars (also $USD)
UTI: Universal Transaction Identifier
Unit of Measure codes:
Unit of Measure Codes
AR – Carat
GR – Gross
LYD – Linear Yard
CFT – Cubic Feet
GAL – Gallon
M – Meters
CG – Centigrams
KG – Kilograms
MG – Milligram
CM – Centimeters
KGM – Kilogram
ML – Milliliter
CM3 – Cubic Centimeters
L – Liter
M2 – Square Meters
DOZ – Dozen
LB – Pound
M3 – Cubic Meters
DPR – Dozen Pair
LFT – Linear Foot
NO – Number
EA – Each
LNM – Linear Meters
OZ – Ounces
G – Grams
LTR – Liters
PCS – Pieces
ZIP (code): Zone Improvement Plan code
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
298
Index
Index
0
4
007: Close Request, 96
019: Service Availability Request, 21
021: Ship a Package Request, 54
022: Rate a Package Request, 28
023: Delete a Package Request, 92
025: Rate Available Services Request, 41
033: Cancel Email Label Request, 172
037: Email Label Request, 155
044: Call Tag Create Request, 176
045: Call Tag Cancel Request, 184
046: Express Tag Dispatch Create Request, 188
047: Express Tag Dispatch Cancel Request, 198
048: Express Tag Availability Request, 202
404: Tracking Request, 101
405: Signature Proof of Delivery Request, 137
410: FedEx Locator Request, 146
420: Tracking Notifications Request, 121
1
Call Tag Cancel Reply (145), 186
Call Tag Cancel Request (045), 184
Call Tag Create Reply (144), 182
Call Tag Create Request (044), 176
Cancel Email Label Reply (133), 174
Cancel Email Label Request (033), 172
Close Reply (107), 99
Close Request (007), 96
Country Codes table, 274
107: Close Reply, 99
119: Service Availability Reply, 25
121: Ship a Package Reply, 82
122: Rate a Package Reply, 34
123: Delete a Package Reply, 94
125: Rate Available Services Reply, 47
133: Cancel Email Label Reply, 174
137: Email Label Reply, 169
144: Call Tag Create Reply, 182
145: Call Tag Cancel Reply, 186
146: Express Tag Dispatch Create Reply, 195
147: Express Tag Dispatch Cancel Reply, 200
148: Express Tag Availability Reply, 204
2
211: Subscription/Registration Request, 16
3
311: Subscription/Registration Reply, 19
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
5
504: Tracking Reply, 108
505: Signature Proof of Delivery Reply, 142
510: FedEx Locator Reply, 151
520: Tracking Notifications Reply, 131
C
D
Delete a Package Reply (123), 94
Delete a Package Request (023), 92
E
Email Label Reply (137), 169
Email Label Request (037), 155
Express Tag Availability Reply (148), 204
Express Tag Availability Request (048), 202
Express Tag Dispatch Cancel Reply (147), 200
Express Tag Dispatch Cancel Request (047), 198
Express Tag Dispatch Create Reply (146), 195
Express Tag Dispatch Create Request (046), 188
299
Index
F
S
FedEx Locator Reply (510), 151
FedEx Locator Request (410), 146
Field Descriptions by Field Tag, 217
Service Availability Reply (119), 25
Service Availability Request (019), 21
Ship a Package Reply (121), 82
Ship a Package Request (021), 54
Shipping Label Specifications, 206
Signature Proof of Delivery Reply (505), 142
Full SPOD letter sample, 144
Partial SPOD letter sample, 145
Signature Proof of Delivery Request (405), 137
Subscription/Registration Reply (311), 19
Subscription/Registration Request (211), 16
G
Glossary, 295
I
Introduction, 9
L
T
label data buffer, 212
label specifications
4x6 PNG Label, 208
custom labels, 210
determining screen resolution, 209
label data buffer, 212
PDF Label, 208
plain paper and thermal, 206
PNG plain paper label, 207
Sample C, 214
shipping label support, 211
using buffer data to print PNG or thermal labels, 213
Legal Terms and Conditions, 294
Tagged Transaction Layouts, 14
Tracking Notifications Reply (520), 131
Tracking Notifications Request (420), 121
Tracking Reply (504), 108
Tracking Request (404), 101
transaction set
formatting, 9
general information, 9
Transaction Terminator, 9
Transaction Type, 9
R
Rate a Package Reply (122), 34
Rate a Package Request (022), 28
Rate Available Services Reply (125), 47
Rate Available Services Request (025), 41
Referenced Documents, 13
Revision History, 4
FedEx Ship Manager® API/Direct Tagged Transaction Guide, June 2006
U
Universal Transaction Identifiers (UTI), 10
V
Vague Commodity Descriptions, 277
W
What’s New, 12
300