Web Services Developer Guide 2016 Fed Ex Developers V2016

User Manual: Pdf

Open the PDF directly: View PDF .
Page Count: 1033

Download
Open PDF In Browser	View PDF

FedEx Web Services
2016

Developer Guide

Table of Contents

Table of Contents
1

Introduction..................................................................................................................................... 18
1.1

Document Overview ................................................................................................................. 19

1.2

Printing All or Part of This Guide ............................................................................................. 20

1.3

Web Services, WSDL, and SOAP Overview ............................................................................ 21

1.4

Implementing FedEx Web Services ......................................................................................... 28

1.5

Understanding the XML Schema............................................................................................. 28

1.6

Implementation Process ........................................................................................................... 35

1.7

Samples...................................................................................................................................... 38

Address Validation Service ........................................................................................................ 39
2.1

Address Validation Request ..................................................................................................... 39

2.2

Address Validation Service Details .......................................................................................... 41

2.3

How FedEx Address Validation Works .................................................................................... 41

2.4

Tips on Getting Accurate Address Matches ........................................................................... 41

2.5

Address Results ......................................................................................................................... 42

2.6

Address Checking Process ....................................................................................................... 42

2.7

Address Classification ............................................................................................................... 42

2.8

Address Validation Coding Details .......................................................................................... 43

Close Service Shipment ............................................................................................................... 55
3.1

Close Service Operations ......................................................................................................... 55

3.2

Close Service Coding Details ................................................................................................... 56

3.3

FedEx Ground Reports .............................................................................................................. 60

3.4

FedEx SmartPost Close Shipment Service Details................................................................. 61

Consolidation Services ................................................................................................................ 65
4.1

Single Shipment Through Customs ........................................................................................ 67

4.2

Single Point of Clearance ......................................................................................................... 67

4.3

Multiple-Piece Freight Shipments............................................................................................ 67

4.4

Transaction Rules ...................................................................................................................... 67

4.5

Non FedEx Trade Networks Customs Broker ......................................................................... 70

4.6

Shipping Service Options ......................................................................................................... 71

4.7

Creating Considation Shipments ............................................................................................. 73

4.8

Requesting Consolidation Services ......................................................................................... 86

4.9

Consolidation Services Labels ................................................................................................. 86

4.10

Ground Commercial Invoice .................................................................................................... 86

4.11

Consolidated Commercial Invoice ........................................................................................... 87

4.12

International DirectDistribution (IDD) Service ........................................................................ 90

FedEx Web Services, Developer Guide 2016

Table of Contents
4.13
5

Useful Tips Consolidation Services Transactions .................................................................. 90

Country Service ............................................................................................................................. 92
5.1

Country Service Coding Details ............................................................................................... 92

Create a Label ................................................................................................................................. 95
6.1

Thermal Labels .......................................................................................................................... 95

6.2

Doc-Tab Configuration ............................................................................................................ 100

6.3

Laser Labels ............................................................................................................................. 106

6.4

Custom Labels ......................................................................................................................... 111

6.5

Portable Network Graphic (PNG) Label ................................................................................. 131

6.6

Label Review Checklist ........................................................................................................... 132

Dangerous Goods and HazMat ................................................................................................ 134
7.1

Dangerous Goods (FedEx Express) ....................................................................................... 134

7.2

Hazardous Materials (FedEx Ground U.S.) ........................................................................... 141

7.3

Dry Ice Shipments ................................................................................................................... 145

Dangerous Good Data Service ................................................................................................ 147
8.1

Dangerous Goods Shipments (FedEx Express) .................................................................... 147

8.2

Hazardous Materials (FedEx Ground U.S.) ........................................................................... 147

8.3

Dangerous Goods Data Service Coding Basics .................................................................... 148

8.4

DGDS Sample Codes .............................................................................................................. 166

8.5

Ship Using FedEx Tracking Number ..................................................................................... 194

Electronic Trade Documents .................................................................................................... 197
9.1

FedEx ETD Service Details ...................................................................................................... 197

9.2

Upload Documents Request Elements .................................................................................. 198

9.3

Upload Documents Reply Elements ...................................................................................... 199

9.4

Ship Request Elements ........................................................................................................... 200

9.5

Ship Reply Elements ............................................................................................................... 201

Estimated Duties and Taxes (Express and Ground) ....................................................... 203

10.1

Estimated Duties and Taxes Service Details ......................................................................... 203

10.2

Estimated Duties and Taxes Coding Details ......................................................................... 204

FedEx Express U.S. Shipping ............................................................................................... 207

11.1

FedEx Express U.S. Service Details ....................................................................................... 207

11.2

FedEx Express U.S. Coding Details ....................................................................................... 210

11.3

FedEx Express U.S. Multiple-Package Shipments ............................................................... 214

11.4

Group Multiple Piece Shipments ........................................................................................... 216

FedEx Express Freight Services: U.S ................................................................................. 217

12.1

Express Freight Service Business Rules ............................................................................... 217

12.2

FedEx Express Freight Services Coding Details ................................................................... 219

FedEx Web Services, Developer Guide 2016

Table of Contents
13

FedEx Freight Services ........................................................................................................... 220

13.1

FedEx Freight Service Features.............................................................................................. 221

13.2

FedEx Freight Service Details ................................................................................................. 221

13.3

FedEx Freight Priority ............................................................................................................. 222

13.4

FedEx Freight Economy .......................................................................................................... 223

13.5

Custom Delivery Date Options ............................................................................................... 223

13.6

Inside Pickup Service Option .................................................................................................. 223

13.7

FedEx Freight Rates and Surcharges .................................................................................... 223

13.8

FedEx Freight Coding Details ................................................................................................. 224

FedEx Ground U.S. Shipping ................................................................................................ 236

14.1

FedEx Ground U.S. Service Details ....................................................................................... 236

14.2

FedEx Ground U.S. Coding Details ........................................................................................ 237

14.3

FedEx Home Delivery Convenient Delivery .......................................................................... 243

14.4

FedEx Home Delivery Service Details ................................................................................... 244

FedEx Intra-Country Shipping .............................................................................................. 246

15.1

Services and Service Areas .................................................................................................... 246

15.2

Intra-Country Services Overview ........................................................................................... 247

15.3

Special Service Options .......................................................................................................... 249

15.4

Rules for Colombia .................................................................................................................. 255

15.5

Rules for India .......................................................................................................................... 256

15.6

Rules for Mexico ...................................................................................................................... 261

15.7

Rules for The United Kingdom............................................................................................... 262

FedEx SmartPost Shipping ................................................................................................... 268

16.1

FedEx SmartPost Service Details ........................................................................................... 268

16.2

FedEx SmartPost Returns Service Details ............................................................................ 277

In-Flight Shipment Service ................................................................................................... 287

17.1

In-Flight Shipment Service Details ........................................................................................ 287

17.2

In-Flight Shipment Service Coding Details ........................................................................... 287

International Shipping ........................................................................................................... 292

18.1

FedEx Express International Shipping .................................................................................. 292

18.2

FedEx Express Freight Services: International ..................................................................... 317

18.3

FedEx International Ground Shipping ................................................................................... 319

18.4

FedEx International Ground Service Details ......................................................................... 320

18.5

FedEx International Ground Coding Details ......................................................................... 321

18.6

FedEx International Broker ..................................................................................................... 332

18.7

B13A for Canada Export Shipping ......................................................................................... 334

18.8

Electronic Export Information ................................................................................................ 335

FedEx Web Services, Developer Guide 2016

Table of Contents
Commercial Destination Control............................................................................................ 338

18.9
19

Locations Service .................................................................................................................... 340

19.1

Locations Service Details ........................................................................................................ 340

19.2

Location Request Coding Details ........................................................................................... 341

19.3

UK/GB Locations Support ....................................................................................................... 350

Open Shipping .......................................................................................................................... 351

20.1

FedEx Services with Open Ship ............................................................................................. 351

20.2

Open Ship Process and Workflow ......................................................................................... 351

20.3

About Web Services Open Ship Transactions ...................................................................... 352

20.4

Create Open Shipment ........................................................................................................... 353

20.5

Route and Time-in-Transit Transaction ................................................................................. 383

20.6

Rate Open Ship Shipment Transaction ................................................................................. 383

20.7

Add Piece Transaction ............................................................................................................ 383

20.8

Returned Add Piece Fields...................................................................................................... 386

20.9

Modify Piece Transaction ....................................................................................................... 387

20.10

Delete Piece Transaction .................................................................................................... 395

20.11

Delete Shipment Transaction ............................................................................................. 395

20.12

Confirm Shipment Transactions ........................................................................................ 396

20.13

Open Ship Print Options ..................................................................................................... 411

20.14

Email Labels ......................................................................................................................... 411

20.15

Email Return Label Elements ............................................................................................. 416

Pickup Service .......................................................................................................................... 421

21.1

Pickup Service Details ............................................................................................................. 421

21.2

LTL Freight Pickup Special Services ...................................................................................... 422

21.3

Pickup Service Request Elements .......................................................................................... 426

21.4

Pickup Service Reply Elements .............................................................................................. 431

21.5

Pickup Service Country Codes ............................................................................................... 432

21.6

Cancel Pickup Service Details ................................................................................................ 433

21.7

Express Tag Availability ......................................................................................................... 444

Rate Services ............................................................................................................................ 446

22.1

RateRequest ............................................................................................................................. 446

22.2

Rate Available Services/Rate Shopping ................................................................................ 446

22.3

Surcharges and Discounts ...................................................................................................... 469

22.4

FedEx One Rate ....................................................................................................................... 475

22.5

Variable Handling Charges ..................................................................................................... 476

23
23.1

Returns Shipping ..................................................................................................................... 479
Global Returns ......................................................................................................................... 480

FedEx Web Services, Developer Guide 2016

Table of Contents
23.2

FedEx Return Tags .................................................................................................................. 481

23.3

FedEx Print Return Label ........................................................................................................ 490

23.4

FedEx Express/Ground Return Label Coding Details ........................................................... 491

23.5

Alternate Return Address ....................................................................................................... 493

Ship Service .............................................................................................................................. 494

24.1

Shipping Services by Region ................................................................................................. 494

24.2

Ship Service Coding Basics .................................................................................................... 495

24.3

Delete Shipment ...................................................................................................................... 509

24.4

Process Shipment Reply ......................................................................................................... 513

24.5

Validate Shipment ................................................................................................................... 520

24.6

FedEx One Rate ....................................................................................................................... 524

24.7

Shipment Notification ............................................................................................................. 526

24.8

Alcohol Shipping ..................................................................................................................... 528

24.9

Future Day Shipping ............................................................................................................... 535

24.10
25

Masked Data ........................................................................................................................ 536

Special Services ....................................................................................................................... 538

25.1

Delivery Signature Options .................................................................................................... 538

25.2

FedEx Priority Alert Options ................................................................................................... 540

25.3

Saturday Service ..................................................................................................................... 542

25.4

FedEx Express Collect on Delivery (C.O.D.) .......................................................................... 543

25.5

FedEx Ground U.S. Collect On Delivery (C.O.D.).................................................................. 549

25.6

Ground E.C.O.D. ...................................................................................................................... 558

25.7

Hold at FedEx Location ........................................................................................................... 558

25.8

Shipping Document Service ................................................................................................... 560

25.9

Upload Images......................................................................................................................... 578

Tracking and Visibility Services ......................................................................................... 580

26.1

Tracking Shipments ................................................................................................................ 580

26.2

Signature Proof of Delivery (SPOD) ...................................................................................... 604

26.3

Notification............................................................................................................................... 611

26.4

FedEx InSight ........................................................................................................................... 618

27
27.1

Validation Availability And Commitment Service ......................................................... 619
Service Availability .................................................................................................................. 619

Appendix ................................................................................................................................................ 625
Appendix A: Country Code Tables .................................................................................................... 625
Appendix B: U.S. State Codes ............................................................................................................ 637
Appendix C: Canada Province Codes ................................................................................................ 639
Appendix D: Mexico State Codes ...................................................................................................... 640
FedEx Web Services, Developer Guide 2016

Table of Contents
Appendix E: United Arab Emirates (UAE) State Code Table ........................................................... 641
Appendix F: Currency Codes .............................................................................................................. 641
Appendix G: Harmonized Tariff Unit of Measure Codes ................................................................. 644
Appendix H: Vague Commodity Descriptions .................................................................................. 647
Appendix I: Waybill Legal Terms and Conditions ............................................................................ 668
Appendix J: Postal-Aware Countries and Formats .......................................................................... 668
Appendix K: Physical Packaging Type Codes ................................................................................... 670
Appendix L: Customs-Approved Document Descriptions ............................................................... 671
Appendix M: Time Zones ................................................................................................................... 673
Appendix N: Minimum Customs Value ............................................................................................. 674
Appendix O: Error Code Messages ................................................................................................... 675
Appendix P: Countries Accepting Electronic Trade Documents ..................................................... 893
Appendix Q: Track Service Scan Codes ............................................................................................ 897
Appendix R: Maximum Field Lengths ............................................................................................... 957
Appendix S: FedEx Express Plain Paper ........................................................................................... 958
Appendix T: FedEx Express Thermal Label Samples ...................................................................... 976
Appendix U: FedEx Ground Plain Paper Labels ............................................................................... 976
Appendix V: FedEx Ground Thermal Label Samples ...................................................................... 981
Appendix W: FedEx SmartPost Label Samples ................................................................................ 996
Appendix X: Sample Shipping Documents .................................................................................... 1000
Appendix Y: Glossary ....................................................................................................................... 1011
Appendix Z: Track Special Handling Type ...................................................................................... 1020
Appendix AA: Test Server Mock Tracking Numbers ..................................................................... 1024
Appendix AB: Customer Reference Elements ................................................................................ 1026
Appendix AC: China Provinces and Regions .................................................................................. 1030
Appendix AD: SmartPost Hub IDs ................................................................................................... 1031
Appendix AE: Web Services and Service IDs ................................................................................. 1033

FedEx Web Services, Developer Guide 2016

List of Tables

List of Tables
Table 1. WSDL Elements .......................................................................................................................... 22
Table 2. XML Schema Diagrams ............................................................................................................. 30
Table 3. Required Elements...................................................................................................................... 32
Table 4 Reply/HighestSeverity/Notification ............................................................................................ 33
Table 5. TransactionDetail Elements ....................................................................................................... 33
Table 6. VersionId Elements ..................................................................................................................... 33
Table 7. Sender Information..................................................................................................................... 34
Table 8. Requirements and Resources for Corporate Developers........................................................ 37
Table 9. Requirements and Resources for Commercial Developers .................................................... 37
Table 10. Countries that support Address Validation ............................................................................ 39
Table 11. Address Matching Results ....................................................................................................... 43
Table 12. AddressValidationRequest Elements ...................................................................................... 44
Table 13. AddressValidationReply Elements .......................................................................................... 45
Table 14: List of Address Attributes ........................................................................................................ 48
Table 15: Notification ................................................................................................................................ 54
Table 16. CloseService Operations .......................................................................................................... 55
Table 17. GroundCloseRequest Elements ............................................................................................... 56
Table 18. GroundCloseWithDocumentsRequest Elements ................................................................... 57
Table 19. GroundCloseServiceWithDocumentReply Elements ............................................................ 58
Table 20. PrintingGroundReports Elements ........................................................................................... 60
Table 21. FedEx SmartPost Close Service Elements ............................................................................. 61
Table 22. FedEx Consolidation Services At-A-Glance ........................................................................... 65
Table 23. FedEx International DirectDistribution Services - Express and Ground Services .............. 66
Table 24. Broker Elements ........................................................................................................................ 70
Table 25. FedEx Express and FedEx Ground Services Allowed by Package Type .............................. 71
Table 26. FedEx Express Special Services Allowed by Service Type - I .............................................. 71
Table 27. FedEx Express Special Services Allowed by Service Type - II ............................................. 72
Table 28. FedEx Ground Special Services Allowed by Service Type ................................................... 73
Table 29. Consolidation Shipment Creation ........................................................................................... 73
Table 30. DeleteOpenConsolidationRequest .......................................................................................... 74
Table 31. ConfirmConsolidationRequest ................................................................................................ 74
Table 32. ConfirmConsolidationReply ..................................................................................................... 81
Table 33: GetConfirmConsolidationResultsReply .................................................................................. 82
Table 34. GetConfirmConsolidationResultsRequest .............................................................................. 86
Table 35. ValidatePostalRequest Elements ............................................................................................. 92
Table 36. ValidatePostalReply Elements ................................................................................................. 92
Table 37. ThermalLabel Elements ........................................................................................................... 96
Table 38. Number of Thermal Labels Printed Per U.S. Service ............................................................ 98
Table 39. Number of Thermal Labels Printed Per U.S. Export Intn'l Service ...................................... 98
Table 40. Number of Thermal Labels Printed Per Intra-Canada Service ............................................. 99
Table 41. Number of Thermal Labels Printed Per Canada Export International Service ................... 99
Table 42. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments..... 99
Table 43. Doc-Tab Configuration Elements .......................................................................................... 100
Table 44. Doc-Tab Prefix (Non-Rate Data) ............................................................................................ 101
Table 45. Doc-Tab Prefix (Rate Data) ..................................................................................................... 101
Table 46. WebServices Elements ........................................................................................................... 107
Table 47. Number of Thermal Labels Printed Per U.S. Service .......................................................... 109
FedEx Web Services, Developer Guide 2016

List of Tables
Table 48. Number of Thermal Labels Printed Per U.S. Export International Service ....................... 109
Table 49. Number of Thermal Labels Printed Per Intra-Mexico Service ............................................ 110
Table 50. Number of Thermal Labels Printed Per Intra-Canada Service ........................................... 110
Table 51. Number of Thermal Labels Printed Per Canada Export Int'l Service ................................. 110
Table 52. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments... 111
Table 53. Custom Label Elements for Text ........................................................................................... 113
Table 54. Custom Label Elements for Graphics ................................................................................... 119
Table 55. Net Explosive Mass Error Information ................................................................................. 136
Table 56. Dangerous Goods Coding Details Elements ........................................................................ 137
Table 57. Hazardous Materials Elements .............................................................................................. 142
Table 58. Hazardous Materials Reply Elements ................................................................................... 144
Table 59. Dry Ice ShipService WSDL Elements .................................................................................... 146
Table 60. List Dangerous Goods Request Elements ............................................................................ 148
Table 61. ListDangerousGoodsReply Elements ................................................................................... 149
Table 62. Validate Dangerous Goods Request Elements .................................................................... 150
Table 63. Validate Dangerous Goods Reply Elements ........................................................................ 154
Table 64. Upload Dangerous Goods Request Elements ...................................................................... 157
Table 65. Upload Dangerous Goods Reply Elements .......................................................................... 157
Table 66. Add Dangerous Goods Handling Unit Request Elements .................................................. 158
Table 67. Add Dangerous Goods Handling Unit Reply Elements....................................................... 159
Table 68. Modify Dangerous Goods Shipment Request Elements .................................................... 160
Table 69. Modify Dangerous Goods Shipment Reply Elements......................................................... 160
Table 70. Modify Dangerous Goods Handling Unit Request Elements ............................................. 161
Table 71. ModifyDangerousGoodsHandlingUnitReply Elements....................................................... 162
Table 72. RetrieveDangerousGoodsRequest Elements ....................................................................... 162
Table 73. RetrieveDangerousGoodsReply Elements ........................................................................... 163
Table 74. Delete Dangerous Goods Request Elements ....................................................................... 164
Table 75. Delete Dangerous Goods Reply Elements ........................................................................... 164
Table 76. Delete Dangerous Goods Handling Unit Request Elements .............................................. 165
Table 77. DeleteDangerousGoodsHandlingUnitReply Elements ........................................................ 166
Table 78. Electronic Trade Documents Request Elements .................................................................. 198
Table 79. Electronic Trade Documents Reply Elements ...................................................................... 199
Table 80. Electronic Trade Documents Request Elements .................................................................. 200
Table 81. Electronic Trade Documents Reply Elements ...................................................................... 201
Table 82. Estimated Duties and Taxes Request Elements ................................................................... 204
Table 83. Recipient Information Elements ............................................................................................ 211
Table 84. Shipment/Package Information Elements ............................................................................ 211
Table 85. Label Requirements Elements ............................................................................................... 213
Table 86. Multiple Piece Shipment Request Elements ........................................................................ 214
Table 87. Multiple Piece Shipment Reply Elements ............................................................................ 215
Table 88. U.S. Express Freight Detail Elements ................................................................................... 219
Table 89. Freight Request Elements ...................................................................................................... 224
Table 90. Optional Pickup Request Elements ....................................................................................... 230
Table 91. Freight Reply Elements .......................................................................................................... 231
Table 92. Recipient Information Elements ............................................................................................ 237
Table 93. Billing Elements ...................................................................................................................... 238
Table 94. Multiple-Package Shipment Elements .................................................................................. 240
Table 95. Package and Shipment Details Elements ............................................................................. 241
Table 96. LabelSpecification Element ................................................................................................... 243
Table 97. Package vs. Shipment Level Shipping Options ................................................................... 243
Table 98. Home Delivery Convenient Delivery Options Elements...................................................... 243
FedEx Web Services, Developer Guide 2016

List of Tables
Table 99. Canadian Services .................................................................................................................. 246
Table 100. Europe, the Middle East and Africa Services and Service Areas ..................................... 246
Table 101. Latin America and the Caribbean Services and Service Areas ........................................ 247
Table 102. Latin America and the Caribbean Special Service Options .............................................. 250
Table 103. Europe, the Middle East and Africa Special Service Options ........................................... 251
Table 104. India Special Service Options .............................................................................................. 253
Table 105. Freight to Collect with Intra-Country Shipping .................................................................. 255
Table 106. Colombia Package Limitations ............................................................................................ 255
Table 107. Intra-Country Shipping Weights and Dimension Limits ................................................... 257
Table 108. ProcessShipmentRequest .................................................................................................... 258
Table 109. Intra-India Shipping Surcharge Reply Element ................................................................. 260
Table 110: Mexico Package Limitations ................................................................................................ 261
Table 111. Intra-Mexico Request Elements ........................................................................................... 261
Table 112. Intra-UK Request Elements .................................................................................................. 263
Table 113. Intra-UK Reply Elements ...................................................................................................... 265
Table 114. FedEx SmartPost Request Elements ................................................................................... 269
Table 115. FedEx SmartPost Reply Elements ....................................................................................... 271
Table 116. FedEx SmartPost APO/FPO/DPO Elements ........................................................................ 273
Table 117. FedEx SmartPost Returns Request Elements .................................................................... 280
Table 118. FedEx SmartPost Email Return Label Request Elements ................................................. 282
Table 119. FedEx SmartPost Reply Elements ....................................................................................... 283
Table 120: ValidateDeliveryRequest Elements ..................................................................................... 287
Table 121: ValidateDeliveryReply Elements ......................................................................................... 289
Table 122: ProcessDeliveryRequest Elements ...................................................................................... 289
Table 123: ProcessDeliveryReply Elements .......................................................................................... 291
Table 124. Recipient Information Elements .......................................................................................... 295
Table 125. Billing Elements .................................................................................................................... 296
Table 126. Multiple Piece Shipment Elements ..................................................................................... 298
Table 127. Shipment/Package Information Elements .......................................................................... 298
Table 128. Label Requirements Element ............................................................................................... 302
Table 129. Document Shipment Options .............................................................................................. 302
Table 130. Recipient Information Elements .......................................................................................... 303
Table 131. Billing Detail Elements ......................................................................................................... 305
Table 132. Multiple-Piece Shipment Elements ..................................................................................... 306
Table 133. Shipment/Package Information Elements .......................................................................... 306
Table 134. Label Requirements Element ............................................................................................... 309
Table 135. Commodity Shipment Elements ......................................................................................... 310
Table 136. Commodity Elements ........................................................................................................... 311
Table 137. Required element if the recipient and importer are not the same ................................... 313
Table 138. Shipping Option and Package vs. Shipment Level ............................................................ 314
Table 139. B13A Elements ...................................................................................................................... 334
Table 140. ITN or EEI Exemption Number Elements ........................................................................... 337
Table 141. Commerce Destination Control Statement Elements ....................................................... 338
Table 142. SearchLocationsRequest Elements ..................................................................................... 341
Table 143. SearchLocationsReply Elements ......................................................................................... 345
Table 144. Open Ship Creation .............................................................................................................. 351
Table 145. Create Open Shipment Request .......................................................................................... 354
Table 146. CreateOpenShipmentReply ................................................................................................. 365
Table 147. CreatePendingShipmentRequest ........................................................................................ 371
Table 148. Create Pending Shipment Reply ......................................................................................... 378
Table 149. Add Packages To Open Shipment Request ........................................................................ 383
FedEx Web Services, Developer Guide 2016

List of Tables
Table 150. AddPackagesToOpenShipmentReply ................................................................................. 386
Table 151. ModifyPackageInOpenShipmentRequest ........................................................................... 387
Table 152. DeletePackagesFromOpenShipmentRequest .................................................................... 395
Table 153. DeleteOpenShipmentRequest ............................................................................................. 395
Table 154. ConfirmOpenShipmentRequest .......................................................................................... 396
Table 155. ConfirmOpenShipmentReply .............................................................................................. 400
Table 156. GetConfirmOpenShipmentResultsRequest ........................................................................ 402
Table 157. RetrieveJobResultsRequest ................................................................................................. 407
Table 158. Retrieve Job Results Reply .................................................................................................. 407
Table 159. Email Return Label Elements ............................................................................................... 412
Table 160. Email Label (non-return) Elements ..................................................................................... 414
Table 161. Cancel Email Label Elements ............................................................................................... 415
Table 162. CreatePendingShipment Basic Returns Email Label Request Elements ......................... 416
Table 163. CreatePendingShipment Request Returns Email Label Through FedEx Elements ........ 418
Table 164. FreightPickupDetail/LineItems ............................................................................................. 422
Table 165. Pickup Service Request Elements ....................................................................................... 426
Table 166. ExpressFreightDetail Elements ............................................................................................ 428
Table 167. PickupServiceReply Elements ............................................................................................. 431
Table 168. Pickup Service Country Codes ............................................................................................. 432
Table 169. CancelPickup Service Request Elements ............................................................................ 433
Table 170. CancelPickupRequest Elements .......................................................................................... 436
Table 171. CancelPickupReply Elements............................................................................................... 437
Table 172. PickupAvailability Elements ................................................................................................. 438
Table 173. PickupAvailabilityRequest Elements ................................................................................... 439
Table 174. Pickup Availability Reply Elements ..................................................................................... 442
Table 175. ExpressTagAvailabilityRequest Element ............................................................................ 444
Table 176. ExpressTagAvailabilityReply Elements .............................................................................. 444
Table 177. RateRequest Elements ......................................................................................................... 447
Table 178. RateReply Elements .............................................................................................................. 457
Table 179. FedEx Express Freight RateRequest Elements .................................................................. 460
Table 180. FedEx Freight Reply Shipment Elements ........................................................................... 465
Table 181. Rate Reply Possible Surcharges for FedEx Service Options ............................................ 467
Table 182. Surcharges and Discounts Rate Quote ............................................................................... 469
Table 183. FedEx Discount Programs .................................................................................................... 474
Table 184. Packaging Types ................................................................................................................... 476
Table 185.Variable Handling Elements ................................................................................................. 477
Table 186. Return Types ......................................................................................................................... 479
Table 187. Process Tag Request Elements ........................................................................................... 482
Table 188. DeleteTagRequest Elements ................................................................................................ 488
Table 189. ExpressTagAvailabilityRequest Element ............................................................................ 489
Table 190. Express Tag Availability Reply Elements ........................................................................... 489
Table 191. Print Return Label Elements ................................................................................................ 492
Table 192. Alternate Return Request Elements .................................................................................... 493
Table 193. Shipping Services by Region ............................................................................................... 494
Table 194. Requested Shipment Elements ........................................................................................... 495
Table 195. Delete Shipment Coding Details Elements ........................................................................ 510
Table 196. Process Shipment Reply Elements ..................................................................................... 513
Table 197. Validate Shipment Request Elements ................................................................................ 520
Table 198. Packaging Types ................................................................................................................... 525
Table 199. Shipment Notification Elements ......................................................................................... 526
Table 200. AlcoholShipping Elements .................................................................................................. 529
FedEx Web Services, Developer Guide 2016

List of Tables
Table 201. Future Day Shipping Elements ............................................................................................ 536
Table 202. Masked Data Coding Elements ............................................................................................ 536
Table 203. Delivery Signature Options .................................................................................................. 538
Table 204. Delivery Signature Elements ............................................................................................... 539
Table 205. Priority Alert Basic Complex Elements ............................................................................... 541
Table 206. Priority Alert Additional Reply Elements ............................................................................ 541
Table 207. Saturday Ship and Delivery Request Elements ................................................................. 543
Table 208. Single C.O.D. Shipment Elements....................................................................................... 544
Table 209. Multiple Piece Shipment C.O.D. Request Elements .......................................................... 547
Table 210. Multiple Piece Shipment C.O.D. Reply Elements ............................................................... 548
Table 211. Multiple Piece Shipment C.O.D. Additional Shipping Options Reply Elements ............. 549
Table 212. Single and C.O.D. Multiple Piece Shipment Elements ...................................................... 550
Table 213. Multiple-Piece Shipment C.O.D. Elements ......................................................................... 556
Table 214. Multiple-Piece Shipment C.O.D. Reply Elements .............................................................. 557
Table 215. Additional Multiple-Piece Package/Shipment C.O.D. Options .......................................... 558
Table 216. Hold at FedEx Location Elements........................................................................................ 559
Table 217. Certificate of Origin Elements .............................................................................................. 561
Table 218. Commerical Invoice Elements ............................................................................................. 562
Table 219. NAFTA Certificate of Origin Elements ................................................................................ 566
Table 220. OP-900 Elements ................................................................................................................... 571
Table 221. Dangerous Goods Shippers Declaration Elements ........................................................... 573
Table 222. Pro Forma Invoice Elements ................................................................................................ 576
Table 223. Freight Address Label Elements.......................................................................................... 577
Table 224. Upload Image Request Elements ........................................................................................ 578
Table 225. Upload Image Reply Elements ............................................................................................ 579
Table 226. TrackRequest Elements ........................................................................................................ 583
Table 227. TrackReply Elements ............................................................................................................ 586
Table 228. TrackReply/CompletedTrackDetails/TrackDetails Elements ............................................. 588
Table 229. Tracking Status Codes .......................................................................................................... 602
Table 230. SPOD Letter Request Elements ........................................................................................... 604
Table 231. SPOD Letter Reply Elements ............................................................................................... 606
Table 232. SPOD Fax Request Elements ............................................................................................... 607
Table 233. SPOD Fax Reply Elements ................................................................................................... 607
Table 234. Valid Language Codes for Notification Service ................................................................. 611
Table 235. SendNotificationsRequest Elements................................................................................... 613
Table 236. SendNotificationsReply Elements ....................................................................................... 616
Table 237. FedEx InSight Elements ....................................................................................................... 618
Table 238. ServiceAvailabilityRequest Elements ................................................................................. 620
Table 239. ServiceAvailability Reply Elements..................................................................................... 622
Table 240. US State Codes ..................................................................................................................... 637
Table 241. Canada Province Codes ....................................................................................................... 639
Table 242. Mexico State Codes .............................................................................................................. 640
Table 243. UAE State Codes ................................................................................................................... 641
Table 244. Currency Codes ..................................................................................................................... 641
Table 245. Harmonized Tariff Unit of Measure Codes ......................................................................... 644
Table 246. Vague Commodity Descriptions .......................................................................................... 647
Table 247. Postal Aware Countries and Formats ................................................................................. 668
Table 248. Physical Packaging Type Codes .......................................................................................... 670
Table 249. Customs-Approved Document Descriptions ...................................................................... 671
Table 250. Time Zones ............................................................................................................................ 673
Table 251. Minimum Customs Value .................................................................................................... 674
FedEx Web Services, Developer Guide 2016

Table 252. Chained SSL Certificate Error Messages ............................................................................ 676
Table 253. Ground Close Service Error Messages ............................................................................... 677
Table 254. Ground Close With Documents Error Messages ............................................................... 678
Table 255. Reprint Ground Close Documents ...................................................................................... 678
Table 256. Electronic Trade Documents Error Messages .................................................................... 679
Table 257. Upload Document Service Error Messages ....................................................................... 679
Table 258. FedEx SmartPost Shipping Error Messages ...................................................................... 680
Table 259. Signature Proof Of Delivery (SPOD) Error Messages........................................................ 681
Table 260. Locations Service Error Messages ...................................................................................... 683
Table 261. Track Service Error Messages ............................................................................................. 689
Table 262. VACS and Country Service Error Messages ...................................................................... 701
Table 263. Dangerous Goods Data Service and List Detail Error Messages ..................................... 721
Table 264. Rate Service Error Messages ............................................................................................... 730
Table 265. Pickup Service Error Messages ........................................................................................... 759
Table 266. Ship Service and Open Shipping Error Messages ............................................................ 824
Table 267. Open Ship Service Error Messages .................................................................................... 893
Table 268. Countries Accepting Electronic Trade Documents ............................................................ 893
Table 269. Track Service Scan Codes .................................................................................................... 898
Table 270. Maximum Field Lengths ...................................................................................................... 957
Table 271. FedEx Express Special Handling Codes ............................................................................. 970
Table 272. Shipping Documents .......................................................................................................... 1000
Table 273. Acronym List and Descriptions ......................................................................................... 1011
Table 274. Track Special Handling Type Valid Values ....................................................................... 1020
Table 275. Tracking Numbers for FedEx Express and Ground ......................................................... 1024
Table 276 Tracking Numbers for SmartPost....................................................................................... 1025
Table 277 Tracking Numbers for Freight LTL ..................................................................................... 1025
Table 278. Customer Reference Elements - Express and Ground .................................................... 1026
Table 279. Customer Reference Elements - SmartPost ..................................................................... 1028
Table 280. Customer Reference Elements - LTL ................................................................................. 1029
Table 281. China Provinces and Regions ............................................................................................ 1030
Table 282. SmartPost Hub IDs.............................................................................................................. 1031
Table 283. Web Service Names and Respective Service IDs ............................................................ 1033

FedEx Web Services, Developer Guide 2016

Table of Figures

Table of Figures
Figure 1: Custom Validator Label .......................................................................................................... 112
Figure 2. Notification email .................................................................................................................... 284
Figure 3. Fedex.com screen.................................................................................................................... 285
Figure 4. Sample SEL-169 Labels .......................................................................................................... 531
Figure 5. Example for Standard Exception Label 169 .......................................................................... 532
Figure 6. Label that includes the standard SEL 169 text at the bottom of the shipping label ......... 533
Figure 7. Sample Label that includes the standard SEL 169 text as a supplemental label .............. 534
Figure 8. SPOD Sample Letter – Partial ................................................................................................. 609
Figure 9. SPOD Sample Letter – Full ..................................................................................................... 610
Figure 10. FedEx Express Plain Paper ................................................................................................... 959
Figure 11. Layout Requirements for Multiple-Piece Shipment Master Label .................................... 960
Figure 12. Font Requirements for Multiple-Piece Shipment Master Label ........................................ 961
Figure 13. International Multiple Piece Shipment Child Label ............................................................ 962
Figure 14. International Multiple Piece Shipment Master Label ......................................................... 963
Figure 15. C.O.D. Return Label (ASTRA Block) ..................................................................................... 964
Figure 16. Priority Saturday Delivery Label (ASTRA Block) ................................................................ 965
Figure 17. FedEx 1Day Freight Saturday Delivery Label ..................................................................... 966
Figure 18. 2Day Saturday Delivery ........................................................................................................ 967
Figure 19. 2Day Delivery ......................................................................................................................... 968
Figure 20. Priority Alert Delivery ............................................................................................................ 969
Figure 21. FedEx Express Domestic Inaccessible Dangerous Goods with Dry Ice and Adult
Signature Required ................................................................................................................................. 971
Figure 22. Requirements for International Single Piece Label ............................................................ 972
Figure 23. FedEx International Priority Label with Broker Select Option ........................................... 973
Figure 24. FedEx International Priority Label with Broker Select Option Airway Bill ....................... 974
Figure 25. International Single Piece Label with Electronic Trade Documents ................................. 975
Figure 26. FedEx Express Thermal Label Sample ................................................................................ 976
Figure 27. Label Layout Requirements .................................................................................................. 977
Figure 28. United States Home Delivery 1D Barcode Label ................................................................ 978
Figure 29. Return Label ........................................................................................................................... 979
Figure 30. HazMat Label ......................................................................................................................... 980
Figure 31. C.O.D. Return Label ............................................................................................................... 981
Figure 32. FedEx International Ground Label ....................................................................................... 981
Figure 33. Is Part of a FedEx Ground thermal label ............................................................................. 982
Figure 34. Layout Requirements for FedEx Ground U.S. Label .......................................................... 983
Figure 35. Font Requirements for FedEx Ground U.S. Label .............................................................. 984
Figure 36. Layout and Font Requirements for FedEx Home Delivery U.S. Label ............................. 985
Figure 37. FedEx Ground U.S. C.O.D. Inbound Shipping Label .......................................................... 986
Figure 38. FedEx Ground U.S. C.O.D. Outbound Payment Label ....................................................... 987
Figure 39. FedEx Ground U.S. E.C.O.D. Second Label ........................................................................ 988
Figure 40. FedEx Ground U.S. C.O.D. with Guaranteed Funds Label................................................. 989
Figure 41.FedEx Ground U.S. C.O.D. with Guaranteed Funds Second Label .................................... 990
Figure 42. FedEx Ground Hold at Location Return Thermal Label with 1D Barcode ........................ 991
Figure 43. FedEx Home Delivery U.S. 1D Barcode Label with ORM-D/Limited Quantity ................. 992
Figure 44. FedEx Ground U.S. Third-Party with FedEx Return Manager Label ................................. 993
Figure 45. FedEx International Ground Label with 3rd Billing and C.O.D. with Guaranteed Funds . 994
Figure 46. FedEx Ground U.S. Label with Doc-Tab .............................................................................. 995
Figure 47. FedEx SmartPost Returns Label ........................................................................................... 996
FedEx Web Services, Developer Guide 2016

Table of Figures
Figure 48. FedEx Ground Thermal SmartPost Label (Large Shipper) ................................................ 997
Figure 49. FedEx Integrated Label (Small Shipper) ............................................................................. 998
Figure 50. FedEx Ground SmartPost Returns Label ............................................................................ 999
Figure 51. Bill of Lading ........................................................................................................................ 1001
Figure 52. Certificate of Origin ............................................................................................................. 1002
Figure 53. Commercial Invoice............................................................................................................. 1003
Figure 54. NAFTA COO ......................................................................................................................... 1004
Figure 55. OP-900 .................................................................................................................................. 1005
Figure 56. OP-950 .................................................................................................................................. 1006
Figure 57. Hazardous Materials Certification Report ......................................................................... 1007
Figure 58. Pro Forma Invoice ............................................................................................................... 1008
Figure 59. FedEx Ground Pickup Manifest .......................................................................................... 1009
Figure 60. Commodity By Tracking Number Report .......................................................................... 1010

FedEx Web Services, Developer Guide 2016

Legal and Copyright Notices

Legal and Copyright Notices
Confidential and Proprietary
The information contained in this guide is confidential and proprietary to FedEx Corporate Services, Inc.
and its affiliates (collectively “FedEx”). No part of this guide may be distributed or disclosed in any form
to any third party without written permission of FedEx. This guide is provided to you and its use is
subject to the terms and conditions of the FedEx Automation Agreement. The information in this
document may be changed at any time without notice. Any conflict between this guide, the FedEx
Automation Agreement and the FedEx Service Guide shall be governed by the FedEx Automation
Agreement and the FedEx Service Guide, in that order.
© 2015 - 2016 FedEx. FedEx and the FedEx logo are registered service marks. All rights reserved.
Unpublished.

Payment
You must remit payment in accordance with the FedEx Service Guide, tariff, service agreement or other
terms or instructions provided to you by FedEx from time to time. You may not withhold payment on any
shipments because of equipment failure or for the failure of FedEx to repair or replace any equipment.

Invoices
If you generate an inaccurate invoice, FedEx ® may bill or refund to you the difference according to the
FedEx Service Guide, tariff service agreement or other terms or instructions provided to you by FedEx
from time to time. A request for refund on a FedEx shipment must be made in accordance with the
applicable Service Guide or terms or instructions provided by FedEx from time to time. A shipment given
to FedEx with incorrect information is not eligible for refund under any FedEx money-back guarantee.
FedEx may suspend any applicable money-back guarantee in the event of equipment failure or if it
becomes inoperative.

Disclaimer
All improper Transaction scenarios are for example only. They do not reflect all error condition scenarios.

FedEx Web Services, Developer Guide 2016

About This Guide

About This Guide
This guide describes how to integrate with FedEx Web Services. It is written for the application
developer who uses web services to design and deploy applications enabled by FedEx. It describes how
to get started with application development and how to use the Application Programming Interface (API).
It also describes each available service in addition to the business logic that drives each FedEx process.

Document Organization
Each web service provides access to FedEx features. The service description includes service details and
a full schema listing to facilitate application development.

Resources


FedEx Developer Resource Center: fedex.com/developer



FedEx Services At-a-Glance: fedex.com/us/services



FedEx Service Guide available at fedex.com/us/service-guide



World Wide Web Consortium XML: https://www.w3.org/XML/



World Wide Web Consortium XML Schema: https://www.w3.org/XML/Schema



Microsoft Web Services: msdn.microsoft.com/en-us/library/ms950421.aspx



O’Reilly XML.com: www.xml.com



Secure Socket Layer Certificates: fedex.com/us/developer/downloads/dev_cert.zip



Web Services organization home page: https://www.w3.org/2000/xp/Group/

Support


Contact FedEx Web Services technical support at websupport@fedex.com.



Regional contact email addresses are:
o
o

For Europe - emeawebservices@fedex.com
For Indian Subcontinent, Middle East and Africa - apacwebservices@fedex.com



For technical support, call 1.877.339.2774 and state “API” at the voice prompt.



Support hours are Monday through Friday, 7:00 a.m. to 9:00 p.m. CST, and Saturday, 9:00 a.m. to
3:00 p.m. CST.



For FedEx Customer Service, call 1.800.GoFedEx 1.800.463.3339.



Customers using a FedEx® Compatible Solutions Program automation solution should contact their
software provider for support.

FedEx Web Services, Developer Guide 2016

Introduction

FedEx Web Services gives you the tools to build custom platform and interface-independent applications
that access FedEx features. You can use FedEx Web Services in a variety of ways to create customized
integration solutions for your specific shipping needs. Here are few of the ways a company can use web
services to streamline operations, improve visibility, and provide more choices to clients:


Verify Address and Improve Customer Satisfaction: Prompt customers for additional information
in the event of an address discrepancy or missing information with the Address Validation WSDL.
See Address Validation Service for more information.



Give Customers More Options: Help customers learn about all the available shipping options and
rates with Ship Service and Rate Services. You can also extend this service to your shopping cart
and website, allowing customers to access money-saving information firsthand.
See Rate Services and Ship Service for more information.



More Convenience: Use the Locations Service to find the FedEx pickup location nearest your
customer. Or, send an email to your customers with a link to this service as part of your standard
order-receipt process.
See Locations Service for more information.



Offer Global Shipping Options: Create shipping labels for worldwide locations. Improve customer
service by offering more shipping options to customers in more countries with the consolidated Ship
Service.
See Ship Service for more information.



Reduce Customer Service Costs: Decrease phone traffic from customers checking the status of
their shipments and cut customer service costs. FedEx provides online Tracking and Visibility
Services that allow you to provide customers with the status of shipments, Signature Proof of
Delivery (SPOD), and Shipment Notification in the Ship Request.
See Shipment Notification in the Ship Request, Signature Proof of Delivery (SPOD) and
Tracking and Visibility Services and for more information.



Simplify Processes and Improve Satisfaction: In addition to ExpressTagAvailability, provide a
simple way to allow customers to return an order with Email Return Labels. This service sends an
email with the address (URL) of a website where the recipient can log in and print a return label.
See ExpressTagAvailability and Email Labels for more information.

Why should developers be interested in web services?


Interoperability: Any web service can interact with any other web service and can be written in any
programming language.



Ubiquity: Web services communicate using HTTP and XML. Any connected device that supports
these technologies can both host and access web services.



Low Barrier to Entry: The concepts behind web services are easy to understand, and developers
can quickly create and deploy them using many toolkits available on the web.



Industry Support: Major content providers and vendors support the web services movement.

Any application running on any platform can interact with a web service by using the Simple Object
Access Protocol (SOAP) and Web Services Description Language (WSDL) standards for message
FedEx Web Services, Developer Guide 2016

Introduction
transfer and service discovery. By following the standards, applications can seamlessly communicate
with platform services.

1.1

Document Overview

The FedEx Web Services Developer Guide provides instructions for coding the functions you need to
develop FedEx supported applications described in the following chapters.


Introduction (this chapter):
o
o
o
o

Documentation overview and guidelines, including how to use the Help application and how to
print this guide.
Overview about web services, including a high-level description of FedEx Web Services
methods.
Coding basics.
Overview about testing and certifying your application.



Rate Services describes services to rate packages.



Validation Availability And Commitment Service and Country Service describes how to check
service availability, postal codes, and route information.



Tracking And Visibility Services covers Track Services and includes:
o
o
o

Elements for requesting tracking information, coding notification requests, and requesting
Signature Proof of Delivery (SPOD).
The Notification service, which can be used to notify shippers and recipients of significant
shipment events.
Elements for configuring FedEx InSight.



Locations Service describes how to receive the addresses of the nearest FedEx package drop-off
locations, including FedEx Office® Print and Ship Center locations.



Address Validation Service explains how to check your shipping addresses for accuracy before
shipping.



Ship Service provides:
o
o

Service details for shipping with FedEx® services.
Service details and coding details for all shipping services, including FedEx Express U.S.
Shipping, FedEx Ground U.S. Shipping, FedEx Express International Shipping, and FedEx
International Ground Shipping.



Returns Shipping describes how to verify that a FedEx ExpressTag® Dispatch can be scheduled for
a given place and time.



Create a Label describes how to configure, customize, and print shipping labels using a variety of
options.



FedEx SmartPost Shipping describes how to configure FedEx SmartPost® shipping options.



Appendices:
o
o
o
o
o

Appendix A: Country Code Tables
Appendix B: U.S. State Codes
Appendix C: Canada Province Codes
Appendix D: Mexico State Codes
Appendix E: UAE State Codes

FedEx Web Services, Developer Guide 2016

Introduction
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o
o

Appendix F: Currency Codes
Appendix G: Harmonized Tariff Unit of Measure Codes
Appendix H: Vague Commodity Descriptions
Appendix I: Waybill Legal Terms and Conditions
Appendix J: Postal-Aware Countries and Formats
Appendix K: Physical Packaging Type Codes
Appendix L: Customs-Approved Document Descriptions
Appendix M: Time Zones
Appendix N: Minimum Customs Value
Appendix O: Error Code Messages
Appendix P: Countries Accepting Electronic Trade Documents
Appendix Q: Track Service Scan Codes
Appendix R: Maximum Field Lengths
Appendix S: FedEx Express Plain Paper Label Samples
Appendix T: FedEx Express Thermal Label Samples
Appendix U: FedEx Ground Plain Paper Labels
Appendix V: FedEx Ground Thermal Label Samples
Appendix W: FedEx SmartPost Label Samples
Appendix X: Sample Shipping Documents
Appendix Y: Glossary
Appendix Z: TrackSpecialHandling Type
Appendix AA: Test Server Mock Tracking Numbers
Appendix AB: Customer Reference Elements
Appendix AC: China Provinces and Regions
Appendix AD: SmartPost Hub IDs
Appendix AE: Web Services and Service IDs

Each chapter covering FedEx Web Services coding includes:


Service Details: Business rules for using the FedEx service.



Service Options: Links to additional services that can be added to the basic Web Service.



Coding Details: Best practices information, basic request and reply elements, and a link to error
messages.



XML Schema: A link to the layout for the service. This layout provides coding requirements for all
elements in the schema.

1.2

Printing All or Part of This Guide

You can print all or part of this guide from the PDF version.

FedEx Web Services, Developer Guide 2016

Introduction

1.3

Web Services, WSDL, and SOAP Overview

This section describes the standard coding technologies used in FedEx Web Services.

1.3.1

Web Services

Web services are a collection of programming technologies, including XML, Web Services Description
Language (WSDL), and Simple Object Access Protocol (SOAP), which allow you to build programming
solutions for specific messaging and application integration.
Web services are, by definition, platform independent. FedEx Web Services allow developers to build
custom applications that are independent of changes to the FedEx interface. Web Services are
consumed by many different applications across many platforms. It is based on the basic principles that
govern XML standards, one of which is how Namespaces can be declared and applied.
Namespaces are declared as an attribute of an element. It is not mandatory to declare namespaces only
at the root element; rather it can be declared for any element in the XML document. The scope of a
declared namespace begins for the element where it is declared. This is applicable to the entire content
of that element, unless overridden by another namespace declaration with the same prefix name. The
content of an element is the content between the and of that element. So
essentially, XML namespace declarations are scoped, meaning that the declared prefix (or default
namespace) is in force for the element on which the declaration occurs (as well as its descendant
elements).
A namespace is declared as follows:

or even (hypothetically) same as

1.3.2

Web Services Description Language (WSDL)

A SOAP request to, or response from a service is generated according to the service’s WSDL definition.
A WSDL document describes a service. It is an XML document that provides information about what the
service does, the methods that are available, their parameters, and parameter types. It describes how to
communicate with the service in order to generate a request to, or decipher a response from, the
service.
The purpose of a WSDL is to completely describe a web service to a client. A WSDL defines where the
service is available and which communication protocol is used to talk to the service. It defines everything
required to write a program that will work with an XML web service. A WSDL document describes a web
service using seven major elements. The elements can be abstract or concrete.
Abstract XML elements that describe the web service are: , , ,
.
Concrete XML elements that provide connection details are: , , .

FedEx Web Services, Developer Guide 2016

Introduction
Table 1. WSDL Elements
Element

Definition

The root element contains name space definitions.

The most important WSDL element. It is a set of all operations that a web service
can accept and is a container for elements. This WSDL element
describes a web service, the operations that can be performed, and the messages
that are involved. It can be compared to a function library (or a module or a class) in a
traditional programming language.

Defines variable types used in the web service (both the parameters passed to a
function and the type of the value passed back via the response). The data types are
described by XML schema. This element contains user-defined data types (in the
form of XML schema). For maximum platform neutrality, WSDL uses XML schema
syntax to define data types.

Defines the data elements of an operation. Each message can consist of one or more
parts that can be compared to the parameters of a function call in a traditional
programming language.

Child of the element that defines each operation that the port exposes.
This element allows only three messages:
Message - Definition
Input Message - Data web services receive
Output Message - Data web services send
Fault Message - Error messages from web services

Contains a child element that describes the URL where the service is located.
This is the location of the ultimate web service.

Defines the message format and protocol details for each port. The binding element
has two attributes: the name attribute and the type attribute. This element Specify
how the client and the web service should send messages to one another.

Note: For more information about the WSDL standard, refer to World Wide Web Consortium (W3C) Website.

1.3.3

Simple Object Access Protocol (SOAP)



SOAP is a simple XML-based protocol that allows applications to exchange information over HTTP.



Built on open standards supported by numerous development tools on various platforms.



It is a request interface object in your application programming language.



Provides a way to communicate between applications running on different operating systems, with
different technologies and programming languages.



Enables the data to pass through layers of intermediaries and arrive at the ultimate receiver the way
it was intended.

Note: You can construct the SOAP messages by yourself using one of the many development tools available today.

FedEx Web Services, Developer Guide 2016

Introduction

1.3.4

SOAP Message

A SOAP message is an XML document that can be a Request for a web service from a client or a Reply
from a web service to a client.


Required



Optional



Required

Example 1:

DeleteTagRequest (SOAP Message)

XXXXXXXXXX

XXXXXXXXX
XXXXXXX
string
Syntel
WSGW
3100
WAPI123
SHIPENT
B123
SHIPENT
INT123
US
ENTERPRISE

string

FedEx Web Services, Developer Guide 2016

Introduction
EN
en

Delete Express Tag

EN
ES

ship
17
0
0

NQAA
2014-11-21

SENDER

XXXXXXXXX

BUSINESS_NATIONAL
123456

123

FedEx Web Services, Developer Guide 2016

Introduction

1.3.5

Non-SOAP Web Services

FedEx offers a non-SOAP web services solution that you can use to send transactions without having to
use tools that provide SOAP protocol support for web services. This may be convenient for developers
using environments that do not provide support for SOAP. With this interface, XML documents are sent
directly to the FedEx servers via the HTTP POST command. FedEx provides a set of specifications and
examples to help with the development of this type of communications method.
To use the non-SOAP web service solution, you must have a working knowledge of HTTPS and Secure
Socket Layering (SSL) encryption, the ability to provide a secure SSL connection to FedEx and the ability
to code to an operation interface using XML.
The interfaces used in the SOAP and non-SOAP web services are defined in WSDL files. The WSDL files
contain schemas that define the layout of the operations. The same WSDL file is used for both the SOAP
and non-SOAP web service users.
Non-SOAP users are concerned only with the schema definitions and not the other WSDL components
that are SOAP-specific. The XML data that is sent via the non-SOAP interface looks almost identical to
the data that is sent via the SOAP interface. The only difference is that the data sent via the non-SOAP
interface does not contain the wrapping Envelope and Body tags that are specific to SOAP. The following
is an example of a TrackRequest using the non-SOAP interface.
Example 2:

TrackRequest

XXXXXXXXXX
XXXXXXXXXX

XXXXXXXXX
XXXXXXX

EN
us

FedEx Web Services, Developer Guide 2016

Introduction

Ground Track By
Number

EN
us

trck
10
0
0

FDXG

TRACKING_NUMBER_OR_DOORTAG
XXXXXXXXXXXXXXX

INCLUDE_DETAILED_SCANS

1.3.6

Error Handling

Error handling for non-SOAP operations is different from error handling for SOAP operations. The SOAP
specification provides an error handling mechanism that is not present for non-SOAP operations. For a
SOAP operation, a fault is returned as a SOAP exception. For a non-SOAP request, the contents of the
SOAP fault are returned as an XML document. These SOAP fault documents are returned in situations
such as schema validation failures or when operation types are unrecognized.
In the following example, a SOAP fault document is returned from a schema validation failure in which
the AccountNumber element was incorrectly sent as the AccountNumberx element:
Example 3:

Error Handling

soapenv:Server
5: Schema validation failed for request.

5
Schema validation failed for request.

FedEx Web Services, Developer Guide 2016

Introduction

Expected element 'AccountNumber@http://fedex.com/ws/ship/v8' instead
of

'AccountNumberx@http://fedex.com/ws/ship/v8' here in element

clientDetail@http://fedex.com/ws/ship/v8

000000000

Expected element 'AccountNumber@http://fedex.com/ws/ship/v1' before
the end of the content in

element

ClientDetail@http://fedex.com/ws/ship/v8

000000000000000000
0000000

Validate
Validate_request
ValidateRequest
request-pipeline

Each reply must be checked for the Fault element to indicate failure in processing the message.
Note: Normal error processing still applies; this is an additional error check for incorrect syntax in XML documents

Keep in mind that if you use either the SOAP or non-SOAP version of FedEx Web Services, labels are
returned as Base64 encoded. To print shipping labels, you must decode labels before sending them to
your printer. For more information on Base64 decoding, see Create a Label.
Example 4:

Non-SOAP HTTP POST

The following HTTPS POST example is a valid working example. It is not guaranteed to work for all
programming languages, applications, and host systems:
POST /xml HTTP/1.0
Referrer: YourCompanyNameGoesHere
Host: ws.fedex.com

FedEx Web Services, Developer Guide 2016

Introduction
Port: 443
Accept: image/gif, image/jpeg, image/pjpeg, text/plain, text/html, */*
Content-Type: text/xml
Content-length: %d
Your FedEx Transaction

Each line is followed by one new line character except Content-length and the FedEx transaction. Two
new line characters follow the Content-length line. The FedEx transaction has no extra characters. The
Content-length line should have the length of the FedEx transaction in place of the %d variable.
Note: Port 443 must be opened for bi-directional communication on your firewall.

After formatting your non-SOAP transaction and placing it in a HTTP POST request, you will need to open
an SSL connection to the FedEx test server and send the request through FedEx by using your SSL
connection. Next, parse the HTTPS response to determine if there were any errors. Examine the HTTP
header to determine if any HTTP or Web Server errors were encountered. If you received a 200 status
code, parse the reply to determine if there were any processing problems.

1.3.7

Visual Basic Project Error

You may receive an error indicating that an element is not set, even after setting it in the code. When
you set a Boolean type element to true, you may also need to set the specified element to true.
Refer to FedEx Web Services Coding Best Practices Guidelines for more information.
For error messages, see Appendix O: Error Code Messages section of the FedEx Web Services,
Developer Guide.

1.4

Implementing FedEx Web Services

Before you begin implementing FedEx Web Services, note the following guidelines:


FedEx Web Services are designed to support any operating system and coding language.
Downloadable sample code is available in Java, C#, VB, .Net and PHP languages from the FedEx
Developer Resource Center Technical Resources.



Transactions submitted to FedEx using FedEx Web Services are required to have a minimum of 128bit encryption to complete the request.

1.5

Understanding the XML Schema

The XML schema defines the messages that you can use to access the FedEx services. You can create a
request that contains business data and other instructions before sending it to FedEx. FedEx replies with
a response that contains the data resulting from the instructions you sent in. The XML schema provides
a means for defining the structure, content, and semantics of XML documents.
An XML schema defines:


Elements and attributes that can appear in a document



Elements that are child elements



Order and number of child elements

FedEx Web Services, Developer Guide 2016

Introduction


Whether an element is empty or can include text



Data types, default values, and fixed values for elements and attributes

Some important facts about the XML schema:


Elements that contain sub-elements or carry attributes have complex types.



Elements that contain numbers (and strings, and dates, etc.), but do not contain any sub-elements,
have simple types. Some elements have attributes. Attributes always have simple types.



Complex types in the instance document, and some of the simple types, are defined in the schema
associated with a FedEx Web Service. Other simple types are defined as part of XML schema's
repertoire of built-in simple types.



XML schema built-in simple types are prefixed by "xs:" which is associated with the XML schema
namespace through the declaration xmlns:xs="http://www.w3.org/2001// XMLSchema", displayed in
the schema element.



The same prefix, and the same association, are also part of the names of built-in simple types, such
as xs:string. This association identifies the elements and simple types as belonging to the vocabulary
of the XML schema language, rather than the vocabulary of the schema author.

1.5.1

Guide to the XML Schema

The XML schema for each WSDL provides details about the structure, content, and semantics of the
request XML document sent to a FedEx Web Service and the XML document returned by that FedEx
Web Service.
The top of each service schema includes:


Schema location and schema file name that ends in an ".xsd" suffix.



Alphabetical listing of complex types for the documented service.



Alphabetical listing of schema simple types for the documented service.



Input or request data type for the documented service.



Output or reply data type for the documented service.

The remainder of the service schema contains tables of information about each element, complex type,
and simple type. Each table consists of some or all of the following sections: diagram, namespace,
children, type, properties, used by, facets, and source.

1.5.2

XML Schema Diagrams

XML schema diagrams describe the elements (usually associated with a request or reply), complex
types, and simple types that make up the WSDL. This table illustrates the relationships and behavior of
elements and types.

FedEx Web Services, Developer Guide 2016

Introduction
Table 2. XML Schema Diagrams
Schema Diagram

Description
Diagrams of a parent element, such as
DeleteShipmentRequest, include
connections to the child elements. Child
elements can be simple or complex types.
A child element connected with a solid line
and surrounded by a box with a solid
border represents a required type, such as
ClientDetail.
A child element connected by a dotted line
and surrounded by a dotted border
represents an optional type, such as
TransactionDetail.
Types that are documented include the
documentation directly below the box.
All children are listed by name below the
diagram.

A box with a single solid border represents
a single element that is required.
The type can be simple or complex.

A box with a dotted border indicates a
single element that is optional.
The type can be simple or complex.

FedEx Web Services, Developer Guide 2016

Introduction

Schema Diagram

Description
A layered box represents a multiple
occurrence element. A solid line represents
a required multiple occurrence element.
The number of possible occurrences
appears below the box, as depicted by the
ProcessShipmentReply.
An unbounded number of occurrences is
represented by the infinity ¥ symbol
(maxOccurs="unbounded"), as depicted by
Notifications.
A layered box with a dotted border
represents an optional multiple occurrence
type (minOccurs="0"), such as ErrorLabels.
Note: An element that is defined as
minOccurs="0" may be required for some
calls. A standard type such as "JobId"
indicates "string" below the element name.

A FedEx specific type such as "ErrorLabels"
indicates the FedEx type below the
element name.

1.5.3

Required Elements

Most requests to FedEx require the following complex elements:
Note: These elements are common to most FedEx Web Services (see the table below to learn which WSDLs need
which common elements) and are not documented service by service.

FedEx Web Services, Developer Guide 2016

Introduction
Table 3. Required Elements
Element

Description

WebAuthenticationDetail

The WebAuthenticationDetail element includes user credentials
issued by FedEx so that your transactions are recognized by the
FedEx back-end systems.
The descriptive data to be used in authentication of the sender's
identity and right to use FedEx Web Services.

WebAuthenticationDetail
\ParentCredential

The value for the primary authentication credential for a specific
account.
Note: This element is available only for Compatible Providers.

WebAuthenticationDetail
\UserCredential

Credential used to authenticate a specific account. It consists of
two-part authentication string, Key and Password, which is used
to verify shipper identity. This value is provided by FedEx after
registration.

WebAuthenticationCredential

Two-part authentication string used to verify shipper identity.

WebAuthenticationCredential
\Key

Unique identifier assigned to each customer as part of their
authentication credentials.

WebAuthenticationCredential
\Password

Second part of the authentication credential which has a direct
relationship with the credential key.

Client Details

The ClientDetail element is required for all services that need
your account number and meter number. Requirements are


A standard type such as “string” appears in black text
below element name.



A FedEx specific type such as “Address” appears in red
text below the element name.

ClientDetail/AccountNumber

The element indicates your FedEx account number.

ClientDetail/MeterNumber

The associated meter number for your FedEx account number.
Maximum of 9 characters.

Note: FedEx Web Services uses four-factor authentication. Ensure that you send the account number that was used
to generate the authentication credentials (key and password) along with the meter number for the transaction
to be successfully authenticated.
Note: When building a web-based application for shipping that will be used at multiple locations, include the local
FedEx Express account and meter in the ClientDetail section of the ship transaction. Create a database to hold
multiple account and meter numbers for the shipping locations

FedEx Web Services, Developer Guide 2016

Introduction
Table 4 Reply/HighestSeverity/Notification
Element

Description

Reply/HighestSeverity/Notification

This element includes the descriptive data detailing the status of
a submitted transaction. It includes the severity of the
notification, which indicates success or failure or some other
information about the request.
Valid values are:


SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to
you about your transaction.



WARNING — Additional information that you need to know
about your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction.

TransactionDetail: The TransactionDetail element is optional for all transactions. However, if you want
to identify associated request and reply transactions, use this element.
Table 5. TransactionDetail Elements
Element

Description

TransactionDetail/CustomerTransactionId

Maximum of 40 characters allowed. This element allows
you to assign a unique identifier to your transaction. This
element is returned in the reply and helps you match
requests to replies.

VersionId: The VersionId element is required and uploads the WSDL version number to FedEx. FedEx
provides the latest version number for the service you are using. This number should be updated when
you implement a new version of the service.
Table 6. VersionId Elements
Element

Description

ServiceId

Identifies a system or sub-system which performs an operation. For a list of
available service IDs, refer to Appendix AE: Web Services and Service IDs.

Major

Identifies the service business level.

Intermediate

Identifies the service interface level.

Minor

Identifies the service code level.

FedEx Web Services, Developer Guide 2016

Introduction
Sender Information: Your shipper information is required for all shipping transactions:
Table 7. Sender Information
Element

Description

AccountNumber

If you include this element in the ship request, this entry overrides the
account number in the ClientDetail element.

TIN

Tax Identification Number — this information is required for
international shipments only.
Note: TIN number for the shipper is not mandatory when shipping from Europe,
Middle East & Africa (EMEA).

Contact

Address

Residential

The Contact element includes:


ContactId



PersonName



Title



CompanyName



PhoneNumber



PhoneExtension



TollFreePhoneNumber



PagerNumber



FaxNumber



EmailAddress

This element includes:


StreetLines: two StreetLines elements are allowed.



City



StateOrProvinceCode: required if your shipper address is in the
U.S. or Canada. See Appendix B and Appendix C



PostalCode: required.



UrbanizationCode: may be required if your shipper address is in
Puerto Rico.



CountryCode: required. See Appendix A



CountryName: required

Required if your shipper address is considered a residential location. If
you are unsure, use the Address Validation Service to check your
address.

FedEx Web Services, Developer Guide 2016

Introduction

Element

Description

Reply/HighestSeverity
/Notification

Includes the descriptive data detailing the status of a submitted
transaction. Includes the severity of the notification, which indicates
success or failure or some other information about the request.
Valid values are:

1.5.4



SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know
about your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction.

WSDL and XML Schema

You can download the WSDL or XML Schema (XSD) for each service by following these steps:
1. Go to the FedEx Developer Resource Center (DRC). Log in with your FedEx.com username and
password. If you do not have one, then click 'Register Now' link. Fill out the form for your DRC
username and password.
2. From the left navigation area of the page, click the link 'FedEx Web Services'.
3. Click the link 'Move to documentation' under 'Documentation and Downloads'.
4. Click on either the Standard Services tab or the Advanced Services tab on the WSDL Downloads
component to find the functionality you are interested in.
5. Click on either the WSDL or XSD link where it says 'Download WSDL or XSD' next to the download
arrow of the appropriate service.
Note: You can download the schema in either WSDL or XML format, depending on which link you choose. Also,
every service has its own WSDL guide that contains more detailed information on that specific service then
the developer guide. Use both guides as best practice.

1.6

Implementation Process

Planning your integration and organizing your application data to address your shipping needs can
sometimes take more time than the actual implementation of the integration. FedEx Web Services
conform to industry standards and are compatible with a comprehensive array of developers’ tools. This
ensures the fastest time-to-market with maximum flexibility to integrate FedEx transactions and
information into your applications. FedEx WSDLs are fully interoperable with any product or developer’s
tool that also conforms to the WS-I Basic Profile. For details, see ws-i.org/Profiles/BasicProfile-1.12004-08-24.
To obtain FedEx Web Services and begin integrating with an application, you need to access
documentation, sample code, and sample service requests and replies with the WSDLs from the FedEx
Developer Resource Center. Also, obtain a test meter number to engage in real-time online testing in the
FedEx hosted test environment.
FedEx Web Services, Developer Guide 2016

Introduction
You will need a Test Key, Test Password, Test Account, and Test Meter Number, all of which can be
obtained at the Developer Resource Center.
Note: Not all services are available outside the U.S.

1.6.1

Testing

FedEx supplies a complete online operating environment with which to test your applications against live
FedEx servers. To execute test interactions, you must first include a test account number, test meter
number, authentication key, and password in your code. These credentials are provided to registered
developers at the FedEx Developer Resource Center.
Production credentials can be obtained prior to the certification process. Advanced services are not
automatically enabled, but standard services are enabled. For more information on support from FedEx,
refer to Preproduction Assistance.

1.6.2

Preproduction Assistance

Preproduction assistance is available via the FedEx Web Integrated Solutions Consultation (WISC) team.
If you are in the preproduction stages of implementing a FedEx web integrated solution and would like to
speak with a FedEx integration consultant who can assist you in understanding FedEx Web Services,
contact your FedEx sales executive or technical support at 1.877.339.2774 Monday thru Friday, 7 a.m. to
9 p.m. and Saturday 9 a.m. to 3 p.m. (CST). Both your FedEx sales executive and technical support can
request a WISC team member to contact you within 3 business days.
Corporate developers may find that solutions to their needs have already been implemented by a
software vendor that is FedEx® Compatible. If improved time-to-market, cost containment, or specialized
knowledge is needed, corporate development planners may want to review the available third-party
solutions. To see a list of the solutions provided by the FedEx Compatible providers, go to the available
FedEx Compatible Solutions page at http://www.fedex.com/us/compatible/.

1.6.3

Certification

Certification is the process of ensuring that your implementation meets a number of requirements for
safe, secure, and effective operation of your solution in the FedEx production environment. Certification
requirements differ based on whether you are a corporate or commercial developer, and whether you are
implementing using the advanced or standard services. The FedEx Web Integrated Solutions
Consultation (WISC) team member assigned to support you will assist you with the certification process.
Note: Certification is not required for any Standard Services.

1.6.4

Go To Production

Once an application has passed certification, the developer must replace the test credentials with the
production credentials issued by FedEx. The application connection is then directed to the production
servers, and the application is live.

1.6.5

Requirements for Corporate and Non-Commercial Developers

There are some differences in how support is provided and in the approvals required to go into
production that depend on whether you are creating an application for use by your own company or if
you are planning to resell your solution to others.

FedEx Web Services, Developer Guide 2016

Introduction

1.6.6

Requirements and Resources for Corporate Developers

Corporate developers are typically part of a dedicated development team at a single company. This
category also includes third-party developers (consultants) hired by the company to work on its behalf. In
all cases, the integration will be used by the company itself and will not be resold or distributed outside
of its own footprint. In this situation, FedEx can support the customer directly.
Table 8. Requirements and Resources for Corporate Developers
Requirements and Resources for Corporate Developers
Must be accepted into the FedEx® Compatible Program.

Certification needed for implementations using standard services.

Certification needed for implementations using advanced services.

Yes

Certification assistance.

Yes (WISC Team)

FedEx supports the customer directly.

Yes

1.6.7

Requirements for Consultants

Consultants developing on behalf of a corporate customer must ensure that their client provides their
account information and a signed End User License Agreement (EULA) to FedEx to obtain a production
test meter.

1.6.8

Requirements and Resources for Commercial Developers

Commercial developers create solutions with the intent of distributing and/or reselling them to their
customers. Fixed. Because they are deployed in a variety of situations, commercial integrations generally
require a higher attention to detail. Commercial developers are responsible for supporting their products
for their customers. FedEx has a dedicated team of professionals to help developers commercialize their
products and to coordinate the three-way interplay between the developer, the end customer, and
FedEx.
Table 9. Requirements and Resources for Commercial Developers
Requirements and Resources for Commercial Developers
Must be accepted into the FedEx Compatible Program.

Yes (Required)

Certification needed for implementations using standard services.

Certification needed for implementations using advanced services.

Yes

Certification assistance.

Yes (via FedEx Compatible)

FedEx supports the customer directly.

FedEx supports the commercial developer’s customer.

Indirectly

FedEx Web Services, Developer Guide 2016

Introduction
If you are a commercial developer interested in becoming a FedEx Compatible provider, go to
http://www.fedex.com/compatible for more information about the FedEx Compatible Program.

1.6.9

URL Errors

If a VB.NET or C# project still sends transactions to the test server after changing the URL in the WSDLs
to print to production, perform the following:


Make sure permissions are already activated in the production environment.



Copy the WSDL files to a different folder.



Follow the directions on changing the new WSDL files to point to production, as described in the
FedEx Developer Resource Center in the “Move to Production” topic.



Remove existing web services references from your project that point to old WSDLs containing the
URLs to the test environment.



Create new web references that point to the modified WSDLs. Use the same names as the old
references.



Compile and test the project. Your new production credentials should work for standard web
services, such as rating or tracking without extra permissions. Advanced web services require
permissions to be active before they will work. Test keys will no longer work with production server
addresses.

1.7

Samples

Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded
following these steps:
1. Go to the FedEx Developer Resource Center (DRC) at www.fedex.com/developer. Log in with your
FedEx.com username and password. If you do not have one, then click Register Now link. Fill out
the form for your DRC username and password.
2. From the left navigation area of the page, click the link 'FedEx Web Services'.
3. Click the link 'Move to documentation' under 'Documentation and Downloads'.
4. Click on either the Standard Services tab or the Advanced Services on the WSDL Downloads
component tab to find the functionality you are interested in.
5. Use the 'Download code in…' drop-down to select a programming language for the sample code of
the WSDL that has the functionality you need and check the 'Include Documentation (PDF)' checkbox under the drop-down in order to download the guide for that WSDL. Then select the gray 'Go'
button beside the programming language you selected on the drop-down.
6. In the light gray margin near the name of the functionality (e.g. Ship Service, Rate Service, etc.),
there is a link for the WSDL. Click the link to download the desired WSDL.
7. If you wish to download all of the WSDLs' sample code, sample transactions, and the Developer
Guide, at the top of the WSDL component, click the programming language of your choice on the
drop-down next to 'DOWNLOAD ALL' and check the 'Include Documentation (PDF)' check-box. Then
select the purple 'Download' button.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Use the Address Validation Service (AVS) to validate or complete recipient addresses. This service
validates recipient addresses before you can ship packages, provides descriptive error details and
corrected options for invalid addresses, and/or determines whether an address is business or residential
to increase the accuracy of courtesy rate quotes.
Note: Do not use this service to determine the deliver-ability of an address. FedEx does offer delivery service to
every valid address. However, FedEx does not deliver to PO Boxes (except via SmartPost).

2.1

Address Validation Request

The Address Validation WSDL AddressValidationRequest allows you to validate recipient address
information before you ship a package. Correct addresses on the shipping label will help eliminate
delivery delays and additional service fees.
Note:



The Address Validation Service is an advanced service and must be enabled by FedEx Customer Support for
production use. Contact your FedEx account executive for more information.



Address resolution rates vary by country.

Table 10. Countries that support Address Validation
Countries that supports Address Validation
Antilles

Italy

Argentina

Jamaica

Aruba

Malaysia

Australia

Mexico

Austria

Netherlands

Bahamas

Netherlands

Barbados

New Zealand

Belgium

Norway

Bermuda

Panama

Brazil

Peru

Canada

Portugal

Cayman Islands

Singapore

Chile

South Africa

FedEx Web Services, Developer Guide 2016

Address Validation Service
Countries that supports Address Validation
Columbia

Spain

Costa Rica

Sweden

Czech Republic

Switzerland

Denmark

Trinadad and Tobago

Dominican Republic

United Kingdom

Estonia

United States

Finland

Uruguay

France

Venezuela

Germany

Virgin Islands

Greece
Guatemala
Hong Kong
Use the Address Validation request to perform the following:


Complete incomplete recipient addresses. For example the AVS helps in completing incomplete
recipient address information like zip code, but not missing apartment number. In some cases, AVS
may be able to add missing information, depending on the verification of the provided information
against reference data. AVS cannot add missing secondary information (i.e. apartment or suite) at
this time.



Correct invalid recipient addresses.



Determine whether an address is business or residential to increase the accuracy of courtesy rate
quotes. Applies to U.S. and Canada addresses only.



Confirm the validity and completeness of addresses in many countries in these regions - U.S.,
Canada, Latin America, Europe and Middle East and Asia Pacific. You are now able to validate
domestic and international address information in the following countries before shipping a package,
eliminating unnecessary delivery delays and additional service fees.

Note: The information returned by AddressValidationRequest is for suggested use only.
Legal Disclaimer:
The data provided herein is FedEx proprietary and confidential information, provided as a courtesy at your request.
No part of this data may be distributed or disclosed in any form to any third party without the written permission of
FedEx. It reflects the current FedEx address-level business/residential classification in the FedEx delivery address
database, and is subject to change. In furnishing this information, FedEx does not guarantee its present or future
accuracy, and does not guarantee that packages shipped to these addresses will be invoiced according to the
business/residential classification provided herein. Providing this information shall not be deemed to alter the terms
of the relationship between the parties. See the FedEx Service Guide and any applicable account pricing agreement
for terms and conditions governing FedEx shipping and charges.

FedEx Web Services, Developer Guide 2016

Address Validation Service

2.2

Address Validation Service Details

The followings service details apply to Address Validation:


Provides street level matches.



Receives monthly updates to its address database.



Checks addresses in several countries in these regions - U.S., Canada, Latin America, Europe and
Middle East and Asia Pacific.



Can distinguish between business and residential addresses (for U.S. and Canada only).



Does not match addresses based upon individual/personal names.



FedEx does not normally deliver to P.O. box addresses for U.S. or U.S. inbound shipments.
However, FedEx may deliver to post office boxes in some rural locations if the P.O. box is associated
with an address. You may also use P.O. box addresses for certain international locations, including
shipments to Puerto Rico, but you must include a valid phone, fax or telex number on the label.



Up to 100 addresses can be checked in one Web Service request.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

2.3

How FedEx Address Validation Works

The Address Validation Service performs the following tasks:


Checks if street, city, state or province, or postal code is entered. In some cases, AVS may be able to
add missing information, depending on the verification of the provided information against reference
data. AVS cannot add missing secondary information (i.e. apartment or suite) at this time.



Checks if the street number is within a valid range for the street entered.



Informs you when an address cannot be resolved (address verified against reference data) based on
the street number, street name, city, state or province, or postal code entered.



Returns "Attibutes" concerning aspects of the address. The attributes provide details about what may
be the reason for an address to be unresolved. Refer to Table 14 for list of attributes

2.4

Tips on Getting Accurate Address Matches



Use correct spacing: Make sure spaces are placed correctly and avoid unnecessary spaces.



Use correct spelling: Eliminate spelling and typographic errors. Make sure you have the correct
usage of the number zero (0) and letter O.



Avoid special characters: Refrain from using special characters not required for the address, such as
periods after abbreviations (Ave vs. Ave.)



Provide additional address and street information: Providing additional address information can
increase the accuracy of address results.
For example:
o
o

Building or house number such as 1, 1A, One
Street name such as Main, George Washington, 42nd

FedEx Web Services, Developer Guide 2016

Address Validation Service
o

Street Suffix such as Road, Avenue, Rd, Ave



Enter city, state/province and postal code: Providing all address information will increase the
accuracy of your results. The ZIP+4 portion of the postal code is not necessary to check an address.



Use correct abbreviations: The United States Postal Service and postal authorities in other countries
define standard abbreviations for state/province, street suffix, and apartment/unit designations. A
nonstandard abbreviation may cause poor search results. If you are unsure about an abbreviation, do
not use it.

2.5

Address Results

Urbanization (Puerto Rico only): This descriptor, commonly used in urban areas of Puerto Rico, is an
important part of the address format as it describes the location of a given street. In Puerto Rico,
repeated street names and address number ranges can be found within the same postal code. These
streets can have the same house number ranges. In these cases, the urbanization name is needed to
correctly identify the location of a particular address.
For example: Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212

2.6

Address Checking Process

Address Validation Service (AVS) is the new central database for address-related information across
FedEx. Address Validation returns the "best" address in the response—one that has been validated
against reference data. This is only true for "Resolved" addresses.
Address Validation Service rules:


If too many changes are required, AVS will not be able to find a match to reference data. In this
situation, AVS will return a normalized form of the raw address input.



If just a zip code is provided, Address Validation Service returns 'unknown' for the
business/residential classification.



Four address classification values may be returned--Business, Residential, Mixed or Unknown.

2.7

Address Classification

Address Validation uses reference data to determine the classification of a given address. The
classification is calculated as part of the address validation process. The classification for a functional
address is calculated independently of the address validation process and is based on feedback by
operational personnel, with commercial data sources used for confirmation only.
Address Validation has only four possible classifications for addresses: unknown, business, residential
and mixed. All addresses begin with an “unknown” classification and stay that way until Address
Validation business rules determine that their classifications should change. A location only gets a
“mixed” classification if it is a multi-tenant based address and contains both business and residential
units.

2.7.1

Residential Address Classification

Residential address relates to a home or private residence, including locations where a business is
operated from the home.
FedEx Web Services, Developer Guide 2016

Address Validation Service

2.7.2

Address Matching Results

Table 11. Address Matching Results
Address Matching Results

Resolved

Not Resolved

Country Not Supported

Country Unknown

Not Processed

Blank

2.7.3

Description
The input address was matched with an acceptable level of
confidence to a record in a reference data set. Note that the level to
which an address has been resolved is described separately by other
flags and indicators. See notes.
The input address was not matched to a reference data set, but it
was parsed and normalized (standard abbreviations applied).
Address Validation Service does not currently include reference data
to support the country of the input address. The raw address is
stored and a Address Validation Service ID is assigned, but no
additional processing is applied.
The country of the address could not be determined. The raw
address is stored and a Address Validation Service ID is assigned,
but no additional processing is applied.
The address could not be processed because of internal errors. The
raw address is stored and a Address Validation Service ID is
assigned, but no additional processing is applied.
The input address in the request contained no data (blank). No data
will be stored in Address Validation Service and no Address
Validation Service ID will be assigned.

Address Formats



RAW: Address information provided by the user. The Raw address is returned when the Address
Validation Service does not support the country for address validation.



NORMALIZED: A formatted version of the address where elements are parsed and standard
abbreviations are applied. The Normalized address is returned when the Address Validation Service
supports a country for address validation, but cannot match the address against reference data.
Reference data include postal data (and map data, for the US only).



STANDARDIZED: A formatted and validated version of the address. The standardized address is
returned when the Address Validation Service can match the address against reference data. Note
that the Address Validation Service may make slight changes to the address in order to find a match.

2.8

Address Validation Coding Details

The following information is the minimum required to check an address:


Address with at least 1 address line



City



State/Province (if applicable)



Postal (if country is postal aware)



Country

FedEx Web Services, Developer Guide 2016

Address Validation Service

2.8.1

AddressValidationRequest Elements

Table 12. AddressValidationRequest Elements
Element

Description

AddressValidationRequest

Validation: Given a raw address the AddressValidation
system responds with all of the information it can
determine about that address including the Business
Residential classification that was in effect at the time,
including information on how the classification was
calculated.

AddressValidationRequest
/InEffectAsOfTimestamp

Optional
DateTime field used to request the data as of this point in
time. This defaults to current date time (of the
AddressValidation System). This is useful because the
AddressValidation database is dynamic and stores historical
data. Characteristics such as Business/Residential indicator
may change over time. Eg. 2013-01-11 T 07:52:56

AddressToValidate

Specify the address to validate.

AddressToValidate
/ClientReferenceId

A reference ID provided by the client.

AddressToValidate
/Contact

The descriptive data for a point-of-contact person.

Contact
/ContactId

Optional.
Client provided identifier corresponding to this contact
information.

Contact
/PersonName

Optional.
Identifies the contact person's name.

Contact
/Title

Optional.
Specifies the contact person's title. The title of the person
may change from time to time but the AV service will not
validate the change of titles.

Contact
/CompanyName

Optional.
Identifies the company this contact is associated with.

Contact
/PhoneNumber

Optional.
Identifies the phone number associated with this contact.

Contact
/PhoneExtension

Optional.
Identifies the phone extension associated with this contact.

Contact
/TollFreePhoneNumber

Optional.
Identifies a toll free number, if any, associated with this
contact.

Contact
/PagerNumber

Optional.
Identifies the pager number associated with this contact.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Element

Description

Contact
/FaxNumber

Optional.
Identifies the fax number associated with this contact.

Contact
/EMailAddress

Optional.
Identifies the email address associated with this contact.

AddressToValidate
/Address

Descriptive data for a physical location. May be used as an
actual physical address (place to which one could go), or as
a container of "address parts" which should be handled as a
unit (such as a city-state-ZIP combination within the US).
Combination of number, street name, etc. At least one line
is required for a valid physical address; empty lines should
not be included.
Required.
Specify the Name of city, town, etc.
Required.
Identifying abbreviation for US state, Canada province, etc.
Format and presence of this field will vary, depending on
country.
Required.
Identification of a region (usually small) for mail/package
delivery. Format and presence of this field will vary,
depending on country.
Optional.
Relevant only to addresses in Puerto Rico.
The two-letter code used to identify a country.

Address
/StreetLines (0 to 4 repetitions)
Address
/City
Address
/StateOrProvinceCode

Address
/PostalCode

Address
/UrbanizationCode
Address
/CountryCode
Address
/CountryName
Address
/Residential

2.8.2

Optional.
Specify the complete name of a country instead of
abbreviations.
Optional.
Indicates whether this address residential (as opposed to
commercial).

AddressValidationReply Elements

Any error conditions or address-checking issues are returned in the Address Validation reply. The
following table describes Address Validation Reply elements:
Table 13. AddressValidationReply Elements
Element

Description

ReplyTimestamp

Date and time of Reply

AddressValidationResult

Results of Address Validation request

AddressValidationResult
/ClientReferenceId

The client reference ID for the validated address.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Element

Description

AddressValidationResult
/State

Specify the degree to which service was able to simplify the
address provided, as per USPS standards and match it to an
address already in the internal FedEx address repository.

AddressValidationResult
/FedExAddressClassificationType

Specfies the classification type of a FedEx address.
Valid values:


NORMALIZED (It is returned when the Address Validation
Service supports a country for address validation, but
cannot match the address against reference data.
Reference data include postal data (and map data, for the
US only)).



RAW (Information is provided by the user and it is returned
when the Address Validation Service does not support the
country for address validation.)



STANDARDIZED (The standardized address is returned
when the Address Validation Service can match the
address against reference data.)

Note that the Address Validation Service may make slight changes to the
address in order to find a match.



UNKNOWN (If just a zip code is provided, Address
Validation Service returns 'unknown' for the
business/residential classification)



BUSINESS



RESIDENTIAL



MIXED (If it is a multi-tenant based address and contains
both business and residential units.)

AddressValidationResult
/EffectiveAddress

EffectiveAddress
/StreetLines (0 to 4 repetitions)

Combination of number, street name, etc. At least one line is
required for a valid physical address; empty lines should not be
included.
Specify the name of city, town, etc.

EffectiveAddress/City
EffectiveAddress/StateOrProvinceCode

EffectiveAddress/PostalCode

EffectiveAddress/UrbanizationCode

Identifying abbreviation for US state, Canada province, etc.
Format and presence of this field will vary, depending on
country.
Identification of a region (usually small) for mail/package
delivery. Format and presence of this field will vary, depending
on country.
Relevant only to addresses in Puerto Rico.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Element

Description

EffectiveAddress/CountryCode

The two-letter code used to identify a country.

EffectiveAddress/CountryName

The fully spelt out name of a country.

EffectiveAddress/Residential

Indicates whether this address residential (as opposed to
commercial).

EffectiveAddress/shareId
AddressValidationResult
/ParsedAddressPartsDetail
ParsedAddressPartsDetail
/ParsedPostalCode
ParsedAddressPartsDetail
/ParsedStreetLineDetail
ParsedStreetLineDetail
/houseNumber
ParsedStreetLineDetail
/preStreetType
ParsedStreetLineDetail
/leadingDirectional
ParsedStreetLineDetail
/streetName
ParsedStreetLineDetail
/streetSuffix
ParsedStreetLineDetail
/trailingDirectional
ParsedStreetLineDetail
/unitLabel
ParsedStreetLineDetail
/unitNumber
ParsedStreetLineDetail
/deliveryStation
deliveryStationNumber
ParsedStreetLineDetail/RuralRoute

The postal code specified in a form that is supported by USPS
as base, secondary and tertiary.
The content of all streetlines parsed into individual street line
components
House Number resulting from standardization/normalization
process, when relevant
Pre Street Type resulting from
standardization/normalization process, when relevant
Leading Directional resulting from
standardization/normalization process, when relevant
Street Name resulting from
standardization/normalization process, when relevant
Street Suffix resulting from
standardization/normalization process, when relevant
Trailing Directional resulting from
standardization/normalization process, when relevant
Unit Label resulting from
standardization/normalization process, when relevant
Unit Number resulting from
standardization/normalization process, when relevant
DeliveryStation resulting from standardization/normalization
process, when relevant
DeliveryStation Number resulting from
standardization/normalization process, when relevant
Rural Route (RR) / Highway Contract (HC)

ParsedStreetLineDetail/PoBox

PO Box resulting from standardization/normalization
process, when relevant

ParsedStreetLineDetail/Building

Building name

ParsedStreetLineDetai
/Organization
AddressValidationResult
/AddressAttribute

Specify additional information about the address processed by
the system as a key-value pair.

AddressAttribute/Name

Specify the key for the address attribute.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Element

Description

AddressAttribute/Value

The value for the key for address attribute

2.8.3

Address Attributes

Table 14: List of Address Attributes
Attribute Names

Description

city

City (Locality1) resulting from standardization/normalization process,
when relevant

Locality2

Locality2 resulting from standardization/normalization process, when
relevant

Locality3

Locality3 resulting from standardization/normalization process, when
relevant

stateProvince

State (Province) resulting from standardization/normalization
process, when relevant

stateProvince2

Province2 resulting from standardization/normalization process,
when relevant

postalText

Formatted Postal Code resulting from standardization/ normalization
process, when relevant. For US this is the complete, formatted
postal code (including hyphens) Internationally this is the complete,
formatted postal code (following country-specific rules). For
international addresses the postText value is the same as the
PostalCodeBase value.
Country resulting from standardization/normalization process. When
no country is provided in the Raw, SHARE may insert a country
(Country Resolver Logic) or leave blank.
ID of Standardized Address stanza that is related to this normalized
address (if applicable) Note: This field is currently being populated
via a crawler (started Oct 2014)
Date/time when standardization/Normalized Address stanza was
created and/or updated via maintenance.

country

parentId

effDate
lastRefDate

Date/time when standardization/Normalized Address was last
referenced.
Note: This is for internal use only as is not updated real-time (lag of 30-90
days can be expected).

shareId

Unique key for address. Points to best version of address.

operationalAddressId

Operational address ID for best address. Includes address ID +
NULL

effectiveDateTime

Date/time when SHARE ID/Operational Address stanza was created.
Note: If the address stanza is deleted (i.e. during a purge) and then
reprocessed, the effective date will reflect the date/time that the

FedEx Web Services, Developer Guide 2016

Address Validation Service

Attribute Names

Description
reprocessing occurred).

addressType

Operational address type (STANDARDIZED, NORMALIZED, or RAW)

addressState

Operational address state (RESOLVED, NOT_RESOLVED,
NOT_PROCESSED)

addressId

Address ID for standardized/normalized/operational address

line (up to four lines)

Address lines resulting from standardization/normalization process,
when relevant

AddressType

Indicates type of address stanze (STANDARDIZED/NORMALIZED)

Inserted

Indicates if Standardized/Normalized Address Stanza was inserted
into SHARE database

BuildingValidated

Indicates if the Building was validated against reference data.

Confidence

Calculated value indicating the amount of change that must be
introduced to be able to standardize the address. For US, the
calculated value comes from a third-party vendor (currently, but
could change). Internationally, SHARE calculates this value.
Data vintage used to evaluate the normalized address during the
attempt to standardize

DataVintage
DPV

InvalidSuiteNumber

Matched

MissingOrAmbiguousDirectional



DPV=Delivery Point Valid.



Indicator translated from values provided by the USPS that
identify the validity of a postal delivery address.



Provided for US addresses only that can be standardized
against Postal Data.



Not provided for US Geo Validated addresses



TRUE: Suite information was provided and was either incorrect,
or was provided for an address that was not recognized as
requiring secondary information



FALSE: Suite information was not provided and was not
needed, or provided suite information was valid



TRUE = Matches to a record in the SHARE DB

 FALSE = Does not match
Flag only returned when address is not resolved.


TRUE: Address is missing a required leading or trailing
directional



FALSE: Address is NOT missing a required leading or trailing
directional.

FedEx Web Services, Developer Guide 2016

Address Validation Service

Attribute Names
MultipleMatches

Description


For US Addresses
o



TRUE: More than one potential match to reference data is available,
usually due to a simple difference, such as a leading directional. The
address remains not_resolved because there is not a systematic
way to determine which candidate is appropriate.
FALSE: No matches (not resolved), or a single match to reference
data exists (resolved).

For International Addresses
o

TRUE: More than one potential match to reference data is available
(not specific to directional. It could be that another required address
element is missing)
FALSE: No matches (not resolved), or a single match to reference
data exists (resolved).

OrganizationValidated

Indicates if the Organization was validated against reference data.

PostalValidated

Indicates if the PostalCode was validated against reference data. For
US addresses, this is only returned when address cannot be
standardized. Always returned for international addresses
Indicates if address can be standardized (resolved)

Resolved
RRConversion

StreetValidated
StreetRangeValidated

SuiteRequiredButMissing

SuiteNotValidated

Indicates if a Rural Route conversion was applied to the address
during standardization. This flag applies to Canadian and International
addresses only. There is a similar flag (standardized.status.name =
RRConversion)associated with the standardized address that applies
to US addresses.
Returned for Canada and Generic Resolver


TRUE: House number and street were validated against a range
of house numbers for that street provided in the reference data



FALSE: House number and street were not validated



TRUE: indicates that an input address was resolved to a
building base address and that a suite or unit number is
required to achieve a more exact match, but this secondary
address information is missing from the input address.



FALSE: Indicates that a suite was either not needed and not
provided, or was provided and was valid



TRUE indicates:
o
o
o



input address contains suite information
reference data is available and has confirmed that this address is a
building base
reference data is not available to validate the suite information

FALSE indicates either:
o

FedEx Web Services, Developer Guide 2016

Suite information was not provided as input

Address Validation Service

Attribute Names

Description
o

ValidlyFormed

Zip4Match

Zip11Match

AddressPrecision



TRUE indicates that sufficient information (the minimal
elements needed to determine that the address meets the
criteria of at least one address precision) has been provided to
attempt to validate the address



FALSE indicates that insufficient information has been provided
to attempt to validate the address



TRUE indicates that the input address was resolved to a
standardized address based upon at least a ZIP+4 match.



FALSE indicates that the address was not resolved to a
standardized address based upon at least ZIP+4 match. (US
Only)



TRUE indicates that the input address was resolved to a
standardized address based upon a match at the postal barcode
level (i.e. Zip-11 match). This is the highest level of postal code
validation. All addresses resolved with the ZIP-11 Match flag
set will also have the ZIP-4 Match flag set.



FALSE indicates that the input address was not resolved to a
standardized address based upon Zip 11match. (US Only)



Indicates the depth/precision of the address.



Valid values are:
o
o

DataVintage
EncompassingZIP

SplitZIP

UniqueZIP

Suite information was provided and reference data is available to
validate the suite information

MULTI_TENTANT_UNIT indicates that the address has valid
secondary information.
MULTI_TENANT_BASE indicates that the address is a valid multi
tenant location but secondary information either was not provided
or could not be validated.
STREET_ADDRESS indicates that the location is not a valid multi
tenant location.

Month and year of the reference data that was used to identify the
address


TRUE indicates that the current address’ zip code encompasses
other zip codes



FALSE indicates that the current address' zip code does not
encompass other zip codes. (US only)



TRUE when the address comes under a new ZIP code that did
not previously exist.



FALSE when the address does not come under a new ZIP code
that did not previously exist.



TRUE indicates that the postal code of the address is unique for
a specific postal customer address. The ZIP may apply to a

FedEx Web Services, Developer Guide 2016

Address Validation Service

Attribute Names

Description
single unit or floor within a building, to an entire building, or to
an institution or corporate campus.


InterpolatedStreetAddress

Intersection

FALSE indicates the the postal code of the address is not
unique for a specific postal customer address.
TRUE indicates that the house number of the address is valid within
a known range of street numbers, but that the existence of the
specific street number could not be confirmed. This usually occurs
when postal data can’t confirm the address and mapping data is
used instead. The house number of the address is included within
the matched range, but the reference data does not include the
point level address data required to validate that the input street
number actually exists within the matched
range.
TRUE indicates that the address is an intersection. FALSE indicates
that the address is not an intersection.

MatchSource
MultiUnitBase

POBox

POBoxOnlyZIP



TRUE indicates that an input address was resolved to a
standardized address for the base address of a multi-unit
building.



FALSE indicates that the address was not resolved to a
standardized address for the base address of a multi-unit
building.



TRUE indicates that the input address was recognized as a PO
Box address.



FALSE indicates that the input address was not recognized as a
PO Box address.



TRUE indicates that USPS considers this ZIP as a PO Box-only
postal code. This means that USPS does not deliver to
individual street addresses in the postal code. Valid street
addresses may exist in the postal code, but they cannot be
validated by the USPS reference data.


PostalDataSource

FALSE indicates that the USPS does not consider this ZIP as a
PO Box only postal code. (US only)
Lists the postal data source for international address validation.

ResolutionMethod

Indicates type of resolution method utilized to resolve the address.

RRConversion



TRUE indicates that the input address was recognized as a
Rural Route or Highway Contract addresses and that it was
matched to a standardized address through a onversion to a
normal street address

FedEx Web Services, Developer Guide 2016

Address Validation Service

Attribute Names

RuralRoute

StreetAddress

StreetRang

StreetPointNotValidated

StreetPointNotApplicable

StreetNameAddress

StreetBuildingAddress

Description


FALSE indicates that the input address was not recognized as a
Rural Route or Highway Contract address and was not
converted to a street address. (US only.)



TRUE indicates that the input address was recognized as a
Rural Route or Highway Contract addresses.



FALSE indicates that the input address was not recognized as a
Rural Route or Highway Contract address.



TRUE indicates that the house number and street name were
validated against reference data.



FALSE indicates that the house number and street name were
not validated against reference data. (Non-US addresses only,
where applicable)



TRUE indicates that the address includes a street number range
instead of a single house number. The range is from the input
address from which this address was resolved, and that the
input range was validated as being included within a known
street range segment for the matched street.



FALSE indicates that the address does not include a street
number range. (Non-US addresses only, where applicable)



TRUE indicates that the house number for the street address
was not validated against reference data



FALSE indicates that the house number for the street address
was either not validated, not provided, or not relevant for the
address (Non-US addresses only, where applicable)



TRUE indicates that house number at the street level is not
applicable for this address



FALSE indicates that the house number at the street level is
applicable for this address (Non-US addresses only, where
applicable)



TRUE indicates that the street name was validated against
reference data, but not house number. Note that house number
may not be applicable for the address.



FALSE indicates that the street name was not validated against
reference data. (Non-US addresses only, where applicable)



TRUE indicates that the building and street information were
validated against reference data, but not house number.



FALSE indicates that the building and street information were
not validated against reference data. (Non-US addresses only,
where applicable)

FedEx Web Services, Developer Guide 2016

Address Validation Service

Attribute Names
StreetOrganizationAddress

ValidMultiUnit

2.8.4

Description


TRUE indicates that organization and street information were
validated against reference data.



FALSE indicates that organization and street information were
not validated against reference data. (Non-US addresses only,
where applicable)



TRUE indicates that the address includes a validated suite or
unit number.



FALSE indicates that the address does not include a validated
suite or unit number.

Notification

Table 15: Notification
Element

Description

Reply/HighestSeverity/Notification

Includes the descriptive data detailing the status of a submitted
transaction and the severity of the notification, which indicates
success or failure or some other information about the request.
Valid values are:


SUCCESS — Your transaction succeeded with no other applicable
information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know about
your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction.

FedEx Web Services, Developer Guide 2016

Close Service Shipment

The Close Service WSDL allows you to reconcile shipping information for your FedEx Ground ® or FedEx
SmartPost® shipments and print a ground manifest for your ground driver. The ground manifest is
generated after a successful close and must be printed before your ground shipments are tendered to
FedEx. You may continue to ship ground packages after a close has been performed. Similarly, FedEx
SmartPost must be closed in order for the system to become aware of the package before it is scanned
at the FedEx SmartPost facility.
Notes:



The Close is required when processing Ground and/or SmartPost shipments.



FedEx Express shipments are automatically closed and do not require a specific close operation.



Shipments with a Future Ship date will not be included in a close until that date.



Close transactions are performed at the meter level. If you have multiple meters, additional close requests are
required.



The address in the manifest header is extracted from the first package shipped on the specified day.

Close by Reference allows you to identify those, and only those, packages that are finalized, and upload
that specific package data to FedEx. This is accomplished by closing the corresponding FedEx Ground
(US domestic and international) or SmartPost shipment via one of the customer reference fields.
This feature includes the following functionalities:
1. Ship with reference designation for close functionality that associates a reference field with a
shipment. All such shipments that have the same reference field can be grouped and closed as one
set.
2. Reference Confirmation functionality that identifies the subset of shipments to print the configured
reports.
3. End of Day Close with reference designation for close functionality that performs the close operation
for the shipments, which are associated with the specified reference field.
4. Trigger data to transfer to Ground backend systems functionality that triggers a transfer of uploaded
shipment information to Ground backend systems.
5. Openship Verification Error functionality that designates the level of error handling returned in a reply.
You can use it to analyze the unconfirmed Open Shipments when performing the End of Day Close
transaction.

3.1

Close Service Operations

The following operations are supported by the Close Service WSDL.
Table 16. CloseService Operations
Element
GroundCloseRequest

FedEx Web Services, Developer Guide 2016

Requirements
Initiates the final stage of processing all shipment data
submitted by the customer for the day (close of business)
for FedEx Ground shipments. Only returns the Ground
Manifest.
55

Close Service Shipment
Element
SmartPostCloseRequest

Requirements
Initiates the final stage of processing all shipment data
submitted by the customer for the day (close of business)
for FedEx SmartPost shipments.
No report is generated or returned for SmartPost.

GroundCloseWithDocumentsRequest

Ground Close with user specified reports. Recommended
for use if/when additional reports are required at the time
of Close outside of the Ground Manifest.

ReprintGroundCloseDocumentsRequest

Generates the user specified reports that were created
when the Close was processed. Returns all the specified
reports generated for a specific day. It can only reprint
reports up to three days in the past.

CloseWithDocumentsRequest

A single close operation for both FedEx Ground and
SmartPost shipments. This operation also offers preview
and reprint options for various end of day reports.

3.2

Close Service Coding Details

3.2.1

FedEx Ground Close Ship Day Details

The Close Operation can be performed multiple times during each shipping day. There is no need to
reopen once a close has been processed, just simply start shipping again. Use the Close Service to
initiate the final stage processing of all shipment data submitted for the day (close of business).
Note: Even though these shipments are not deleted, customers will not be charged for those if they are not shipped
(tendered to FedEx).

In addition to the manifest, it’s possible that the following reports could be returned after a successful
close and should be printed (if shipments with these services are included in the Close reply):


FedEx Ground® C.O.D. / FedEx Ground® Electronic C.O.D. (E.C.O.D.)



HazMat



FedEx Ground Multiweight® Package Detail

C.O.D./E.C.O.D. and HazMat reports can be printed anytime during the shipping day for shipments that
have already been closed (up to three days in the past). FedEx Ground Multiweight reports (if the account
is multiweight enabled) are produced at close time and cannot be reprinted.
For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

3.2.2

Ground Close Request Transaction

The following elements are required for a Ground Close Request transaction:
Table 17. GroundCloseRequest Elements
Element
TransactionDetail
/CustomerTransactionId
FedEx Web Services, Developer Guide 2016

Requirements
Maximum of 40 characters. This element allows you to
assign a unique identifier to your transaction. This element
56

Close Service Shipment
Element

Requirements
is returned in the reply and helps you match requests to
replies.
CloseGroupingType
Specify how the shipment close requests are grouped.
This is an optional field and it defaults to TIME which in
turn will default to End-of-Day.
CloseGroupingType
Specify that the shipments will be closed by a Shipment
/MANIFEST_REFERENCE
Manifest element.
CloseGroupingType
Specify that the shipments will be closed by a shipping
/SHIPPING_CYCLE
cycle
CloseGroupingType
Default value. Specify that the shipments will be closed by
/TIME
the date/time indicated in the
“TimeUpToWhichShipmentsAreToBeClosed” field (exists
for GroundClose Requests currently)
TimeUpToWhichShipmentsAreToBeClosed Identifies the date and time up to which unclosed
shipments are to be closed. Both the date and time
portions of the string are expected to be used.
The time is the local time based on shipper’s time zone.
The date component must be in the format:YYYY-MM-DD
(eg.2009-04-26).
The time component must be in the format :HH-MM-SS
using a 24 hour clock (e.g.11:00 a.m is 11:00:00, whereas
5:00 p.m is 17:00:00).
The date and time parts are separated by a T (e.g.2009-0426T17:00:00)
ManifestReferenceDetail
Used in Close by Reference. Specifies that the shipments
will be closed based on a Customer Reference value.

3.2.3

Ground Close With Documents Request Transaction

The following elements are required for a Close Service transaction:
Table 18. GroundCloseWithDocumentsRequest Elements
Element

Requirements

CloseDate

Date on which shipments were closed.

CloseDocumentSpecification

Specify characteristics of document(s) to be returned for this
request. You may request the following close documents.


COD_REPORT



MANIFEST



MULTIWEIGHT_REPORT



OP_950



DetailedDeliveryManifestDetail



ManifestDetail



HAZARDOUS_MATERIALS_CERTIFICATION

FedEx Web Services, Developer Guide 2016

Close Service Shipment

Element

Requirements
Contains all data required for close-time documents to be
produced in conjunction with a specific set of shipments.

Note: OP950 is deprecated and will be unavailable in a future load.

3.2.4

Ground Close Service With Documents Reply Transaction

The following elements may be returned in the Ground Close with Documents reply:
Table 19. GroundCloseServiceWithDocumentReply Elements
Element

Requirements

HighestSeverity

Identifies the highest severity encountered when performing
the request.
Valid values:

Notifications



FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some other
information about the request.
Valid values


SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to
you about your transaction.



WARNING — Additional information that you need to
know about your transaction that you may need to take
action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your
transaction

TransactionDetail

Descriptive data for this customer transaction. The
TransactionDetail from the request is echoed back to the
caller in the corresponding reply.

Version

Identifies the version/level of a service operation expected by
a caller (in each request) and performed by the callee (in each
reply).

FedEx Web Services, Developer Guide 2016

Close Service Shipment

Element

Requirements

Close Document Type

Actual document contents for all provided reports.

Example 5:

GroundCloseWithDocumentsRequest

Input Your Information
Input Your Information

EN
EN

CloseWithDocumentsRequest_v5

EN
EN

clos
5
0
0

FedEx Web Services, Developer Guide 2016

Close Service Shipment

ERROR_IF_OPEN_SHIPMENTS_FOUND

FDXE
2015-12-29T11:30:47-05:00

CUSTOMER_REFERENCE
string

MANIFEST

3.3

FedEx Ground Reports

When you perform a Close, FedEx Web Services generates four ground reports:


Ground Manifest



C.O.D./E.C.O.D. Report



Multiweight Detail



Hazardous Materials Certification Report (U.S. only)

3.3.1

FedEx Ground Report Printing Coding Details

You can also choose to reprint C.O.D./E.C.O.D., FedEx Ground Manifest and HazMat reports using the
Close service. FedEx Ground Multiweight reports (if the account is multiweight enabled) are produced at
close time and cannot be reprinted. Additional elements for printing ground reports include the following:
Table 20. PrintingGroundReports Elements
Element

Requirements

GroundCloseReportsReprintRequest If this element is set to true, you receive ground reporting from
the last three closed shipping days. To indicate which report(s)
you want to receive, include the CloseReport Type element and
specify a date from the previous three calendar days.
If this element is set to false, the Close Service processes and
all valid reporting is returned.
CloseReportType

If the CloseRequest/ReportOnly is set to true, you may request
the following reports:


MANIFEST



COD

FedEx Web Services, Developer Guide 2016

Close Service Shipment

Element

TrackingNumber

3.4

Requirements


HAZMAT



MULTIWEIGHT

If you include the tracking number of a particular FedEx Ground
shipment for which you want to print ground reports (manifest,
C.O.D., HazMat, or Multiweight Detail), the report(s) requested
in the CloseReportType element are returned.

FedEx SmartPost Close Shipment Service Details

The Close Operation can be performed multiple times during each shipping day. There is no need to
reopen once a close has been processed, just simply start shipping again. Use the Close Service to
initiate the final stage processing of all shipment data submitted for the day (close of business).
Note packages can no longer be deleted once the close occurs.

SmartPost Small Shippers must process both a Ground Close and a SmartPost Close as both FedEx
Ground and FedEx SmartPost handle your shipments. Close FedEx Ground prior to FedEx SmartPost to
ensure your package data is transmitted accurately.
SmartPost Large Shippers only need to process the SmartPost Close.


FedEx SmartPost Close is independent of a FedEx Ground Close.



No reports are returned in the FedEx SmartPost Close Reply.



SmartPost shipments are not trackable on FedEx.com unless they are scanned by a FedEx
SmartPost facility.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

3.4.1

FedEx SmartPost Close Ship Day Coding Details

The following elements are required for a Close Service transaction:
Table 21. FedEx SmartPost Close Service Elements
Element

Requirements

WebAuthenticationDetail

The descriptive data to be used in authentication of the sender's
identity and right to use FedEx Web Services.

ParentCredential

The value for the primary authentication credential for a specific
account.
Note: This element is available only for Compatible Providers.

FedEx Web Services, Developer Guide 2016

Close Service Shipment

Element

Requirements

UserCredential

Credential used to authenticate a specific account. It consists of twopart authentication string, Key and Password, which is used to verify
shipper identity. This value is provided by FedEx after registration.

WebAuthenticationCredential Two-part authentication string used to verify shipper identity.
Key

Unique identifier assigned to each customer as part of their
authentication credentials.

Password

Second part of the authentication credential which has a direct
relationship with the credential key.

ClientDetail/AccountNumber

The FedEx Express nine-digit meter number that has been used in the
Ship transactions.

ClientDetail/MeterNumber

The FedEx Express nine-digit meter number that has been used in the
Ship transactions.

Version/ServiceId

The value is "clos".

Version/Major

The current value is "5".

Version/Intermediate

The current value is "0".

Version/Minor

The current value is "0".

HubId

Specify the HubId. For valid values refer to Appendix AD: SmartPost
Hub IDs.
Note: Include only the numeric HubId value in your request. HubID 5531 should
be used in the FedEx Test Environment.

smartPostCustomerId

Unique FedEx SmartPost Customer ID.

DestinationCountryCode

For FedEx SmartPost the value is always US.

PickupCarrier

The value will be either FDXG or FXSP, depending on which driver
picks up your FedEx SmartPost packages.

CustomerManifestId

Optional. Maximum length 8 characters. If no CustomerManifestId
values were sent in the individual Ship request, then do not include this
element in the request at all.
If CustomerManifestId values were sent in the Ship requests, then
send one FedEx SmartPost close for each unique CustomerManifestId.
Each Close request will only close the packages with a matching
CustomerManifestId value.

FedEx Web Services, Developer Guide 2016

Close Service Shipment

Element

Requirements

ManifestReferenceDetail

Used in Close by Reference. Specifies that the shipments will be
closed based on a Customer Reference value.

Example 6:

GroundCloseReportsReprintRequest

Input Your Information
Input Your Information

Input Your Information
Input Your Information
String

String
String

String

String
String

clos
5
0

FedEx Web Services, Developer Guide 2016

Close Service Shipment
0

2015-12-29

MANIFEST

FedEx Web Services, Developer Guide 2016

Consolidation Services

FedEx offers consolidation services for shippers who want to consolidate their FedEx Express® and
Ground® international shipments for customs clearance at a single entry and then, within the destination
country, break the shipment down into smaller components to distribute to individual recipients. FedEx
International DirectDistribution Surface Solutions (IDD Surface) lets you streamline large shipments from
Canada and Mexico for distribution in the U.S.
FedEx® Consolidation services are specific to Canadian shipments and allows qualified U.S. shippers to
consolidate FedEx Ground shipments for distribution within Canada by either FedEx Trade Networks® or
a broker of your choice. The shipment clears Canadian customs as a single shipment and is broken down
into smaller shipments once inside Canada. After your shipment clears customs you will receive access
to the full range of FedEx services.
FedEx Consolidation services are contract-only. Contact your FedEx account executive to learn how to
get approved for these services.
FedEx Consolidation Services At-A-Glance lists the FedEx Consolidation services that you can
implement. FedEx software lets you code shipping transactions to support FedEx International
DirectDistribution Surface Solutions services and provides all of the reporting you need for shipping and
customs clearance.
Note: FedEx International Priority DirectDistribution ® (IPD), FedEx International Economy DirectDistribution SM (IED)
and FedEx International Priority DirectDistribution® Freight (IDF) are the only consolidation services where
origin doesn't matter. FedEx International Ground® Distribution (IGD) and FedEx International Ground®
DirectDistribution Surface Solutions U.S. to Canada must be based in the United States. International
DirectDistribution (IDD) consolidations must be based in Canada or Mexico and a drop-off location ID must be
setup for the specified account. For purposes of this document, the general term ‘IPD’ is used to refer to all
forms of consolidated distribution of international shipments.

Table 22. FedEx Consolidation Services At-A-Glance
Your Shipping Need

Our Service

FedEx Express International DirectDistribution Services
Consolidate FedEx Express® shipments to clear
customs at a single entry, then deliver to individual
recipients in the destination country.



FedEx International Priority DirectDistribution®
(IPD)



This is a Contract-only Service*

Clear shipments through customs at a single entry,

with delivery to individual recipients in the destination
country.

Consolidate cross-border shipments from Canada
and Mexico to multiple recipients in the U.S.

FedEx International Economy
DirectDistribution® Service (IED)
This is a Contract-only Service*

FedEx® International DirectDistribution (IDD)

FedEx Ground International DirectDistribution Services
A drop-ship service in which you can arrange for bulk
delivery via your own less-than-truckload carrier,
FedEx Freight® or FedEx Ground® to a Canadian hub.

FedEx Web Services, Developer Guide 2016

FedEx International Ground® Distribution (IGD)

Consolidation Services

Your Shipping Need

Our Service

FedEx Ground breaks down the consolidation in
Canada and delivers the individual shipments.
FedEx Express International DirectDistribution Freight Service
Consolidate shipments from a single origin location
FedEx International Priority DirectDistribution®
to multiple recipients in one destination country using Freight
one FedEx® International Air Waybill.
After your shipment enters the U.S., the shipment may be managed by FedEx U.S. services, including
FedEx Express®, FedEx Ground and FedEx Home Delivery.
FedEx International DirectDistribution Services – FedEx Express and FedEx Ground Services lists
the FedEx U.S. services available to FedEx International DirectDistribution Service shipments after they
enter the U.S.
FedEx International Economy DirectDistribution (IED) is a time-definite, customs-cleared, door-to-door
deferred product. It is a contractual service and is available for international consolidations from one
origin in Asia to multiple destinations through out continental United States and European Union. Goods
are shipped as one shipment, clearing customs as one unit with one consolidated commercial invoice.
Upon clearance at Anchorage, all IED will move to Oakland, Indianapolis and Newark for final ground
delivery. (IED is not available as a service type for U.S. outbound shipments.)
Note: IED is only APAC outbound to US and Europe and It is not enabled for Europe outbound. LAC calls its Flower
Delivery distribution as IED, but it actually uses the IPD service code and directs the freight to Miami. IED is
not available for MEIA (Middle East and Africa).

Table 23. FedEx International DirectDistribution Services - Express and Ground Services
Your Shipping Need

Our Service

FedEx Express Services - International Priority DirectDistribution (IPD)
First thing the next-business-day morning.

FedEx First Overnight®

Next-business-day morning.

FedEx Priority Overnight®

Next-business-day afternoon.

FedEx Standard Overnight®

2 business days.

FedEx 2Day®

Second-business day by 10:30 a.m. to most
business areas; for certain shipments to
Alaska and Hawaii, delivery is in 3 business
days.

FedEx 2Day® A.M.

3 business days.

FedEx Express Saver®

In 1, 2 or 3 business days within the U.S. for
packages over 150 pounds each.

FedEx 1Day® Freight, FedEx 2Day® Freight, FedEx 3Day®
Freight

FedEx Ground Services - International DirectDistribution (IDD) Surface Solutions
FedEx Web Services, Developer Guide 2016

Consolidation Services

Your Shipping Need

Our Service

Economical ground delivery to businesses.

FedEx Ground®

Economical ground delivery to residences.

FedEx Home Delivery®

4.1

Single Shipment Through Customs

Consolidation shipments move and clear destination Customs as a single shipment. The entire shipment
is consigned to (and entry is made) in the name of only one importer of record (IOR). The shipment must
also come from a single exporter of record. Individual pieces within the shipment are delivered to the
recipient indicated on each FedEx Express® Shipping or Express Manifest label. FedEx International
Priority Freight (IPF) standards and restrictions for size, weight, and commodity types apply to individual
packages in a consolidation shipment.

4.2

Single Point of Clearance

Consolidation services also allow Single Point of Clearance (SPOC), which permits you to send a
consolidated shipment that includes packages to multiple countries in the European Union. These
packages are cleared at a single Customs point. After clearance, the shipment is broken up for delivery to
multiple countries.
Note: Single point of clearance (SPOC) is currently available to the European Union (EU) only.

If you require FedEx International Priority DirectDistribution, FedEx International Economy
DirectDistribution Service or FedEx International Priority DirectDistribution Freight service configuration,
you must call your FedEx account executive. These are contract services which must be configured by a
FedEx Customer Support representative.

4.3

Multiple-Piece Freight Shipments

In addition to providing consolidation services, you can ship multiple-piece freight shipments (exceeding
150 pounds/68 kilograms) using FedEx International Priority DirectDistribution Freight (IDF). All pieces
must be skidded to ship IDF.
Note: You must have a service contract on file with FedEx before you can process your consolidation shipments. For
more information, contact your FedEx account executives.

4.4

Transaction Rules

The following rules apply to FedEx Consolidation Services transactions. These rules include restrictions
for package size and weight.


Automated Export System (AES)
If you are the shipper, you must provide the required AES information for the Electronic Export
Information regardless of whether FedEx files the EEI or if you file your own EEI.



Clearance Locations

FedEx Web Services, Developer Guide 2016

Consolidation Services
If you are clearing the shipment in a country with more than one clearance location, use the following
clearance locations, unless otherwise directed by the FedEx implementation team:
o
o
o
o
o
o
o
o
o
o


Canada: YWGI
China: SZXI
Japan: QCBI
Malaysia: KULI
Mexico: TLCI
Philippines: SFSI
U.S.: As Directed
France (Paris): IDSI
Denmark (Cologne): IDVI
UK (Stansted): IPDI

Child Reference Numbers (CRNs)
All CRNs are on a single master air waybill. Therefore, you are allowed to ship to a single recipient
address for FedEx International Priority DirectDistribution and FedEx International Priority
DirectDistribution Freight. However, you must provide at least two addresses for FedEx International
Economy DirectDistribution. A single recipient may have more than one package; however, a single
package may not have more than one recipient.

Note: You must not add more than 300 CRNs on a single master air waybill.



Currency
You can select a single currency for the customs value of the entire transaction. After the FedEx
Consolidation Services shipment is opened, the currency you selected for the first piece in the
shipment remains constant for the other pieces in the shipment.



Declared Values
Declared value limits are based on the FedEx service you select for the shipment.



Destination
Consolidation shipping services to the U.S. only covers the 50 U.S. States. Shipments to U.S.
territories, such as Guam and the U.S. Virgin Islands, must be shipped using regular FedEx
International Priority® service. Shipments to Puerto Rico cannot be combined with packages that
have destinations within the 50 U.S. States. The Recipient address for a FedEx Consolidation
Services transaction must be a U.S. address. A valid zip code that corresponds to the city and state
entered for the shipment is required.



Dimension and Weight Types
You can only select a single weight type — pounds (LB) or kilograms (KG) — and a single dimension
type: inches (IN) if using LB as the weight type, or centimeters (CM) if using KG as the weight type.
After you create an open FedEx Consolidation Services shipment, the weight type you select for the
first piece in the shipment is the prevailing type for the rest of the pieces in the shipment.

Note: If you ship packages using FedEx Ground or FedEx Home Delivery, then you must code measurements in
pounds (LB) and inches (IN).



Electronic Export Information (EEI)
You are required to file an EEI for all U.S. export shipments if one or more commodities (Schedule B
number) total more than $2,500 USD in the consolidated shipment on any given day. The EEI is the
equivalent electronic version of the Shipper's Export Declaration (SED). You may file one Automated
Export System (AES) filing for all commodities in the shipment that must be reported to the U.S.

FedEx Web Services, Developer Guide 2016

Consolidation Services
Customs and Border Protection (CBP). Check with the FedEx Regulator for details if you have any
questions on filing with AES.


Exporter of Record (EOR)
You must identify a single exporter of record in the origin country. If FedEx is filing the EEI, you must
include the shipper phone number and shipper IRS/EIN/EORI number if no exporter Employer
Identification Number (EIN) or Internal Revenue Service (IRS) number is provided.



Importer of Record
Identify only one importer of record (IOR) in the destination country for the entire consolidation. An
IOR is listed as the "Sold To" party for the consignment and is not required to be the actual recipient.



Labels
You must print at least one FedEx Express label for each recipient delivery.



Number of Commodites
Enter a maximum of 999 commodities (FedEx Express and FedEx Ground, as appropriate) per
shipment.



Number of Pieces
Enter a maximum of 300 pieces (associated with one shipment) for a FedEx Consolidation Services
shipment.



Packaging Type Required



For FedEx Express, you must include the Packaging Type in the FedEx Consolidation Services
transaction. You can use FedEx Express packaging for Express shipments or your own custom
packaging. For FedEx Ground, FedEx Home Delivery and FedEx Consolidation Services shipments,
you must use your own packaging.



Payment
Only Bill Sender and Bill Third Party are allowed for transportation charges and for duties and taxes.



Processing Shipments
You can process several consolidation shipments simultaneously providing that the meter number,
ship date and clearance facility/destination country do not match.



Rounding Up Weights
The exact weight of each CRN is uploaded and added together to create the shipment master
weight. The shipment master weight is rounded for rating purposes. For example, a shipment
consisting of three packages with weights of 4.2 lbs., 3.1 lbs. and 6.8 lbs equals a shipment master
weight of 14.1 lbs. The weight that is used to rate for cost is the rounded up Master Air Waybill
(MAWB) weight - 15 lbs.



Shipping Methods
Use the Open Ship shipping method to create, process and complete consolidation shipments.



Size and Weight
You are not limited to a shipment weight for a consolidation services shipment. However, you cannot
ship an individual piece for a FedEx International Priority DirectDistribution Freight shipment that is
less than 68 kg or 151 lbs. Enter package size and weight data that does not exceed the current

FedEx Web Services, Developer Guide 2016

Consolidation Services
intra-U.S. FedEx Express, FedEx Ground and FedEx Home Delivery size and weight restrictions. For
more information about package weight restrictions, see the FedEx Developer Resource Center
Note: Dimensional weight does not apply to individual CRNs in the shipment. It applies to the entire shipment.

4.4.1

Transaction Restrictions

Collect on Delivery is not available with FedEx Consolidation Services.

4.5

Non FedEx Trade Networks Customs Broker

If you plan to use your own Customs clearance broker, then you must include the required
CustomsClearanceDetail/Brokers elements listed in this table.
Table 24. Broker Elements
Element

Multiple
Occurrence

Description

CreateConsolidationRequest
/RequestedConsolidation
/CustomsClearanceDetail
/Brokers

Yes

Optional.
The descriptive data for the broker doing
business with FedEx.

CreateConsolidationRequest
/RequestedConsolidation
/CustomsClearanceDetail
/Brokers/AccountNumber

Optional.
The FedEx account number associated with this
transaction.

CreateConsolidationRequest
/RequestedConsolidation
/CustomsClearanceDetail/Brokers
/Tins

Yes

Optional.
The descriptive data for the taxpayer identification
information.

CreateConsolidationRequest
/RequestedConsolidation
/CustomsClearanceDetail
/Brokers
/Contact

Optional.
Descriptive data identifying the point-of-contact
person.

CreateConsolidationRequest
/RequestedConsolidation
/CustomsClearanceDetail
/Brokers
/Address

No.

Optional.
Descriptive data identifying the actual address of
the broker.

CreateConsolidationRequest
/RequestedConsolidation
/SpecialServicesRequested
/SpecialServiceTypes

Yes

Valid value: BROKER_SELECT_OPTION

FedEx Web Services, Developer Guide 2016

Consolidation Services

4.6

Shipping Service Options

Tables FedEx Express and FedEx Ground Services Allowed by Package Type through FedEx Ground
Special Services Allowed by Service Type list the FedEx services that are allowed for FedEx
Consolidation Services shipments.
Table 25. FedEx Express and FedEx Ground Services Allowed by Package Type
FedEx
Envelope

FedEx Pak

FedEx Box

FedEx Tube

FedEx Priority Overnight® Yes

Yes

FedEx Standard
Overnight®

Yes

FedEx 2Day®

Yes

FedEx 2Day® A.M.

Yes

FedEx First Overnight®

Yes

FedEx 1Day® Freight

Yes

FedEx 2Day® Freight

Yes

FedEx 3Day® Freight

Yes

FedEx Express Saver®

Yes

FedEx Ground®

Yes

FedEx Home Delivery®

Yes

Service

Customer
Packaging

Table 26. FedEx Express Special Services Allowed by Service Type - I
Service

C.O.D.

IDG

ADG

Signature
Inside
Dry Ice Required
Alcohol
Delivery
Type

FedEx Priority Overnight

Yes

FedEx Standard
Overnight

Yes

FedEx 2Day

Yes

FedEx 2Day® A.M.

Yes

FedEx First Overnight

Yes

FedEx 1Day Freight

Yes

FedEx 2Day Freight

Yes

FedEx 3Day Freight

Yes

FedEx Web Services, Developer Guide 2016

Consolidation Services

Service

C.O.D.

IDG

ADG

Signature
Inside
Dry Ice Required
Alcohol
Delivery
Type

FedEx Express Saver

Yes

Table 27. FedEx Express Special Services Allowed by Service Type - II

Service

Priority
Alert
Concurrent
Hold at
Saturday Sunday and
Inside Saturday Shipments
FedEx
Delivery Delivery Priority
Pickup Pickup
& Future
Location
Alert
Day
Plus

FedEx Priority Overnight

Yes

—

FedEx Standard Overnight

Yes

—

FedEx 2Day

Yes

—

FedEx 2Day® A.M.

Yes

—

FedEx First Overnight

Yes

—

FedEx 1Day Freight

Yes

—

FedEx 2Day Freight

Yes

—

FedEx 3Day Freight

Yes

—

FedEx Express Saver

Yes

—

FedEx First Overnight®
Freight

—

Yes

—

FedEx International Priority ® —

—

Yes

—

FedEx International First®

—

Yes

—

FedEx Europe First®

—

Yes

—

FedEx International Priority ® —
Freight

—

Yes

—

FedEx International Priority
DirectDistribution®

Yes

—

Yes

—

Yes

FedEx International
Economy DirectDistribution

Yes

—

Yes

FedEx Web Services, Developer Guide 2016

Consolidation Services
Table 28. FedEx Ground Special Services Allowed by Service Type
Service

NonSignature
Date
Appt
Evening
C.O.D. ECOD Standard HazMat Required
Certain
Delivery Delivery
Packaging
Type
Delivery

FedEx Ground

Yes

FedEx Home
Delivery

Yes

4.7

Creating Considation Shipments

FedEx Consolidation Services shipments are processed using the Open Ship shipping method. Open
Ship is a highly flexible shipping option. Open Ship allows you to enter information for a shipment as it is
received throughout the day, rather than entering all shipping information only when the shipment is
ready to be processed. The consolidation remains open accepting each piece as it is entered and closing
only when you confirm the consolidation.
For information about the Open Ship shipping process, see the Open Shipping chapter.
Table 29. Consolidation Shipment Creation
Workflow Item

Description

1. CREATE Consolidation

To CREATE a consolidation shipment, use the
CreateConsolidationRequest.
Use the ConsolidationIndex to give the consolidation a unique
identifier.

2 - 4. Add a Shipment to a
consolidation*
*not to exceed 300 pieces per
shipment

Entire shipment is added to the consolidation one shipment at a time
(not one package at a time) using the CreateOpenShipment Web
Service. All the packages in the entire shipment are defined in the
CreateOpenShipment request and the ship The recipient email
address of the notificationment is sent with the Action CONFIRMED.

5. CONFIRM Consolidation

To confirm consolidation you can use a Confirm Consolidation web
service.

4.7.1

Add a Shipment to a Consolidation

After you create a FedEx Consolidation, you add entire shipment to the consolidation one at a time.
While packages require many of the same elements that are used for regular shipments, the
ConsolidationIndex element is required to associate the shipment with a FedEx Consolidation. The
ModifyConsolidationRequest transaction can then be used to edit the consolidation information. See the
Open Shipping Chapter for more information.

FedEx Web Services, Developer Guide 2016

Consolidation Services

4.7.2

Delete Consolidation Services Package

To delete a shipment from a consolidation, use the DeleteOpenShipmentRequest. Use the
DeleteOpenConsolidationRequest to delete an entire consolidation before it is confirmed and closed out.
See Open Shipping Chapter for more information.
Table 30. DeleteOpenConsolidationRequest
Element

Multiple
Occurrence

Description

ConsolidationKey

Required. The ConsolidationKey contains the Type,
Index and Date.

ConsolidationKey/Type

Required. Specify the type of consolidation.

ConsolidationKey/Index

Required. The unique consolidation identifier which
was specified in the CreateConsolidationRequest.

ConsolidationKey/Date

Required. The date on which the consolidation was
created.

TrackingId

Optional. The tracking ID of the shipment within the
consolidation.

TrackingId/TrackingIdType

Optional. Describes the type of tracking ID.

TrackingId/FormId

Optional. Describes in detail the type of airbill and
shipment moving through the FedEx system.

TrackingId/UspsApplicationId

Optional. For use with SmartPost tracking IDs only.

TrackingId/TrackingNumber

Optional.

4.7.3

Confirm Consolidation Services Shipment

Confirming a consolidation closes the consolidation and prevents further shipping activity. To CONFIRM a
FedEx Consolidation, use the ConfirmConsolidationRequest transaction. The
ConfirmConsolidationRequest confirms the entire consolidation, so no more shipments can be added to
it.
Table 31. ConfirmConsolidationRequest
Element

Multiple
Description
Occurrence

AsynchronousProcessingOptions

Required.
This is used to specify processing options related to
synchronous or asynchronous processing.

AsynchronousProcessingOptions
/Options

Yes

Required.
Describes the type of processing the customer has
set for return of the shipment artifacts.
Valid values are:

FedEx Web Services, Developer Guide 2016



ALLOW_ASYNCHRONOUS (Recommended)



ASYNCHRONOUS_ONLY
74

Consolidation Services
Element

Multiple
Description
Occurrence


SYNCHRONOUS_ONLY

Note: ALLOW_ASYNCHRONOUS is a recommended
option. Please refer to section "4.16 Useful Tips
Consolidation Services Transactions"

CompletedConsolidationDetail
/ConsolidationShipments
/RequestedShipment
/SpecialServicesRequested
/DangerousGoodsDetail
/UploadedTrackingNumber

UploadedTrackingNumber element is used to
identify an instance of an uploaded dangerous
goods handling unit. This element is required only if
you have already validated DG data using the FedEx
provided Dangerous Goods / Hazardous Materials
information upload option.

ConsolidationKey

Required for IPD.
Specify the unique identifier specified in the
ConsolidationIndex.

ConsolidationKey
/Type

Required. Specify the type of consolidation.

ConsolidationKey
/Index

Required to confirm the consolidation.

ConsolidationKey
/Date

Required. The date on which the consolidation was
created.

Note: When this value is not added the following error
message "Invalid consolidation index" is displayed in
the reply.

LabelSpecification

LabelSpecification
/CustomerSpecifiedLabelDetail
/LabelMaskableDataType

FedEx Web Services, Developer Guide 2016

Required.
Description of shipping label to be returned in the
reply.
Names of data elements/areas which may be
suppressed from printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NU
MBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_
ACCOUNT_NUMBER

Consolidation Services
Element

Multiple
Description
Occurrence

LabelSpecification
/CustomerSpecifiedLabelDetail
/CustomLabelDetail
/CustomLabelTextBoxEntry

Constructed string, based on format and zero or
more data fields, printed in specified printer font (for
thermal labels) or generic font/size (for plain paper
labels).

CustomLabelTextBoxEntry
/TopLeftCorner

Horizontal and vertical position, relative to left edge
of custom area.

CustomLabelTextBoxEntry
/BottomRightCorner

Horizontal and vertical position, relative to left edge
of custom area.

CustomLabelTextBoxEntry
/Position

Horizontal and vertical position, relative to left edge
of custom area.

CustomLabelTextBoxEntry
/Format

Format

CustomLabelTextBoxEntry
/DataFields

Data fields

CustomLabelTextBoxEntry
/ThermalFontId

Printer-specific font name for use with thermal
printer labels.

CustomLabelTextBoxEntry
/FontName

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry
/FontSize

Generic font size for use with plain paper labels.

CustomLabelTextBoxEntry
/Rotation

Describes the rotation of an item from its default
orientation.
Valid values are:


NONE



RIGHT



UPSIDE_DOWN

LabelSpecification/
LabelFormatType

Yes

Required.
Specify the type of label to be returned.

LabelSpecification/
ImageType

Optional.
Specify the image format used for a shipping
document.

FedEx Web Services, Developer Guide 2016

Consolidation Services
Element

Multiple
Description
Occurrence

LabelSpecification
/LabelStockType

ShippingDocumentSpecification

ShippingDocumentSpecification
/FreightAddressLabelDetail
/DocTabContent
/DocTabContentType

Optional.
For thermal printer labels this indicates the size of
the label and the location of the doc tab if present.
Valid values are:


PAPER_4X6



PAPER_4X8



PAPER_4X9



PAPER_7X4.75



PAPER_8.5X11_BOTTOM_HALF_LABEL



PAPER_8.5X11_TOP_HALF_LABEL



STOCK_4X6



STOCK_4X6.75_LEADING_DOC_TAB



STOCK_4X6.75_TRAILING_DOC_TAB



STOCK_4X8



STOCK_4X9_LEADING_DOC_TAB



STOCK_4X9_TRAILING_DOC_TAB

Optional.
Contains data used to create additional (non-label)
shipping documents.
Valid values are:


BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001

ShippingDocumentSpecification
/ShippingDocumentTypes

Yes

Optional.
Indicates the types of shipping documents
requested by the shipper.

ShippingDocumentSpecification
/CertificateOfOrigin

Optional.

ShippingDocumentSpecification
/CommercialInvoiceDetail

Optional.

FedEx Web Services, Developer Guide 2016

Consolidation Services
Element

Multiple
Description
Occurrence

ShippingDocumentSpecification
/ReturninstructionsDetail
/ShippingDocumentFormat
/documentFormatOptionsrequested
/DocumentFormatOptionType

SUPPRESS_ADDITIONAL_LANGUAGES" - This
value will suppress English language if another
language is specified in language code field.
(Default is English)

ShippingDocumentSpecification
/CustomPackageDocumentDetail

Yes

Optional.
Specify the production of each package-level
custom document (the same specification is used
for all packages).

ShippingDocumentSpecification
/CustomShipmentDocumentDetail

Yes

Optional.
Specify the production of a shipment-level custom
document.

ShippingDocumentSpecification
/ExportDeclarationDetail

Optional.

ShippingDocumentSpecification
/GeneralAgencyAgreementDetail

Optional.

ShippingDocumentSpecification
/NaftaCertificateOfOriginDetail

Optional.

ShippingDocumentSpecification
/Op900Detail

Optional.
Specify the production of the OP-900 document for
hazardous materials packages.

ShippingDocumentSpecification
/ProformainvoiceDetail

No.

Optional.

ShippingDocumentSpecification/
ReturninstructionsDetail

No.

Optional.

ShippingDocumentSpecification/
DangerousGoodsShippers
DeclarationDetail

Optional.
Specify the production of the 1421-C document for
dangerous goods shipment.

ShippingDocumentSpecification
/FreightAddressLabelDetail

Optional.

ShippingDocumentSpecification
/CustomDocumentDetail

FedEx Web Services, Developer Guide 2016

Data required to produce a custom-specified
document, either at shipment or package level.

Consolidation Services
Element

Multiple
Description
Occurrence

CustomDocumentDetail
/Format

Common information controlling document
production.

CustomDocumentDetail
/LabelPrintingOrientation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail
/LabelRotation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail
/SpecificationId

Identifies the formatting specification used to
construct this custom document.

CustomDocumentDetail
/CustomDocumentIdentifier

Identifies the individual document specified by the
client.

CustomDocumentDetail
/DocTabContent

If provided, thermal documents will include
specified doc tab content. If omitted, document will
be produced without doc tab content.

CustomDocumentDetail
/CustomLabelDetail

This allows the customer to define how custom
information is to be positioned and formatted on a
custom label or the customizable portion of a
shipping label, and what the custom information
should be.

ShippingDocumentSpecification
/ReturnInstructionsDetail

Optional.
Specify the production of the return instructions
document.

ConsolidationDocumentSpecification

Optional.
Contains data used to create additional (non-label)
consolidation documents.

ConsolidationDocumentSpecification
/ConsolidationDocumentTypes

Yes

Optional.
Indicates the types of international distribution
documents requested by the shipper.
Valid values are:

FedEx Web Services, Developer Guide 2016



CONDENSED_CRN_REPORT



CONSOLIDATED_COMMERCIAL_INVOICE



CONSOLIDATED_CUSTOMS_LINEHAUL_REP
ORT



CONSOLIDATED_PARTY_REPORT



CONSOLIDATED_SOLD_TO_SUMMARY_REP
ORT



CRN_REPORT

Consolidation Services
Element

Multiple
Description
Occurrence


CUSTOMS_PACKING_LIST



CUSTOM_CONSOLIDATION_DOCUMENT



COMMODITIES_BY_TRACKING_NUMBER_RE
PORT

ConsolidationDocumentSpecification
/CondensedCrnReportDetail

Optional.
Specify the production of the short form of the Child
Reference Number document.

ConsolidationDocumentSpecification
/ConsolidatedCommercialInvoice

Optional.
Specify the production of the consolidated
commercial invoice document.

ConsolidationDocumentSpecification
/CustomDocumentDetails

Yes

Optional.
Specify the production of the consolidation-level
custom documents.

ConsolidationDocumentSpecification
/CustomsPackingListDetail

Optional.
Specify the production of the consolidation-level
customs packing list.

ConsolidationDocumentSpecification
/CrnReportDetail

Optional.
Specify the production of the Child Reference
Number document.

ConsolidationDocumentSpecification No
/CommoditiesByTrackingNumberRep
ortDetail

Optional.
Specify the production of the Commodities By
Tracking Number document.

RateRequestTypes

Optional.
Indicates the type of rates to be returned.
Valid values are:

Yes



LIST — Returns published rates in response.



PREFERRED — Returns rates in currency
specified in the PreferredCurrency element.



NONE — Returns no rates in response.

Note: To receive discount rates in the reply transaction, do
not send this element in the request.

EdtRequestType

FedEx Web Services, Developer Guide 2016

Optional.
Specify whether the customer wishes to have
estimated Duties and Taxes provided with the rate
quotation on this shipment. Only applies with
shipments moving under international services.

Consolidation Services
Element

Multiple
Description
Occurrence
Note: Individual Create OpenShipment transactions must
include the correct Harmonized Code for each
Commodity described in the requests to receive
Estimated Duties and Taxes when confirming the
consolidation.

Note: The ConfirmConsolidationReply table is for Synchronous mode only.

Table 32. ConfirmConsolidationReply
Element

Multiple Occurrence

Description

HighestSeverity

Identifies the set of severity values for a Notification.
Valid values are:

Notifications

JobId

Yes

FedEx Web Services, Developer Guide 2016



FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request. Valid values are:


SUCCESS – Your transaction succeeded with no
other applicable information.



NOTE – Additional information that may be of interest
to you about your transaction.



WARNING – Additional information that you need to
know about your transaction that you may need to
take action on.



ERROR – Information about an error that occurred
while processing your transaction.



FAILURE – FedEx was unable to process your
transaction at this time due to a system failure.
Please try again later.

—

Consolidation Services
Table 33: GetConfirmConsolidationResultsReply
Element

Multiple
Occurrence

Description

HighestSeverity

Identifies the set of severity values for a Notification.
Valid values are:

Notifications

Yes



FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request. Valid values are:


SUCCESS – Your transaction succeeded with no
other applicable information.



NOTE – Additional information that may be of
interest to you about your transaction.



WARNING – Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR – Information about an error that occurred
while processing your transaction.



FAILURE – FedEx was unable to process your
transaction at this time due to a system failure.
Please try again later.

JobId

—

AsynchronousProcessingResults

This indicates whether the transaction was processed
synchronously or asynchronously.

CompletedConsolidationDetail

—

CompletedConsolidationDetail
/ConsolidationShipments
/RequestedShipment
/SpecialServicesRequested
/DangerousGoodsDetail
/UploadedTrackingNumber

UploadedTrackingNumber element is used to identify
an instance of an uploaded dangerous goods handling
unit. This element is required only if you have already
validated DG data using the FedEx provided Dangerous
Goods / Hazardous Materials information upload option.

CompletedConsolidationDetail
/ConsolidationShipments
/RequestedShipment/

Shipment-level totals of dry ice data across all
packages.

FedEx Web Services, Developer Guide 2016

Consolidation Services
Element

Multiple
Occurrence

Description

ConsolidationDetail
/InternationalDistributionDetail
/SummaryDetail/DryIceDetail
CompletedConsolidationDetail
/ConsolidationShipment
/RequestedShipment
/LabelSpecification
/CustomerSpecifiedLabelDetail
/LabelMaskableDataType

Names of data elements/areas which may be
suppressed from printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_
NUMBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACCOUN
T_NUMBER

RequestedShipment
/SmartPostShipmentDetail
/SmartPostShipmentProcessing
OptionsRequested

Through this option, an existing SmartPost small
shipper or return shipper can specify to have the
Ground tracking number provided in the shipment reply.
This is a contingency feature in case the customer
requires the Ground tracking number for internal
processes or for tracking SmartPost shipments. The
Ground tracking number will only be provided for
existing SmartPost small shippers or return shippers.
Customers will have the same reporting and tracking
capabilities as today when they receive a Ground
tracking number. However, the Ground tracking
number will not be printed on the FXSP shipping label.
Fedex.com provides the same tracking visibility for
SmartPost shipments when using either the SmartPost
tracking number or the Ground tracking number. Fedex
recommends using fedex.com, rather than USPS.com,
for all tracking activities for SmartPost shipments.

RequestedShipment
/SmartPostShipmentDetail
/SmartPostShipmentProcessingOption
sRequested
/SmartPostShipmentProcessingOption
Type

Valid values:

CompletedConsolidationDetail
/ConsolidationShipment
/RequestedShipment
/ShippingDocumentSpecification
/CustomDocumentDetail

Data required to produce a custom-specified document,
either at shipment or package level.

FedEx Web Services, Developer Guide 2016



GROUND_TRACKING_NUMBER_REQUESTED

Consolidation Services
Element

Multiple
Occurrence

Description

CustomDocumentDetail
/Format

Common information controlling document production.

CustomDocumentDetail
/LabelPrintingOrientation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail
/LabelRotation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail
/SpecificationId

Identifies the formatting specification used to construct
this custom document.

CustomDocumentDetail
/CustomDocumentIdentifier

Identifies the individual document specified by the
client.

CustomDocumentDetail
/DocTabContent

If provided, thermal documents will include specified
doc tab content. If omitted, document will be produced
without doc tab content.

CustomDocumentDetail
/CustomLabelDetail

This allows the customer to define how custom
information is to be positioned and formatted on a
custom label or the customizable portion of a shipping
label, and what the custom information should be.

CustomLabelDetail
/CoordinateUnits

Valid values are:


MILS (thousanths of an inch)



PIXELS (device-dependent)

CustomLabelDetail
/TextEntries

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for thermal
labels) or generic font/size (for plain paper labels).

CustomLabelDetail
/GraphicEntries

Image to be included from printer's memory, or from a
local file for offline clients.

CustomLabelDetail
/BoxEntries

Solid (filled) rectangular area on label.

CustomLabelDetail
/CustomLabelTextBoxEntry

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for thermal
labels) or generic font/size (for plain paper labels).

CustomLabelTextBoxEntry
/TopLeftCorner

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry
/BottomRightCorner

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry
/Position

Horizontal and vertical position, relative to left edge of
custom area.

FedEx Web Services, Developer Guide 2016

Consolidation Services
Element

Multiple
Occurrence

Description

CustomLabelTextBoxEntry
/Format

Format

CustomLabelTextBoxEntry
/DataFields

Data fields

CustomLabelTextBoxEntry
/ThermalFontId

Printer-specific font name for use with thermal printer
labels.

CustomLabelTextBoxEntry
/FontName

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry
/FontSize

Generic font size for use with plain paper labels.

CustomLabelTextBoxEntry
/Rotation

Describes the rotation of an item from its default
orientation.
Valid values are:


NONE



RIGHT



UPSIDE_DOWN

CustomLabelDetail
/BarcodeEntries

Constructed string, based on format and zero or more
data fields, printed in specified barcode symbology.

RequestedPackageLineItem
/PackageSpecialServicesRequested
/DangerousGoodsDetail
/DangerousGoodsContainer
/HazardousCommodityContent
/NetExplosiveDetail

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.

RequestedPackageLineItem
/PackageSpecialServicesRequested
/DangerousGoodsDetail
/DangerousGoodsContainer
/HazardousCommodityContent
/NetExplosiveDetail
/NetExplosiveClassificationType

Valid values:

CompletedConsolidationDetail
/ConsolidationShipment
/RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/DocTabContent
/DocTabContentType

Valid values are:

FedEx Web Services, Developer Guide 2016



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT



BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001
85

Consolidation Services

Table 34. GetConfirmConsolidationResultsRequest
Element

Multiple
Occurrence

Description

UserDetail

Optional

JobId

Required

Asynchronous processing lets you specify the manner in which the shipment artifacts (shipping labels
and all associated documents) print. See Asynchronous Processing for more information. The following
documents print when you successfully complete a CONFIRM shipment transaction:


FedEx Consolidated Commercial Invoice



FedEx Domestic Express Courier Report — for Express packages



FedEx Ground Manifest Report — for Ground packages

FedEx Consolidation Services shipments are automatically confirmed and closed no later than one (1) day
after the ship date. Any shipment that has no packages is automatically deleted.

4.8

Requesting Consolidation Services

Flexible shipping requirements are provided as part of the FedEx Consolidation Services. To request
Consolidation Service for Rate/ Route/ Time-in-Transit, you can use:


RateService WSDL to obtain rate information



TrackService WSDL to obtain route and time-in-transit information

Run a Ground End of Day Close for the Account and Meter number at the end of the shipping day before
the Ground courier picks up the packages.

4.9

Consolidation Services Labels

FedEx Consolidation Services shipments are created using the Open Shipping method which allows you
to print labels at the end when you CONFIRM the shipment (Print-At-The-End mode). For more
information about Open Ship, see the Open Shipping chapter.
There is no label for the master (Canada to U.S.) shipment. Although multiple piece shipping (MPS) is
allowed, the child label always shows a “one-to-one” relationship with the package for which it was
generated. FedEx Consolidation Services labels do not display any package counts (for example: package
3 of a 10 package shipment does not display “3 of 10” on the label).

4.10 Ground Commercial Invoice
You can generate a FedEx Ground Commercial Invoice for all your FedEx Ground shipments. For U.S.
inbound and U.S. to CA shipments, you may generate the Commercial Invoice - Customs Entry (PAPS) by
specifying a RequestedConsolidationDocumentType of CONSOLIDATED_PARTY_REPORT and a
RequestedConsolidation of TRANSBORDER_DISTRIBUTION. This results in the
ReturnedConsolidationDocumentType of STANDARD_BROKER_CLEARANCE_PARTY_REPORT.
FedEx Web Services, Developer Guide 2016

Consolidation Services
This report provides consignee level shipment information for all buyers associated with the entry for the
Customs Entry (PAPS) in the consolidation and groups them by consignee. For any buyers to do not
quality for Section 321 entries (or the shipper selects to submit them as a Customs Entry due to
regulated commodities) the associated consignees must be submitted by Customs Entry (PAPS).
For U.S. inbound shipments only, you may generate the Commercial Invoice - Section 321. To quality for
Section 321 entry, the total value of all the commodities sold to a particular buyer must be $200 USD or
less. If any buyer qualifies for a Section 321 entry, the consignees associated with that buyer may be
listed on the CI for Section 321. The shipment details are grouped/listed by consignee.
Note: If a shipper decides to submit all of their shipments for a Customs Entry (PAPS), then all shipments in the
consolidation are listed on the CI for Customs Entry (PAPS), including any shipments that would have qualified
for Section 321. In this case, if a CI for Section 321 entry is printed, no shipment information would appear on
that report.

The Commercial Invoice (CI) contains the following shipment data.


Which buyers and associated shipments qualify for Section 321 of the Tariff Act of 1930.

Note: Merchandise (with the exception of textiles, waste and garbage shipments) valued at less than $200 U.S. may
be released without entry or payment of duty.



Which buyers and associated shipments qualify for Pre-Arrival Processing System (PAPS)

Note: The Pre-Arrival Processing System (PAPS) is a U.S. Bureau of Customs and Border Protection (CBP) crossborder cargo release mechanism that uses barcode technology to expedite the release of commercial
shipments while still processing each shipment through Border Cargo Selectivity (BCS) and the Automated
Targeting System (ATS).
Each PAPS shipment requires a unique barcode label, which the carrier attaches to the invoice and the truck
manifest while the merchandise is still in Canada. The barcode consists of the U.S. Standard Carrier Alpha
Code (SCAC) and Pro-Bill number. This information is then faxed ahead to the Customs broker in the U.S., who
prepares a BCS entry in the Automated Commercial System (ACS). Upon the truck’s arrival at the border, the
Customs Inspector scans the barcode, which automatically retrieves the entry information from ACS. If no
examination is required, the Inspector then releases the truck from the primary booth, reducing the carrier’s
wait time and easing congestion at the U.S. border.

4.11 Consolidated Commercial Invoice
To request the Consolidated Commercial Invoice, specify a RequestedConsolidationDocumentType of
CONSOLIDATED_PARTY_REPORT and the RequestedConsolidation of TRANSBORDER_DISTRIBUTION
and CustomsClearanceType of STANDARD_BROKER_CLEARANCE. The resulting Consolidated
Commercial Invoice provides the shipment information for all customs entry (PAPS) packages in the
consolidation and groups/lists them by "buyer" (SoldTo element). There are two version of this report:


U.S. inbound for IDD



U.S. to CA for IGD

The following is a review of each section of the FedEx Consolidated Commercial Invoice (CCI).
FedEx CCI Header
The CCI header provides the following shipment information:


Ship Date



International Air Waybill Number — Master air waybill (MAWB) tracking number for the shipment



Invoice Number — FedEx-generated invoice number for the shipment

FedEx Web Services, Developer Guide 2016

Consolidation Services
FedEx CCI Shipment Summary
The summary section which prints after the CCI header information provides this shipment level
information:


Shipper — identification of shipper from your shipper record



Consignee — FedEx location where the shipment is cleared by Customs



Broker — broker identification if you use a broker other than FedEx



Importer of Record — importer identification if an importer other than the shipper is used



Package Summary — totals for the shipment, including Weight, Currency Type and number of
packages (CRN)



Layout — groups the commodity and organizes it in a logical manner. The criteria for grouping
commodities are exact matching values of the following fields:
o
o
o
o

Description
Country of Manufacture
Unit of measure
HS Code (optional)

FedEx CCI CRN Data
Following the CCI summary section is the individual package information identifying each package in the
shipment. This information is entered as part of the request transaction and is required to clear packages
through Customs.
CCI Totals
A total of all package values for the shipment is listed at the bottom of the CCI. These totals include:


Total Shipment Weight — total weight of all packages in the shipment



Total Express Weight — total weight of packages to be shipped using FedEx Express after packages
have cleared Customs. When added to the Total Ground Weight, the sum equals the Total Shipment
Weight.



Total Ground Weight — total weight of packages to be shipped using FedEx Ground after packages
have cleared Customs. When added to the Total Express Weight, the sum equals the Total Shipment
Weight.



Total Commodity Value — total declared commodity value of all packages in the shipment



NCOterm — terms of sale for the shipment. For example: if FOB/FCA is selected, this indicates
Free on Board/Free Carrier as the terms of sale.



Freight — total freight charges for the shipment



Insurance — insurance costs for the shipment



Other — total of any ancillary charges incurred for shipping



Total Invoice Value — total value derived from the sum of the Total Commodity Value, Freight,
Insurance, and Other.

4.11.1 Ground Pickup Manifest
The FedEx Ground Pickup Manifest for FedEx Consolidated Services is identical to the standard report
generated for any type of FedEx Ground package shipping. The FedEx Ground Pickup Manifest is
FedEx Web Services, Developer Guide 2016

Consolidation Services
required by the FedEx Ground courier to tender packages for shipping. It provides a summary of the
packages picked up on a given day to the FedEx Ground courier and provides the following information:


Sender’s account number



Sender’s meter number



Tracking number for all packages



C.O.D. amount (if applicable)



Declared value (if applicable)



Number of Oversize I packages



Number of Oversize II packages



Number of packages requiring additional handling



Number of residential delivery packages



Total number of packages



Pickup number

If you have chosen to ship any FedEx Consolidated Services packages using FedEx Ground or FedEx
Home Delivery, the FedEx Ground Pickup Manifest prints after you CONFIRM the shipment.

4.11.2 Express Courier Report
The Express Courier Report for FedEx Consolidated Services is identical to the report generated for
express package shipping. The Express Courier Report is printed after you confirm a shipment when you
use the FedEx Express service to ship one or more FedEx Consolidated Services packages. The Express
Courier Report is required to tender packages for express shipping.

4.11.3 Cross-Border Linehaul Report
This report is generated for U.S. inbound shipments from either Canada or Mexico and provides the
following information:


Which buyers and associated shipments qualify for Section 321 of the Tariff Act of 1930.

Note: Merchandise (with the exception of textiles, waste and garbage shipments) valued at less than $200 U.S. may
be released without entry or payment of duty.



Which buyers and associated shipments qualify for Pre-Arrival Processing System (PAPS)



The drop off location and address



Third party drop off location or facility information

FedEx Web Services, Developer Guide 2016

Consolidation Services
To request the Cross-Border Linehaul Report, specify a RequestedConsolidationDocumentType of
CONSOLIDATED_CUSTOMS_LINEHAUL_REPORT and the RequestedConsolidation of
TRANSBORDER_DISTRIBUTION.

4.11.4 Commodity By Tracking Number Report
Commodity By Tracking Number Report is available in the RequestedConsolidationDocumentType
options in order to support consignee-level reporting of commodities.

4.12 International DirectDistribution (IDD) Service
IDD (formerly Transborder Distribution service) from Canada to the U.S. is made available to external
customers. The CI and CCI Shipment Details reports represent one of the minimum required Customs
reports needed for the consolidated shipment in order to successfully cross the international border into
the destination country.
CI Shipment Details provides the following information:


Provides the consignee level shipment information for all Broker Entry (PAPS) and/or Section
321packages in the consolidation and groups them by “Consignee” (i.e. “Delivered to” party)



CCI Shipment Details provides the following information:



The CCI Shipment Detail report provides the shipment information for all Broker Entry (PAPS)
Packages in the consolidation and groups/lists them by “Buyer” (i.e. “Sold to” party).

Note: Child shipments are listed in the CCI under one of the following conditions.



Child shipments that do not qualify for Section 321 are listed in the CCI for Customs entry by the
designated Broker.



The shipper specifies that all Child shipments in the consolidation are to be submitted for entry by
the Broker.



The IDD Linehaul Report provides the following information:



Which Buyers and associated shipments qualify for Section 321 and which qualify for PAPS.



The drop off location and address



Third Party Drop off Location or facility information.

Note: This report is also known as Consolidated Customs Linehaul Report and is generated for US inbound
shipments from either Canada or Mexico.

4.13 Useful Tips Consolidation Services Transactions
Consolidation shipments can be processed in two ways – synchronously and asynchronously depending
on the number of packages per shipment or package level commodities in a shipment. For synchronous
processing, a transaction can have either 40 packages/shipment only or 10 or less package level
commodities in a shipment.
Note: These limits are subjected to change. As a best practice, use ALLOW_ ASYNCHRONOUS option for
AsynchronousProcessingOptions element while processing Consolidation shipments and FedEx systems will
process the shipment either synchronously or asynchronously depending on the packages/shipments/package
level commodities. Also, make sure that you code to check for the reply which could contain either
“SYNCHRONOUSLY_PROCESSED” or “ASYNCHRONOUSLY_PROCESSED”.

FedEx Web Services, Developer Guide 2016

Consolidation Services
If the transaction is synchronously processed, then the reply will have the results. If the transaction is
asynchronously processed, then the reply only confirms that the request is queued successfully for
asynchronous processing. The shipment itself might not be successfully processed and so the
corresponding get result method will have to be used to check if the shipments were processed
successfully. Please give some time for the shipments to be processed successfully before you retrieve
the results. When shipments are processed asynchronously, run getConfirmConsolidationResults to see
the results.
The following 4 methods can be processed asynchronously –


CreateOpenShipmentRequest



ModifyOpenShipmentRequest



ConfirmOpenShipmentRequest



ConfirmConsolidationRequest

Best practice to process large number of packages asynchronously, when there are more number of
packages in a shipment, is to use ALLOW_ ASYNCHRONOUS option for
AsynchronousProcessingOptions element and run them using multiple transactions with each
transaction having manageable number of packages say 50 or 100 and set disposition type as STORED
to store the labels. These labels can then be retrieved using retrieveJobResults.

FedEx Web Services, Developer Guide 2016

Country Service

Country Service enables customers to validate postal codes and service commitments. Supports city,
postal, country and Origin-Destination related lookups and validations. Also returns postal and location
details in the ValidatePostalReply.

5.1

Country Service Coding Details

In addition to the basic request elements required for all operations, the following elements are available
when coding a ValidatePostalRequest:
Table 35. ValidatePostalRequest Elements
Element

Description

ShipDateTime

Specify the Ship date and time.

Address

RoutingCode

Routing code is the information that identifies the route the package or
shipment may take.
The element checks for mismatch between state and city values. The City
and State is set if CheckForMismatch is true and if country is US or CA.
Identification of a FedEx operating company.
Examples of FedEx Operating Companies are:

CheckForMismatch
CarrierCode



FDXE - FedEx Express



FDXG - FedEx Ground



FXFR - FedEx Freight



FXSP - FedEx SmartPost



FXCC - FedEx Custom Critical

ValidatePostalReply data (based on your search criteria) are returned in a ValidatePostalReply.
Table 36. ValidatePostalReply Elements
Element

Description

PostalDetail

Postal detail.

PostalDetail/StateOrProvinceCode

State or province code.

PostalDetail/CityFirstInitials

City first initials.

PostalDetail/CleanedPostalCode

Cleaned postal code.

FedEx Web Services, Developer Guide 2016

Country Service

Element

Description

PostalDetail/LocationDescription

Location description.

Example 7:

Validate Postal Request

XXXXXXXXXX
XXXXXXXXXX

XXXXXXXXXX
XXXXXXXXXX
US

EN
US

ValidatePostalRequest_Basic

EN
US
7

cnty
3
0
0

FedEx Web Services, Developer Guide 2016

Country Service
2015-02-05T12:34:56-06:00

StreetLine_101
PIPERTON
TN
38017
US
1

FDSD
1
FDXE

FedEx Web Services, Developer Guide 2016

Create a Label

FedEx Web Services supports a variety of label options, including thermal, plain paper, and customizable
labels. With FedEx Web Services, you can use the Ship Service to produce a wide variety of labels. In
this section, you will find instructions for generating the labels you need to support your shipping
application.
FedEx offers 2 label formats to support shipping services:


Thermal Labels



Laser Labels

6.1

Thermal Labels

FedEx Web Services allows you to print shipping labels for all shipping types, such as FedEx Express ®,
FedEx Ground®, and FedEx International Ground® using a variety of thermal label printers. The following
thermal label sizes are supported by FedEx Web Services:


4" x 6" — without a configurable document tab (Doc-Tab)



4" x 6.75" — includes a Doc-Tab



4" x 8" — provides space to include a graphic or text file of your choice



4" x 9" — provides space for graphics or text as well as a Doc-Tab

If you print shipping labels using a thermal printer, you may choose label stock that includes a Doc-Tab, a
removable sticky tab with additional shipping information. You can configure this shipping information
from your shipping data or choose to print configurable data that is specific to your shipping needs.

6.1.1

Thermal Label Elements

Thermal shipping labels contain three basic elements:
1. Human-readable content: this part of the label contains the shipping information from the FedEx Web
Services Ship Service.
2. Ground Human Readable Barcode will be encrypted by default.
3. Two dimensional (2D) barcode: the dimensional alphanumeric barcode stores data for both FedEx
Express and FedEx Ground shipments using the American National Standards Institute (ANSI)
MH10.8.3 standard. The 2D barcode is created using the Portable Document Format (PDF) 417
symbology.
4. FedEx specific barcode:
a.

ASTRA (Advanced Sorting Tracking Routing Assistance) for FedEx Express shipments until the
FDX 1D barcode has been fully phased in; barcode "96" for FedEx Ground and FedEx Home
Delivery® shipments. FedEx Ground also allows for the use of the SSCC-18 "00" barcode.
b. FedEx 1D (FDX1D) barcode for FedEx Express shipments is created using ANSI/AIM BC4-1995
(Uniform Symbology Specification Code-128)
All labels required for a shipment are generated and returned in a single buffer. For example, if a label
request is made on a C.O.D. shipment, the label server returns the shipping label and a copy of the

FedEx Web Services, Developer Guide 2016

Create a Label
C.O.D. Return label. The label server always returns the appropriate quantity of labels for each type of
shipment, so the client does not need to make multiple label calls to FedEx.
The following FedEx Web Services elements are required to generate a thermal label:
Table 37. ThermalLabel Elements
Web Services Element
LabelSpecification/LabelFormatType

LabelSpecification/ImageType

Description/Valid Values
Required to receive the correct label image in the Ship
Reply service:
Valid values:


COMMON2D: The label format type to receive a
label.



FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING



LABEL_DATA_ONLY: The value used to receive the
barcode data if you create a custom label.



VICS_BILL_OF_LADING

Required to format the thermal label for the printer you
use; provides the type of data stream or bitmap to be
returned.
Valid values:


DOC



EPL2 — Eltron



PDF



PNG



RTF



TEXT



ZPLII — Zebra

Note: These printers are all compatible with the ASCII Eltron
Programming Language (EPL2) page mode.

LabelSpecification/LabelStockType

CustomerSpecifiedLabelDetail/
FedEx Web Services, Developer Guide 2016

Required only for thermal labels. Specify whether label
stock has Doc-Tab on leading or trailing end of labels or
has no Doc-Tab.
Valid values:


STOCK_4X6



STOCK_4X6.75_LEADING_DOC_TAB



STOCK_4X6.75_TRAILING_DOC_TAB



STOCK_4X8



STOCK_4X9_LEADING_DOC_TAB



STOCK_4X9_TRAILING_DOC_TAB

Defines any custom content to print on the label.
96

Create a Label
Web Services Element
CustomContent

Description/Valid Values

CustomContent/CoordinateUnits

Valid values for CustomLabelCoordinateUnits:


MILS



PIXELS

CustomContent/TextEntries

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for thermal
labels) or generic font/size (for plain paper labels).

CustomContent/GraphicEntries

Image to be included from printer's memory, or from a
local file for offline clients.

GraphicEntries/Position

X and Y position of the graphic.

GraphicEntries/PrinterGraphicId

Printer-specific index of graphic image to be printed.

GraphicEntries/FileGraphicFullName

Fully-qualified path and file name for graphic image to be
printed.

CustomContent/BoxEntries

Solid (filled) rectangular area on label.

BoxEntries/TopLeftCorner

The custom label position of the top, left corner.

BoxEntries/BottomRightCorner

The custom label position of the bottom, right corner.

CustomContent/BarcodeEntries

Constructed string, based on format and zero or more
data fields, printed in specified barcode symbology.

CustomerSpecifiedLabelDetail/
SecondaryBarcode/SecondaryBarcodeType

Requests customer-specific barcode on FedEx Ground
and FedEx Home Delivery labels.
Valid values:


NONE



COMMON_2D



SSCC_18



USPS

Note:USPS is applicable for FedEx SmartPost shipments.

6.1.2

Send Thermal Label to Local or Network Printer

If you use FedEx Web Services (SOAP request) or non-SOAP requests, the returned label buffer is
Base64 encoded. Therefore, before you send the commands to the printer, you must Base64 decode the
buffer. You can perform Base64 encoding and decoding using built-in functions of many XML parsers or
Microsoft XML Core Services (MSXML). Once decoded, the thermal label buffer contains a list of printer
commands to print the label for the type of printer you select in your Ship request. To print the thermal
label, send that list of commands to the configured printer port for your thermal printer. Be sure to
include the CR/LF characters as you send the commands to the printer.
Note: Labels may be reprinted by sending the original thermal label buffer to the printer. However, labels should be
reprinted only if the original label is damaged or lost before the package is picked up, or as a copy for your
records. Duplicate labels applied to packages will cause re-labeling and, in some cases, suspension of your
shipping capabilities.

FedEx Web Services, Developer Guide 2016

Create a Label

6.1.3

Supported Thermal Printers

The following thermal printers are recommended with FedEx Web Services:


Unimark



Eltron
o
o



Orion (EPL2)
Eclipse (EPL2)

Zebra
o
o
o
o
o

LP2443 (EPL2)
LP2844 (EPL2)
LP2348 Plus (EPL2)
Z4M Plus (ZPL or EPL)
ZP500 (ZPL or EPL)

These printers are all compatible with the ASCII Eltron Programming Language (EPL2) page mode. If your
printer supports this programming language it may work as well. Check your printer user’s guide for
details. Thermal printers are supported both as a direct write to the printer connected to a system serial
port, and as a native Windows installed printer for LPT, Serial, or USB connections.

6.1.4

Number of Thermal Labels Printed Per Service

The following table indicates the number of each type of label needed for a specific special service. All
the necessary labels are generated by a call to the FedEx Common Label Server (CLS), and CLS returns a
single buffer with the exception of the C.O.D. Return labels.
Table 38. Number of Thermal Labels Printed Per U.S. Service
Service Type

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)

FedEx Express U.S.

1 Shipping label

FedEx Express U.S. C.O.D.

1 Shipping label
1 C.O.D. (Collect On Delivery) Return label

FedEx Ground U.S. / FedEx Home Delivery

1 Shipping label

FedEx Ground U.S. C.O.D.

1 Shipping label
2 C.O.D. Return labels

Table 39. Number of Thermal Labels Printed Per U.S. Export Intn'l Service
Service Type
FedEx Express U.S. Export International

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)
1 Shipping label
2 Recipient labels

FedEx Express U.S. Export International
Broker Select Option

1 Shipping label
2 Recipient labels

FedEx Ground U.S. Export International

1 Shipping label

FedEx Web Services, Developer Guide 2016

Create a Label
Service Type
FedEx Ground U.S. Export International
C.O.D.

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)
1 Shipping label
2 C.O.D. Return labels

Table 40. Number of Thermal Labels Printed Per Intra-Canada Service
Service Type
FedEx Express intra-Canada

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)
Non-DG (Dangerous Goods)/Dry ice shipment:
1 Shipping label

FedEx Ground intra-Canada

1 Shipping label

FedEx Ground intra-Canada C.O.D.

1 Shipping label
2 C.O.D. Return labels

Table 41. Number of Thermal Labels Printed Per Canada Export International Service
Service Type
FedEx Express Canada Export International

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)
Non-DG/Dry ice shipment:
1 Shipping label
2 Recipient labels

FedEx Express Canada Export International
Broker Select

Non-DG/Dry ice shipment:
1 Shipping label
2 Recipient labels

FedEx Ground Canada (CA) Export
International

1 Shipping label

Table 42. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments
Service Type
Thermal Labels (FedEx CLS will return the appropriate
number of labels in the response)
Philippines inbound shipments

2 Shipping labels with account number printed
1 Recipient label without account number printed
3 Commercial Invoice copies

Thailand inbound commodity shipments

3 Shipping labels with account number printed
1 Recipient label without account number printed

Thailand inbound document shipments

2 Shipping labels with account number printed
1 Recipient label without account number printed

FedEx Web Services, Developer Guide 2016

Create a Label

6.2

Doc-Tab Configuration

The notation for specifying Doc-Tab value sources begins as a strict subset of standard XPath notation,
with a small set of Doc-Tab-specific extensions (described below). A path is prefixed with a small set of
“aliases” that identify the object to which the rest of the path applies.
The following examples should give the overall “look and feel” of the notation:
Table 43. Doc-Tab Configuration Elements
Desired element

Doc-Tab path (string)

Shipper’s company name

REQUEST/SHIPMENT/Shipper/Contact/CompanyName

Total number of packages

REQUEST/SHIPMENT/PackageCount

Current package’s sequence
number

REQUEST/PACKAGE/SequenceNumber

Current package’s weight

REQUEST/PACKAGE/Weight/Value

Shipment total net charge

REPLY/SHIPMENT/RATES/ACTUAL/TotalNetCharge/Amount

Current package’s dim weight

REPLY/PACKAGE/RATES/ACTUAL/DimWeight/Value

Contents of the first Customer
Reference Field

REQUEST/PACKAGE/CustomerReferences[1]/Value
Defines the first record of a possible multi-occurence array

Total Net Charge using List rates

REPLY/SHIPMENT/RATES/PAYOR_LIST_PACKAGE/TotalNetCharg
e/Amount
Note: RateRequestTypes value must be "LIST" in the request so that List
rates are included in the reply.

Every “segment” (portion between “/” separators) in these samples is the actual name of an element
from the WSDL, except for the starting segments, which specify where to begin navigating to the
desired data. The client developer would know what names are available from the WSDL. The notation is
case-sensitive and the client should use the same names as in the WSDL.

6.2.1

Doc-Tab Coding Details

All data from the customer’s description of the shipment (RequestedShipment) and the data returned to
the customer (CompletedShipmentDetail) is eligible for use in the Doc-Tab. The complete structure of
those objects is necessarily complex, due to the tremendous range of service features that may occur
within a FedEx shipment. The first segments of a Doc-Tab path come from a set of alias/shortcut values
that allow the customer to indicate whether the requested value is to come from one of the following:


Client or transaction detail



Request or reply data



Shipment- or Package-level data



Rate data, and if so, which rate type

Note: You must include the LabelPrintingOrientation element within the CustomDocumentDetail, or doc-tabs will not

FedEx Web Services, Developer Guide 2016

100

Create a Label
print.

The prefix (leading segments) of the path specifies the above choices in that order, as shown in the
following tables:
Table 44. Doc-Tab Prefix (Non-Rate Data)
Prefix (Non-Rate Data)
ClientDetail/…

Remainder of path selects data from…
The effective copy of the ClientDetail

TransactionDetail/…

The effective copy of the TransactionDetail

RequestedShipment/…

The effective copy of the RequestedShipment

RequestedPackageLineItem/…

The effective copy of the current RequestedPackage

CompletedShipmentDetail/…

The CompletedShipmentDetail

CompletedPackageDetail/…

The CompletedPackageDetail

Table 45. Doc-Tab Prefix (Rate Data)
Prefix (Rate Data)

Remainder of path selects data from…

RateReply/RateReplyDetail/
RatedShipmentDetail/ShipmentRateDetail/...

Shipment-level rate data (totals for actual rate
applied)

RateReply/RateReplyDetail/
RatedShipmentDetail/
ShipmentRateDetail/
ReturnedRateType/…

Shipment-level rate data (totals for specific returned
rate type) ok

RateReply/RateReplyDetail/
RatedShipmentDetail/RatedPackageDetail/
PackageRateDetail/...

Package-level rate data (details for actual rate
applied)

RateReply/RateReplyDetail/
RatedShipmentDetail/RatedPackageDetail/
PackageRateDetail/ReturnedRateType/...

Package-level rate data (details for specified
returned rate type) ok

Example 8:

Doc-Tab Coding

COMMON2D
EPL2
STOCK_4X6.75_LEADING_DOC_TAB
TOP_EDGE_OF_TEXT_FIRST

ZONE001

FedEx Web Services, Developer Guide 2016

101

Create a Label
1
REF
REQUEST/PACKAGE/CustomerReferences[CustomerReferenceType="CUSTOMER_REFER
ENCE"]/value
LEFT

2
INV
REQUEST/PACKAGE/CustomerReferences[CustomerReferenceType="INVOICE_NUMBER
"]/value
LEFT

3
PON
REQUEST/PACKAGE/CustomerReferences[CustomerReferenceType="P_O_NUMBER"]/v
alue
LEFT

4
SHP
REQUEST/SHIPMENT/ShipTimestamp
LEFT

5
WHT
REQUEST/PACKAGE/weight/Value
LEFT

6
INS
REQUEST/PACKAGE/InsuredValue/Amount
LEFT

FedEx Web Services, Developer Guide 2016

102

Create a Label
7
COD
REQUEST/SHIPMENT/SpecialServicesRequested/CodDetail/CodCollectionAmount/
Amount
LEFT

8
DLV
REPLY/SHIPMENT/OperationalDetail/DeliveryDate
LEFT

9
BASE
REPLY/PACKAGE/RATE/ACTUAL/BaseCharge/Amount
LEFT

10
DISC
REPLY/PACKAGE/RATE/ACTUAL/TotalFreightDiscounts/Amount
LEFT

11
SURCHG
REPLY/PACKAGE/RATE/ACTUAL/TotalSurcharges/Amount
LEFT

12
NETCHG
REPLY/PACKAGE/RATE/ACTUAL/NetCharge/Amount
LEFT

SHIPPER_ACCOUNT_NUMBER

FedEx Web Services, Developer Guide 2016

103

Create a Label

6.2.2

Doc-Tab Specification

The RequestedShipment contains a LabelSpecification that describes each zone on the Doc-Tab portion
of the label by a DocTabZoneSpecification, located as follows:
RequestedShipment
…
LabelSpecification (LabelSpecification)
CustomerSpecifiedLabelDetail (CustomerSpecifiedLabelDetail)
DocTabContent (DocTabContent)
DocTabContentType (DocTabContentType)
Zone001 (DocTabContentZone001)
DocTabZoneSpecifications[] (DocTabZoneSpecification)
ZoneNumber (positiveInteger)
Header (string)
DataReference (string)
LiteralValue (string)
Justification (DocTabZoneJustificationType:string)

After identifying the zone number, the specification can indicate:


An optional header



Either a data reference (path to a request/reply element) or a literal value (actual data to be printed)



An optional justification

Literal value takes precedence over data reference when a reference data and literal value are passed.
The reference data specifies a path to the element desired, based on a specific starting point:


Client detail data (ClientDetail)



Transaction detail data (TransactionDetail)



Request data for the entire shipment (RequestedShipment)



Request data for the current package (RequestedPackage)



Reply data for the entire shipment (CompletedShipment)



Reply data for the current package (CompletedPackage)

The path is made up of selectors, each of which specifies a step “into” the structure of the starting-point
object. For single-valued (non-array) elements, the name of the element is the selector. All examples on
the previous page used single-valued elements.
Array elements are qualified by a predicate that indicates which element of the array should be used,
either by position or by content.
Examples of this usage would be:
Shipper’s first street address line: REQUEST/SHIPMENT/Shipper/Address/StreetLines[1]

FedEx Web Services, Developer Guide 2016

104

Create a Label
Third-party number of shipment uploaded to FedEx InSight® system:
REQUEST/SHIPMENT/ShipmentContentRecords[3]/PartNumber
Shipment fuel surcharge:
REPLY/PACKAGE/RATES/PAYOR_ACCOUNT/Surcharges[SurchargeType="FUEL"]/Amount

There are few cases where array elements would be needed; the most likely scenario involves data
(such as surcharges and taxes).
Example 9:
ZoneNumber 1-8 specify data elements (using the XPath notation) and Zone 9
specifies a literal value.

COMMON2D
EPL2
STOCK_4X6.75_LEADING_DOC_TAB
TOP_EDGE_OF_TEXT_FIRST

ZONE001

1
Street
REQUEST/SHIPMENT/Shipper/Address/StreetLines[1]

2
Meter
CLIENT/MeterNumber

3
TransId
TRANSACTION/CustomerTransactionId

4
TotalSur
REPLY/SHIPMENT/RATES/PAYOR_ACCOUNT/TotalSurcharges/
Amount

FedEx Web Services, Developer Guide 2016

105

Create a Label
5
TotalWt
REQUEST/SHIPMENT/TotalWeight/Value

6
Date
REQUEST/SHIPMENT/ShipTimestamp

7
Contact
REQUEST/SHIPMENT/Recipient/Contact/PersonName

8
Insured
REQUEST/PACKAGE/InsuredValue/Amount

9
Literal 1
mytext

6.3

Laser Labels

FedEx Web Services supports label printing with a laser printer. Labels that are printed with a laser
printer are generated in PDF format and do not need to be scaled or resized. These labels are usually
printed on U.S. Letter or A4 paper and folded in half to fit in the standard FedEx label pouch. The
following requirements apply to PDF labels:


Adobe Reader 6.0 or higher is required to process the label.



Printer driver configuration must have printer scaling set to none.



Using an HTML wrapper is not necessary for displaying a plain paper PDF label in a browser.



Acrobat recommends the following browsers for viewing PDF documents:
o

Microsoft Internet Explorer 10 or higher

FedEx Web Services, Developer Guide 2016

106

Create a Label
o
o

Firefox 1.0 or higher
Mozilla 1.7 or higher

The PDF label option eliminates the need to specify the image orientation parameter (width and height)
or the screen resolution to display the label properly in the browser.

6.3.1

Laser Label Elements

Laser shipping labels contain three basic elements:
1. Human-readable content — This part of the label contains the shipping information from FedEx Web
Services Ship Services.
2. Ground Human Readable Barcode will be encrypted by default.
3. Two dimensional (2D) barcode — The dimensional alphanumeric barcode stores data for both FedEx
Express and FedEx Ground shipments using American National Standards Institute (ANSI) MH10.8.3
standard. The 2D barcode is created using the Portable Document Format (PDF) 417 format.
4. FedEx specific barcode:
a.

6.3.2

Generating a Laser Label

The following FedEx Web Services elements are required to generate a laser label:
Table 46. WebServices Elements
Web Services Element

Description

LabelSpecification/LabelFormatType

Required to receive the correct label image in the Ship Reply
service:
Valid values:

LabelSpecification/ImageType



COMMON2D — label format type to receive a label.



FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING — creates
a FedEx Freight (LTL) Bill of Lading, which is formatted for
an 8.5x11" sheet of plain paper.



LABEL_DATA_ONLY — this value is used to receive the
barcode data if you create a custom label.



VICS_BILL_OF_LADING — Creates a FedEx Freight (LTL)
VICS Bill of Lading, which is formatted for an 8.5x11" sheet
of plain paper.

Required to indicate label formatting. Type of data stream or
bitmap to be returned:
Valid values are:

FedEx Web Services, Developer Guide 2016

107

Create a Label

Web Services Element

LabelSpecification/LabelStockType

Description


PDF — plain paper



PNG — plain paper



DOC



RTF



TEXT



EPL2



ZPLII

Required for all label types. Specify whether label stock has DocTab on leading or trailing end of labels or has no Doc-Tab.
When using an ImageType of PDF or PNG,


these values display a thermal format label:
o
o
o



PAPER_4X6
PAPER_4X8
PAPER_4X9

These values display a plain paper format shipping label:
o
o
o
o

PAPER_7X4.75
PAPER_8.5X11_BOTTOM_HALF_LABEL
PAPER_8.5X11_TOP_HALF_LABEL
PAPER_LETTER

Note: If you request a plain paper label, the data returned is a Base64 encoded label image, which must be Base64
decoded prior to displaying the label file.

6.3.3

Supported Laser Printers

Most laser printers are supported for this label type; however, labels will not be accepted if they are
printed on an ink jet printer. If you are using a color laser printer, the color definition should be set to
black, even if the printer only has a black cartridge installed. This setting is necessary to achieve the
correct barcode definition for scanning at the FedEx hubs.

6.3.4

Printing a Laser Label

FedEx returns one laser label per shipping request, with the exception of C.O.D. labels. If you need to
print multiple labels (for example, international shipments need additional copies of shipping labels to
accompany the customs clearance documentation), you must request additional copies.
To prepare your package for shipment, you must:
1. Use the Print button on your browser to print the page containing your label.
2. The shipping portion of the laser label prints on the top half of an U.S. Letter or A4 page.
3. If you use FedEx approved label stock that accommodates the half page label as a peel and stick,
affix this portion of the label to the package. The bottom portion of the label provides terms and
conditions and a recap of your tracking number. This portion of the label should be kept for your
records.
4. If you use plain paper instead of label stock, fold the page in half and place it in a waybill pouch.
FedEx Web Services, Developer Guide 2016

108

Create a Label
Attach the pouch to your package so that the barcode portion of the label can be read and scanned.
Note: Labels may be reprinted by sending the original PDF to the printer. However, labels should be reprinted only if
the original label is damaged or lost before the package is picked up or as a copy for your records. Duplicate
labels applied to packages will cause re-labeling and, in some cases, suspension of your shipping capabilities.
Note: For all Mexico to Mexico shipments, if no language is specified, the Legal Terms and Conditions will be
provided in Spanish.

6.3.5

Account Masking on Shipping Label

The purpose of the Account Masking on Shipping Label feature is to prevent the exposure of the FedEx
account numbers to the final recipient of the shipment:


Prevent account numbers from printing on International and non-US Domestic Express plain paper
shipping labels.



The account numbers continue to print on FedEx plain paper Air Waybill copies used by operations
and customs clearance.

By adopting the Thermal Label Layout on plain paper labels, the above requirements are satisfied while
moving FedEx towards harmonizing the label images, regardless of the requested format (thermal, pdf,
png, and dib).
Shipping clients will now receive 2 new label images from Common Label Service (CLS), and will print
appropriate numbers of copies as defined by current business rules for the origin and destination
countries and shipment type (doc, non-doc, ITAR, etc).

6.3.6

Number of Laser Labels Required Per Service

The following table indicates the number of each type of label needed for a specific special service. All
the necessary labels are generated by a call to the FedEx Common Label Server (CLS), and CLS returns a
single buffer with the exception of the C.O.D. Return labels.
Table 47. Number of Thermal Labels Printed Per U.S. Service
Service Type

Laser Label - PDF Format

FedEx Express U.S. C.O.D.

1 Shipping label
1 C.O.D. (Collect On Delivery) Return label

FedEx Ground / FedEx Home Delivery
U.S.

1 Shipping label

FedEx Ground U.S. C.O.D.

1 Shipping label
2 C.O.D. Return labels

Table 48. Number of Thermal Labels Printed Per U.S. Export International Service
Service Type

Laser Label - PDF Format

FedEx Express U.S. Export International

1 Shipping label in the reply; a minimum of 3 labels must be
printed — 1 label on the package and 2 in the document
pouch.

FedEx Express U.S. Export International
Broker Select

1 Shipping label in the reply; a minimum of 3 labels must be
printed — 1 label on the package and 2 in the document
pouch.

FedEx Web Services, Developer Guide 2016

109

Create a Label
Service Type

Laser Label - PDF Format

FedEx Ground U.S. Export International

1 Shipping label

FedEx Ground U.S. Export International
C.O.D.

1 Shipping label
2 C.O.D. Return labels

Table 49. Number of Thermal Labels Printed Per Intra-Mexico Service
Service Type

Laser Label - PDF Format

FedEx Express Intra-Mexico

FedEx Express Intra-Mexico
Non-DG (Dangerous Goods)/Dry ice shipment:
1 Shipping label

Table 50. Number of Thermal Labels Printed Per Intra-Canada Service
Service Type

Laser Label - PDF Format

FedEx Express Intra-Canada

FedEx Express Intra-Canada
Non-DG (Dangerous Goods)/Dry ice shipment:
1 Shipping label

FedEx Ground Intra-Canada

1 Shipping label

FedEx Ground Intra-Canada C.O.D.

1 Shipping label
2 C.O.D. Return labels

Table 51. Number of Thermal Labels Printed Per Canada Export Int'l Service
Service Type

Laser Label - PDF Format

FedEx Express Canada Export International

FedEx Express Canada Export International
Non-DG/Dry ice shipment:
1 Shipping label
2 Recipient labels

FedEx Express Canada Export International
Broker Select

FedEx Express Canada Export International Broker
Select
Non-DG/Dry ice shipment:
1 Shipping label
2 Recipient labels

FedEx Ground Canada (CA) Export
International

1 Shipping Label

FedEx Web Services, Developer Guide 2016

110

Create a Label
Table 52. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments
Service Type
Philippines inbound shipments

Thailand inbound commodity shipments

Thailand inbound document shipments

6.4

Thermal Labels (FedEx CLS will return the
appropriate number of labels in the response)
2 Shipping labels with account number printed
1 Recipient label without account number printed
3 Commercial Invoice copies
3 Shipping labels with account number printed
1 Recipient label without account number printed
2 Shipping labels with account number printed
1 Recipient label without account number printed

Custom Labels

FedEx allows some customizing of the FedEx-generated label. The label's human readable content and
barcode in the common portion of the label cannot be altered. However, you may add text pertaining to
your business and choose the type of barcode (symbology) used on FedEx documents and labels in the
custom portion of thermal labels. To support your shipping application, FedEx Web Services provide two
options for customizing your shipping label:
1. Place the PNG PAPER 7" x4.75" graphic on your label stock. For example, you may create a packing
list on an 8-1/2" x 11" form. As part of this form, you may also place the 7" x 4.75" PNG PAPER
graphic instead of creating a custom label on your own.
2. Add a graphic or text file to the 4" x 8" or 4" x 9" thermal label. This label size provides 2 inches of
space for your graphic or text.

FedEx Web Services, Developer Guide 2016

111

Create a Label

6.4.1

Custom Validator Label

You can create non-shipping custom labels at both package-level and shipment-level by specifying what
custom information is desired, how to format that information, and where to place it on the custom label.
Custom labels are limited to the thermal label format.
For a complete list of elements used in custom validator label, see the elements under
CustomDocumentDetail in Requested Shipment Elements table.
Figure 1: Custom Validator Label

6.4.2

Customize a Thermal Label

FedEx Web Services provides two thermal label formats that you can customize with either a graphic or
text file t prevent the need for creating a custom label. These labels support all FedEx shipping services.
These formats are:


4" x 8" thermal label without Doc-Tab



4" x 9" thermal label with Doc-Tab

These label types provide a 2 inch customizable section. This feature is only applicable to the thermal
label printed on a thermal printer set to 203 DPI.
Rules for using the label formats are:
FedEx Web Services, Developer Guide 2016

112

Create a Label


Only the shipping label can be customized. For example, if you print a 4" x 8" Express shipping label
with your logo, the secondary recipient labels will not display it.



The customizable graphic or text must not exceed 2 inches high and 4-1/2 inches wide.



No correction is provided by FedEx. The graphic and/or text prints as it is submitted in the shipping
service.



If all the necessary data for printing the graphic and/or text is not provided (for example: X and Y
coordinates), a valid shipping label is returned without the customized data. You must cancel the
shipment represented by this label if you attempt to recreate another label with the graphic and/or
text.



Regarding the placement on X and Y coordinates, insertion point coordinate datum is the intersection
of the top and left edges of the 4.00” x 6.75” thermal label with bottom doc tab. For 4.00” x 6.75”
thermal label with top doc tab, increment insertion point coordinate Y values by 164 dots. For 4.00” x
6.00” label without doc tab, increment insertion point coordinate Y values by 8 dots. Thermal label
element attributes are based on 203 DPI (8 dots/mm) printer resolution.



Character insertion point is the top left corner of the first character in the string, at the cap line.



Printer restrictions require the position origin at the top left quadrant of the front. Therefore, it is
possible for data to start in the customizable section of the label and write down into the FedEx
portion of the label (actual thermal label data). If this occurs, your logo or text will be written over
with the FedEx label information. You must correct this positioning to use the shipping label.



The addition of Doc-Tab information to the 4" x 9" label must be configured using the same process
as you would use for a standard 4" x 6" Doc-Tab thermal label.

To Add Text to the 4x8 or4x9 Label, in the Ship Service WSDL, use the following elements.
Table 53. Custom Label Elements for Text
Web Services Element

Description/Valid Values

RequestedShipment
/LabelSpecification

Description of shipping label to be returned in the reply.

RequestedShipment
/LabelSpecification
/Dispositions

Specify how to create, organize, and return the document.

RequestedShipment
/LabelSpecification
/LabelFormatType

Specify the type of label to be returned. The label format type
should be set to COMMON2D.

RequestedShipment
/LabelSpecification
/ImageType

Specify the image type of this shipping document.

RequestedShipment
/LabelSpecification
/LabelStockType

For thermal printer labels this indicates the size of the label
and the location of the doc tab if present. Either STOCK_4X8
or STOCK_4X9_LEADING_DOC_TAB.

RequestedShipment
/LabelSpecification

This indicates if the top or bottom of the label comes out of
the printer first.

FedEx Web Services, Developer Guide 2016

113

Create a Label

Web Services Element

Description/Valid Values

/LabelPrintingOrientation
RequestedShipment
/LabelSpecification
/PrintedLabelOrigin

If present, this contact and address information will replace
the return address information on the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail

Allows customer-specified control of label content.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/DocTabContent

If omitted, no doc tab will be produced, such as the default is
former NONE type).

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContentPosition

RelativeVerticalPositionType

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent

Defines any custom content to print on the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/CoordinateUnits

Valid values for CustomLabelCoordinateUnits.
Valid values are:

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries/Position

Contains the x/y coordinates for placement of the text.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/Position
/X

Horizontal position, relative to left edge of custom area.
Only non-negative integers may be used.

RequestedShipment
/LabelSpecification

Vertical position, relative to the top edge of the custom area.
Only non-negative integers may be used.



MILS



PIXELS

FedEx Web Services, Developer Guide 2016

114

Create a Label

Web Services Element

Description/Valid Values

/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/Position
/Y
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/Format

Contains the text to be printed on the label.
Note: This is a format string used to format the printed text. It is not
the actual text.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/DataFields

Contains the text to be printed on the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/ThermalFontID

Printer-specific font name for use with thermal printer.
Valid values are from 1 to 23.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/FontName

Generic font name for use with plain paper labels.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/FontSize

Generic font size for use with plain paper labels.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/TextEntries
/Rotation

Relative to normal orientation for the printer.
Valid values:

RequestedShipment
/LabelSpecification



LEFT



NONE



RIGHT



UPSIDE_DOWN

Solid (filled) rectangular area on label.

FedEx Web Services, Developer Guide 2016

115

Create a Label

Web Services Element

Description/Valid Values

/CustomerSpecifiedDetail
/CustomContent
/BoxEntries
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries

Constructed string, based on format and zero or more data
fields, printed in specified barcode symbology.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position

Contains the x/y coordinates for placement of the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position/X

Horizontal position, relative to left edge of custom area.
Only non-negative integers may be used.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position/Y

Vertical position, relative to the top edge of the custom area.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Format
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/DataFields
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/BarHeight
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/ThinBarWidth

Width of thinnest bar/space element in the barcode.

FedEx Web Services, Developer Guide 2016

116

Create a Label

Web Services Element

Description/Valid Values

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries
/BarcodeSymbology

Identification of the type of barcode (symbology) used on
FedEx documents and labels. Specify the
BarcodeSymbologyType.
Valid values:


CODEBAR



CODE128



CODE128B



CODE128C



CODE128_WIDEBAR



CODE39



CODE93



120F5



PDF417



POSTNET



QR_CODE



UCC128

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/ConfigurableReferenceEntries

Defines additional data to print in the configurable portion of
the label, this allows you to print the same type information on
the label that can also be printed on the doc tab.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/MaskedData

Controls which data/sections will be suppressed.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/SecondaryBarcode

For customers producing their own Ground labels, this field
specifies which secondary barcode will be printed on the
label; so that the primary barcode produced by FedEx has the
correct SCNC.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/TermsAndConditionsLocalization

Identifies the representation of human-readable text.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/AdditionalLabels

Controls the number of additional copies of supplemental
labels.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail

This value reduces the default quantity of
destination/consignee air waybill labels. A value of zero

FedEx Web Services, Developer Guide 2016

117

Create a Label

Web Services Element

Description/Valid Values

/AirWaybillSuppressionCount

indicates no change to default. A minimum of one copy will
always be produced.

RequestedShipment
/ShippingDocumentSpecification

Contains data used to create additional (non-label) shipping
documents.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail

Data required to produce the Freight handling-unit-level
address labels.
Note: The number of UNIQUE labels, the N as in 1 of N, 2 of N, and so
on, is determined by total handling units.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/Format

Specify characteristics of a shipping document to be
produced.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/Copies

Indicates the number of copies to be produced for each
unique label.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/StartingPosition

Specify the quadrant of the page on which the label printing
will start.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/DocTabContent

If omitted, no doc tab will be produced, such as default =
former NONE type.

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/CustomContentPosition

RelativeVerticalPositionType

RequestedShipment
/ShippingDocumentSpecification
/FreightAddressLabelDetail
/CustomContent

Defines any custom content to print on the Freight label.

Example 10:

Transaction Sample for Custom Text on a Label

There may be over 20 available fonts in thermal printer memory. The format value will print a hard-coded
string in a barcode. If the developer wants to pull a value from out of the ship request, then use the "%s"
Format Value, and use the DataFields element with an XPath statement pointing to the value field.
For example, if you included a Reference element in the Ship Request and you want that value in the
barcode, then the DataFields value will be:
ShippingDocumentRequest/RequestedShipment/RequestedPackageLineItems[1]/CustomerReferences[1
]/Value

COMMON2D

FedEx Web Services, Developer Guide 2016

118

Create a Label
ZPLII
STOCK_4X8
BOTTOM_EDGE_OF_TEXT_FIRST

PIXELS

50
200

Data for text
14

50
50

%s
ShippingDocumentRequest/RequestedShipment/
RequestedPackageLineItems[1]/CustomerReferences[1]/Value
100
8
CODE128C

SHIPPER_ACCOUNT_NUMBER

6.4.3

Custom Label Graphic Entries Elements

Only single bit color images should be added since labels will print in black and white.
To add a graphic to the 4x8 or 4x9 thermal label in the Ship Service WSDL, use the following elements
are required.
Table 54. Custom Label Elements for Graphics
Web Services Element

Description/Valid Values

RequestedShipment
/LabelSpecification/

Description of shipping label to be returned in the reply.

FedEx Web Services, Developer Guide 2016

119

Create a Label

Web Services Element

Description/Valid Values

RequestedShipment
/LabelSpecification
/Dispositions

Specify how to create, organize, and return the document.

RequestedShipment
/LabelSpecification
/LabelFormatType

Specify the type of label to be returned. The label format type
should be set to COMMON2D.

RequestedShipment
/LabelSpecification
/ImageType

Specify the image type of this shipping document.

RequestedShipment
/LabelSpecification
/LabelStockType

For thermal printer labels this indicates the size of the label
and the location of the doc tab if present. Either STOCK_4X8
or STOCK_4X9_LEADING_DOC_TAB.

RequestedShipment
/LabelSpecification
/LabelPrintingOrientation

This indicates if the top or bottom of the label comes out of
the printer first.

RequestedShipment
/LabelSpecification
/PrintedLabelOrigin

If present, this contact and address information will replace the
return address information on the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail/

Allows customer-specified control of label content.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/DocTabContent

If omitted, no doc tab will be produced, such as the default is
former NONE type).

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent

Defines any custom content to print on the label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/CoordinateUnits

Valid values for CustomLabelCoordinateUnits.
Valid values are:

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent/
TextEntries

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent

Image to be included from printer's memory, or from a local
file for offline clients.



MILS



PIXELS

FedEx Web Services, Developer Guide 2016

120

Create a Label

Web Services Element

Description/Valid Values

/GraphicEntries
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/GraphicEntries/Position

Contains the x/y coordinates for placement of the graphic.
x=

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/GraphicEntries/Position/X

Horizontal position, relative to left edge of custom area.
Only non-negative integers may be used.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/GraphicEntries/Position/Y

Vertical position, relative to the top edge of the custom area.
Only non-negative integers may be used.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/GraphicEntries/PrinterGraphicID

Printer-specific index of graphic image to be printed.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/GraphicEntries/FileGraphicFullName

Fully-qualified path and file name for graphic image to be
printed.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BoxEntries

Solid (filled) rectangular area on label.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries

Constructed string, based on format and zero or more data
fields, printed in specified barcode symbology.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position

Contains the x/y coordinates for placement of the label.

RequestedShipment
/LabelSpecification

Horizontal position, relative to left edge of custom area.
Only non-negative integers may be used.

FedEx Web Services, Developer Guide 2016

121

Create a Label

Web Services Element

Description/Valid Values

/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position/X
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Position/Y

Vertical position, relative to the top edge of the custom area.
Only non-negative integers may be used.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/Format

The Actual value desired in the barcode.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/DataFields
RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/BarHeight

Numerical Field.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/ThinBarWidth

Width of thinnest bar/space element in the barcode.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/CustomContent
/BarcodeEntries/BarcodeSymbology

Identification of the type of barcode (symbology) used on
FedEx documents and labels. Specify the
BarcodeSymbologyType.
Valid values:


CODEBAR



CODE128



CODE128B



CODE128C



CODE128_WIDEBAR



CODE39



CODE93



120F5



PDF417

FedEx Web Services, Developer Guide 2016

122

Create a Label

Web Services Element

Description/Valid Values


POSTNET



QR_CODE



UCC128

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/ConfigurableReferenceEntries

Defines additional data to print in the configurable portion of
the label, this allows you to print the same type information on
the label that can also be printed on the doc tab.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/MaskedData

Controls which data/sections will be suppressed.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/SecondaryBarcode

For customers producing their own Ground labels, this field
specifies which secondary barcode will be printed on the label;
so that the primary barcode produced by FedEx has the correct
SCNC.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/TermsAndConditionsLocalization

Identifies the representation of human-readable text.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/AdditionalLabels

Controls the number of additional copies of supplemental
labels.

RequestedShipment
/LabelSpecification
/CustomerSpecifiedDetail
/AirWaybillSuppressionCount

This value reduces the default quantity of
destination/consignee air waybill labels. A value of zero
indicates no change to default. A minimum of one copy will
always be produced.

Example 11:

Custom Label Barcode Transaction Sample

XXXXXXXXXX

FedEx Web Services, Developer Guide 2016

123

Create a Label

XXXXXXXXXX
XXXXXXX
string
Syntel
WSGW
3100
WAPI123
SHIPENT
B123
SHIPENT
INT123
US
ENTERPRISE

string

EN
en

ProcessShip_Basic

ship
17
0
0

2014-11-18T15:46:24-06:00
REGULAR_PICKUP
INTERNATIONAL_PRIORITY
YOUR_PACKAGING

XXXXXXXXX

JAN14 CL

FedEx Web Services, Developer Guide 2016

124

Create a Label
SndrConnm
9987878787

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117
US

SHIP TO CONTACT NAME
SHIP TO RECIPIENT CMPNY
9967898787
abc@syntelinc.com

TC021 JAN14 US
IP - CuPack - US to BE
Waterloo
BE
1410
BE

JAN14 CL
SndrConnm
9987878787

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117

FedEx Web Services, Developer Guide 2016

125

Create a Label
US

SENDER

XXXXXXXXXX

JAN14 CL
SndrConnm
9987878787

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117
US

XXXXXXXXXX

JAN14 CL
SndrConnm
9987878787

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117
US

FedEx Web Services, Developer Guide 2016

126

Create a Label

SENDER

XXXXXXXXXX

JAN14 CL
SndrConnm
9987878787

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117
US

DOCUMENTS_ONLY

USD
100

Special Instructions
string

CUSTOMER_REFERENCE
TC#053

FOB

BOOKS
1
Books

FedEx Web Services, Developer Guide 2016

127

Create a Label
US

LB
30

1
EA

USD
10.00

USD
100

COMMON2D
ZPLII
STOCK_4X6.75_LEADING_DOC_TAB

CUSTOM

201
rapidum iaculata
premere et
insuper altos
LEFT

BELOW

PIXELS

200
3

FedEx Web Services, Developer Guide 2016

128

Create a Label
aeoliam venit
altos imposuit
regemque

200
3

profundum quippe
premit ac vinclis
luctantis ventos
luctantis ventos tempestatesque
201
NONE

200
3

altos imposuit
sonoras imperio premit
3

FedEx Web Services, Developer Guide 2016

129

Create a Label
3
CODE128C

LIST
1

USD
100

LB
30

20
15
20
IN

CUSTOMER_REFERENCE
TC#053

FedEx Web Services, Developer Guide 2016

130

Create a Label

6.5

Portable Network Graphic (PNG) Label

Web Services provides PNG (Portable Network Graphic) images for FedEx Express, FedEx Ground and
FedEx International Express Freight® labels. The PNG label graphic is a replica of the thermal or plain
paper labels supported by Web Services. This label option allows you to place the PNG label graphic on
your label stock to prevent the need for creating a custom label.
The following requirements apply when using the 4" x 6" PNG graphic embedded in your shipping
document:

6.5.1

Label Stock

4" x 6" PNG labels should only be used with peel-and-stick label stock. The FedEx Ground and FedEx
Express label certification teams will reject 4" x 6" PNG labels that are not on peel-and-stick label stock,
including any labels printed on plain paper.

6.5.2

Printer

Laser printers are recommended for printing labels. Ink jet printers should not be used because of their
inconsistency in creating scannable barcodes. Due to the inconsistent print quality, the label certification
teams reject most labels that are created with ink jet printers. The 4" x 6" PNG label cannot be printed
using a color printer unless the color definition is set to black, even if the printer only has a black cartridge
installed. This setting is necessary to achieve the correct barcode definition for scanning at the FedEx
hubs.

6.5.3

Scaling

The image returned in your shipping transaction is 200 dots per inch (DPI) and measures 4" (W) x 6" (H) or
800 x 1200 pixels. This label has a vertical orientation and is designed to print in a 4" x 6" label area. When
printed, the label should measure 4" x 6".
When you generate a PNG label image in Web Services, the image is produced in 200 DPI, which is the
minimum barcode DPI. When you view the image on your screen, most applications degrade the DPI to
your screen resolution. Typically, this is 96 DPI, which is far less than the minimum barcode DPI required.
To produce the label and barcodes in the required DPI, you must scale (or resize) the image before
printing. How you scale the image depends on the application you are using to view and print the label.
To scale the PNG image for a 4" x 6" label in inches: use 4" width and 6" length exactly.
To scale the PNG image for a 4" x 6" label in pixels:


If your screen resolution is 96 DPI:
o
o



If your screen resolution is 72 DPI:
o
o



Width = 384 pixels (96 ÷ 200 x 800 = 384)
Height = 576 pixels (95 ÷ 200 x 1200 = 576)

Width = 288 pixels (72 ÷ 200 x 800 = 288)
Height = 432 pixels (72 ÷ 200 x 1200 = 432)

If your screen resolution is not 96 or 72 DPI
o
o

Width = Your screen DPI ÷ 200 x 800
Height = Your screen DPI ÷ 200 x 1200

FedEx Web Services, Developer Guide 2016

131

Create a Label

6.6

Label Review Checklist

Use these lists to check for problems before you submit each set of labels.

6.6.1

All Barcodes

Required for validation:


Quiet Zone: Must always have at least 0.1" white space both above and below barcode.



Quiet Zone: Must always have at least 0.2" white space both left and right of barcode.



Validate that all barcodes meet minimum height requirements.

6.6.2

Print Quality

Common problems that cause labels to be rejected:


Split Bars



Faded Print/White Voids



Repeating White Voids (roller problem)



Smudging (thermal transfer)



Flaking (laser) indicates Toner Fusion Problem



Wrinkled in the Print (thermal transfer)



Print Contrast for direct thermal labels must be at least 90%

6.6.3

Human Readable for FedEx Ground Labels

For the Human Readable for Fedex Ground Labels, the following are required for validation:


Data matches barcode



FedEx Ground logo: Logos are available for download from the FedEx Identity website
brand.fedex.com.



FedEx Home Delivery logo: labels must have a large “H” in a box within 1" of the ship to address.
The “H” must be at least .25" x .70".



Service Description



Sender Information



Recipient Information



Postal code and routing



Ship date



Actual Weight



Customer Automation Device information (meter, application/system, version)



Dimensions



Miscellaneous reference information



Tracking number and Form ID (Tracking number must be 14 digits)

FedEx Web Services, Developer Guide 2016

132

Create a Label


Airport Ramp ID



Postal code

See Appendix U: FedEx Ground Plain Paper Labels and Appendix V: FedEx Ground Thermal Label
Samples sections of Web Services Developer Guide for more information.

6.6.4

Human Readable for Express Labels

The following elements must be printed on the label to pass certification:


FedEx Express logo: Logos are available for download from the FedEx Identity Website
brand.fedex.com.



Service Description



Package type, if International



Delivery day of the week (example: MON for Monday)



Deliver by date



Meter number



Ship date



Format of piece count, Master label verbiage, CRN label verbiage on all MPS



Airport Ramp ID



Postal code and routing



URSA routing prefix and suffix



Handling codes



Service area commitment



Recipient and shipper's phone numbers



Weight



Dims, if applicable (Dims are always required for Express Freight)



Reference field if an alcohol shipment



Tracking number and Form ID (Tracking number must be 14 digits)



In the ASTRA label, the 12 digit tracking number is located in positions 17 through 28 of the 32character barcode. In the new FDX 1D barcode, the tracking number occupies positions 21 through
34. The FedEx Express tracking number will continue to be 12 digits. Zeros will occupy the leading
two positions.

FedEx Web Services, Developer Guide 2016

133

Dangerous Goods and HazMat

The section describes how the dangerous and hazardours goods are handled using FedEx Express and
Ground Services with US.

7.1

Dangerous Goods (FedEx Express)

Shipments with dangerous goods must be tendered to FedEx Express® in accordance with current
International Air Transport Association (IATA) regulations for air transport and the FedEx Express Terms
and Conditions. FedEx provides the option to upload your Dangerous Goods or Hazardous Materials
information to FedEx before processing DG or Hazmat shipments. See Section 8, Dangerous Goods
Data Service, for details.
There are two types of dangerous goods:
1. Accessible dangerous goods that may be shipped using:
o
o
o
o
o
o

FedEx Priority Overnight®
FedEx 1Day® Freight
FedEx International Priority ®
FedEx International Priority ® Freight
FedEx International Economy®
FedEx International Economy® Freight

2. Inaccessible dangerous goods that may be shipped using:
o
o
o
o
o
o
o
o
o
o
o

FedEx Priority Overnight
FedEx Standard Overnight®
FedEx 2Day®
FedEx 2Day® A.M.
FedEx Express Saver®
FedEx 1Day Freight
FedEx 2Day® Freight
FedEx 3Day® Freight
FedEx First Overnight® Freight
FedEx International Priority
FedEx International Priority Freight

To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the
Service Availability Service.
Note: Dangerous goods shipping through FedEx Web Services is available for U.S. and C.A. origin shipments.
HazMat shipping through FedEx Web Services is only available for U.S. origin shipments.

It is the shipper’s responsibility to identify, classify, package, mark, label, and complete documentation
for dangerous goods according to all national and international governmental regulations. In addition,
FedEx can only accept the Shipper’s Declaration for Dangerous Goods in typed or computer-generated
formats, not hand-written. The shipper must provide three copies of the completed Shipper’s Declaration
for Dangerous Goods, 1421C, for each shipment. The term “Dangerous Goods” applies to FedEx
Express shipments only.
For more information about dangerous goods, call 1.800.GoFedEx 1.800.463.3339 and press 81 to reach
the Dangerous Goods/Hazardous Materials Hotline. Purchase and download the latest IATA tables from
https://fedex.registration.meetingevolution.net/index.php/dg-publications-for-sale.html
FedEx Web Services, Developer Guide 2016

134

Dangerous Goods and HazMat
Note: For FedEx Ground® services, these types of shipments are referred to as hazardous materials (HazMat)
shipments.

7.1.1

Dangerous Goods Service Details

The following shipping rules apply to dangerous-goods shipments:


Dangerous goods cannot be shipped in FedEx Express packaging, with the exception of biological
substances.



Many FedEx drop-off locations cannot accept dangerous goods. Use the Locations Service WSDL to
determine locations that accept dangerous goods.



There are limitations for dangerous-goods shipments to Alaska, Hawaii, and many international
destinations. Use the RateService WSDL to determine if your destination allows dangerous-goods
handling.



The federal government requires every shipper to have job-specific dangerous-goods training before
tendering a dangerous-goods shipment to any air carrier. FedEx sponsors a number of seminars for
which you can register online.



FedEx packaging cannot be used for dangerous-goods shipments. Proper package marking and
required documentation must be included before the FedEx courier will accept dangerous-goods
shipments.



OP-900LL and OP-900LG forms are returned in the shipment reply. See the Shipping Document
Service for more information.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

7.1.2

Dangerous Goods Shipping Regulations

Technical Name and Proper Shipping Name (PSN) Regulations:


When you enter a technical name for a UN ID that does not require a technical name and you have
not duplicated or reproduced a PSN, a warning is displayed advising you that a technical name is not
needed. This is just a warning and will not stop the shipment.



When you enter the PSN in the Technical Name Field (when the Technical Name is/is not required), a
hard error will be displayed and the shipment will be stopped.

PSN Qualifying Words: The following qualifying words can be added to the PSNs: solution , mixture,
molten, and stabilized. This is printed at the end of the PSN on the Express DG Shippers Declaration.
Globalization of Dangerous Goods Phone numbers: DG phone numbers—‘Emergency Response
Telephone Number’ and ‘Infectious Substance Responsible Party'—are modified for all Express
Shipments regardless of the Origin/Destination pair of the shipment.
Note: For error messages, see Net Explosive Mass Error Information

7.1.3

Class 1 Net Explosive Mass

For certain Class 1 Dangerous Goods commodities (explosives), additional information is captured and
printed on the Shipper's Declaration for Dangerous Goods Form. For Web Services this is the PDF
formatted LZR DG DEC form (1421c).
The additional information is related to the net explosive mass. The following are the three new fields
added to capture this additional information.
FedEx Web Services, Developer Guide 2016

135

Dangerous Goods and HazMat


Net Explosive Mass Abbreviation (NEM, NEC, NEQ, NEW)



Net Explosive Mass Unit of Measure (g, kg)



Net Explosive Mass Amount

Table 55. Net Explosive Mass Error Information
Error Code

Error Message

Error Condition

149

For commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX} the
NetExplosiveDetail type, amount
and units are required.

A DG commodity is Class 1 and the
NetExplosiveDetail is not provided in the
request.

150

The hazard class is not valid with
the NetExplosiveDetail
information for commodity
{COMMODITY_INDEX} within
Container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX}.

The DG commodity is not Class 1 and NEM
details are provided.

151

The NetExplosiveDetail amount
must be greater than zero for
commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX}.

The DG commodity in a container has a
hazardClass of 1 and the net explosive
amount is zero.

152

For commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX} the Net
Explosive amount must be less
than or equal to the associated
quantity amount.

The DG commodity in a container has a
hazardClass of 1 and The NEM amount
provided is equal to or greater than the DG
commodity amount.

153

NetExplosiveDetail units must be
g or kg for commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX}.

The DG commodity has a hazardClass of 1.x
and the NEM unit of measure is not
provided in g or kg.

154

NetExplosiveDetail type is invalid
for commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}

The DG commodity is Class 1 and
netExplosiveDetail. Type is not a valid value
(NET_EXPLOSIVE_CONTENT",
"NET_EXPLOSIVE_MASS",

FedEx Web Services, Developer Guide 2016

136

Dangerous Goods and HazMat

Error Code

Error Message

Error Condition

within package
{PACKAGE_INDEX}.

"NET_EXPLOSIVE_QUANTITY",
"NET_EXPLOSIVE_WEIGHT").

155

Quantity units must be provided
in g or kg for commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX}.

The DG commodity is Class 1 and
HazardousCommoditiesQuantityDetail.units
received in the request are not in g or kg
and NetExplosiveDetail is present.

156

The hazard class derived from
regulation data is not valid with
Net Explosive Detail for
commodity
{COMMODITY_INDEX} within
container {CONTAINER_INDEX}
within package
{PACKAGE_INDEX}.

The class provided in the request does not
match the class in the IATA file for a UNID.
For example, if the class that is passed in is
1.x but the class in the IATA file is different
from 1.x and Net Explosive detail is present.

7.1.4

Dangerous Goods Coding Details

The following Ship Service WSDL elements are available for dangerous goods:
Table 56. Dangerous Goods Coding Details Elements
Element

Requirements

RequestedPackageLineItems/
SpecialServicesRequested/SpecialServiceTypes

Specify DANGEROUS_GOODS.

/DangerousGoodsDetail

The descriptive data required for a FedEx shipment
containing dangerous goods (hazardous materials).

/DangerousGoodsDetail/Regulation

Identifies the source of regulation for hazardous
commodity data.
Valid values:

/DangerousGoodsDetail/Accessibility

FedEx Web Services, Developer Guide 2016



ADR



DOT



IATA



ORMD

Identifies whether or not the products being
shipped accessible or inaccessible during delivery.
Valid values are:


ACCESSIBLE



INACCESSIBLE

137

Dangerous Goods and HazMat

Element

Requirements

/DangerousGoodsDetail/Cargo
AircraftOnly

Optional. Shipment is packaged and documented
for movement on cargo aircraft only.

/DangerousGoodsDetail/Options

Indicates which kinds of hazardous content are in
the current package.
Valid values are:


HAZARDOUS_MATERIALS: Package contains
hazardous materials requiring complete
documentation, using
HazardousCommodityDescription data.
Batteries with 5 grams or more of lithium
should also be labeled HAZMAT. See
Hazardous Materials (FedEx Ground U.S.)
for more information.



LIMITED_QUANTITIES_COMMODITES:



BATTERY: Package contains batteries with
nonhazardous quantities of lithium.
Nonhazardous batteries contain less than 5
grams of lithium. HazMat batteries contain 5
grams or more of lithium and will be treated as
hazardous materials.



ORM_D/Limited Quantity: Package contains
other regulated materials for U.S. shipping.



SMALL_QUANTITY_EXCEPTION: Package
contains hazardous content in excepted
quantities.



REPORTABLE_QUANTITIES: Package
contains hazardous materials in an amount
that needs to be reported.

/DangerousGoodsDetail/Packing
Option

Indicates whether there is additional customer
provided packaging enclosing the approved
dangerous goods containers.
Valid value is:
OVERPACK

/DangerousGoodsDetail/
ReferenceID

Identifies the configuration of this dangerous goods
package. The common configuration is represented
at the shipment level.

/DangerousGoodsDetail/Containers

Indicates one or more containers used to pack
dangerous goods commodities.

Containers/PackingType

Indicates whether there are additional inner
receptacles within this container.
Valid value is:


FedEx Web Services, Developer Guide 2016

ALL_PACKED_IN_ONE

138

Dangerous Goods and HazMat

Element

Requirements

Containers/ContainerType

Indicates the type of this dangerous goods
container, as specified by the IATA packing
instructions.
For example, steel cylinder, fiberboard box, plastic
jerrican and steel drum.

Containers/RadioactiveContainer
Class

Indicates the packaging type of the container used
to package the radioactive materials.
Valid values are:


EXCEPTED_PACKAGE



INDUSTRIAL_IP1



INDUSTRIAL_IP2



INDUSTRIAL_IP3



TYPE_A



TYPE_B_M



TYPE_B_U



TYPE_C

Containers/NumberOfContainers

Indicates the number of occurrences of this
container with identical dangerous goods
configuration.

Containers/HazardousCommodities

Documents the kinds and quantities of all
hazardous commodities in the current container.

Containers/HazardousCommodities
HazardousCommodityContent/Description

Identifies and describes an individual hazardous
commodity.

/Description/Id

Regulatory identifier for a commodity (e.g. "UN ID"
value).

/Description/SequenceNumber

In conjunction with the regulatory identifier, this
field uniquely identifies a specific hazardous
materials commodity.

/Description/PackingGroup

Identifies IATA packing group for a hazardous
commodity.

/Description/PackingDetails

Specify documentation and limits for validation of
an individual packing group/category.

/Description/ReportableQuantity

The quantity of the hazardous material which, when
shipped, requires release notification to the U.S.
Nuclear Regulatory Commision (NRC).

/Description/ProperShippingName

Hazardous material proper shipping name. Up to
three description lines of 50 characters each are
allowed for a HazMat shipment.

/Description/TechnicalName

Hazardous material technical name.

FedEx Web Services, Developer Guide 2016

139

Dangerous Goods and HazMat

Element

Requirements

/Description/Percentage

Specify the percentage for the hazardous
commodity.

/Description/HazardClass

IATA hazardous material class or division.

/Description/SubsidiaryClasses

Hazardous material subsidiary classes.

/Description/LabelText

IATA diamond hazard label type. Can also include
limited quantity or exemption number.

/Description/ProcessingOptions

Indicates any special processing options to be
applied to the description of the dangerous goods
commodity.

/Description/Authorization

Information related to quantity limitations and
operator or state variations as may be applicable to
the dangerous goods commodity.

Containers/HazardousCommodities
HazardousCommodityContent/Quantity

Specify the amount of the commodity in alternate
units.

Containers/HazardousCommodities
HazardousCommodityContent/InnerReceptacles

This describes the inner receptacle details for a
hazardous commodity within the dangerous goods
container.

Containers/HazardousCommodities
HazardousCommodityContent/Options

Customer-provided specifications for handling
individual commodities.

Containers/HazardousCommodities
HazardousCommodityContent/RadionuclideDetail

Specify the details of any radioactive materials
within the commodity.

/DangerousGoodsDetail/Packaging

Describes the commodity packaging as used on
OP-900 and OP-950 forms for FedEx Ground
shipping of hazardous materials. See Hazardous
Materials FedEx Ground U.S. for more
information.

/DangerousGoodsDetail/Signatory

Specify the name, title and place of the signatory
responsible for the dangerous goods shipment.
Valid values are:


ContactName



Title



Place

/DangerousGoodsDetail/
EmergencyContactNumber

Telephone number to use for contact in the event
of an emergency.

/DangerousGoodsDetail/Offeror

Offeror's name or contract number per DOT
regulation.

/DangerousGoodsDetail
/InfectiousSubstanceResponsibleContact

Specify the contact of the party responsible for
handling the infectious substances, if any, in the
dangerous goods shipment.

FedEx Web Services, Developer Guide 2016

140

Dangerous Goods and HazMat

Element

Requirements

/DangerousGoodsDetail/AdditionalHandling

Specify additional handling information for the
current package.

/DangerousGoodsDetail/RadioactivityDetail

Specify the radioactivity detail for the current
package, if the package contains radioactive
materials.
Valid values:


TransportIndex



SurfaceReading



CriticalitySafetyIndex



Dimensions

Note: For details about creating a Shipper's Declaration for Dangerous Goods form, see the Shipping Document
Service section.

7.2

Hazardous Materials (FedEx Ground U.S.)

FedEx Web Services supports FedEx Ground ® hazardous materials (HazMat) shipping under 49CFR —
FedEx Ground regulations. FedEx provides the option to upload your Dangerous Goods or Hazardous
Materials information to FedEx before processing DG or Hazmat shipments. See Section 8, Dangerous
Goods Data Service, for details.
Note: For FedEx Express® services, these types of shipments are referred to as Dangerous Goods.

7.2.1

Hazardous Materials Service Details

The following service details apply to hazardous materials shipments:


Ship, rate, and track services are available for Dangerous Goods shipments for HazMat, ORMD/Limited Quantity, Dry Ice, Small Quantity Exception and HazMat/NonHazMat Battery.



FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and
Hawaii.



FedEx Ground HazMat weight is limited to 70 lbs.



If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account
executive first. FedEx needs to confirm that you have met government training requirements and can
generate the documentation your shipments need.



Additional information regarding hazardous materials shipping is provided at
http://www.fedex.com/us/services/options under the Hazardous Materials link.



OP-900LL and OP-900LG forms are returned in the shipment reply. See the Shipping Document
Service for more information.



OP-950, the Shipper’s Hazardous Materials Certification report, prints after a successful FedEx
Ground close. See the Shipping Document Service for more information.



HazMat shipments must be a single package. If you create a multiple-package HazMat shipment,
only one commodity prints on the OP-950.

FedEx Web Services, Developer Guide 2016

141

Dangerous Goods and HazMat
For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

7.2.2

Hazardous Materials Coding Details

In addition to the basic elements required for a FedEx Ground ship request using the ShipService WSDL,
the following elements are required to create a HazMat ship request:
Table 57. Hazardous Materials Elements
Element

Description

SpecialServicesRequested/
DangerousGoodsDetail/Options

Set to HAZARDOUS_MATERIALS.

SpecialServicesRequested
Describes the kinds and quantities of all hazardous
/DangerousGoodsDetail/Containers/H commodities in the package, including customer-specified
azardousCommodities
options for handling and regulatory identifiers.
HazardousCommodities/
Description

Identifies and describes an individual hazardous commodity.

Description/Id

Hazardous material regulatory commodity identifier referred to
as Department of Transportation (DOT) location ID number
(UN or NA).

Description/SequenceNumber

In conjunction with the regulatory identifier, this field uniquely
identifies a specific hazardous materials commodity.

/Description/PackingGroup

Hazardous material packaging group.
Valid values:


DEFAULT



III

Description/PackingDetails

Specify documentation and limits for validation of an individual
packing group/category.

Description/PackingDetails
/PackingInstructions

Coded specification for how commodity is to be packed.

Description/ReportableQuantity

Specify the reportable quantity for the hazardous commodity

Description/ProperShippingName

Hazardous material proper shipping name. Up to three
description lines of 50 characters each are allowed for a
HazMat shipment. These description elements are formatted
on the OP950 form in 25-character columns (up to 6 printed
lines).

Description/TechnicalName

Technical name for Hazardous material.

Description/Percentage

Specify the percentage for the hazardous commodity

Description/HazardClass

DOT hazardous material class or division.

FedEx Web Services, Developer Guide 2016

142

Dangerous Goods and HazMat

Element

Description

Description/SubsidiaryClasses

Hazardous material subsidiary classes.

Description/LabelText

DOT diamond hazard label type. Can also include limited
quantity or exemption number.

Description/ProcessingOptions

Specify any special processing to be applied to the dangerous
goods commodity description validation.
Valid value is:
INCLUDE_SPECIAL_PROVISIONS

Description/Authorization

Information related to quantity limitations and operator or state
variations as may be applicable to the dangerous goods
commodity.

HazardousCommodities/Quantity

Specify the amount of the commodity in alternate units.

Quantity/Amount

Number of units of the type specified in "Units."

Quantity/Units

Units by which the hazardous commodity is measured. For
IATA commodity, the units values are restricted based on
regulation type.

Quantity/QuantityType

Specify which measure of quantity is to be validated.

HazardousCommodities/
InnerReceptacles

Describes the inner receptacle details for a hazardous
commodity within the dangerous goods container.

InnerReceptacles/Quantity

Specify the quantity contained in the inner receptacle.

HazardousCommodities/Options

Customer-provided specifications for handling individual
commodities.

Options/LabelTextOption

Specify how the customer wishes the label text to be handled
for this commodity in this package.

Options/CustomerSuppliedLabelText

Text used in labeling the commodity under control of the
LabelTextOption field.

HazardousCommodities/
RadionuclideDetail

Specify the details of any radio active materials within the
commodity.

RadionuclideDetail/Radionuclide

An atom with an unstable nucleus.

RadionuclideDetail/Activity

The number of radioactive decays per second.

Activity/Value

The data content of this instance.

Activity/UnitOfMeasure

Valid values are:




GBQ



KBQ



MBQ



PBQ



TBQ

FedEx Web Services, Developer Guide 2016

143

Dangerous Goods and HazMat

Element

Description

RadionuclideDetail/
Indicates whether packaging type EXCEPTED or
ExceptedPackagingIsReportableQuan EXCEPTED_PACKAGE is for radioactive material in reportable
tity
quantity.
RadionuclideDetail/PhysicalForm

Valid values:


GAS



LIQUID



SOLID



SPECIAL

RadionuclideDetail/ChemicalForm

—

SpecialServicesRequested/
DangerousGoodsDetail/
EmergencyContactNumber

Telephone number to use for contact in the event of an
emergency.

SpecialServicesRequested
/DangerousGoodsDetail/Offeror

Shipper name (offeror) or contact number. Required on all
shipping papers, including OP-900LL, OP-900LG forms, and
Hazardous Materials Certification per DOT regulation.

Note: Hazardous material must be specified at the package level, not at the shipment level. For more information
regarding DOT requirements for hazardous material elements, go to
http://www.fedex.com/us/services/options/hazmat/ .

7.2.3

Hazardous Materials Reply Elements

Table 58. Hazardous Materials Reply Elements
Element

Description

CompletedPackageDetail/HazardousPa Documents the kinds and quantities of all hazardous
ckageDetail
commodities in the current package, using updated hazardous
commodity description data.
HazardousPackageDetail/ReferenceID

A unique reference ID that matches the package to a package
configuration. This is populated if the client provided a
package configuration for several packages that have the
exact same dangerous goods content.

HazardousPackageDetail/Accessibility
HazardousPackageDetail/CargoAircraft When true indicates that the package can be transported only
Only
on a cargo aircraft.
HazardousPackageDetail/RadioactiveTr Specify the maximum radiation level from the package
ansportIndex
(measured in microSieverts per hour at a distance of one
meter from the external surface of the package, divided by
10).
HazardousPackageDetail/LabelType

Specify the label that is to be put on a package containing
radioactive material. The label type is determined in

FedEx Web Services, Developer Guide 2016

144

Dangerous Goods and HazMat

Element

Description
accordance with the Transportation of Dangerous Goods Act
and indicates the type of radioactive material being handled
as well as the relative risk.
Valid values:


III_YELLOW



II_YELLOW



I_WHITE

HazardousPackageDetail/Containers

Documents the kinds and quantities of all hazardous
commodities in the current package.

Containers/QValue

Indicates that the quantity of the dangerous goods packaged
is permissible for shipping. This is used to ensure that the
dangerous goods commodities do not exceed the net
quantity per package restrictions.

Containers
ValidatedHazardousContainer/
HazardousCommodities

Documents the kinds and quantities of all hazardous
commodities in the current package.

7.3

Dry Ice Shipments

FedEx Web Services can be used to ship packages containing dry ice, as long as the specifics for the dry
ice shipment are included in the shipping transaction. Dry ice is considered a Dangerous Goods
material. For more information about dry ice, call 1.800.GoFedEx 1.800.463.3339 and press 81 to reach
the FedEx Dangerous Goods / Hazardous Materials Hotline.

7.3.1

Dry Ice Service Details

The following shipping rules apply to dry ice shipments:


Dry ice shipping through FedEx Web Services is allowed for FedEx Express® U.S. shipments, FedEx
International Economy® U.S. shipments, FedEx International Economy® Freight U.S. shipments,
FedEx Ground® U.S. shipments and Canada origin FedEx Express international shipments.



Dry ice weight must be submitted in kilograms.



The weight entered for dry ice must be less than the total weight of the shipment.



FedEx Ground is used to ship dry ice weighing 70 lbs. or more.



Dry ice is considered Dangerous Goods material and requires Dangerous Goods elements for
shipping.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

FedEx Web Services, Developer Guide 2016

145

Dangerous Goods and HazMat

7.3.2

Dry Ice Coding Details

The following ShipService WSDL elements are required for dry ice:
Table 59. Dry Ice ShipService WSDL Elements
Element

Description

RequestedPackages/SpecialServicesRequested/
SpecialServiceTypes

Identifies the special service type at the package
level. For dry ice packages, the valid value is:
DRY_ICE

RequestedShipment/SpecialServicesRequested/
SpecialServiceTypes

Identifies the special service type at the shipment
level. For dry ice packages, the valid value is:
DRY_ICE

RequestedPackages/SpecialServicesRequested/
DryIceWeight

Descriptive data required for a FedEx shipment
containing dry ice. Descriptive data includes Weight
and Units in KGs.
This element is required when SpecialServiceType
DRY_ICE is present in the SpecialServiceTypes
collection at the package level.

RequestedShipment/SpecialServicesRequested/
ShipmentDryIceDetail/PackageCount

Number of packages in this shipment which contain
dry ice.

RequestedShipment/SpecialServicesRequested/
ShipmentDryIceDetail/TotalWeight

Descriptive data or total weight of the dry ice for
this shipment.
Descriptive data includes Units, in KGs, and Value.
SHIPMENT_LEVEL_DRY_ICE_ONLY
This option Specify that dry ice information is only
applicable at the shipment level. Package level dry
ice information would not apply.

RequestedShipment/SpecialServicesRequested/
ShipmentDryIceDetail/ ProcessingOptions

FedEx Web Services, Developer Guide 2016

146

Dangerous Goods Data Service

Dangerous Good Data Service

Dangerous Goods Data Service (DGDS) is a FedEx system created to receive Dangerous Goods
declaration or Hazmat shipping paper data from shippers and publish to FedEx operational systems. After
receiving the uploaded DG data, the service returns a FedEx tracking number if the data is accepted or
returns an error if data is incomplete or does not comply with regulations, FedEx operator variations, or
FedEx customer account authorizations.
DGDS maintains the uploaded dangerous goods shipment details and establishes a link between the
uploaded data and the actual shipment (label creation). This link is established using:


FedEx tracking number, which is returned in the DGDS reply transactions and the same is used in
the subsequent shipment request.



Upload ID, which is an identifier of the uploaded dangerous goods data, and can be used for
subsequent retrieval or modification transactions.

8.1

Dangerous Goods Shipments (FedEx Express)

Shipments with dangerous goods must be tendered to FedEx Express® in accordance with current
International Air Transport Association (IATA) regulations for air transport and the FedEx Express Terms
and Conditions. There are two types of dangerous goods.
1. Accessible dangerous goods - Certain dangerous goods must be accessible during transit. You can
ship these accessible dangerous goods using FedEx First Overnight, FedEx Priority Overnight, FedEx
First Overnight Freight, FedEx 1Day Freight, FedEx International First (U.S. inbound), FedEx
International Priority, FedEx International Economy (except to Puerto Rico), FedEx International
Priority Freight, FedEx International Economy Freight (except to Puerto Rico), FedEx International
Premium and FedEx International Express Freight® services.
2. Inaccessible dangerous goods - are dangerous goods that can be shipped via FedEx First Overnight
Freight, FedEx 1Day Freight, FedEx 2Day Freight and FedEx 3Day Freight to and from primary and
extended service areas. It is the shipper’s responsibility to identify, classify, package, mark, label, and
complete documentation for dangerous goods according to all national and international
governmental regulations.
3. In addition, FedEx can only accept the Shipper’s Declaration for Dangerous Goods in typed or
computer-generated formats, not hand-written. The shipper must provide three copies of the
completed Shipper’s Declaration for Dangerous Goods, 1421C, for each shipment. The term
“Dangerous Goods” applies to FedEx Express shipments only.
For more information see Shipping Dangerous Goods via FedEx Express or you may call 1.800.GoFedEx
1.800.463.3339 and press 81 to reach the Dangerous Goods/Hazardous Materials Hotline.
Note: For FedEx Ground® services, these types of shipments are referred to as hazardous materials (HazMat)
shipments.

8.2

Hazardous Materials (FedEx Ground U.S.)

147

Dangerous Goods Data Service
Note: For FedEx Ground® services, these types of shipments are referred to as hazardous materials (HazMat)
shipments.

8.2.1

Hazardous Materials Service Details

The following service details apply to hazardous materials shipments:


Ship, rate, and track services are available for Dangerous Goods shipments for HazMat, ORMD/Limited Quantity, Dry Ice, Small Quantity Exception and HazMat/NonHazMat Battery.



FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and
Hawaii.



FedEx Ground HazMat weight is limited to 70 lbs.



Additional information regarding hazardous materials shipping is provided at
http://www.fedex.com/us/services/options under the Hazardous Materials link.



OP-900LL and OP-900LG forms are returned in the shipment reply. See the Shipping Document
Service for more information.



OP-950, the Shipper’s Hazardous Materials Certification report, prints after a successful FedEx
Ground close. See the Shipping Document Service for more information.



HazMat shipments must be a single package. If you create a multiple-package HazMat shipment,
only one commodity prints on the OP-950.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.
For more information see Shipping Dangerous Goods via FedEx Express at fedex.com/dangerousgoods,
you may call 1.800.GoFedEx 1.800.463.3339 and press 81 to reach the Dangerous Goods/Hazardous
Materials Hotline.

8.3

Dangerous Goods Data Service Coding Basics

Dangerous Goods Data Service (DGDS) offers new methods for the dangerous goods data upload and to
establish a link between the uploaded data and the actual shipment (label creation).

8.3.1

Dangerous Goods List Detail (DGLD) Service

The DGLD service method allows the shipping clients to obtain a list of Dangerous Goods from DGDS
service. It retrieves all of the undeleted shipment and handling unit data that belongs to the Upload ID of
the requested tracking number.
Table 60. List Dangerous Goods Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client submitting a
transaction.

TransactionDetail

Specify the Customer Transaction ID that is sent to the request.

FedEx Web Services, Developer Guide 2016

148

Dangerous Goods Data Service
Elements

Description

VersionId

Specify the version number of the service you are using. This number is
updated each time a new version of the service is implemented.

Origin

Specify the postal code and country code of the shipment from where it
originates.

Destination

The destination field specifies the postal code and country code of the
shipment destination.

CarrierCode

The carrier code is the unique code that identifies the transportation used for
the package's delivery.

ServiceType

Service Type field identifies the type of service that is used to ship the
package.
See ServiceType for valid values.

ShipDate

This is the date on which the package will be shipped. The date format must
be YYYY-MM-DD.

TrackingNumber

This field identifies a specific instance of an uploaded dangerous goods
handling unit.

Table 61. ListDangerousGoodsReply Elements
Elements

Description

HighestSeverity

The field includes the descriptive data detailing the status of a
submitted transaction.
Valid values are:

Notifications

TransactionDetail
Version

Regulation



SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know
about your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.

 FAILURE — FedEx was unable to process your transaction.
The field provides descriptive data regarding the result of the
submitted transaction. It includes the severity of the notification,
which indicates success or failure or some other information about
the request.
Specify the Customer Transaction ID that is sent to the request.
Specify the version number of the service you are using. This
number is updated each time a new version of the service is
implemented.
Specify the source of regulation for hazardous commodity data.
Valid values are:

FedEx Web Services, Developer Guide 2016

149

Dangerous Goods Data Service
Elements

accessibility

Description


ADR



DOT



IATA

 ORMD
Specify whether or not the products being shipped is accessible or
inaccessible during delivery.
Valid values are:


 INACCESSIBLE
Specify which kind of hazardous content is being reported.
Valid values are:

options



BATTERY



HAZARDOUS_MATERIALS



LIMITED_QUANTITIES_COMMODITIES



ORM_D



REPORTABLE_QUANTITIES

 SMALL_QUANTITY_EXCEPTION
Specify detailed commodity information related to the regulations.

Details

8.3.2

ACCESSIBLE

Validate Dangerous Goods Data

The Validate method provides validation of dangerous goods data orchestrated by DGDS service.

8.3.2.1 Validate Dangerous Goods Request Elements
Table 62. Validate Dangerous Goods Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client
submitting a transaction.
Specify the Customer Transaction ID that is sent to the request.

TransactionDetail
VersionId

ShipmentDetail
\Attributes
ShipmentDetail
\Origin
ShipmentDetail
\Destination

Specify the version number of the service you are using. This
number is updated each time a new version of the service is
implemented.
Valid value: MANUAL_SHIPPING_LABEL
The origin field specifies the postal code and country code of the
shipment from where it originates.
The destination field specifies the postal code and country code
of the shipment destination.

FedEx Web Services, Developer Guide 2016

150

Dangerous Goods Data Service
Elements

Description

ShipmentDetail
\CarrierCode
ShipmentDetail
\ServiceType

The carrier code is the unique code that identifies the
transportation used for the package's delivery.
Service Type field identifies the type of service that is used to
ship the package.
See ServiceType for valid values.
This is the date on which the package will be shipped. The date
format must be YYYY-MM-DD.
Offeror's name or contract number per DOT regulation.

ShipmentDetail
\ShipDate
ShipmentDetail
\Offeror
ShipmentDetail
\Signatory
ShipmentDetail
\InfectiousSubstanceResponsibleC
ontact
ShipmentDetail
\EmergencyContactNumber
ShipmentDetail
\aircraftCategoryType

Name, title and place of the signatory for this shipment.
The contact information of the company or individual who is
responsible for infectious substances.
Specify the contact number to use in the event of an
emergency.
The type of aircraft available for shipment.
Valid values are:


ShipmentDetail
\AdditionalHandling
ShipmentDetail
\MasterTrackingId
HandlingUnitGroups
HandlingUnitGroups
\Id
HandlingUnitGroups
\Description
HandlingUnitGroups
\NumberOfHandlingUnits
HandlingUnitGroups
\TrackingNumberUnits
HandlingUnitGroups
\HandlingUnit
\Attributes
HandlingUnitGroups
\HandlingUnit
\RadioactiveDetail
HandlingUnitGroups
\HandlingUnit
\RadioactiveDetail
\TransportIndex
HandlingUnitGroups
\HandlingUnit
\RadioactiveDetail
\SurfaceReading

PASSENGER_AND_CARGO_AIRCRAFT

 CARGO_AIRCRAFT_ONLY
Additional handling information other than already specified for
the current package.
Unique tracking number of the shipment
Specify the groups of handling units in the shipment.
Specify the Unique ID for the handling unit group.
Specify the detailed commodity information related to the
regulations.
Specify the number of identical handling units in the shipment
for this group.
Specify the tracking number of each unit that is grouped
together within a package.
Valid value: OVERPACK

Specify the radioactive information required for a handling unit.

FedEx Web Services, Developer Guide 2016

151

Dangerous Goods Data Service
Elements

Description

HandlingUnitGroups\ HandlingUnit \
RadioactiveDetail \
CriticalitySafetyIndex
HandlingUnitGroups
This element species the radioactive label type for this handling
\HandlingUnit
unit or package.
\RadioactiveDetail
Valid values are:
\LabelType
 III_YELLOW

HandlingUnitGroups
\HandlingUnit
\ContainerGroups

II_YELLOW

 I_WHITE
A container group is used to specify a single dangerous goods
container or specify a group of identical dangerous goods
containers. A dangerous goods container may also be known as
a dangerous goods package. The term 'package' is not
necessarily the same concept as a requested package line item
in the shipping domain.
The element specifies the number of identical containers in the
container group.

HandlingUnitGroups
\HandlingUnit
\ContainerGroups
\numberOfIdenticalContainers
HandlingUnitGroups\ HandlingUnit \ This specifies the commodities in the container. A container may
ContainerGroups \ Container
also be known as a dangerous goods package, but this is not
necessarily the same as the 'package' or handling unit that a
courier transports for shipping. If the handling unit is an
OVERPACK, then this container is inside the handling unit.
HandlingUnitGroups\ HandlingUnit \ The container attributes is used to specify whether there are
ContainerGroups \ Container \
additional inner receptacles within this container.
Attributes
Valid value is:
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
ContainerType
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
QValue
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
GrossWeight
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \
IdType

 ALL_PACKED_IN_ONE
The element specifies type of container or dangerous goods
packaging, like 'Fiberboard Box' or 'Type B(U) Package'.

The element specifies the uploaded dangerous goods
commodity content details.
The description element specifies detailed commodity
information related to the regulations.
The ID specifies the type of commodity ID. (e.g. - UN, ID, or NA)

FedEx Web Services, Developer Guide 2016

152

Dangerous Goods Data Service
Elements

Description

HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \ Id
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \
SequenceNumber
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \
PackingGroup
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \
PackingInstructions
HandlingUnitGroups\ HandlingUnit \
ContainerGroups \ Container \
Commodities \ Description \
AircraftCategoryType

The ID specifies the regulatory identifier of a commodity. (e.g. –
‘UN ID’ value)
Sequence number is in conjunction with the regulatory identifier
uniquely identifies a specific record in the commodity regulation
table.
Packaging group element identifies IATA packing group for a
hazardous commodity.
Valid values are:
"I", "II", "III"
Packing Instructions element specifes how the package content
has to be packed.

Aircraft Catgory Type element specifies the type of aircraft
available for the commodity.
Valid values are:


PASSENGER_AND_CARGO_AIRCRAFT

 CARGO_AIRCRAFT_ONLY
HandlingUnitGroups\ HandlingUnit \ The element specifies the proper shipping name as defined by
ContainerGroups \ Container \
the regulation. The name can also include qualifying words.
Commodities \ Description \
properShippingName
HandlingUnitGroups\ HandlingUnit \ The element specifies the technical name for the hazardous
ContainerGroups \ Container \
material.
Commodities \ Description \
technicalName
HandlingUnitGroups\ HandlingUnit \ The element specifies the IATA hazardous material class or
ContainerGroups \ Container \
division.
Commodities \ Description \
primaryClass
HandlingUnitGroups\ HandlingUnit \ The element specifies the hazardous material subsidiary classes.
ContainerGroups \ Container \
Commodities \ Description \
subsidiaryClasses
HandlingUnitGroups\ HandlingUnit \ The element specifies the reportable quantity of the hazardous
ContainerGroups \ Container \
material.
Commodities \ Description \
reportableQuantity
HandlingUnitGroups\ HandlingUnit \ The element specifies the percentage of the hazardous material
ContainerGroups \ Container \
in the package.
Commodities \ Description \
percentage
HandlingUnitGroups\ HandlingUnit \ This element is auto populated with any authorization and other
ContainerGroups \ Container \
required information. Depending on the regulation, this can
Commodities \ Description \
include the DOT Label(s) Type, special permit numbers, or other
authorizationInformation
information as needed.
FedEx Web Services, Developer Guide 2016

153

Dangerous Goods Data Service
Elements

Description

For ground shipments, this is equivalent to the labelText
element.
HandlingUnitGroups\ HandlingUnit \ The element specifies total quantity of the commodity within the
ContainerGroups \ Container \
container.
Commodities \ Quantity
HandlingUnitGroups\ HandlingUnit \ The element specifies the inner receptacles within the container
ContainerGroups \ Container \
- including the quantities of this commodity in the receptacles.
Commodities \ InnerReceptacles
HandlingUnitGroups\ HandlingUnit \ The element specifies the quantity of the commodity within the
ContainerGroups \ Container \
receptacles.
Commodities \ InnerReceptacles \
Quantity
HandlingUnitGroups\ HandlingUnit \ The element specifies the radioactive information for the
ContainerGroups \ Container \
commodity.
Commodities \ RadionuclideDetail
HandlingUnitGroups\ HandlingUnit \ The element specifies the radionuclide(s) of the dangerous
ContainerGroups \ Container \
goods commodity (e.g. - U-238 or Tm-168).
Commodities \ RadionuclideDetail \
Radionuclides
HandlingUnitGroups\ HandlingUnit \ The element specifies the measure of radioactivity for this
ContainerGroups \ Container \
dangerous goods commodity.
Commodities \ CadionuclideDetail \
Activity
HandlingUnitGroups\ HandlingUnit \ The element specifies the physical form or nature of the
ContainerGroups \ Container \
radioactive material.
Commodities \ RadionuclideDetail \
PhysicalForm
HandlingUnitGroups\ HandlingUnit \ The element specifies the chemical details of the radioactive
ContainerGroups \ Container \
material.
Commodities \ RadionuclideDetail \
ChemicalForm
HandlingUnitGroups\ HandlingUnit \ The element specifies the net explosive details of the
ContainerGroups \ Container \
radioactive material.
Commodities \ NetExplosiveDetail

8.3.2.2 Validate Dangerous Goods Reply Elements
Table 63. Validate Dangerous Goods Reply Elements
Elements
HighestSeverity

FedEx Web Services, Developer Guide 2016

Description
The element includes the descriptive data
detailing the status of a submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded
with no other applicable information.



NOTE — Additional information that may
be of interest to you about your
transaction.
154

Dangerous Goods Data Service
Elements

Description


WARNING — Additional information that
you need to know about your transaction
that you may need to take action on.



ERROR — Information about an error that
occurred while processing your transaction.


Notifications

TransactionDetail
Version

CompletedShipmentDetail \ Regulation
CompletedShipmentDetail \
RegulationAttributes

CompletedShipmentDetail
\ TotalHandlingUnitCount
CompletedShipmentDetail
\ AircraftCategoryType

FAILURE — FedEx was unable to process
your transaction.
The element provides descriptive data regarding
the result of the submitted transaction. It
includes the severity of the notification, which
indicates success or failure or some other
information about the request.
The element specifies the Customer
Transaction ID that is sent to the request.
The element specifies the version number of
the service you are using. This number is
updated each time a new version of the service
is implemented.
The regulation under which the DG data has
been validated.
This attribute type identifies characteristics of a
dangerous goods regulation that influence how
FedEx systems process dangerous goods
shipments.
Valid value is
 DRY_ICE_DECLARATION_REQUIRED
The total number of dangerous goods handling
units (or packages) in the shipment.
Aircraft Catgory Type element specifies the type
of aircraft available for the commodity.
Valid values are:


CompletedShipmentDetail \Accessibility

 CARGO_AIRCRAFT_ONLY
The element specfies whether or not the
products being shipped are accessible or
inaccessible during delivery.
Valid values are:


CompletedShipmentDetail \Options

FedEx Web Services, Developer Guide 2016

PASSENGER_AND_CARGO_AIRCRAFT

ACCESSIBLE

 INACCESSIBLE
The element specifies which kind of hazardous
content is being reported.
Valid values are:


BATTERY



HAZARDOUS_MATERIALS

155

Dangerous Goods Data Service
Elements

CompletedShipmentDetail
\ShipmentDryIceDetail

CompletedShipmentDetail
\ShipmentDryIceDetail \PackageCount
CompletedShipmentDetail
\ShipmentDryIceDetail \TotalWeight
CompletedShipmentDetail
\ShipmentDryIceDetail \ProcessingOptions
CompletedHandlingUnitGroups \ID
CompletedHandlingUnitGroups \
NumberOfHandlingUnits
CompletedHandlingUnitGroups \
HandlingUnitShippingDetail
CompletedHandlingUnitGroups \
HandlingUnitShippingDetail \
TrackingNumberUnits
CompletedHandlingUnitGroups \
HandlingUnitShippingDetail \ Description
CompletedHandlingUnitGroups
\HandlingUnitShippingDetail
\AircraftCategoryType

Description


LIMITED_QUANTITIES_COMMODITIES



ORM_D



REPORTABLE_QUANTITIES

 SMALL_QUANTITY_EXCEPTION
The element specifies the total dry ice
information for the shipment. It includes the
shipment-level totals of dry ice data across all
packages.
The element specifies the total number of
packages in the shipment that contain dry ice.
The element specifies the total shipment dry ice
weight for all packages.
Valid values:
SHIPMENT_LEVEL_DRY_ICE_ONLY

The element provides the information needed
for shipping, rating, validation, and label
generation.
The element specifies each instance of this
class groups together with the TrackingID
instances that pertain to the same entity (e.g.
package).
The element specifies the customer provided
description for this handling unit.
Aircraft Catgory Type element specifies the type
of aircraft available for the commodity.
Valid values are:


CompletedHandlingUnitGroups \
HandlingUnitShippingDetail \ Accessibility

 CARGO_AIRCRAFT_ONLY
The element specfies whether or not the
products being shipped are accessible or
inaccessible during delivery.
Valid values are:


CompletedHandlingUnitGroups \
HandlingUnitShippingDetail
\Options

FedEx Web Services, Developer Guide 2016

PASSENGER_AND_CARGO_AIRCRAFT

ACCESSIBLE

 INACCESSIBLE
The element specifies which kind of hazardous
content is being reported.
Valid values are:


BATTERY



HAZARDOUS_MATERIALS



LIMITED_QUANTITIES_COMMODITIES



ORM_D
156

Dangerous Goods Data Service
Elements

Description


 SMALL_QUANTITY_EXCEPTION
The element specifies the total dry ice weight
for this handling unit (or package).

CompletedHandlingUnitGroups
\HandlingUnitShippingDetail
\DryIceWeight

8.3.3

REPORTABLE_QUANTITIES

Upload Dangerous Goods Data

The Upload method provides upload and validation of dangerous goods data orchestrated by DGDS
service. With this method, DGDS service also records the uploaded Dangerous Goods and HazMat
Shipment Details. The service returns Upload ID as an identifier for the uploaded dangerous goods data.
The service also returns FedEx tracking number which establishes a link between the uploaded data and
the actual shipment (label creation).

8.3.3.1 Upload Dangerous Goods Request Elements
Table 64. Upload Dangerous Goods Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client
submitting a transaction.

TransactionDetail

The element specifies the Customer Transaction ID that
is sent to the request.

VersionId

The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.

ShipmentDetail

For WSDL element details, refer to ShipmentDetail
group listed in ValidateDangerousGoodsRequest
Elements table.
For WSDL element details, refer to HandlingUnitGroups
group listed in ValidateDangerousGoodsRequest
Elements table.

HandlingUnitGroups

8.3.3.2 UploadDangerousGoodsReply Elements
Table 65. Upload Dangerous Goods Reply Elements
Elements
Description
HighestSeverity
The element includes the descriptive data detailing the
status of a submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.

FedEx Web Services, Developer Guide 2016

157

Dangerous Goods Data Service
Elements

Description


WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.


Notifications

TransactionDetail
Version

UploadId
MasterTrackingId

CompletedShipmentDetail

CompletedHandlingUnitGroups

8.3.4

FAILURE — FedEx was unable to process your
transaction.
The element provides descriptive data regarding the
result of the submitted transaction. It includes the
severity of the notification, which indicates success or
failure or some other information about the request.
The element specifies the Customer Transaction ID that
is sent to the request.
The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.
The ID uniquely identifies the upload, which can be used
for subsequent retrieval or modification transactions.
The ID is used with multiple-transaction shipments to
identify the master package in a multi-piece shipment.
The element is used to identify an instance of an
uploaded dangerous goods handling unit.
For WSDL element details, refer to
CompletedShipmentDetail group listed in
ValidateDangerousGoodsReply Elements table.
For WSDL element details, refer to
CompletedHandlingUnitGroups listed in
ValidateDangerousGoodsReply Elements table.

Add Dangerous Goods Handling Unit

The Add method provides addition of dangerous goods handling units to the record identified by an
existing upload ID.
Table 66. Add Dangerous Goods Handling Unit Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client
submitting a transaction.

TransactionDetail

The element is used to identify associated request and
reply transactions.

VersionId

The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.

FedEx Web Services, Developer Guide 2016

158

Dangerous Goods Data Service
Elements

Description

UploadId

The ID uniquely identifies the uploaded dangerous goods
handling unit that is being added to.

HandlingUnitGroup

The element specifies the groups of handling units in the
shipment

HandlingUnitGroups\ Id

The element specifies the Unique ID for the handling
unit group.

HandlingUnitGroups\ Description

The element specifies the detailed commodity
information related to the regulations.

HandlingUnitGroups\
NumberOfHandlingUnits

The element specifies the number of identical handling
units in the shipment for this group.

HandlingUnitGroups\
TrackingNumberUnits

The element specifies the tracking number of each unit
that is grouped together within a package.

HandlingUnitGroups\
HandlingUnit

For WSDL element details, refer to handlingUnitGroups\
handlingUnit group listed in
ValidateDangerousGoodsRequest Elements table.

Table 67. Add Dangerous Goods Handling Unit Reply Elements
Elements
Description
HighestSeverity
The element includes the descriptive data detailing the
status of a submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.


Notifications

TransactionDetail
Version

FedEx Web Services, Developer Guide 2016

159

Dangerous Goods Data Service
Elements
CompletedShipmentDetail

CompletedHandlingUnitGroup

8.3.5

Description
For the WSDL element details, refer to
completedShipmentDetail group listed in
ValidateDangerousGoodsReply Elements table.
For the WSDL element details, refer to
CompletedHandlingUnitGroup listed in
ValidateDangerousGoodsReply Elements table.

Modify Dangerous Goods Shipment Data

The Modify method updates the dangerous goods shipment level data. Modified dangerous goods data
replaces the previously processed dangerous goods data. This does not support adding or removing
dangerous goods handling units.
The following elements are eligible for modification via this method: origin, destination, serviceType,
shipDate, offeror, signatory, infectiousSubstanceResponsibleContact, emergencyContactNumber,
aircraftCategoryType and additionalHandling.
Table 68. Modify Dangerous Goods Shipment Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client
submitting a transaction.
The element specifies the Customer Transaction ID that
is sent to the request.
The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.
The ID uniquely identifies the upload, which can be used
for subsequent retrieval or modification transactions.
For WSDL element details, refer to ShipmentDetail
group listed in ValidateDangerousGoodsRequest
Elements table.

TransactionDetail
VersionId

UploadId
ShipmentDetail

Table 69. Modify Dangerous Goods Shipment Reply Elements
Elements
Description
HighestSeverity
The element includes the descriptive data detailing the
status of a submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.

FedEx Web Services, Developer Guide 2016

160

Dangerous Goods Data Service
Elements

Description


Notifications

TransactionDetail
Version

CompletedShipmentDetail

8.3.6

Modify Dangerous Goods Handling Unit Data

This method supports modification of dangerous goods handling unit group associated with an existing
upload ID. Modified dangerous goods handling unit group completely replaces previously processed
handling unit group. Handling unit count may be incremented by this method.
Table 70. Modify Dangerous Goods Handling Unit Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client
submitting a transaction.
The element is used to identify associated request and
reply transactions.
The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.
The element specifies the ID associated with the
dangerous goods handling unit to which it is being
added to.
For WSDL element details, refer to HandlingUnitGroup
listed in AddDangerousGoodsHandlingUnitRequest
Elements table.

TransactionDetail
VersionId

UploadId

HandlingUnitGroup

FedEx Web Services, Developer Guide 2016

161

Dangerous Goods Data Service
Table 71. ModifyDangerousGoodsHandlingUnitReply Elements
Elements

Description

HighestSeverity

The element includes the descriptive data detailing the
status of a submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.



Notifications

TransactionDetail

The element specifies the Customer Transaction ID that
is sent to the request.

Version

The element specifies the version number of the service
you are using. This number is updated each time a new
version of the service is implemented.

CompletedShipmentDetail

For the WSDL element details, refer to
completedShipmentDetail group listed in
AddDangerousGoodsHandlingUnitReply Elements table.

CompletedHandlingUnitGroup

For the WSDL element details, refer to
CompletedHandlingUnitGroup listed in
AddDangerousGoodsHandlingUnitReply Elements table.

8.3.7

Retrieve Dangerous Goods Data

The Retrieve method retrieves previously uploaded dangerous goods data associated with the provided
upload ID.
Table 72. RetrieveDangerousGoodsRequest Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client submitting a transaction.

FedEx Web Services, Developer Guide 2016

162

Dangerous Goods Data Service

Elements

Description

TransactionDetail

The element is used to identify associated request and reply transactions.

Version

The element specifies the version number of the service you are using. This
number is updated each time a new version of the service is implemented.

UploadId

The element specifies the ID associated with the uploaded dangerous goods
that is being retrieved.

Table 73. RetrieveDangerousGoodsReply Elements
Elements

Description

HighestSeverity

The element includes the descriptive data detailing the status of a
submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no other applicable
information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know about
your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction

Notifications

The descriptive data regarding the result of the submitted transaction.
Includes the severity of the notification, which indicates success or
failure or some other information about the request.

TransactionDetail

The element is used to identify associated request and reply
transactions.

Version

ShipmentDetail \
UploadedShipmentDetail

The element specifies the version number of the service you are using.
This number is updated each time a new version of the service is
implemented.
For WSDL element details, refer to ShipmentDetail group listed in
ValidateDangerousGoodsRequest Elements table.

ShipmentDetail \
CompletedShipmentDetail

For WSDL element details, refer to CompletedShipmentDetail group
listed in ValidateDangerousGoodsReply Elements table.

HandlingUnitGroups

This specifies the groups of handling units in the shipment.

FedEx Web Services, Developer Guide 2016

163

Dangerous Goods Data Service
Elements

Description

HandlingUnitGroups \
UploadedHandlingUnitGroup

For WSDL element details, refer to HandlingUnitGroups listed in
ValidateDangerousGoodsRequest Elements table.

HandlingUnitGroups \
HandlingUnitShippingDetail

Refer to HandlingUnitShippingDetail listed in
ValidateDangerousGoodsReply Elements table.

8.3.8

Delete Dangerous Goods Data

The Delete method supports deletion of dangerous goods handling unit groups associated with the
provided upload ID. Meter and account number provided with request need to match with the meter and
account number provided with the originally uploaded dangerous goods record.
Table 74. Delete Dangerous Goods Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client submitting
a transaction.

TransactionDetail

The element specifies the Customer Transaction ID that is sent to
the request.

Version

The element specifies the version number of the service you are
using. This number is updated each time a new version of the
service is implemented.

UploadId

The element specifies ID of the uploaded data that will be used to
identify the dangerous goods data being deleted.

Table 75. Delete Dangerous Goods Reply Elements
Elements

Description

HighestSeverity

The element includes the descriptive data detailing the status of a
submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know
about your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction

FedEx Web Services, Developer Guide 2016

164

Dangerous Goods Data Service

Elements

Description

Notifications

The descriptive data regarding the result of the submitted
transaction. Includes the severity of the notification, which
indicates success or failure or some other information about the
request.

TransactionDetail

The element specifies the Customer Transaction ID that is sent to
the request.

Version

The element specifies the version number of the service you are
using. This number is updated each time a new version of the
service is implemented.

8.3.9

Delete Dangerous Goods Handling Unit Data

The method deletes the specified dangerous goods handling unit. This handling unit is identified by the
specified upload ID and handling unit group ID. Meter and account number provided with request need to
match with the meter and account number provided with the originally uploaded dangerous goods
record.
Table 76. Delete Dangerous Goods Handling Unit Request Elements
Elements

Description

ClientDetail

The Client details include descriptive data for the client submitting
a transaction.

TransactionDetail

The element is used to identify associated request and reply
transactions.

VersionId

The element specifies the version number of the service you are
using. This number is updated each time a new version of the
service is implemented.

UploadId

The element specifies unique identifier for the dangerous goods
handling unit to which it is being added to.

HandlingUnitGroupId

The element specifies unique ID for the handling unit being
deleted.

TrackingNumbers

The element specifies unique tracking IDs from the previously
uploaded dangerous goods data.

FedEx Web Services, Developer Guide 2016

165

Dangerous Goods Data Service
Table 77. DeleteDangerousGoodsHandlingUnitReply Elements
Elements

Description

HighestSeverity

The element includes the descriptive data detailing the status of a
submitted transaction.
Valid values are:


SUCCESS — Your transaction succeeded with no other applicable
information.



NOTE — Additional information that may be of interest to you about
your transaction.



WARNING — Additional information that you need to know about
your transaction that you may need to take action on.



ERROR — Information about an error that occurred while processing
your transaction.



FAILURE — FedEx was unable to process your transaction

Notifications

The descriptive data regarding the result of the submitted transaction.
Includes the severity of the notification, which indicates success or failure
or some other information about the request.

TransactionDetail

The element specifies the Customer Transaction ID that is sent to the
request.

Version

The element specifies the version number of the service you are using.
This number is updated each time a new version of the service is
implemented.

CompletedShipmentDetail For the WSDL element details, refer to completedShipmentDetail group
listed in AddDangerousGoodsHandlingUnitReply Elements table.

8.4

DGDS Sample Codes

Sample codes for each of the transactions are given below.
Example 12:

List Dangerous Goods Request Transaction

Input your Information
Input your Information

Input your Information

FedEx Web Services, Developer Guide 2016

166

Dangerous Goods Data Service
Input your Information

Input your Information
Input your Information
US

EN
US

ListDangerousGoodsRequestExpress_APR24

dgds
1
0
0

Input your Information
MEMPHIS
TN
381167510
US
1

Input your Information
Colorado Springs
CO
80903
US

FDXE
PRIORITY_OVERNIGHT
2015-12-30
Input your Information

Example 13:

List Dangerous Goods Reply Transaction

FedEx Web Services, Developer Guide 2016

167

Dangerous Goods Data Service

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

ListDangerousGoodsRequest-Express_APR24

dgds
1
0
0

IATA
ACCESSIBLE
HAZARDOUS_MATERIALS

Input your Inforrmation
ACCESSIBLE
HAZARDOUS_MATERIALS

Example 14:

Validate Dangerous Goods Request Transaction

Input Your Information
Input Your Information

Input Your Information

FedEx Web Services, Developer Guide 2016

168

Dangerous Goods Data Service
Input Your Information

Input Your Information
Input Your Information
US

EN
US

validateDangerousGoods-Express

dgds
2
0
0

Input Your Information
MEMPHIS
TN
381167510
US
1

Input Your Information
Colorado Springs
CO
80903
US

FDXE
PRIORITY_OVERNIGHT
2015-12-29
Input Your Information

Input Your Information
Input Your Information
MEMPHIS

FedEx Web Services, Developer Guide 2016

169

Dangerous Goods Data Service
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information

Input Your Information
CARGO_AIRCRAFT_ONLY

UDDG
1

FEDEX
Input Your Information

OVERPACK

Aluminum Boxes

UN
Input Your Information
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
0.0

5
KG

FedEx Web Services, Developer Guide 2016

170

Dangerous Goods Data Service

Example 15:

Validate Dangerous Goods Reply Transaction

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

validateDangerousGoods-Express

dgds
2
0
0

IATA
DRY_ICE_DECLARATION_REQUIRED
1
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
5.0

UDDG
1

FedEx Web Services, Developer Guide 2016

171

Dangerous Goods Data Service

FEDEX
Input Your Information

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
5.0

Add Dangerous Goods Handling Unit Request Transaction

Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

EN
US

AddDangerousGoodsHandlingUnitExpress

FedEx Web Services, Developer Guide 2016

172

Dangerous Goods Data Service

dgds
2
0
0

Input Your Information

UDDG1
2

OVERPACK

Aluminum Boxes

UN
1845
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
0.0

1
KG

Example 16:

Add Dangerous Goods Handling Unit Reply Transaction

SUCCESS

FedEx Web Services, Developer Guide 2016

173

Dangerous Goods Data Service
SUCCESS
dgds
000
SUCCESS
SUCCESS

AddDangerousGoodsHandlingUnitExpress_GAGAN

dgds
2
0
0

IATA
DRY_ICE_DECLARATION_REQUIRED
3
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
7.0

UDDG1
2

FEDEX
0441
Input Your Information

FedEx Web Services, Developer Guide 2016

174

Dangerous Goods Data Service

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
1.0

Example 17:

Modify Dangerous Goods Handling Unit Request Transaction

Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

EN
US

ModifyDangerousGoodsHandlingUnitExpress

dgds

FedEx Web Services, Developer Guide 2016

175

Dangerous Goods Data Service
2
0
0

Input Your Information

Group#1
01

FEDEX
0263
Input Your Information

OVERPACK

Aluminum Boxes

KG
10

UN
1845
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
0.0

1
KG

FedEx Web Services, Developer Guide 2016

176

Dangerous Goods Data Service

Example 18:

Modify Dangerous Goods Handling Unit Reply Transaction

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

ModifyDangerousGoodsHandlingUnit-Express

dgds
2
0
0

IATA
DRY_ICE_DECLARATION_REQUIRED
3
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
3.0

Group#1
1

FedEx Web Services, Developer Guide 2016

177

Dangerous Goods Data Service
FEDEX
0263
Input Your Information

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
1.0

Example 19:

Retrieve Dangerous Goods Request Transaction

Input Your Information
Input Your Information

EN
US

RetrieveDangerousGoodsRequestExpress

FedEx Web Services, Developer Guide 2016

178

Dangerous Goods Data Service

dgds
2
0
0

Input Your Information

Example 20:

Retrieve Dangerous Goods Reply Transaction

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

RetrieveDangerousGoodsRequest-Express

dgds
2
0
0

Input Your Information
MEMPHIS
TN
381167510
US
true

Input Your Information
RICHMOND

FedEx Web Services, Developer Guide 2016

179

Dangerous Goods Data Service
BC
V7C4v7
CA
false

FDXE
INTERNATIONAL_PRIORITY
2015-12-29

Input Your Information
Input Your Information
MEMPHIS

Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information

Input Your Information
CARGO_AIRCRAFT_ONLY

IATA
DRY_ICE_DECLARATION_REQUIRED
3
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
7.0

Group#1
1

FedEx Web Services, Developer Guide 2016

180

Dangerous Goods Data Service

FEDEX
0441
Input Your Information

OVERPACK

Aluminum Boxes
0.0

UN
1845
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
false
0.0

5
KG

FEDEX
0441
Input Your Information

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

FedEx Web Services, Developer Guide 2016

181

Dangerous Goods Data Service

KG
5.0

UDDG1
2

FEDEX
0441
Input Your Information

OVERPACK

Aluminum Boxes
0.0

UN
1845
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
false
0.0

1
KG

FedEx Web Services, Developer Guide 2016

182

Dangerous Goods Data Service

FEDEX
0441
Input Your Information

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
1.0

Example 21:

Upload Dangerous Goods Request Transaction

Input Your Information
Input Your Information

FedEx Web Services, Developer Guide 2016

183

Dangerous Goods Data Service
Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

EN
US

uploadDangerousGoods-Express

dgds
2
0
0

Input Your Information
MEMPHIS
TN
381167510
US
1

Input Your Information
RICHMOND
BC
V7C4v7
CA

FDXE
INTERNATIONAL_PRIORITY
2015-12-29

Input Your Information
Input Your Information
MEMPHIS

FedEx Web Services, Developer Guide 2016

184

Dangerous Goods Data Service
Input Your Information
Input Your Information
Input Your Information
D Company
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information

Input Your Information
CARGO_AIRCRAFT_ONLY

OVERPACK

Aluminum Boxes

UN
1845
2
UNDEFINED
954
PASSENGER_AND_CARGO_AIRCRAFT
Dry ice
9
0.0

5
KG

Example 22:

UploadDangerousGoodsReply

FedEx Web Services, Developer Guide 2016

185

Dangerous Goods Data Service

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

uploadDangerousGoods-Express

dgds
2
0
0

Input Your Information

IATA
DRY_ICE_DECLARATION_REQUIRED
1
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
5.0

Group#1
1

FEDEX
0441
Input Your Information

FedEx Web Services, Developer Guide 2016

186

Dangerous Goods Data Service

PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
5.0

Example 23:

Delete Dangerous Goods Request

Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

EN
US

DeleteDangerousGoods-Express

dgds
2
0

FedEx Web Services, Developer Guide 2016

187

Dangerous Goods Data Service
0

Input Your Information

FedEx Web Services, Developer Guide 2016

188

Dangerous Goods Data Service
Example 24:

Delete Dangerous Goods Reply

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

DeleteDangerousGoods-Express

dgds
2
0
0

Example 25:

Modify Dangerous Goods Shipment Request

Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

FedEx Web Services, Developer Guide 2016

189

Dangerous Goods Data Service

EN
US

ModifyDangerousGoods-Express

dgds
2
0
0

Input Your Information

Input Your Information
Colliervilee
TN
38017
US
0

Input Your Information
Colorado Springs
CO
80903
US

FDXE
PRIORITY_OVERNIGHT
2015-12-29
FedEx

Input Your Information
Input Your Information
MEMPHIS

Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information
Input Your Information

FedEx Web Services, Developer Guide 2016

190

Dangerous Goods Data Service
Input Your Information
Input Your Information
Input Your Information

Input Your Information
CARGO_AIRCRAFT_ONLY

Example 26:

Modify Dangerous Goods Shipment Reply

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

ModifyDangerousGoods-Express

dgds
2
0
0

IATA
DRY_ICE_DECLARATION_REQUIRED
3
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
3.0

FedEx Web Services, Developer Guide 2016

191

Dangerous Goods Data Service

Example 27:

Delete Dangerous Goods Handling Unit Request

Input Your Information
Input Your Information

Input Your Information
Input Your Information
US

EN
US

DeleteDangerousGoodsHandlingUnitExpress

dgds
2
0
0

Input Your Information
UDDG1
Input Your Information

FedEx Web Services, Developer Guide 2016

192

Dangerous Goods Data Service

Example 28:

Delete Dangerous Goods Handling Unit Reply

SUCCESS

SUCCESS
dgds
000
SUCCESS
SUCCESS

DeleteDangerousGoodsHandlingUnit-Express

dgds
2
0
0

IATA
DRY_ICE_DECLARATION_REQUIRED
2
PASSENGER_AND_CARGO_AIRCRAFT
DRY_ICE
HAZARDOUS_MATERIALS

KG
2.0

FedEx Web Services, Developer Guide 2016

193

Dangerous Goods Data Service

8.5

Ship Using FedEx Tracking Number

The dangerous goods upload method returns a FedEx tracking number. Use this tracking number in your
shipping transaction in the following WSDL element.
RequestedShipment / RequestedPackageLineItems / specialServiceRequested /DangerousGoodsDetail
/UploadedTrackingNumber
Following is a sample shipment request transaction which uses the above mentioned element

Input Your Information
Input Your Information

Ship_International_basic

ship
19
0
0

2015-12-29T12:34:56-06:00
REGULAR_PICKUP
FEDEX_EXPRESS_SAVER
YOUR_PACKAGING

Input Your Information

FedEx Web Services, Developer Guide 2016

194

Dangerous Goods Data Service
Input Your Information
Input Your Information
Input Your Information
Input Your Information

Input Your Information
MEMPHIS
TN
38117
US

Input Your Information

Input Your Information
Input Your Information
Input Your Information
Input Your Information

Input Your Information
Input Your Information
Collierville
TN
38017
US

SENDER

Input Your Information

Input Your Information
Input Your Information

FedEx Web Services, Developer Guide 2016

195

Dangerous Goods Data Service

COMMON2D
PNG

LIST
1

LB
40

5
5
5
IN

BAG

794874646807

Book

CUSTOMER_REFERENCE
NAFTA_COO

FedEx Web Services, Developer Guide 2016

196

Electronic Trade Documents

FedEx® Electronic Trade Documents (ETD) is an international shipping solution that simplifies your
international shipping needs. You can submit most of your trade documentation electronically and no
longer have to print and attach trade documents. Capturing and sharing critical trade information as early
as possible optimizes the customs clearance process. Customs and other agencies receive documents
sent electronically faster than paper copies. You have two choices for using FedEx Electronic Trade
Documents. You can either upload your own documents or let FedEx generate them for you. See
Shipping Document Service section for details on documents that FedEx can generate).
If you use FedEx generated documents, you can provide the necessary information as specified in the
Shipping Document Service section and then specify Electronic Trade Documents as a special service in
your ship request. If you also want to receive copies of FedEx generated documents in the ship reply, be
sure to also specify RequestedDocumentCopies.
If you are using your own uploaded documents, FedEx Electronic Trade Documents requires FedEx Web
Services.
1. Upload your trade documents (Commercial Invoice, Certificate of Origin, etc.) using the
UploadDocuments WSDL. After uploading a document successfully, you will receive a Document ID
in the reply.
2. Create the FedEx shipment using the ShipService WSDL. You can indicate Electronic Trade
Documents as a special service and reference the Document ID for each uploaded document
associated with your shipment.

9.1

FedEx ETD Service Details



For the most current list of Electronic Trade Document-enabled countries, check FedEx website
fedex.com/international/etd.



Valid file types for uploaded documents are PDF, TXT, PNG, JPG, GIF, BMP, TIF, RTF, DOC, and
XLS. Before uploading documents, you must convert them to a Base64-encoded string.



FedEx Electronic Trade Documents does not accept shipments that include dangerous goods,
hazardous materials, or dry ice because they require that all paperwork physically accompany them.



Each uploaded trade document cannot exceed 1 MB.



A maximum of 5 trade documents can be uploaded per transaction.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

FedEx Web Services, Developer Guide 2016

197

Electronic Trade Documents

9.2

Upload Documents Request Elements

The following Electronic Trade Documents request elements are available from the UploadDocuments
WSDL:
Table 78. Electronic Trade Documents Request Elements
Element
Documents/LineNumber

Description
Optional.
Specify a positive integer value to sequence your uploaded
documents.
This value is returned in reply but is not stored with your
document.

Documents/CustomerReference

Optional.
Specify a string value to provide additional information about
the uploaded document.

Documents/DocumentType

Required.
Specify the type of document being uploaded. Valid options
are:


COMMERCIAL_INVOICE



CERTIFICATE_OF_ORIGIN



NAFTA_CERTIFICATE_OF_ORIGIN



PRO_FORMA_INVOICE



OTHER

Documents/FileName

Required.
Specify the file name, such as CI.pdf, of the document to be
uploaded.

Documents/Content

Required.
Provide the document to be uploaded as a Base64-encoded
string.
Specify the date until which the document is available.
Specify the Origin country code.
Specify the Destination country code.
Specify the intent or the usage of the documents being
uploaded. This provides details about how the documents are
relevant to the current transaction.
Valid values are:

Documents/Expiration Date
OriginCountryCode
DestinationCountryCode
DocumentUsageType



CUSTOMER_INFORMATION



ELECTRONIC_TRADE_DOCUMENTS



PRICING_DOCUMENTS

FedEx Web Services, Developer Guide 2016

198

Electronic Trade Documents

9.3

Upload Documents Reply Elements

The following Electronic Trade Documents reply elements are available from the UploadDocuments
WSDL:
Table 79. Electronic Trade Documents Reply Elements
Element

Description

DocumentStatuses/LineNumber

Returns the number (if any) specified in the
UploadDocuments request and returns a value of zero if none
is specified. This value is not stored with your document.

DocumentStatuses/CustomerReference

Returns the string (if any) specified in the UploadDocuments
request.

DocumentStatuses/DocumentProducer

Returns CUSTOMER.

DocumentStatuses/DocumentType

Returns the type specified in the UploadDocuments request.

DocumentStatuses/FileName

Returns the file name specified in the UploadDocuments
request.

DocumentStatuses/Status

Returns the high-level results for the document upload.
Valid values:

DocumentStatuses/StatusInfo



SUCCESS



FAILURE



ERROR

Returns one or more of the following specific reasons for
high-level results:


DOCUMENT_CONTENT_FAILED_VIRUS_CHECK



DOCUMENT_CONTENT_MISSING



DOCUMENT_CONTENT_TOO_LARGE



DOCUMENT_FILE_NAME_MISSING



DOCUMENT_FORMAT_NOT_SUPPORTED



DOCUMENT_ID_INVALID



DOCUMENT_ID_MISSING



DOCUMENT_TYPE_INVALID



DOCUMENT_TYPE_MISSING



DOCUMENT_TYPE_NOT_ALLOWED_FOR_ETD



ELECTRONIC_CLEARANCE_NOT_ALLOWED_AT_DESTI
NATION

FedEx Web Services, Developer Guide 2016

199

Electronic Trade Documents

Element

Description


ELECTRONIC_CLEARANCE_NOT_ALLOWED_AT_ORIGI
N



EXPIRATION_DATE_INVALID



FILENAME_TOO_LONG



UNABLE_TO_PROCESS_DOCUMENT



UPLOAD_NOT_ATTEMPTED

DocumentStatuses/MessageReturn

Returns additional information about specific results.

DocumentStatuses/DocumentId

Returns the Document ID you will need to reference when
creating your shipment with the ShipService WSDL.

9.4

Ship Request Elements

The following Electronic Trade Documents request elements are available from the ShipService WSDL:
Table 80. Electronic Trade Documents Request Elements
Element

Description

ShipmentSpecialServicesRequested/
EtdDetail/RequestedDocumentCopies

Optional
Specify FedEx generated documents for which you
want copies returned.
Valid values:


COMMERCIAL_INVOICE



CERTIFICATE_OF_ORIGIN



NAFTA_CERTIFICATE_OF_ORIGIN



PRO_FORMA_INVOICE



GENERAL_AGENCY_AGREEMENT

CustomsClearanceDetail

Specifies customs clearance data that is used for both
international and intra-country shipping.

DocumentReferences/LineNumber

Optional.
Specify a positive integer value to sequence your
uploaded documents. This value is not stored with
your document.

DocumentReferences/CustomerReference

Optional.
Specify a string value to provide additional information
about the uploaded document. Use this option to
change the CustomerReference specified during
document upload.

DocumentReferences/DocumentProducer

Reserved.

FedEx Web Services, Developer Guide 2016

200

Electronic Trade Documents

Element

Description
This element is reserved for future use and should not
be specified.

DocumentReferences/DocumentType

Optional.
Specify the type of uploaded document.
Valid values are:


COMMERCIAL_INVOICE



CERTIFICATE_OF_ORIGIN



NAFTA_CERTIFICATE_OF_ORIGIN



PRO_FORMA_INVOICE

 OTHER
Use this element to change the DocumentType
specified during document upload.
DocumentReferences/DocumentIDProducer

Details for uploaded documents provided by the
shipment initiator. The valid values are:


CUSTOMER



FEDEX_CAFE



FEDEX_CSHP



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM



FEDEX_INET

Note: Effective October 3, 2016, You can combine your shipments designated as ETD (Electronic Trade Documents)
with special services listed in the above table.

9.5

Ship Reply Elements

The following Electronic Trade Documents reply elements are returned from the ShipService WSDL:
Table 81. Electronic Trade Documents Reply Elements
Element

Description

CompletedEtdDetail/UploadDocumentR Returns the number (if any) specified in the
eferenceDetails/ LineNumber
ProcessShipment request or returns a value of zero if none
is specified. This value is not stored with your document.
CompletedEtdDetail/UploadDocumentR Returns the string (if any) specified in the ProcessShipment
eferenceDetails/ CustomerReference
request.

FedEx Web Services, Developer Guide 2016

201

Electronic Trade Documents

Element

Description

CompletedEtdDetail/UploadDocumentR Returns the value (if any) specified in the ProcessShipment
eferenceDetails/ DocumentProducer
request for the uploaded documents in addition to other
values for FedEx generated documents such as shipping
labels. This element is reserved for future use and should
not be specified in the ProcessShipment requests.
CompletedEtdDetail/UploadDocumentR Returns the type of document (if any) specified in the
eferenceDetails/ DocumentType
ProcessShipment request.
CompletedEtdDetail/UploadDocumentR Returns the value specified in the ProcessShipment request
eferenceDetails/ DocumentId
for your uploaded documents in addition to other values for
FedEx generated documents such as shipping labels.
CompletedEtdDetail/UploadDocumentR Returns the value (if any) specified in the ProcessShipment
eferenceDetails/ DocumentIdProducer request for your uploaded documents. This element is
reserved for future use and should not be specified in the
ProcessShipment requests.
CustomsClearanceDetail

Customs clearance data is used for both international and
intra-country shipping.

FedEx Web Services, Developer Guide 2016

202

Estimated Duties and Taxes (Express and Ground)

10 Estimated Duties and Taxes (Express
and Ground)
FedEx Estimated Duties and Taxes allows you to request a complete international shipping rate quote for
FedEx Express® and FedEx Ground International shipping rate, including applicable duties and taxes. The
Estimated Duties and Taxes feature supports the shipping of any product that is classified under the
Harmonized Tariff Code and is shipped to or from supported countries.
Note: To sign up for FedEx Estimated Duties and Taxes, contact your FedEx account executive.

10.1 Estimated Duties and Taxes Service Details
Estimated Duties and Taxe information is available when shipping any FedEx Express International singlepiece or multi-piece shipment and FedEx International Ground single-piece shipments. FedEx
International Ground multi-piece shipments are not currently supported by the Estimated Duties and
Taxes feature.
To receive an estimate on a shipment's applicable duties and taxes, you must know the following:


Harmonized Tariff Codes for the product to be shipped



Unit of measure for the product to be shipped



Applicable excise conditions

Note the following:


An estimate is returned only if you are paying all shipping charges and all duties and taxes, or if you
are paying the shipping charges only.



For FedEx Express - the origin/destination pair must be countries supported by the FedEx Trade
Tools system. See Appendix B: U.S. State Codes section of Web Services Developer Guide for
more information.



For FedEx Ground - the origin/destination pair must be countries supported by the FedEx Trade Tools
system. See Appendix A: Country Code Tables of Web Services Developer Guide for more
information.



Several countries are already supported by Estimated Duties and Taxes, but FedEx may add
countries in the future. Results apply only to the country of origin, country of manufacture, and
country of destination, as specified by the user.



This is an estimate only; final charges may vary.



The estimate may change based on fluctuations in exchange rates and/or changes to tariff rates.



The estimate includes shipping charges and estimates on duties and taxes only. Total landed costs,
which can include additional charges, are not included in this estimate.



For product shipments to countries that use the costs, insurance, and freight (CIF) value as the basis
for customs valuation, Estimated Duties and Taxes distributes insurance and freight costs
proportionately to each product. This distribution is based as a percentage of product weight or
product value, depending on the rules of the destination country. For countries that do not use CIF as

FedEx Web Services, Developer Guide 2016

203

Estimated Duties and Taxes (Express and Ground)
the basis for customs valuation, transportation and insurance costs are excluded from the calculation.
Currently, the Estimated Duties and Taxes feature does not generate compound duty rates and
calculations.


All estimates are calculated based on the lowest available preferential trade agreement rate in effect
for the countries selected. If the product does not meet the eligibility criteria for the preferential trade
agreement, the actual charges may be higher than the estimate.



The estimate is based on the value of each commodity in a package, not on the aggregate package
value.

For example, assume you need to ship a single package that contains 5 individual commodities. All
commodities are valued under $500, but the dutiable limit for the destination country is $2,000. In this
instance, the system returns a zero duty estimate. Although the aggregate package value exceeds the
$2,000 limit, the system calculates the estimate on a commodity-by-commodity basis, and returns a zero
duty estimate.

10.1.1 Unit of Measure
To ensure an accurate estimate, enter a correct unit of measure value in the appropriate element. This
element varies depending on the shipped commodity.
Review Appendix G Harmonized Tariff Unit of Measure Codes section of Web Services Developer
Guide. If the applicable unit of measure for any commodity being shipped is listed, then that information
must be stored in the quantityUnits field or in the additionalMeasures field. For units of measure stored
in the additionalMeasures field, an additional placeholder value of EA must be stored in the quantityUnits
field.
If the unit of measure is listed, then failure to store the value EA in the quantityUnits field will result in an
error.

10.2 Estimated Duties and Taxes Coding Details
Estimated duties and taxes can be requested by using the ShipService and RateService WSDLs.

10.2.1 Estimated Duties and Taxes Request Elements
Use the following elements from the ShipService and RateService WSDLs to code an estimated duties
and taxes request:
Table 82. Estimated Duties and Taxes Request Elements
Element

Description

RequestedShipment/EdtRequestType

Optional
Specify the types of estimated duties and taxes to be included
in a rate quotation for an international shipment. Valid values
are:

EdtCommodityTax/HarmonizedCode



ALL



NONE

Optional
Specify the appropriate Harmonized Tariff Code. Harmonized
Tariff Codes are used by customs to determine duties, taxes,

FedEx Web Services, Developer Guide 2016

204

Estimated Duties and Taxes (Express and Ground)

Element

Description
and clearance requirements for each commodity in your
shipment.
You can use FedEx® Global Trade Manager to look up your
Harmonized Tariff Code and determine which customs
documents may be required for your shipment.

EdtCommodityTax/Taxes

Optional
Specify the tax amount.

EdtExciseCondition/Category

Optional
Specify the excise condition.

EdtExciseCondition/Value

Optional
Specify the customer-declared value, with data type and legal
values, depending on the excise condition. This element
defines the taxable value of the item.

EdtTaxDetail

Optional
Specify the tax details.

EdtTaxDetail/TaxType

Optional
Specify the tax type. Valid values are:


CONSULAR_INVOICE_FEE



CUSTOMS_SURCHARGES



DUTY



EXCISE_TAX



FOREIGN_EXCHANGE_TAX



GENERAL_SALES_TAX



IMPORT_LICENSE_FEE



INTERNAL_ADDITIONAL_TAXES



INTERNAL_SENSITIVE_PRODUCTS_TAX



OTHER



SENSITIVE_PRODUCTS_TAX



STAMP_TAX



STATISTICAL_TAX



TRANSPORT_FACILITIES_TAX

EdtTaxDetail/Name

Optional
Specify the tax name.

EdtTaxDetail/EffectiveDate

Optional
Specify the effective date.

EdtTaxDetail/TaxableValue

Optional
Specify the taxable value.

FedEx Web Services, Developer Guide 2016

205

Estimated Duties and Taxes (Express and Ground)

Element

Description

EdtTaxDetail/Description

Optional
Specify the tax description.

EdtTaxDetail/Formula

Optional
Specify the tax formula.

EdtTaxDetail/Amount

Optional
Specify the tax amount.

FedEx Web Services, Developer Guide 2016

206

FedEx Express U.S. Shipping

11 FedEx Express U.S. Shipping
Use the ShipService WSDL to access the FedEx Express® U.S. shipping features. See Shipping
Services by Region for a list of FedEx Express U.S. services by region.
FedEx Express U.S. shipping offers the following services:


Alcohol Shipping



Alternate Return Address



Delivery Signature Options



Dry Ice Shipments



FedEx Express U.S. Multiple-Package Shipments



Future Day Shipping



Hold at FedEx Location



FedEx Intra-Country Shipping



Masked Data



Saturday Service



Shipment Notification in the Ship Request



Variable Handling Charges

11.1 FedEx Express U.S. Service Details
Before coding a FedEx Express U.S. transaction, you should be familiar with the basic shipping rules for
this service:


FedEx Express U.S. service is available to 50 States with United States of America. Transit times
vary depending on the package destination and the service you choose.



FedEx provides custom packaging for FedEx Express shipments. You may choose to ship using the
FedEx® Envelope, FedEx® Pak, FedEx® Box, or FedEx® Tube. You may also ship using your own
packaging.



Both commercial and residential shipments may be shipped using FedEx Express U.S. services.
Residential packages must be identified in your shipping transaction.



There are several options available to you for billing the transaction charges. These billing options
include Bill Shipper’s FedEx Account, Bill Recipient’s FedEx Account, FedEx Ground ® COLLECT, and
Bill Third Party’s FedEx Account.



The maximum size limit for a FedEx Express U.S. package is 150 lbs. and 119" in length, or 165 total
inches in length plus girth (L+2W+2H). If your package exceeds these limits, you must use one of
the FedEx Freight® shipping services.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

FedEx Web Services, Developer Guide 2016

207

FedEx Express U.S. Shipping

11.1.1 FedEx First Overnight
FedEx First Overnight® provides early-morning delivery between 8 and 10 a.m. depending upon the
destination postal code.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Available throughout all states except Hawaii (outbound-only from Alaska).



Available for intra-country shipping in Mexico and Canada.



Not available to Alaska, but delivery is available from Alaska to many U.S. markets, depending on
destination postal code. Not available to or from Hawaii. For more information about Alaska and
Hawaii shipments, go to http://www.fedex.com/us/service-guide/our-services/us/.

Options include Saturday Service, Dangerous Goods support for Dry Ice Shipments only, and
Delivery Signature Options

11.1.2 FedEx First Overnight Freight
FedEx First Overnight® Freight business rules are as follows:


Service days are Monday through Friday, with Saturday pickup and delivery service available in many
areas for palletized shipments.



Not available to and from Puerto Rico or transborder countries.



Next-business-day delivery by 8:30 a.m. to H0 and H1 service areas.



Next-business-day delivery by 9:30 a.m. to H2 service areas.



Next-business-day delivery by 12:00 p.m. for H3 service areas.



Pallet or skid size guidelines: up to 70" in height, 119" in length, or 80" in width.



Individual pallets/skids weighing in excess of 2200 lbs., or larger than 70" in height, 119" in length, or
80" in width require prior approval by calling FedEx Express Freight Customer Service at
1.800.332.0807.



Packaging type: Customer’s Own



Maximum declared value is $50,000



Advance confirmation required. Book space using FedEx Ship Manager at fedex.com or by calling
1.800.332.0807.
Options include Saturday Service, Dangerous Goods, support for Inaccessible Dangerous
Goods (IDG), Accessible Dangerous Goods (ADG) and Dry Ice Shipments, Inside Pickup and
Delivery, and Shipment Notification in the Ship Request that includes FedEx Priority Alert
Options (for contracted accounts only), Ship Alert, Exception, and Delivery.

11.1.3 FedEx Priority Overnight
FedEx Priority Overnight® provides next-business-day delivery by 10:30 a.m. to most U.S. addresses,
delivery by 5 p.m. to remote areas, and delivery by 1:30 p.m. on Saturdays.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Available to and from all 50 states, but not all areas of Alaska and Hawaii.

FedEx Web Services, Developer Guide 2016

208

FedEx Express U.S. Shipping


Available for intra-Mexico shipping. Also available for intra-country shipping in Canada and
Switzerland.



Delivery to and from many areas of Alaska and Hawaii in 1 or 2 business days. For more information
about Alaska and Hawaii shipments, go to http:\\www.fedex.com\us\service-guide\ourservices\us\.

Options include Saturday Service, Dangerous Goods, FedEx Ground U.S.Collect On Delivery C.O.D,
Delivery Signature Options and Hold at FedEx Location.

11.1.4 FedEx Standard Overnight
FedEx Standard Overnight® provides next-business-day delivery by 3 p.m. to most addresses, and by
4:30 p.m. to rural areas.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Available to and from all 50 states, but not all areas of Alaska and Hawaii.



Available for intra-Mexico shipping. Also available for intra-country shipping in UAE.



Delivery to and from many areas of Alaska and Hawaii in 1 or 2 business days. For more information
about Alaska and Hawaii shipments, go to http:\\www.fedex.com\us\service-guide\ourservices\us\.



Options include Saturday Service, Dangerous Goods, Delivery Signature Options and Hold at
FedEx Location.

11.1.5 FedEx 2Day A.M.
FedEx 2Day® A.M. provides second business day delivery by 10:30 a.m. to most business areas. For
certain shipments to Alaska and Hawaii, delivery is in three business days.


Available throughout all 50 U.S. states, Alaska and Hawaii for intra-U.S. shipments only, including the
intra-U.S. portion of a Transborder Distribution shipment from Canada and Mexico.



Delivery in 2 business days by 10:30 a.m. to A1, A2, AA, and A4 service areas.



Delivery in 2 business days by 12:00 p.m. to A3, A5, and AM service areas.



When estimating time-in-transit and delivery date, keep in mind delivery days are Monday through
Friday.



Maximum declared value packaging level limit is $50,000 for FedEx Customer packaging, FedEx®
Pak, FedEx® Box, and FedEx® Tube and $500 for a FedEx® Envelope.



Maximum size limit is 119" in length, or 165" in length and girth (L+2W+2H). If your package exceeds
these dimensions, you must use FedEx Express U.S. Freight as your shipping service.



Options include Saturday Service, Dangerous Goods, support for inaccessible items only, Delivery
Signature Options, Hold at FedEx Location, Returns Shipping, and Shipment Notification in the
Ship Request that includes Ship Alert, Exception and Delivery.

Note: Shipment notification is not available while tracking a package.

FedEx Web Services, Developer Guide 2016

209

FedEx Express U.S. Shipping

11.1.6 FedEx Express Saver
FedEx Express Saver® provides delivery in 3 business days to businesses by 4:30 p.m. and to residences
by 7 p.m.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Available to and from all states except Alaska and Hawaii.
Options are Saturday Service, Dangerous Goods inaccessible items only, Delivery Signature
Options and Hold at FedEx Location.

11.1.7 Pharmacy Delivery
Pharmacy Delivery allows you to designate pharmacy as the required delivery location for a shipment,
bypassing loading docks and receiving areas.
Pharmacy Delivery provides the ability for customers to determine if the pharmacy delivery special
service type is available for a shipping destination on a US Domestic Express parcel (non-Freight)
shipment.
Notes:
1. This applies to both outbound as well as return shipments (print and email returns).
2. Express tags are not included.
3. For Pharmacy Delivery, US Domestic includes only the 50 US states (including Alaska and Hawaii) and does NOT
include Puerto Rico or any of the US territories (i.e., US Virgin Islands, American Samoa, Guam, etc).
4. The packaging types allowed for Pharmacy Delivery are same as those allowed for 'like' shipments without
pharmacy delivery.

11.2 FedEx Express U.S. Coding Details
The following coding details apply to FedEx Express U.S. shipping:


FedEx provides several standard package types and allows you to use your own packaging for FedEx
Express shipping.



Both commercial and residential shipments are allowed with FedEx Express U.S. shipping.
Residential shipments are charged a delivery surcharge.

Note: Shipments to residential addresses will be invoiced as Residential Delivery regardless of the information in the
ProcessShipmentRequest or RateRequest. The flag is there to ensure you have the surcharge included in your
courtesy rate quote. It is helpful if you store the recipient address with the residential surcharge flag in your
shipping address book database. If you are unsure about the residential status of an address, use Address
Validation to do a residential status check.



There are several options available to you for billing the transaction charges. These billing options
include Bill Shipper’s FedEx Account, Bill Recipient’s FedEx Account, and Bill Third Party’s FedEx
Account. Make sure you enter the appropriate FedEx account number if you want recipient or thirdparty billing. If the account number is missing or incorrect, you will be billed for the shipping costs.



You can add reference elements to your Ship request which print on the shipping label, the invoice,
or both. See the Reference Elements with Output Location table for more information.



The maximum limits for FedEx Express U.S. packages are 150 lbs., 119"s in length, and 165" in
length plus girth (L+2W+2H.

FedEx Web Services, Developer Guide 2016

210

FedEx Express U.S. Shipping

11.2.1 Express U.S. Basic Ship Request Elements
In addition to the basic complex elements required for all web service requests described in the
Introduction, the following elements are available for FedEx Express U.S. ship requests:
Table 83. Recipient Information Elements
Element
RequestedShipment/Company

Description
Required if Contact name is blank.

RequestedShipment/Contact

Required if Company name is blank.

RequestedShipment/StreetLines

At least one street address line is required. This is a
multiple occurrence field.

RequestedShipment/City

Required.
Specify the recipient city.

RequestedShipment/StateOrProvinceCode

Required.
Valid value for FedEx Express – U.S. is U.S.
See Appendix B: U.S. State Codes section of Web
Services Developer Guide for more information on state
codes.

RequestedShipment/Postal Code

Required.
Specify the recipient postal code.

RequestedShipment/PhoneNumber

Required.
Specify the recipient phone number.

Table 84. Shipment/Package Information Elements
Element
ServiceType

PackagingType

Description
Required.
Specify the service type for your shipment/package.
Valid values:


PRIORITY_OVERNIGHT



STANDARD_OVERNIGHT



FEDEX_2_DAY



FEDEX_2_DAY_AM



FEDEX_EXPRESS_SAVER



FEDEX_FIRST_FREIGHT



FEDEX_FREIGHT_PRIORITY



FEDEX_FREIGHT_ECONOMY



FIRST_OVERNIGHT



SAME_DAY



SAME_DAY_CITY

Required.

FedEx Web Services, Developer Guide 2016

211

FedEx Express U.S. Shipping
Element

Description
Specify the type of packaging for your shipment.
Valid values:


FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_PAK



FEDEX_TUBE



YOUR_PACKAGING

Weight

The Weight/Units element must also be included in your Ship
request. This element requires either LB (pounds) or KG
(kilograms) as the weight unit descriptor. The maximum limits
for FedEx Express U.S. packages are 150 lbs. and 119" in
length and 165" in length and girth (L+2W+2H).

Height

Optional but recommended if your package type is
YOUR_PACKAGING.

Width

Optional but recommended if your package type is
YOUR_PACKAGING.

Length

Optional but recommended if your package type is
YOUR_PACKAGING.

Units

Required if dimensions are specified.
Values are:

InsuredValue/Amount



FedEx liability for each package is limited to $100USD unless a
higher value is declared and paid for. Use this element if you
want to declare a higher value.
Note: "InsuredValue" refers to declared value of the package.

RequestedShipment/ShipTimestamp

Time of shipment based on shipper’s time zone. Defaults to
CDT.
This element must be formatted as follows:


The date format must be YYYY-MM-DDTHH:MM:SSxx:xx.



The time must be in the format: HH:MM:SS using a 24hour clock. The date and time are separated by the letter
T, such as 2009-06-26T17:00:00.



The UTC offset indicates the number of hours/minutes,
for example xx:xx from UTC, such as 2009-0626T17:00:00-05:00 is defined as June 26, 2009 5:00 p.m.
Eastern Time.
See Appendix M: Time Zones section of Web Services
Developer Guide for more information about time zones
FedEx Web Services, Developer Guide 2016

212

FedEx Express U.S. Shipping
Element
Address/Residential

Description
This element must be set to true in order to obtain a residential
surcharge included in the estimate of shipping charges
returned in the reply. To determine if an address is considered
residential, use the Address Validation Service.

Table 85. Label Requirements Elements
Element
LabelSpecification

Description
To identify the format of the label you will receive, elements in the
LabelSpecification complex type element should be included in the
ProcessShipmentRequest (depending on your label format). More
information about label printing is provided in FedEx SmartPost
Shipping.

11.2.2 FedEx Express U.S. Ship Reply Elements
In the ShipResponse/ProcessShipmentReply, the following elements are returned for a Ship request:


Tracking number(s): A tracking number is assigned to all packages. For FedEx ® Collect on Delivery
(C.O.D.), you receive the origin shipment-status tracking number and the C.O.D. return payment
tracking number.



Rates and surcharges: For more information on the rating elements that are returned in a Ship Reply,
see Rate Services. The maximum number of packages in one rate request is 100. For more
information about multiple-piece shipments (MPS), see FedEx Express U.S. Multiple-Package
Shipments.



Service commitment.



Routing code.



Origin commitment.



Time-in-transit detail.



Delivery day.



Destination location ID.



Station ID (where applicable).

11.2.3 Reference Elements with Output Location
The ShipService WSDL uses the CustomerReferences/CustomerReferenceType element to define
reference information. See Appendix AB: Customer Reference Elements for the child elements.
Note: These elements can also be configured to print on the thermal label Doc-Tab. For more information, see the
Doc-Tab instructions in Create a Label. You may use reference elements to track packages or to tie
packages together for a single track request.
See Tracking and Visibility Services for more information.

FedEx Web Services, Developer Guide 2016

213

FedEx Express U.S. Shipping

11.3 FedEx Express U.S. Multiple-Package Shipments
A multiple-package shipment (MPS) consists of two or more packages shipped to the same recipient.
The first package in the shipment request is considered the master package.
To create a multiple-package shipment,


Include the shipment level information such as TotalWeight, PackageCount, SignatureOptions) on
the master package. The SequenceID for this package is 1.



In the master package reply, assign the tracking number of the first package in the MasterTrackingID
element for all subsequent packages. You must return the master tracking number and increment
the package number (SequenceID) for subsequent packages.

Note: The maximum number of packages in an MPS request is 200.

11.3.1 Multiple Piece Shipment Request Elements
Table 86. Multiple Piece Shipment Request Elements
Element

Description

SequenceNumber

Each shipment must contain a SequenceNumber. For example, the
first package (also known as the master package) has a sequence
number of 1. All additional packages are numbered sequentially.
This number system is important because the master package
carries shipment-level information.
Required for multiple-package shipments (MPS).
Field Level: Package

MasterTrackingID

The reply for the first package (master package) in a shipment
includes the MasterTrackingID element. This element is the
MasterTrackingNumber. FormID is included only for C.O.D.
shipments.
Required for MPS tracking requests and for each subsequent ship
request for an MPS.
Field Level: Package

MasterTrackingID/TrackingIDType

Field Level: Package
Valid values:


EXPRESS



FREIGHT



GROUND



USPS



FEDEX

Note: Use "FEDEX" when using the standard 34 digit barcode for FedEx
Express, FedEx Ground and FedEx SmartPost.

PackageCount

This is the total number of packages in the MPS. Include this
element in the master package request. The maximum number of
packages in one rate request is 200.

FedEx Web Services, Developer Guide 2016

214

FedEx Express U.S. Shipping
Element

Description
Field Level: Shipment

TotalShipmentWeight

Total shipment weight is added to the master package in the
multiple-package shipment and contains the total weight of all
packages in the shipment.
Field Level: Shipment

11.3.2 Multiple Piece Shipment Reply Elements
Table 87. Multiple Piece Shipment Reply Elements
Element

Description

PackageSequenceNumber

Returned for all multiple piece shipment (MPS) requests.
Indicates the sequence number of the package within the
MPS.

MasterTrackingID

Returned in the master package reply for an MPS C.O.D.
Includes tracking number and form ID.
Used when requesting child pieces in an MPS. The master
tracking information will be returned in reply from the first
package requested for an MPS. That master tracking
information is then inserted into the requests for each
additional package requested for that MPS.

MasterTrackingID/TrackingIDType

Valid values:


EXPRESS



FREIGHT



GROUND



USPS



FEDEX

Note: Use "FEDEX" when using the new standard 34 digit barcode for
FedEx Express, FedEx Ground and FedEx SmartPost.

SpecialServicesRequested/CodDetail/
ReturnTrackingId

Optional.
Returned in the reply only when used with multipiece COD
shipments sent in multiple transactions. Required on last
transaction only.

Note: For a FedEx Ground MPS rate request, the reply will include piece-level detail. This information is not available
for FedEx Express replies. For a FedEx Express MPS rate request, the reply will include only shipmentlevel
detail.

FedEx Web Services, Developer Guide 2016

215

FedEx Express U.S. Shipping

11.4 Group Multiple Piece Shipments
Multiple Piece Shipments (MPS) group multiple packages prepared with different shipping devices or
technologies so that they can be tracked together.
The grouping process will create daily MPS, consisting of 2 or more packages, that have the same ship
date, shipper, recipient, payor, service, delivery instructions and shipper-provided reference number. The
grouping process links packages coming from the same account, same facility and multiple automation
devices.
Group MPS is an opt-in process that must be enabled at the account level by FedEx Sales and
Technology support per a shipper's request and shipping process. A shipper will set one reference field
within FedEx shipping technology to populate with a unique shipment reference number (e.g., purchase
order number).
Contact your FedEx account executive to start the enrollment process.

11.4.1 Group Multiple-Piece Shipment Details


A shipment must contain two or more packages.



All packages must have the same ship date.



All packages must have the same shipper account, address lines, city, state, postal code, and contact
name.



All packages must have the same recipient address lines, city, state, postal code, and contact name.



All packages must have the same service type.



All packages must have the same bill-to account.



FedEx® Delivery Signature Options must be the same for all packages.



FedEx® Collect on Delivery selections must be the same for all packages.



Saturday Pickup and Delivery selection must be the same for all packages.



Hold at FedEx Location selection must be the same for all FedEx Express packages.



Inside Pickup and Delivery selection must be the same for all FedEx Freight packages.



FedEx Home Delivery® convenient delivery options must be the same for all packages.



FedEx Ground shipment integrity selection must be the same for all packages.



For FedEx Ground, packaging type must be “your packaging” for all packages



All packages must have the same grouping-trigger reference field value (value cannot be spaces).



The shipper must be enrolled in the group multiple-piece shipment (MPS) program.



Signature type must be the same.

FedEx Web Services, Developer Guide 2016

216

FedEx Express Freight Services: U.S

12 FedEx Express Freight Services: U.S
FedEx Express® Freight Services is used when for packages that exceed 150 lbs. The freight must be
shrink-wrapped and/or banded to a skid. It must be palletized, stackable, and forkliftable. For more
detailed information about the services offered by FedEx, see the electronic FedEx Service Guide.

12.1 Express Freight Service Business Rules
12.1.1 FedEx 1Day Freight
FedEx 1Day® Freight service provides next-business-day delivery for packages/skids weighing in excess
of 150 lbs. The business rules are:


Service days are Monday through Friday, with Saturday pickup and delivery available to many major
markets.



For intra-United Kingdom shipments, ship to an address within the U.K. and deliver within the next
business day (by end of day). Supports the customer packaging type.



A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.



Available throughout all 50 states; Hawaii service is to and from the island of Oahu only. Not available
to Puerto Rico.



Skid and/or package size and weight: Exceeding 119" in length or 80" in width or 70" in height.
Individual packages and/or skids greater than 151 lbs. Skids weighing in excess of 2,200 lbs. require
prior approval by FedEx.



The following special services are allowed (depending on the destination location): Saturday
Service, Dangerous Goods, FedEx Express Collect on Delivery C.O.D., Hold at FedEx Location,
and FedEx Priority Alert Options (for contracted accounts only).

12.1.2 FedEx 2Day Freight
FedEx 2Day® Freight services provide delivery in 2 business days for packages or skids weighing in
excess of 150 lbs. The business rules are as follows:


Service days are Monday through Friday, with Saturday pickup and delivery available to many major
markets.



Available throughout all 50 states; Hawaii service is to and from the island of Oahu only. Not available
to Puerto Rico.



Skid and/or package size and weight: Exceeding 119" in length or 80" in width or 70" in height.
Individual packages/skids greater than 151 lbs. Skids weighing in excess of 2,200 lbs. require prior
approval by FedEx.



The following special services are allowed (depending on destination location): Saturday Service,
Dangerous Goods, FedEx Express Collect on Delivery C.O.D., Hold at FedEx Location, and
FedEx Priority Alert Options (for contracted accounts only).

FedEx Web Services, Developer Guide 2016

217

FedEx Express Freight Services: U.S

12.1.3 FedEx 3Day Freight
FedEx 3Day® Freight services provide delivery in 3 business days for packages or skids weighing in
excess of 150 lbs. The business rules are as follows:


Service days are Monday through Friday with Saturday pickup available to many major markets.



Available throughout all states except Alaska and Hawaii. Not available to Puerto Rico.



The following special services are allowed (depending on destination location): Dangerous Goods,
FedEx Express Collect on Delivery C.O.D., Hold at FedEx Location, and FedEx Priority Alert
Options (for contracted accounts only).

12.1.4 FedEx First Overnight Freight
FedEx First Overnight® Freight business rules are as follows:


Service days are Monday through Friday, with Saturday pickup and delivery service available in major
markets.



Available within all 50 U.S. states including Hawaii (only to the island of Oahu), and not available to
and from Puerto Rico or transborder countries.



Next-business-day delivery by 9:00 a.m.or 10:30 a.m. to most primary service area ZIP codes.



Pallet or skid size guidelines: up to 70" in height, 119" in length, or 80" in width.



Individual pallets/skids weighing in excess of 2200 lbs. or larger than 70" in height, 119" in length, or
80" in width require prior approval by calling FedEx Express® Freight Services Customer Service at
1.800.332.0807.



Packaging type: Customer’s Own.



Maximum declared value is $50,000.



Advance confirmation required. Book space using FedEx Ship Manager ® at fedex.com or by calling
1.800.332.0807.



Options include Saturday Service, Dangerous Goods, support for Inaccessible Dangerous Goods
(IDG), Accessible Dangerous Goods (ADG) and Dry Ice Shipments, Inside Pickup and Delivery, and
Shipment Notification in the Ship Request that includes FedEx Priority Alert (for contracted
accounts only), Ship Alert, Exception, and Delivery.

12.1.5 Inside Pickup and Delivery
For FedEx Express® Freight Services, you may request inside pickup and/or inside delivery. Inside pickup
and delivery options are intended for customers who do not have the necessary equipment to move
shipments to the loading area. FedEx moves shipments from positions beyond the pickup or delivery site
which are directly accessible from the curb and are no more than 50 feet inside the outermost door.
FedEx Inside Pickup and FedEx Inside Delivery are available for FedEx 1Day Freight, FedEx 2Day Freight
and FedEx 3Day Freight services and do not require special service contracts with FedEx. If a shipment
breakdown is needed to fit a shipment through a doorway, additional charges may be assessed. FedEx
does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the
delivery site.
FedEx Web Services, Developer Guide 2016

218

FedEx Express Freight Services: U.S

12.2 FedEx Express Freight Services Coding Details
Before you begin coding FedEx Express Freight Services U.S., you should know:


Freight shipping weight must exceed 150 lbs.



You should use the ServiceAvailability Service to determine what freight services are available for
your origin/destination pair.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.
FedEx Express Freight Services U.S. are included in the ShipService WSDL. In addition to the basic
shipping elements required for a FedEx Express shipment, the following elements are available:
Table 88. U.S. Express Freight Detail Elements
Element
ExpressFreightDetail/
BookingConfirmationNumber

Description
Optional.
An advance booking number is optional for FedEx 1Day
Freight. When you call 1.800.332.0807 to book your
freight shipment, you will receive a booking number. This
booking number is included in the Ship request, and prints
on the shipping label.

ExpressFreightDetail/PackingListEnclosed

Optional.
If you enclose a packing list with your FedEx Express
Freight Services shipment, this element informs FedEx
operations that shipment contents can be verified on your
packing list.

Note: Additional services available for FedEx Express Freight Services U.S. include: Saturday Service,

Dangerous Goods, FedEx Express Collect on Delivery C.O.D., Hold at FedEx Location.

FedEx Web Services, Developer Guide 2016

219

FedEx Freight Services

13 FedEx Freight Services
One streamlined network, FedEx Freight®, offers you two easy service options: FedEx Freight ® Priority
(formerly FedEx Freight) for speed, and FedEx Freight® Economy (formerly FedEx National LTL) for
savings. The change in services allows FedEx to offer you two levels of service, priority or economy
freight, in one fully integrated, nationwide pickup and delivery network.
Choose fast-transit FedEx Freight Priority (formerly FedEx Freight transit times) to meet your supply
chain needs. Our all-points coverage and on-time reliability make FedEx Freight Priority the perfect choice
for your time-sensitive shipments.
With FedEx Freight Economy, you get reliable, economical delivery to meet your freight shipping needs
and budget. All-points coverage and on-time reliability make FedEx Freight Economy the ideal service
when you can trade time for savings.


FedEx Freight® Priority focuses on regional next-day and second-day services that provide the benefit
of fast-cycle logistics. Delivery is typically in 1 or 2 business days by 5 p.m. for U.S. shipments. Use
this service when speed is critical to meet your supply chain needs.



FedEx Freight® Economy provides long-haul service for planned inventory replenishment, with
multiple service options to meet your needs. Delivery is typically in 3–5 business days for U.S.
shipments. Use this service when you have the option to trade time for savings.

With FedEx Freight, you can ship palletized or non-palletized freight up to 20,000 lbs. in weight and 20
feet in length.
Whatever type of shipping service you need, you will have one Bill of Lading to process your shipments,
one invoice statement for less paperwork, one pickup and one delivery for all of your shipments. You will
also enjoy simplified account numbers and streamlined web applications, without any changes to your
current pricing agreement.
FedEx Freight address labels are optional and contain very little information, compared to FedEx Express
and FedEx Ground labels. The PRO number is the equivalent of the FedEx Express® / FedEx Ground®
tracking number. A single PRO number is assigned to an LTL freight shipment, regardless of the number
of pallets in the shipment.
Use the ShipService WSDL and the PickupService WSDL to access FedEx Freight shipping features, and
use the following ServiceType enumerated values:


FEDEX_FREIGHT_PRIORITY



FEDEX_FREIGHT_ECONOMY

See the Freight Elements for information on how to specify the freight elements.
Use either the Shipper Freight Account or the Bill To Freight Account depending on your role.
Shipper: The company or person in the "From" fields on the FedEx shipping document; sometimes called
the consignor. The shipper is the party that gives the shipment to the carrier. The shipper is often
responsible for the shipping charges, but this is not always the case.
Bill To: "Bill To" is an abbreviation of "Third Party Bill To" which is the company or person that will receive
and pay a shipment's invoice.
Freight services and special services (accessorials) are supported via Web Services for rate quote,
shipment, and pickup requests. Tracking of freight shipments is also supported. There is no specific
element for freight that must be specified in a track request.
FedEx Web Services, Developer Guide 2016

220

FedEx Freight Services

13.1 FedEx Freight Service Features
FedEx Freight Priority and FedEx Freight Economy services ship packages within the United States,
Canada, Mexico, and Puerto Rico. Specifically, service areas include:


United States (including to/from Alaska and Hawaii) to: Mexico, Canada, Puerto Rico and within the
United States



Canada to: United States, Puerto Rico and within Canada



Mexico to: United States, Puerto Rico and within Mexico



Puerto Rico to: United States, Canada and Mexico

Other service features include the ability to


Create and print a Bill of Lading (BOL)

Note: The BOL can only be printed in PDF file format.



Schedule an optional pickup



Update or cancel a previously scheduled pickup



Print the BOL in multiple formats (Uniform or VICS)



Request a rate quote



Create international customs documents (Commercial Invoice, Certificate of Origin and NAFTA
Certificate of Origin)

13.2 FedEx Freight Service Details
Service details play a vital role in getting your shipment delivered and handled correctly. The following
service details include information on shipping rules, packaging, Bills of Lading, and restrictions using
these services.

13.2.1 Shipping Rules


Both commercial and residential shipments may be shipped using FedEx Freight Priority and FedEx
Freight Economy.



Residential packages must be identified in your shipping transaction.



The FreightShipmentDetail/FedExFreightAccountNumber and the corresponding
FreightShipmentDetail/FedExFreightBillingContactAndAddress for the given freight account number
are required entries for all shipments. The billing contact and address must match that in the FedEx
Customer Database for the given account number. The account number and billing information
should be that of the party that is presenting the information in the shipment transaction.



If the FreightShipmentDetail/Role is set to CONSIGNEE, then the PaymentType must be set to
RECIPIENT, and the FreightShipmentDetail/CollectTermsType of either STANDARD or
NON_RECOURSE_SHIPPER_SIGNED must be specified.



The ShippingChargesPayment/PaymentType is required entry for all shipments.
Valid values are: SENDER, RECIPIENT or THIRD_PARTY.

FedEx Web Services, Developer Guide 2016

221

FedEx Freight Services
o

If the ShippingChargesPayment/PaymentType is set to SENDER, then the
ShippingChargesPayment/Payor/ResponsibleParty/AccountNumber must be populated with the
same account number as that in FreightShipmentDetail/FedExFreightAccountNumber.
If the ShippingChargesPayment/PaymentType is set to THIRD_PARTY, then
ShippingChargesPayment/Payor/ResponsibleParty/Contact and
ShippingChargesPayment/Payor/ResponsibleParty/Address must both be populated. Required
fields are either the company/person name and the phone number. Required address fields are
the street line 1, city, state/province code and country code.
If the ShippingChargesPayment/PaymentType is set to RECEPIENT, then
ShippingChargesPayment/Payor/ResponsibleParty/Contact and
ShippingChargesPayment/Payor/ResponsibleParty/Address must both be populated. Required
fields are either the company/person name and the phone number. Required address fields are
the street line 1, city, state/province code and country code.

13.2.2 Packaging
FedEx provides standard packaging options for FedEx Freight Priority and FedEx Freight Economy
shipments.
Freight max dimensions are:


Height: 106 inches



Width: 93 inches



Length: 179 inches

Note: Anything with a length of 180 inches and greater is considered Extreme Length and would need to be flagged
as such within in the SpecialServicesRequested element.

For more information on freight packaging guidelines , refer to Fedex Freight Packaging Guidelines
document.

13.2.3 Creating and Printing a Bill of Lading
1. You can indicate within the transaction one of the following formats for a thermal label.
a. 4" x 8"
b. 4" x 9"
2. You can indicate within the transaction to print a thermal image on plain paper in one of these
formats only.
a. 4" x 8" PNG or PDF
b. 4" x 9" PNG or PDF

13.3 FedEx Freight Priority
With industry-leading on-time performance and fast transit times, FedEx Freight Priority delivers your
shipments quickly and reliably. Count on our international and nationwide service for extensive next-day
and second-day delivery to your customers, all backed by a no-fee money-back guarantee.*
FedEx Freight Priority service features include:


Careful handling of shipments.



Complete coast-to-coast coverage.

FedEx Web Services, Developer Guide 2016

222

FedEx Freight Services


Consistent, on-time reliability.



Direct delivery to virtually every ZIP code in the continental U.S.



End-to-end shipment visibility.



Knowledgeable and dependable employees.



No-fee money-back guarantee.*



State-of-the art information technology with end-to-end shipment visibility.

For more information, contact your account executive, or call our customer service team at
1.866.393.4585.
*All services are subject to the terms and conditions of the FXF 100 Series Rules Tariff.

13.4 FedEx Freight Economy
FedEx Freight Economy provides economical delivery, focused on your basic freight shipping needs.
FedEx takes care of you and your customers with the on-time reliability and careful handling you expect.
FedEx Freight Economy delivers:


Economical freight solutions.



Consistent, on-time reliability.



Direct delivery to virtually every ZIP code in the contiguous U.S.



State-of-the art information technology with end-to-end shipment visibility.



Dedicated team of professionals to assist with all of your freight needs.

For more information, contact your account executive, or call our customer service team at
1.866.393.4585.
*All services are subject to the terms and conditions of the FXF 100 Series Rules Tariff.

13.5 Custom Delivery Date Options
FedEx Freight Economy supports Custom Delivery Date options to prepare a shipment to be sent at a
specific time, on a specific date, or sometime within a specific date range.

13.6 Inside Pickup Service Option
Review the following before shipping using the inside pickup service option.


Inside pickup service does not require a special service contract with FedEx.



If a shipment breakdown is needed to fit a shipment through a doorway, additional charges may be
assessed.

13.7 FedEx Freight Rates and Surcharges
Freight Priority services and special services (accessorials) are supported via FedEx Web Services for rate
quote, shipment, and pickup requests. Tracking of Freight shipments is also supported via the PRO
FedEx Web Services, Developer Guide 2016

223

FedEx Freight Services
number. A single PRO number is assigned to a Freight shipment, regardless of the number of pallets in
the shipment. If your shipping operation charges handling fees in addition to shipping charges, then you
can add these handling fees to your total shipment charge.
For applicable FedEx Freight Priority and FedEx Freight Economy package and freight services, an
additional surcharge applies to any package that requires special handling pertaining to the following
surcharge types:


Extreme length



Freight guarantee



Liftgate delivery



Protection from freezing



Delivery area surcharge

Additionally, a fuel surcharge may apply to shipments destined to select ZIP codes. Find surcharge and
fee information in the Fees and Other Shipping Information in the FedEx Service Guide. Updates to
surcharges and fees are available online at fedex.com/us/2014rates/surcharges-and-fees.html.
Find Freight accessorial service info online at fedex.com/us/freight/rulestariff/AccessorialRates.pdf. For
more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide.
Note: LTL Freight Offshore (Alaska, Hawaii, Puerto Rico) rating is not currently supported in the FedEx Web Services
solution.

13.8 FedEx Freight Coding Details
In addition to the basic complex elements required for all FedEx Web Services requests, the following
elements are available for FedEx Freight Priority and FedEx Freight Economy ship requests:

13.8.1 Freight Elements
Table 89. Freight Request Elements
Element

Description

RequestedShipment/ServiceType

Required
Identifies the FedEx service to use in shipping the package. See
ServiceType for list of valid enumerated values. Use one of the
following enumerated values:

RequestedShipment/
ShippingChargesPayment



FEDEX_FREIGHT_PRIORITY



FEDEX_FREIGHT_ECONOMY

Optional
Descriptive data indicating the method and means of payment to
FedEx for providing shipping services. Enter the party responsible
for the transportation charges: SENDER, RECIPIENT or
THIRD_PARTY.

FedEx Web Services, Developer Guide 2016

224

FedEx Freight Services
Element

Description

RequestedShipment/
ShippingChargesPayment/
Payor/ResponsibleParty/
AccountNumber

Optional
Identifies the FedEx account number assigned to the customer. If
the shipment is a Bill Sender transaction, enter the shipper's
FedEx 9 digit Enterprise account number or the 8 or 9 digit Freight
account number. If the shipment is Bill Recipient and the payor's
FedEx account number is known, enter the payor's FedEx account
number.

RequestedShipment/
SpecialServicesRequested/
FreightGuaranteeDetail/Type

Optional.
The type of guarantee.
Valid values are:


GUARANTEED_DATE



GUARANTEED_MORNING

Note: The Guaranteed delivery options are available for both the Freight
Priority service and the Freight Economy service for an additional
charge.

RequestedShipment/
SpecialServicesRequested
/FreightGuaranteeDetail/Date

Optional
Date for all Freight guarantee types.

RequestedShipment/
FreightShipmentDetail

Optional
Data applicable to shipments using FedEx Freight services.

RequestedShipment/
FreightShipmentDetail/
FedExFreightAccountNumber

Required
Account number used with FEDEX_FREIGHT services. If the
shipper is responsible for the transportation charges, enter the
SAME account number in the FedExFreightAccountNumber that is
entered in the
ShippingChargesPayment/Payor/ResponsibleParty/Account
number. If the shipper is not responsible for the transportation
charges, enter a valid FedEx Freight 8- or 9-digit account number.

RequestedShipment/
FreightShipmentDetail/
FedExFreightBillingContactAndAddr
ess

Required
Enter the Billing Address information in
FedExFreightBillingContactAndAddress fields for the above
FedExFreightAccountNumber. Entries in
FedExFreightAccountNumber and
FedExFreightBillingContactAndAddress are required for security
purposes.

RequestedShipment/
FreightShipmentDetail/
AlternateBilling

Optional
Used in connection with "Send Bill To" (SBT) identification of
customer's account used for billing. To bill the transportation
charges to someone other than the sender or recipient, enter the
FedEx account number (9 digit Enterprise account number or 8 or
9 digit Freight account number.
Note: If this option is desired, the ShippingChargesPayment Payment must

FedEx Web Services, Developer Guide 2016

225

FedEx Freight Services
Element

Description
be set to SENDER.

RequestedShipment/
FreightShipmentDetail/
AlternateBilling/AccountNumber

Optional
Identifies the FedEx Account number assigned to the customer. If
the transportation charges are to be billed to a payor other than the
sendor or the recipient, enter the FedEx account number (9 digit
Enterprise Account number or the 8 or 9 digit Freight account
number).
Note: If this option is desired, the ShippingChargesPayment/PaymentType
must be set to SENDER.

RequestedShipment/
FreightShipmentDetail/
AlternateBilling/Contact

Required
Descriptive data identifying the point-of-contact person. If an
AlternateBilling/Account number has been specified, enter an
AlternateBilling/Contact/PersonName and/or
AlternateBilling/Contact/CompanyName associated with the
AlternateBilling/Address.

RequestedShipment/
FreightShipmentDetail
/AlternateBilling/Address

Optional
The descriptive data for a physical location. If an
AlternateBilling/AccountNumber has been specified, enter the
corresponding required Billing Address information associated with
the specified AlternateBilling/AccountNumber:


Street Line



City



State or Province



Country Code

RequestedShipment/
FreightShipmentDetail/
PrintedReferences

Optional
Identification values to be printed during creation of a Freight Bill of
Lading.

RequestedShipment/
FreightShipmentDetail/Role

Required
Indicates the role of the party submitting the transaction.
CONSIGNEE is the equivalent of Collect and SHIPPER is the
equivalent of Prepaid.
Valid values are:

RequestedShipment/
FreightShipmentDetail/
CollectTermsType



CONSIGNEE



SHIPPER

Optional
Designates the terms of the “collect” payment for a Freight
Shipment.
Valid values are:


SECTION_7_SIGNED

FedEx Web Services, Developer Guide 2016

226

FedEx Freight Services
Element

Description


NON-RECOURSE_SHIPPER_SIGNED



STANDARD

RequestedShipment/FreightShipme Optional
ntDetail/
Identifies the declared value for the shipment.
DeclaredValuePerUnit
RequestedShipment/FreightShipme Optional
ntDetail
Identifies the declared value units corresponding to the above
/DeclaredValueUnits
defined declared value.
RequestedShipment/FreightShipme Optional
ntDetail/
Identifies the Liability Coverage Amount. For January 2011, this
LiabilityCoverageDetail
value represents coverage amount per pound
RequestedShipment/FreightShipme Optional
ntDetail/
Identifiers for promotional discounts offered to customers.
Coupons
RequestedShipment/FreightShipme Required
ntDetail/
Total number of individual handling units in the entire shipment (for
TotalHandlingUnits
unit pricing).
RequestedShipment/FreightShipme Optional
ntDetail/
Estimated discount rate provided by client for unsecured rate
ClientDiscountPercent
quote.
RequestedShipment/FreightShipme Optional
ntDetail/
Total weight of pallets used in shipment.
PalletWeight
RequestedShipment/FreightShipme Optional
ntDetail/
Overall shipment dimensions.
ShipmentDimensions
RequestedShipment/FreightShipme Optional
ntDetail
Description for the shipment.
/Comment
FreightShipmentDetail/SpecialServi
cePayments

Optional
Specify which party will pay surcharges for any special services
which support split billing.

RequestedShipment/FreightShipme Optional
ntDetail/
Identifies the special service.
SpecialServicePayments/SpecialSer
vice
RequestedShipment/FreightShipme Optional
ntDetail/
Indicates who will pay for the special services.
SpecialServicePayments/PaymentT
ype

FedEx Web Services, Developer Guide 2016

227

FedEx Freight Services
Element

Description

RequestedShipment/FreightShipme Optional
ntDetail/
Must be populated if any line items contain hazardous materials.
HazardousMaterialsEmergencyCon
tactNumber
RequestedShipment/FreightShipme Optional
ntDetail/
Must be populated with a contact name if any line items contain
HazardousMaterialsOfferor
hazardous materials.
RequestedShipment/FreightShipme Optional
ntDetail/
Details of the commodities in the shipment.
LineItems
RequestedShipment/FreightShipme Required
ntDetail
Freight class for this line item.
/LineItems/FreightClass
RequestedShipment/FreightShipme Optional
ntDetail/
Number of individual handling units to which this line applies.
LineItems/HandlingUnits

Note: Total of line-item-level handling units may not balance to shipmentlevel total handling units.)

RequestedShipment/FreightShipme Required
ntDetail
Specification of handling-unit packaging for this commodity or
/LineItems/Packaging
class line.
RequestedShipment/FreightShipme Required
ntDetail
Number of pieces for this commodity or class line.
/LineItems/Pieces
Maximum supported value for this field is 9999.
RequestedShipment/FreightShipme Optional
ntDetail/
NMFC Code for commodity.
LineItems/NmfcCode
RequestedShipment/FreightShipme Optional
ntDetail/
Indicates the kind of hazardous material content in this line item.
LineItems/HazardousMaterials
RequestedShipment/FreightShipme Optional
ntDetail/
For printed reference per line item.
LineItems/BillOfLadingNumber
RequestedShipment/FreightShipme Optional
ntDetail
For printed reference per line item.
/LineItems/PurchaseOrderNumber
RequestedShipment/FreightShipme Required
ntDetail/
Customer-provided description for this commodity or class line.
LineItems/Description
RequestedShipment/FreightShipme Required
ntDetail/
Weight for this commodity or class line.
LineItems/Weight

FedEx Web Services, Developer Guide 2016

228

FedEx Freight Services
Element

Description

RequestedShipment/FreightShipme Identifies the unit of measure associated with a weight value. See
ntDetail
the list of enumerated types for valid values.
/LineItems/Weight/Units
Valid values:




RequestedShipment/FreightShipme Required
ntDetail/
Identifies the weight value of a package/shipment.
LineItems/Weight/ValueDecimal
RequestedShipment/FreightShipme Optional
ntDetail/
Volume (cubic measure) for this commodity or class line.
LineItems/Volume
RequestedShipment/
ShippingDocumentSpecification

Required
Indicates the types of shipping documents produced for the
shipper by FedEx.

RequestedShipment/
ShippingDocumentSpecification/
DangerousGoodsShippersDeclarati
onDetail

Optional
Indicates the instructions on how to print the 1421c form for
dangerous goods shipment.

DangerousGoodsShippersDeclarati
onDetail/
Format

Optional
Specify characteristics of a shipping document to be produced.

DangerousGoodsShippersDeclarati
onDetail/
CustomerImageUsages

Optional
Specify the usage and identification of customer supplied images
to be used on this document.

RequestedShipment/
ShippingDocumentSpecification/
ShippingDocumentTypes

Required
Indicates the types of shipping documents requested by the
shipper.

RequestedShipment/
ShippingDocumentSpecification/
FreightAddressLabelDetail/Starting
Position

Optional
Specify which quadrant on an 8-1/2" x 11" sheet is the starting
quadrant for printing the Freight address labels in a "4 per sheet"
configuration.
Valid values:

RequestedShipment
/ShippingDocumentSpecification/



BOTTOM_LEFT



BOTTOM_RIGHT



TOP_LEFT



TOP_RIGHT

Optional
If omitted, no doc-tab will be produced (i.e. default - former NONE
type).

FedEx Web Services, Developer Guide 2016

229

FedEx Freight Services
Element

Description

FreightAddressLabelDetail/DocTab
Content
ShippingDocumentSpecification/
ReturnInstructionsDetail

Optional
Specify the production of the return instructions document
(document characteristics and printing). This information will print
on the Return Instructions returned in the transaction for the Print
Return Label.

ReturnInstructionsDetail/Format

Optional
Common information controlling document production.

ReturnInstructionsDetail/CustomTe
xt

Optional
Specify additional customer provided text to be inserted into the
return document.

Table 88. Optional Freight Request Elements for using Pre-Assigned PRO numbers
Element

Description

RequestedShipment
/MasterTrackingId
/TrackingIdType

Set the TrackingIdType to FREIGHT

RequestedShipment
/MasterTrackingId
/TrackingNumber

Set TrackingNumber to the pre-assigned PRO Tracking Number

Notes:
1. Using pre-assigned Pro numbers in your Ship Web Service is only available for LTL Freight shipments and is not
supported for Express Freight or small parcel shipping.
2. Your company should contact your FedEx Sales Account Executive if you are interested in using pre-assigned PRO
numbers.

Table 90. Optional Pickup Request Elements
Element

Description

CreatePickupRequest/
AssociatedAccountNumber

Optional
The number associated with the FedEx Account.

CreatePickupRequest/OriginDetail

Optional
Descriptive data about the origin of the shipment being
picked up by FedEx.

CreatePickupRequest/FreightPickupDetail

Optional
Descriptive data for a freight shipment being picked up by
FedEx. This element is only required when requesting a

FedEx Web Services, Developer Guide 2016

230

FedEx Freight Services

Element

Description
freight service pickup and should not be used for other
types of pickups including FedEx Freight pickups

CreatePickupRequest/CarrierCode

Optional
Identifies the FedEx service that is being sent the package
pickup request.

CreatePickupRequest/Remarks

Optional
Identifies any remarks or comments to be passed to the
FedEx courier picking up the shipment.

Table 91. Freight Reply Elements
Element

Description

CompletedShipmentDetail/
ShipmentRating/ActualRateType

The rate type identifies which entry in the
following array is considered ad presenting the
"actual" rates for the shipment.

CompletedShipmentDetail/
ShipmentRating/EffectiveNetDiscount

The "list" total net charges minus "actual" total net
charges.

CompletedShipmentDetail
/ShipmentRating/ShipmentRateDetails

Each element of this field provides shipmentlevel rate totals for a specific rate type.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/RateType

Type used for this specific set of rate data.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/RateScale

Indicates the rate scale used.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/RateZone

Indicates the rate zone used (based on origin and
destination).

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/PricingCode

Identifies the type of pricing used for this
shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
RatedWeightMethod

Indicates which weight was used.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
CurrencyExchangeRate

Specify the currency exchange performed on
financial amounts for this rate.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
SpecialRatingApplied

Indicates which special rating cases applied to
this shipment.

CompletedShipmentDetail
/ShipmentRating/ShipmentRateDetails/DimDivisor

The value used to calculate the weight based on
the dimensions.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FuelSurchargePercent

Specify a fuel surcharge percentage.

FedEx Web Services, Developer Guide 2016

231

FedEx Freight Services

Element

Description

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalBillingWeight

The weight used to calculate these rates.

CompletedShipmentDetail
/ShipmentRating/ShipmentRateDetails/
TotalDimWeight

Sum of dimensional weights for all packages.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalBaseCharge

The total freight charge that was calculated for
this package before surcharges, discounts and
taxes.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalFreightDiscounts

The total discounts used in the rate calculation.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalNetFreight

The freight charge minus discounts.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalSurcharges

The total amount of all surcharges applied to this
shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalNetFedExCharge

This shipment's totalNetFreight + totalSurchages
(not including totalTaxes).

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalTaxes

Total of the transportation-based taxes.

CompletedShipmentDetail
/ShipmentRating/ShipmentRateDetails/
TotalNetCharge

The net charge after applying all discounts and
surcharges.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalRebates

The total sum of all rebates applied to this
shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalDutiesAndTaxes

Total of all values under this shipment's
dutesAndTaxes;only provided if estimated duties
and taxes were calculated for this shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalNetChargeWithDutiesAndTaxes

This shipment's totalNetCharge +
totalDutiesAndTaxes; only provided if estimated
duties and taxes were calculated for this
shipment AND duties, taxes and transportation
charges are all paid by the same sender's
account.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail

Rate data specific to FedEx Freight services.

FedEx Web Services, Developer Guide 2016

232

FedEx Freight Services

Element

Description

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/QuoteNumber

A unique identifier for a specific rate quotation.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/QuoteType

Specify the type of rate quote. Valid values are:


AUTOMATED



MANUAL

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseChargeCalculation

Specify how total base charge is determined.

CompletedShipmentDetail/ShipmentRating/
ShipmentRateDetails/FreightRateDetail/
BaseCharges

Individual charge which contributes to the total
base charge for the shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/FreightClass

Freight class type. These values represent the
industry-standard freight classes used for FedEx
Freight Priority and FedEx Freight Economy
shipment description.
Note: The alphabetic prefixes are required to distinguish
these values from decimal numbers on some client
platforms.

Valid values:

FedEx Web Services, Developer Guide 2016



CLASS_050



CLASS_055



CLASS_060



CLASS_065



CLASS_070



CLASS_077_5



CLASS_085



CLASS_092_5



CLASS_100



CLASS_110



CLASS_125



CLASS_150



CLASS_175



CLASS_200



CLASS_250



CLASS_300

233

FedEx Freight Services

Element

Description


CLASS_400



CLASS_500

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/RatedAsClass

Effective freight class used for rating this line
item.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/NmfcCode

NMFC Code for commodity.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/Description

Customer-provided description for this
commodity or class line.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/Weight

Weight for this commodity or class line.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/ChargeRate

Rate or factor applied to this line item.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/ChargeBasis

Identifies the manner in which the chargeRate for
this line item was applied.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/BaseCharges/ExtendedAmount

The net or extended charge for this line item.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/Notations

Human-readable descriptions of additional
information on this shipment rating.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/Notations/Code

Unique identifier for notation.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightRateDetail/Notations/Description

Human-readable explanation of notation.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
FreightDiscounts

All rate discounts that apply to this shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
Rebates

All rebates that apply to this shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
Surcharges

All surcharges that apply to this shipment.

FedEx Web Services, Developer Guide 2016

234

FedEx Freight Services

Element

Description

CompletedShipmentDetail
/ShipmentRating/ShipmentRateDetails/
Taxes

All transportation-based taxes applicable to this
shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
DutiesAndTaxes

All commodity-based duties and taxes applicable
to this shipment.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
VariableHandlingCharges

The "order level" variable handling charges.

CompletedShipmentDetail/
ShipmentRating/ShipmentRateDetails/
TotalVariableHandlingCharges

The total of all variable handling charges at both
shipment (order) and package level.

FedEx Web Services, Developer Guide 2016

235

FedEx Ground U.S Shipping

14 FedEx Ground U.S. Shipping
Use the Shipping service to access the FedEx Ground® U.S. shipping features.
See Shipping Services by Region for a list of FedEx Ground U.S. services available by region.

14.1 FedEx Ground U.S. Service Details
The following rules apply to FedEx Ground U.S. shipping:


Shipments can originate from and be delivered to the 50 United States. Delivery between 1 to 5
business days within the contiguous U.S. and between 3 to 7 business days to and from Alaska and
Hawaii.



No Saturday pickup or delivery for FedEx Ground; shipping and delivery days are Monday through
Friday (8 a.m. to close of business day).



FedEx Ground delivery is not available to P.O. boxes.



FedEx Ground accepts packages up to 150 lbs. The dimensions must not exceed 108" in length or
165" in length plus girth (L + 2W + 2H).



HazMat shipments are allowed with restrictions. See Hazardous Materials FedEx Ground U.S. for
details. No hazardous materials can be shipped to or from Alaska and Hawaii.



If the package is to a business, the service type is FedEx Ground. If the package is to a residence,
the service type is FedEx Home Delivery®.



For information about FedEx Home Delivery, see FedEx Home Delivery Service Details.

Note: The shipper's account number must be enabled for Ground Residential functionality. Once the account
number is enabled, the customer may specify a service type of Ground instead of Ground Home Delivery for a
shipment weighing less than 70 pounds and destined to a residential address.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide. For more information on International Signature Options, see Delivery Signature Options.

14.1.1 FedEx Ground U.S. Service Options
The following service options are available for use with FedEx Ground U.S. shipping:


Alternate Return Address



Delivery Signature Options



Future Day Shipping



FedEx Ground U.S.Collect On Delivery C.O.D.



Hazardous Materials FedEx Ground U.S.



Hold at FedEx Location



FedEx Home Delivery Service Details



Masked Data



Shipment Notification in the Ship Request

FedEx Web Services, Developer Guide 2016

236

FedEx Ground U.S Shipping


Variable Handling Charges

14.2 FedEx Ground U.S. Coding Details


Both commercial and residential shipments are allowed with FedEx Ground U.S. shipping. If you
select FedEx Ground as the shipping service but are shipping to a residential address, the Ship reply
returns an error and you must select FedEx Home Delivery as the shipping service. If you are unsure
about the residential status of an address, use the Address Validation Service to do a residential
status check.



You can bill shipping costs to your own account, your recipient’s FedEx account, or a third-party
FedEx account. You should always be sure you enter the appropriate FedEx account number if you
want recipient or third-party billing. If the account number is missing or incorrect, you will be billed
for the shipping costs.



You can add reference elements to your Ship request that print on the shipping label, the customer
invoice, or both. See the following tables for details.



FedEx Ground shipments that exceed the published FedEx Ground limits are considered oversize
shipments. A surcharge applies to any FedEx Ground package that measures greater than 60" in
length but equal to or less than 108" in length. The oversize surcharge is returned in the Ship reply.
For more information regarding oversize calculations, see the electronic FedEx Service Guide.



Nonstandard containers also incur an additional surcharge. The nonstandard container definition is:
o
o
o



A package not fully encased in an outer shipping container
A package encased in an outer shipping container made of wood
A drum or pail (less than 5 gallons) not fully encased in an outer shipping container made of
corrugated cardboard

FedEx Ground shipments may be created as multiple-package shipments (MPS). A multiple-package
shipment consists of two or more packages shipped to the same recipient.

14.2.1 Required Elements
The following elements are available to ship a FedEx Ground U.S. package:
Table 92. Recipient Information Elements
Element

Multiple
Occurrence

Description

CompanyName

Required.
The name of the company associated with the
recipient.

Contact

Required.
The name of the person receiving the shipment.

StreetLines

Combination of number, street name, and so on. At
least one line is required for a valid physical address;
empty lines should not be included.
Combination of number, street name, street type, and
other defining attribute. At least one line is required for
a valid physical address; empty lines should not be
included.

FedEx Web Services, Developer Guide 2016

237

FedEx Ground U.S Shipping
Element

Multiple
Occurrence

Description
Multiple occurrence field.

City

Required.
Name of the city or town of the recipient.

StateOrProvinceCode

Required.
Identifying abbreviation for U.S. state or Canada
province. Format and presence of this field will vary,
depending on country.
For more information, see Appendix B: U.S. State
Codes and Appendix C: Canada Province Codes
sections of Web Services Developer Guide.

PostalCode

Required.
Identification of a region (usually small) for mail and
package delivery. Format and presence of this field will
vary, depending on country.

Country Code

Identifies the recipient country.

CountryName

Required.
The fully spelled out name of a country.

PhoneNumber

Required.
The recipient’s phone number.

Residential

Optional.
However, if you ship to a residential address and do not
include the Residential element, your rate quote will be
incorrect.

Table 93. Billing Elements
Element

Multiple
Occurrence

Description

ShippingChargesPayment
/PaymentType

Required. Values are:


ACCOUNT



COLLECT



SENDER



RECIPIENT



THIRD_PARTY

AccountNumber

Required.
To ensure that shipping and customs charges are
billed to the correct account number, include the
AccountNumber element that corresponds to the
Bill To element if payment type is SENDER,
RECIPIENT, or THIRD_PARTY.

Currency

Required.

FedEx Web Services, Developer Guide 2016

238

FedEx Ground U.S Shipping
Element

Multiple
Occurrence

Description
The currency code of the monetary exchange for
FedEx Services.
See Appendix F: Currency Codes section of
Web Services Developer Guide for a list of codes.
Note: FedEx will provide currency conversion using
FedEx Web Services. If you enter a currency other
than the currency associated with your FedEx
account number, rate quotes will be returned
based on the specified currency.

CountryCode

The country code associated with the currency
type.

CountryName

Optional.
The fully spelled out name of a country.

CustomerReferenceType

Optional.
This element allows you to add reference
information that prints on the shipping label and
on your invoice. Reference information may also
be used to track packages.
Values are:


BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRACOUNTRY_REGULATORY_REFEREN
CE



INVOICE_NUMBER



P_O_NUMBER



RMA_ASSOCIATION



SHIPMENT_INTEGRITY



STORE_NUMBER

SHIPMENT_INTEGRITY prints on the Ship ID line
on the label for Ground and invoice.
Note: Reference information is submitted on the
shipment level. However, you may add up to three
references per shipment. See the Reference
Elements with Output Location table for
more information about where your reference
information prints.

CustomerReference/Value

FedEx Web Services, Developer Guide 2016

Optional.
239

FedEx Ground U.S Shipping
Element

Multiple
Occurrence

Description
Reference information to be associated with the
CustomerReferenceType.
For example, if you designate
INVOICE_NUMBER in the
CustomerReferenceType element, the actual
invoice number associated with the package is
included in the CustomerReference/Value
element.

14.2.2 Multiple-Package Shipment Elements
This option is available for FedEx Express U.S. and international multiple-package shipments (MPS),
FedEx Ground U.S. and international MPS, FedEx Express U.S. C.O.D. and international C.O.D. MPS and
FedEx Ground U.S. C.O.D. and international C.O.D. MPS.
For more information about MPS see FedEx Express U.S. Multiple-Package Shipments.
Note: Up to 200 MPS packages may be created for one master shipment.

Table 94. Multiple-Package Shipment Elements
Element

Multiple
Occurrence

Description

PackageCount

Required for MPS.
Total number of packages in the shipment.

SequenceNumber

Required
if PackageCount is greater than 1. The sequence
number determines the master package and is
important when shipment level information is
added for that package. The shipment level
information added to a master package applies to
all packages in the shipment.

MasterTrackingID

Required.
The MasterTrackingID element is returned with
the first package reply. This element contains both
the MasterTrackingNumber and the FormID
elements. The MasterTrackingID element must be
added to each subsequent ship request for all
other packages in the multiple-package shipment.

MasterTrackingID/TrackingIDType

Valid values are:

FedEx Web Services, Developer Guide 2016



EXPRESS



FREIGHT



GROUND



USPS



FEDEX

240

FedEx Ground U.S Shipping

14.2.3 Package and Shipment Details
Table 95. Package and Shipment Details Elements
Element

Multiple
Occurrence

Description

ServiceType

Required.
Valid values:


FEDEX_GROUND



GROUND_HOME_DELIVERY



FEDEX_FREIGHT_PRIORITY



FEDEX_FREIGHT_ECONOMY



SAME_DAY



SAME_DAY_CITY

Note: If you ship to a residential address, your service
type must be GROUND_HOME_DELIVERY.

PackagingType

Yes

Required.
Valid value: YOUR_PACKAGING.

Weight

Yes

Required.
Units and Value are included in this element.
Values for the Units element:


 KG
The Value element must contain the actual
package weight. For MPS, each ship request
must contain the package weight.
TotalWeight

Required for MPS.
The TotalWeight element is submitted for the
master package only, not the subsequent child
packages. The master package (designated as 1
in the PackageCount element) contains the total
package weight in the multiple-package
shipment.
Units and Value are included in this Element.
Values for the Units element:


 KG
The Value element must contain actual package
weight.
Dimensions/Height

Yes

FedEx Web Services, Developer Guide 2016

Optional.
Submitted in the Ship request on the package
level.

241

FedEx Ground U.S Shipping
Element

Multiple
Occurrence

Description

Dimensions/Width

Yes

Optional.
Submitted in the Ship request on the package
level.

Dimensions/Length

Yes

Optional.
Submitted in the Ship request on the package
level.

Dimensions/Units

Yes

Required if dimensions (Height, Width, Length)
are submitted.
Valid values:




TotalInsuredValue/Amount

You may enter a value in this element to declare
additional insured value for this shipment.
For MPS, the master package should contain the
total insured value for the shipment. No declared
value is added to subsequent child shipments.

PreferredCurrency

Indicates the currency the shipper requests to
have used in all returned monetary values (when
a choice is possible).

ShipmentAuthorizationDetail

Specify details about the entity responsible for
the shipment.

ShipmentAuthorizationDetail
/accountNumber

Provides details about a specific FedEx
customer account.

ShipTimestamp

Date of shipment. For FedEx Ground and FedEx
Home Delivery packages, this can be the current
date or up to 10 days in the future.
The date format must be YYYY-MMDDTHH:MM:SS-xx:xx.
The time must be in the format: HH:MM:SS
using a 24-hour clock. The date and time are
separated by the letter T, such as 2009-0626T17:00:00.
The UTC offset indicates the number of
hours/minutes, such as xx:xx, from UTC, such as
2009-06-26T17:00:00-04:00 is defined as June
26, 2009 5:00 p.m. Eastern Time.
See Appendix M: Time Zones section of Web
Services Developer Guide for more information
about time zones.

FedEx Web Services, Developer Guide 2016

242

FedEx Ground U.S Shipping

14.2.4 Label Requirements
Table 96. LabelSpecification Element
Element

Multiple
Occurrence

Description

LabelSpecification

To identify the type of label format you will receive,
elements in the LabelSpecification complex type element
should be included in the ProcessShipment request
(depending on your label format). More information about
label printing is provided in Create a Label.

To determine if special options apply at the shipment level (controls every package in the MPS) or at the
package level (levied for a particular package), refer to the following table:
Table 97. Package vs. Shipment Level Shipping Options
Shipping Option
Delivery Signature Options

Package vs. Shipment Level
Shipment

HazMat

Shipment

Reference Elements

Package

Shipment Notification

Package

14.3 FedEx Home Delivery Convenient Delivery
You may also choose from three convenient delivery options for your FedEx Home Delivery shipments:


FedEx Date Certain Home Delivery®: FedEx contacts the recipient (recipient’s phone number is
required in transaction) and schedules a specific date for package delivery.



FedEx Evening Home Delivery®: Just like “Date Certain Delivery,” FedEx contacts the customer
(recipient’s phone number is required in transaction) and schedules an evening package delivery.



FedEx Appointment Home Delivery®: This option is time-specific. If you want your package delivered
at 1:30 on Tuesday, FedEx calls the recipient to confirm this date and time. The recipient phone
number is required in the transaction.

Note: FedEx Home Delivery convenient delivery options are requested on the shipment level and incur surcharges.

Table 98. Home Delivery Convenient Delivery Options Elements
Element

Description

HomeDeliveryPremiumDetail/
HomeDeliveryPremiumType

Valid values are:


APPOINTMENT



DATE_CERTAIN



EVENING

HomeDeliveryPremiumDetail/Date

Required for FedEx Date Certain Home Delivery. Valid
dates are Monday through Saturday.

HomeDeliveryPremiumDetail/

Optional.

FedEx Web Services, Developer Guide 2016

243

FedEx Ground U.S Shipping
Element

Description

DeliveryInstructions

Allows additional delivery instructions are for any FedEx
Home Delivery convenient delivery option.

HomeDeliveryPremiumDelivery/
PhoneNumber

Required for FedEx Date Certain Home Delivery and FedEx
Appointment Home Delivery. FedEx contacts the recipient
at this number to schedule delivery.

14.3.1 Reply Elements
In the ShipResponse/ProcessShipmentReply, the following elements are returned:


Error messages with severity



Tracking number(s): Assigned to all packages. For FedEx Ground C.O.D., you receive origin
shipment-status tracking number and C.O.D. return payment tracking number.



Rates and surcharges: For more information, see Registration Service.



Service commitment



Routing code



Origin commitment



Time in transit detail



Station ID (where applicable)

14.3.2 Reference Elements with Output Location
The ShipService WSDL includes the CustomerReference/CustomerReferenceType elements. See
Appendix AB: Customer Reference Elements for the child elements.
Note: Additional surcharges apply to FedEx Home Delivery convenient delivery options. These elements can also be
configured to print on the thermal label Doc-Tab. For more information, see the Canada Export
International.

You may use reference elements to track packages or to tie packages together for a single track request.

14.4 FedEx Home Delivery Service Details
The following rules apply to FedEx Home Delivery (residential flag checked):


Shipment can originate from and be delivered to 50 States within US, although longer transit times
apply to Alaska and Hawaii.



Shipping and delivery days are Tuesday through Saturday from 9 a.m. to 8 p.m.



Package weight and size can be up to 70 lbs., 108" in length, or 165" in combined length plus girth
(L+2W+2H).



FedEx Home Delivery is not available to P.O. boxes.



No HazMat except ORM-D/Limited Quantity packages: see Chapter 23: Hazardous Materials (FedEx
Ground U.S.) for details.



Options include Delivery Signature Options, Signature Proof of Delivery (SPOD), and FedEx
SmartPost Shipping.

FedEx Web Services, Developer Guide 2016

244

FedEx Ground U.S Shipping


Nonstandard packaging: Include this element in your transaction to indicate that your shipment is
packaged in a nonstandard or irregularly shaped container (such as a pail). A surcharge may apply.
Contact FedEx Ground Customer Service at 1.800.GoFedEx 1.800.463.3339 for guidelines or to find
out if your packaging is nonstandard.



For shipments including alcohol, see Alcohol Shipping for more information.



For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

14.4.1 FedEx Home Delivery Convenient Delivery Options
FedEx Home Delivery is part of FedEx Ground shipping. You can use FedEx Home Delivery to ship
packages to residential addresses. You can use the basic FedEx Ground transaction for FedEx Home
Delivery shipments. You can also use the following options as needed:
1. FedEx Date Certain Home Delivery
Use this convenient delivery option to specify a delivery date for FedEx Home Delivery. For example,
if your recipient is available to accept packages on Thursdays only, you may enter a specific Thursday
as the delivery date in your shipping transaction.
2. FedEx Evening Home Delivery
Use this convenient delivery option to specify delivery between 5 p.m. and 8 p.m., based on the
recipient’s local time zone.

14.4.2 FedEx Appointment Home Delivery
Use this convenient delivery option to specify an appointment for delivery. The recipient is contacted by
the local FedEx Home Delivery terminal when the shipment arrives, to set a delivery appointment.

FedEx Web Services, Developer Guide 2016

245

FedEx Intra-Country Shipping

15 FedEx Intra-Country Shipping
Use the ShipService WSDL to ship domestically within the countries listed in the following tables. These
tables describe shipping areas and services, special handling options, packaging requirements, weight
and dimension limits, and coding and service details for intra-country shipping transactions. Intra-country
shipping within most European countries and Mexico requires specific test and production credentials for
each country. Credentials can be obtained from the Developer Resource Center.

15.1 Services and Service Areas
The service areas for intra-country shipping are detailed below.

15.1.1 Canada
Table 99. Canadian Services
FedEx
Ground®

FedEx
Priority
FedEx First
Overnight® Overnight®

FedEx
Standard
FedEx
Overnight® Economy

FedEx 2Day®
Service

FedEx 1 Day®
Freight

Note: FedEx Standard Overnight Intra-Canada Express service for non-freight shipments offers delivery by 5:00 pm
the next business day (by 8:00pm if residential delivery is selected) with variable day commitment. For more
information on International Signature Options, see Delivery Signature Options.

15.1.2 Europe, the Middle East and Africa
Table 100. Europe, the Middle East and Africa Services and Service Areas
®

Country

FedEx
FedEx
FedEx
Priority
FedEx
Standard
1Day
Overnight Economy Overnight® Freight™

Austria

Belgium

Czech
Republic

Denmark

Finland

France

Germany

Hungary

FedEx
Next
Day by
9 a.m.

FedEx®
FedEx Next
Next
Day by
Day by 12
10 a.m. noon
®

FedEx®
Next
Day

FedEx Web Services, Developer Guide 2016

246

FedEx Intra-Country Shipping

FedEx
Next
Day by
9 a.m.

FedEx®
FedEx Next
Next
Day by
Day by 12
10 a.m. noon

FedEx®
Next
Day

Country

FedEx
FedEx
FedEx
Priority
FedEx
Standard
1Day
Overnight Economy Overnight® Freight™

India

Italy

Luxembourg

Norway

Poland

Spain

Sweden

Switzerland

The
Netherlands

United Arab
Emirates

United
Kingdom

Note: Intra-country shipping in Belgium, Denmark, France, Germany, Italy, Luxembourg and the Netherlands was
introduced in 2012; however, those services and options have been enhanced for 2013.

15.1.3 Latin America and the Caribbean
Table 101. Latin America and the Caribbean Services and Service Areas

Country

FedEx
Priority
Overnight®

Colombia

Mexico

FedEx First
Overnight®

FedEx
Economy

FedEx
Standard
Overnight®

X
X

FedEx
1Day®
Freight

FedEx 2Day®
Freight

15.2 Intra-Country Services Overview
The following information gives an overview of the services that are available for intra-country shipping.
Not all services are available in all areas. Refer to Services and Service Areas for more information on
which services are available and at which location.

15.2.1 FedEx Economy
FedEx Economy® provides delivery in 3 business days to businesses by 4:30 p.m. and to residences by 7
p.m.

FedEx Web Services, Developer Guide 2016

247

FedEx Intra-Country Shipping
For an intra-United Kingdom shipment, you can ship a package to an address within the U.K. and deliver
within 2 - 7 business days (by end of day) variable delivery commitment. Supports the customer
packaging type.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Available for intra-country shipping in Mexico.



Options are Dangerous Goods inaccessible items only, Delivery Signature Options, Hold at
FedEx Location and Saturday Service.

15.2.2 FedEx First Overnight
FedEx First Overnight® provides early-morning delivery between 8 and 10 a.m. depending upon the
destination postal code.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Options include Saturday Service, Dangerous Goods support for Dry Ice Shipments only, and
Delivery Signature Options.

15.2.3 FedEx Priority Overnight
FedEx Priority Overnight® provides next-business-day delivery by 10:30 a.m. to most U.S. addresses, by
noon, 4:30 p.m. or 5 p.m. in remote areas. Deliveries are also made on Saturdays by noon, 1:30 p.m. or
4:30 p.m.
Service days are Monday through Friday with Saturday pickup and delivery available for an extra charge.

15.2.4 FedEx Standard Overnight
FedEx Standard Overnight® provides next-business day delivery by 3 p.m. to most addresses; by 4:30
p.m. to rural areas. Service days are Monday through Friday with Saturday pickup and delivery available
for an extra charge.

15.2.5 FedEx 1Day Freight
FedEx 1Day® Freight service provides next-business-day delivery for packages/skids weighing in excess
of 150 lbs. The business rules are:


Service days are Monday through Friday, with Saturday pickup and delivery available to many major
markets.



A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.



15.2.6 FedEx 2Day Freight
FedEx 2Day® Freight services provide delivery in 2 business days for packages or skids weighing in
excess of 150 lbs. The business rules are as follows:


Service days are Monday through Friday, with Saturday pickup and delivery available to many major
markets.

FedEx Web Services, Developer Guide 2016

248

FedEx Intra-Country Shipping


15.2.7 FedEx Ground
The following rules apply to FedEx Ground shipping transactions:


Do not include fields for Saturday delivery or pickup. This service option is not available for FedEx
Ground.



When estimating time-in-transit or ship dates, consider FedEx Ground delivery days: Mon. through
Fri. (8 a.m. to close of business day).



Do not include packages over 150 lbs. in a FedEx Ground shipment.



Do not include HazMat packages over 70 lbs. in a FedEx Ground shipment.



Do not include ORM-D/Limited Quantity packages over 66 lbs. in a FedEx Ground shipment.



Do not include special accessorial Hold at Location with a HazMat or ORM-D/Limited Quantity
shipment.



Do not include packages which exceed 108" in length or 165" in length plus girth (L + 2W + 2H).



Before you ship hazardous materials, you must be certified to do so. See fedex.com for
certification and training information.

15.2.8 FedEx SameDay
FedEx SameDay® service provides door-to-door delivery within hours between select cities and postal
codes in an area. Use the SAME_DAY element to identify this service type when shipping a package.
Note: This is an intra Mexico service in Web Services. This is not the US domestic FedEx SameDay service.

15.2.9 FedEx SameDay City
FedEx SameDay® City service provides cross-city delivery within hours in select cities and postal codes.
Pickups and deliveries can be made Monday through Friday.
Use the SAME_DAY_CITY element to identify this service type when shipping a package.
A contract is required to use FedEx SameDay City service. See your FedEx Account Executive for more
information about SameDay City.
Note: Manual air waybills are not available with SameDay City service. This is an intra Mexico service in Web
Services. This is not the US domestic FedEx SameDay service.

15.3 Special Service Options
The following special services are allowed (depending on the destination location): Saturday Service,
Dangerous Goods, FedEx Express Collect on Delivery C.O.D., Hold at FedEx Location, and FedEx
Priority Alert Options (for contracted accounts only).

15.3.1 Service Options for Canada
These special service options are available in Canada:


Future Day Shipping

FedEx Web Services, Developer Guide 2016

249

FedEx Intra-Country Shipping


Hold at Location



Residential Delivery

15.3.2 Service Options for Latin America and the Caribbean
Table 102. Latin America and the Caribbean Special Service Options

Country

Delivery on
Invoice
Acceptance

Freight to
Collect

Colombia
Mexico

FedEx Web Services, Developer Guide 2016

Future Day
Shipping

Hold at
Location

Residential
Delivery

250

FedEx Intra-Country Shipping

15.3.3 Service Options for Europe, the Middle East and Africa
Table 103. Europe, the Middle East and Africa Special Service Options
Country
Dangerous
Goods

Dry
Ice

Austria

Belgium

Czech
Republic

Denmark

Finland

France

Germany

Hungary

India

Italy

Luxembourg

Freight
Future Hold at
Holiday
to Collect Day
Location Delivery

On Call
Pickup

Priority
Alert

Priority
Alert Plus

Returns

Saturday
Delivery

Ship
Alerts

The
Netherlands

Norway

Poland

Russia

FedEx Web Services, Developer Guide 2016

Residential
Delivery

Special
Delivery

Sunday
Delivery

251

FedEx Intra-Country Shipping
Country
Dangerous
Goods

Dry
Ice

Spain

Sweden

United
Kingdom

Freight
Future Hold at
Holiday
to Collect Day
Location Delivery

FedEx Web Services, Developer Guide 2016

On Call
Pickup

Priority
Alert

Priority
Alert Plus

Residential
Delivery

Returns

Saturday
Delivery

Ship
Alerts

Special
Delivery

Sunday
Delivery

252

FedEx Intra-Country Shipping

15.3.4 Service Options for India
Not all special service options are available for each service. This table lists the options that are
supported with each service.
Table 104. India Special Service Options
FedEx Priority
Special Service Option Overnight

FedEx Standard
Overnight

FedEx Economy

Collect on Delivery
(C.O.D.)

Dangerous Goods

Delivery Invoice
Acceptance (D.I.A.)

Dry Ice

Freight on Value Carrier
Risk

Freight on Value Own
Risk

Freight to Collect

Hold at Location

Holiday, Special and
Sunday Delivery

Outside Delivery Area
(ODA)

Outside Pickup Area
(OPA)

Priority Alert

Priority Alert Plus

Note: Freight on Value, C.O.D., D.I.A., and Sunday, Holiday and Special Delivery must be enabled for your account.
See your FedEx Account Executive for more information on using these special handling options. Also, ODA is
not supported with Hold at Location or Priority Alert/Priority Alert Plus, and Priority Alert is not supported with
Inaccessible Dangerous Goods.

15.3.4.1 Collect on Delivery
For intra-India shipments with the Collect on Delivery (C.O.D.) option, FedEx will deliver goods to the
consignee, collect payment for those goods and remit the payment to the FedEx customer or shipper.
Allows Unsecured Payments (U), Secured Payments (S) and Cash (R). Unsecured payments include
personal check, business check and certified check. Secured payments include banker’s check and
demand draft.
When using this service the following rules apply.

FedEx Web Services, Developer Guide 2016

253

FedEx Intra-Country Shipping


These are not valid C.O.D. payment options: traveler’s checks, credit cards, counter checks, checks
endorsed by a third party or checks made payable to FedEx.



These requirements apply when the C.O.D. option is combined with the D.I.A. special handling
option for intra-India shipments:
o
o
o

o
o
o
o
o
o

You may select either or both services, such as COD only, DIA only or COD/DIA combined.
You must return both the C.O.D. remit and the D.I.A. receipt to the same address if both options
are selected.
C.O.D. and D.I.A. shipments travel on a separate label from standard shipments and are subject
to a surcharge. Outbound shipping attributes, such as size, weight, MPS and so on, are the same
as a standard shipment.
C.O.D. and D.I.A. special handling options are only available with FedEx Standard Overnight (SO)
and FedEx Express Saver (XS).
Weight limit is 1-68 kg.
Payment/Invoice maximum value is 5,000,000 INR. Cash payment maximum limit is 20,000 INR.
Remit shipments for C.O.D. and D.I.A. travel on FedEx Priority Overnight (PO) service and
require no clearance support as they are documents.
Unless you provide a new delivery address for the remit shipment, the remit will be returned to
the original shipper as the default.
Freight To Collect is not a valid special handling option with C.O.D. or D.I.A.

15.3.4.2 Delivery on Invoice Acceptance
For intra-India shipments with the Delivery on Invoice Acceptance (D.I.A.) option, you can request that
the recipient sign the Commercial Invoice (CI) at delivery and have FedEx return it to the FedEx customer
or shipper.

15.3.4.3 Return Receipt
Return Receipt provides formal proof of delivery (POD) to a shipper that includes both FedEx-generated
detail Air Waybill information and a formal signature/stamp from the recipient company. The
stamped/signed POD is physically returned to the sender.
This special handling option


Is supported for FedEx Express and FedEx Freight intra-Mexico shipments for manual Air Waybill
(AWB) shipping only.



Includes a flat fee surcharge per shipment. The special handling code used to identify this option is
70.

Note: The Freight To Collect special handling option takes precedence the Return Receipt.

15.3.4.4 Freight to Collect
Freight to Collect (FTC) is a FedEx Express® value-added payment option in which the transportation
charges are paid by the recipient in cash at the time of delivery. The shipper account number is required
for the shipment as a backup form of payment if the recipient refuses the shipment or cannot pay. The
FTC surcharge is applied per shipment with no available discounts; only list rates will apply. Local country
standard operating procedures will manage this requirement for paper Air Waybills.

FedEx Web Services, Developer Guide 2016

254

FedEx Intra-Country Shipping
FTC will display on an intra-India and intra-Mexico FTC shipping label, including multiple-piece shipping
labels. The FTC amount is not printed unless configured on the doc-tab. The special handling code used
to identify this option is 22 and is included on the 1D and 2D barcode.
The following services are available with FTC.
Table 105. Freight to Collect with Intra-Country Shipping
Country

FedEx First
Overnight

FedEx
Priority
Overnight

FedEx
Standard
Overnight

FedEx 1Day FedEx 2Day
Freight
Freight

FedEx
Express Saver

Mexico

India

15.3.4.5 Rules


FTC option takes precedence over the selection of FedEx SameDay services and the Return Receipt
on a paper Air Waybill (AWB).



FTC surcharge takes precedence over any other surcharges that would otherwise be applied, such as
Commercial Delivery.



Rate quotes are limited to list rates only.



Return list rates by specifying the FREIGHT_TO_COLLECT element with the RECIPIENT payment
type, without including the account number.



Return account specific rates by specifying the FREIGHT_TO_COLLECT element with the SENDER
payment type and include the account number.

15.3.4.6 Restrictions
FTC cannot be combined with the COD/DIA service option.

15.4 Rules for Colombia
The following information pertains to intra-country shipping within Colombia.


Packaging Types
Only the FedEx Envelope and customer packaging are supported.



Weight and Dimension Limits

Table 106. Colombia Package Limitations
Packaging

Service

Dimension

Error Message

Customer
Packaging

1Day Freight (Express)
2Day Freight (Express)

Weight > 1,000 kgs /
2,206 lbs

0270 "The weight limit for this service
type has been exceeded."

Length > 302 cm / 119
in

0422 "Length cannot be greater than
the maximum allowed."

FedEx Web Services, Developer Guide 2016

255

FedEx Intra-Country Shipping

Packaging

Service

Dimension

Error Message

Width > 302 cm / 119 in

2025 "Width cannot be greater than
the maximum allowed."

Height > 178 cm / 70 in

2083 "Height cannot be greater than
the maximum allowed."

Length + Girth > 1,064
cm / 419 in

0421 "Length & girth combined
cannot be greater than the maximum
allowed."

15.5 Rules for India
The following information pertains to intra-country shipping within India.


Collect on Delivery (C.O.D.) and Delivery Invoice Acceptance (D.I.A.)
o
o
o

o


When the shipment is C.O.D. or D.I.A. only, the C.O.D. or D.I.A. return address fields will be
used first if included, respectively. If not, the original shipper address will be used.
C.O.D. and D.I.A. may be selected together or separately. If both are requested, the existing
C.O.D. return fields will be used; there are no combination C.O.D./D.I.A. return fields.
If a shipment is both C.O.D. and D.I.A., only one return address will be supported. The return
label will be populated with the C.O.D. return address if it is included in the transaction,
otherwise the shipper address information will be used. The D.I.A. return fields will be ignored.
For Intra-India COD shipments, the COD amount is allowed to be lower than the invoice amount

Collection Types
The following collection types are supported:
o
o
o
o
o



Cash
Company Check
Personal Check
Demand Draft
Pay Order

Clearance/Tax Documents
Clearance and/or tax documents may be required for interstate transit.



Dangerous Goods
Excepted Package Radioactive Reportable Quantity (EPRRQ) shipments are supported for intra-India
shipments.



Hold at Location
Hold at Location and Sunday Delivery special services cannot be combined.



Limitations on Commercial Value and Weight
For FedEx Express Standard Overnight shipments, the total invoice value cannot exceed 5 million
INR and the total weight cannot exceed 68 kgs.



Multiple Piece Shipments

FedEx Web Services, Developer Guide 2016

256

FedEx Intra-Country Shipping
o
o
o


Package Type
o



If the first piece is FedEx Priority Overnight, then all pieces in the shipment must qualify for
FedEx Priority Overnight.
If any subsequent piece in the shipment does not qualify for FedEx Priority Overnight, then an
error is returned for that piece.
If the invoice value of all pieces in the shipment make the shipment ineligible for FedEx Priority
Overnight, then an error is returned and the shipment fails.

Only customer packaging is supported.

Payment Types
The following payment types are supported:
o
o
o



Purpose of Shipment
o
o



Shipments with the purpose of "Sold" are not allowed with Priority Overnight service in India.
The purpose of shipment is required for intra-India Standard Overnight and Economy shipments.

State/Province Code Required
o



Bill Sender
Bill Recipient or Consignee
Bill Third Party

The state/province code is required with intra-India shipping.

Sunday Delivery
o

See Hold at Location above.

15.5.1 Intra-India Shipping Weight and Dimension Limits
Intra-India shipping is only available in the Ship WSDL v12 and higher.
Table 107. Intra-Country Shipping Weights and Dimension Limits

Size and Weight
Restrictions

FedEx Priority
Overnight

FedEx Standard
Overnight

FedEx Express Saver

Maximum allowable
weight for single piece:
31 kg/ 68.2 lbs

Maximum allowable
weight for single piece:
68 kg/ 149.6 lbs

Maximum allowable
weight for single
piece: 68 kg/ 149.6
lbs

Length: 274 cm/ 108 inches
Width: 157 cm/ 62 inches
Height: 157 cm/ 62 inches
Combined length + girth = 330 cm/ 130 inches
Dimensional Limitations

Note:
1.
2.
3.

A shipment is considered oversized if it is more than 274 cm in length or if it is
more 330 cm length and girth combined.
Length is defined as the longest side of the object or package.
Girth is calculated as twice the width plus twice the height of the package.

FedEx Web Services, Developer Guide 2016

257

FedEx Intra-Country Shipping
The available Service Types for intra-India shipments are Priority Overnight, Standard Overnight, and
FedEx Express Saver. See table India Special Service Options for guidelines when choosing an intraIndia shipping option.

15.5.2 Intra-India Coding Details
Table 108. ProcessShipmentRequest
Element

Description

RequestedShipment

Required
Descriptive data about the shipment being sent by the
requestor.

RequestedShipment/ShipTimestamp

Required
Identifies the date and time the package is tendered to
FedEx. Both the date and time portions of the string are
expected to be used.

RequestedShipment/DropofType

Required
Identifies the method by which the package is to be
tendered to FedEx.

RequestedShipment/ServiceType

Required
Identifies the FedEx services to use in shipping the
package.
Valid values:


PRIORITY_OVERNIGHT



FEDEX_EXPRESS_SAVER



FEDEX_1_DAY_FREIGHT



STANDARD_OVERNIGHT

RequestedShipment/PackagingType

Required
Identifies the packaging used by the requestor for the
package.
Valid value: YOUR_PACKAGING

RequestedShipment/Shipper

Required
Descriptive data identifying the party responsible for
shipping the package. Shipper and Origin should have the
same address.

RequestedShipment/Recipient

Required
Descriptive data identifying the party receiving the package.

RequestedShipment
/ShippingChargesPayment/Payment/
PaymentType

Descriptive data indicating the method and means of
payment to FedEx for providing shipping services.
Valid values:

FedEx Web Services, Developer Guide 2016



ACCOUNT



COLLECT



RECIPIENT

258

FedEx Intra-Country Shipping

Element

Description


SENDER



THIRD_PARTY

RequestedShipment/
SpecialServicesRequested

Descriptive data regarding special services requested by
the shipper for this shipment.

RequestedShipment/
SpecialServicesRequested/CodDetail

Descriptive data required for a FedEx COD (Collect-onDelivery) shipment.

RequestedShipment/
SpecialServicesRequested/
DeliveryOnInvoiceAcceptanceDetail

The Recipient and Tracking ID data for the Delivery On
Invoice Acceptance service.

RequestedShipment/
SpecialServicesRequested/
HoldAtLocationDetail

Descriptive data required for a FedEx shipment that is to be
held at the destination FedEx location for pickup by the
recipient.

RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail

Number of packages in this shipment which contain dry ice
and the total weight of the dry ice for this shipment.

RequestedShipment/
CustomsClearanceDetail/FreightOnValue

Identifies responsibilities with respect to loss, damage, etc.
Valid values:


CARRIER_RISK



OWN_RISK

Note: This element is only valid for intra-India shipping. If this
element is added on an international shipment, it will cause a
hard stop.

RequestedShipment/
LabelSpecification

Details about the image format and printer type for the
label.

RequestedShipment/
RateRequestTypes

Required
Specify whether and what kind of rates the customer
wishes to have quoted on this shipment. The reply will also
be constrained by other data on the shipment and
customer.

RequestedShipment/
PackageCount

Required
The total number of package in the entire shipment (even
when the shipment spans multiple transactions).

RequestedShipment/
RequestedPackageLineItems

One or more package-attribute descriptions, each of which
describes an individual package, a group of identical
packages, or (for the total-piece-total-weight case) common
characteristics of all packages in the shipment.

RequestedShipment/RequestedPackageLi
neItem/
SpecialServicesRequested/
PackageSpecialServicesRequested/

The types of all special services requested for the enclosing
shipment or package.
Valid values:

FedEx Web Services, Developer Guide 2016



COD
259

FedEx Intra-Country Shipping

Element
SpecialServiceTypes

Description


DANGEROUS_GOODS



DRY_ICE



FREIGHT_TO_COLLECT

RequestedShipment/
Descriptive data required for a FedEx shipment containing
RequestedPackageLineItem/SpecialServic dangerous materials.
esRequested/
PackageSpecialServicesRequested/Danger
ousGoodsDetail
RequestedShipment/RequestedPackageLi
neItems/
SpecialServicesRequested/DangerousGoo
dsDetail/
UploadedTrackingNumber
ProcessShipmentRequest/RequestedShip
ment/
SpecialServicesRequested/ShipmentDryIc
eDetail
CreatePickupRequest/
FreightPickupDetail/FreightPickupLineItem
/ShipmentSpecialServicesRequested/Extra
LaborDetail
CreatePickupRequest/FreightPickupDetail
/FreightPickupLineItem/ShipmentSpecialS
ervicesRequested
/ExtraLaborDetail

Customers reference the previously uploaded DG shipment
in the Ship/OpenShip request by passing in
'UploadedTrackingNumber' in the request to complete the
shipment and produce the label. DG data upload mode is
identified by the presence of UploadedTrackingNumber.

Specification for labor to be performed with the shipment.
List the total labor time in ExtraLaborDetail/Duration.

Specify details for a package containing alcohol

An EXTRA_SURFACE_HANDLING_CHARGE will be assessed for all FedEx Express Saver Intra-India
shipments.
Note: For more information about C.O.D. coding details, see FedEx Express C.O.D. Coding Details.

Table 109. Intra-India Shipping Surcharge Reply Element
Element

Description

CompletedShipmentDetail
/CompletedPackageDetail/
PackageRating/PackageRateDetail/
Surcharges/
SurchargeType/EXTRA_SURFACE_HANDLING_CHARGE

Surcharge for all FedEx Express Saver
Intra-India shipments.

FedEx Web Services, Developer Guide 2016

260

FedEx Intra-Country Shipping

15.6 Rules for Mexico
The following information pertains to intra-country shipping within Mexico. 
Contract Required - A contract is required for FedEx Same Day City service. Contact your FedEx
sales representative for details.
Packaging Types - Only the FedEx Envelope and customer packaging are supported.


Weight and Dimension Limits

Table 110: Mexico Package Limitations
Packaging

Service

Customer
Packaging

First
Overnight
Priority
Overnight
Standard
Overnight

Service
Option
Priority Alert
Priority Alert
Plus

Dimension

Error Message

Weight > 68
kgs / 150 lbs

0270 "The weight limit for this service
type has been exceeded."

Length > 274
cm / 108 in

0422 "Length cannot be greater than the
maximum allowed."

Width > 274 cm 2025 "Width cannot be greater than the
/ 108 in
maximum allowed."
Height > 274
cm / 108 in

2083 "Height cannot be greater than the
maximum allowed."

Length + Girth
> 330 cm / 130
in

0421 "Length & girth combined cannot
be greater than the maximum allowed."

15.6.1 Intra-Mexico Coding Details
Table 111. Intra-Mexico Request Elements
Element

RequestedShipment/ServiceType

FedEx Web Services, Developer Guide 2016

Description
Identifies the FedEx services to use in shipping the
package.
Valid values:


FEDEX_1_DAY_FREIGHT



FEDEX_2_DAY_FREIGHT



FIRST_OVERNIGHT



FEDEX_EXPRESS_SAVER



SAME_DAY



SAME_DAY_CITY



PRIORITY_OVERNIGHT



STANDARD_OVERNIGHT

261

FedEx Intra-Country Shipping
Element

RequestedShipment/
SpecialServicesRequested/SpecialServiceTypes

Description
The types of all special services requested for the
enclosing shipment or package.
Valid values: FREIGHT_TO_COLLECT
Return list rates by specifying the
FREIGHT_TO_COLLECT element with the RECIPIENT
payment type without including the account number.
Return account specific rates by specifying the
FREIGHT_TO_COLLECT element with the SENDER
payment type and include the account number.

15.7 Rules for The United Kingdom
The following information pertains to intra-country shipping within the United Kingdom.


Contract Required
Intra-UK shipping must be enabled for your account.



Dangerous Goods
You must be approved by FedEx before you can ship dangerous goods. Contact your FedEx sales
representative for more information.



Minimum Billable Weight
There is a minimum billable weight of 250 KGS / 550 LBS for a intra-United Kingdom FedEx Freight
shipments. Also, the weight must be greater than zero. If it is not, Error Message 0531, "Package
weight cannot be zero or left blank," is returned and the transaction fails.



Rating
Full postal codes are required when requesting rates. Using a partial postal code when requesting
rating may result in an incorrect rate quote.



Returns
Only FedEx Express Return Tags are enabled. If Express Return Tags are not enabled for a specific
location, however, then Error Message 2541, "Returns Not Available To and/or From Location" is
returned and the shipment fails.
Express Return tags are limited to single piece shipments and cannot be combined with dangerous
goods, dry ice, appointment delivery, Hold at Location, email notifications or rate quotes. FedEx Print
Return Labels are not supported for Intra-United Kingdom shipments.

Note: Dimensions are required for freight returns and also limited to one piece per FedEx Express Return Tag
request.

FedEx Web Services, Developer Guide 2016

262

FedEx Intra-Country Shipping

15.7.1 Intra-UK Coding Details
Tracking is supported for all intra-UK shipments. In addition to the basic elements required to generate a
shipment, the following elements apply specifically to intra-country shipping in the UK.
Table 112. Intra-UK Request Elements
Element

Description
Identifies the FedEx service to use in shipping the
package.
Valid values:

RequestedShipment/ServiceType



FEDEX_DISTANCE_DEFERRED



FEDEX_NEXT_DAY_AFTERNOON



FEDEX_NEXT_DAY_EARLY_MORNING



FEDEX_NEXT_DAY_END_OF_DAY



FEDEX_NEXT_DAY_FREIGHT



FEDEX_NEXT_DAY_MID_MORNING

RequestedShipment/
ShippingChargesPayment/PaymentType

Identifies the method of payment for a service. Valid value
is SENDER.

RequestedShipment/
PackageSpecialServicesRequested

These special services are available at the package level
for some or all service types. If the shipper is requesting a
special service which requires additional data, the package
special service type must be present in the
SpecialServiceTypes collection, and the supporting detail
must be provided in the appropriate sub-object below.

RequestedShipment/
The types of all special services requested for the
PackageSpecialServicesRequested/Special
enclosing shipment or package.
ServiceTypes
RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail

Descriptive data required for a FedEx shipment containing
dangerous materials. This element is required when
SpecialServiceType.DANGEROUS_GOODS or
HAZARDOUS_MATERIAL is present in the
SpecialServiceTypes collection.

SpecialServicesRequested//DangerousGoo
This field is used to identify an instance of an uploaded
dsDetail
dangerous goods handling unit.
/UploadedTrackingNumber
Identifies the source of regulation for hazardous
commodity data.
Valid values:
RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Regulation

FedEx Web Services, Developer Guide 2016



ADR (Required)



DOT



IATA



ORMD
263

FedEx Intra-Country Shipping

Element

Description
Indicates which kind of hazardous content (as defined by
DOT) is being reported.
Valid values:

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Options



HAZARDOUS_MATERIALS



BATTERY



ORM_D



REPORTABLE_QUANTITIES



SMALL_QUANTITY_EXCEPTION



LIMITED_QUANTITIES_COMMODITIES

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers

Indicates one or more containers used to pack dangerous
goods commodities.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/Packin
gType

Indicates whether there are additional inner receptacles
within this container.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/Contain
erType

Indicates the type of this dangerous goods container, as
specified by the IATA packing instructions. For example,
steel cylinder, fiberboard box, plastic jerrican and steel
drum.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
RadioactiveContainerClass

Indicates the packaging type of the container used to
package the radioactive materials.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
NumberOfContainers

Indicates the number of occurrences of this container with
identical dangerous goods configuration.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
Containers/HazardousCommodities

Documents the kind and quantity of all hazardous
commodities in the current container.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/Description

Identifies and describes an individual hazardous
commodity.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/Quantity

Specify the amount of the commodity in alternate units.

FedEx Web Services, Developer Guide 2016

264

FedEx Intra-Country Shipping

Element

Description

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/InnerReceptacles

This describes the inner receptacle details for a hazardous
commodity within the dangerous goods container.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/Options

Customer-provided specifications for handling individual
commodities.

RequestedShipment/
PackageSpecialServicesRequested/
Specify the details of any radio active materials within the
DangerousGoodsDetail/Containers/
commodity.
HazardousCommodities/RadionuclideDetai
l
RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities

Documents the kinds and quantities of all hazardous
commodities in the current container.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/InnerReceptacles

This describes information about the inner receptacles for
the hazardous commodity in a particular dangerous goods
container.

RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
Specify the amount of the commodity in alternate units.
HazardousCommodities/InnerReceptacles/
Quantity
RequestedShipment/
PackageSpecialServicesRequested/
DangerousGoodsDetail/Containers/
HazardousCommodities/Description

Documents the kinds and quantities of all hazardous
commodities in the current package.

Table 113. Intra-UK Reply Elements
Element

Description

ProcessShipmentReply/CompletedShipme The reply payload. All of the returned information about
ntDetail/
this shipment/package.
ProcessShipmentReply
/CompletedShipmentDetail/
HazardousShipmentDetail

Computed shipment level hazardous commodity
information.

ProcessShipmentReply
/CompletedShipmentDetail/
HazardousShipmentDetail/ADRLicense

Contains the ADR License information, which identifies
the license number and ADR category under which the
customer is allowed to ship.

FedEx Web Services, Developer Guide 2016

265

FedEx Intra-Country Shipping

Element

Description

ProcessShipmentReply
/CompletedShipmentDetail/
HazardousShipmentDetail/
ADRLicense/LicenseOrPermitDetail

This contains the ADR License information, which
identifies the license number, the effective date and the
expiration date under which the customer is allowed to
ship.

ProcessShipmentReply
/CompletedShipmentDetail/
CompletedPackageDetails

Package level details about this package.

ProcessShipmentReply
/CompletedShipmentDetail/
CompletedPackageDetails
/HazardousPackageDetail

Documents the kinds and quantities of all hazardous
commodities in the current package using updated
hazardous commodity description data.

ProcessShipmentRepl
/CompletedShipmentDetail/
CompletedPackageDetails/
HazardousPackageDetail/Containers

Describes the kinds and quantities of all hazardous
commodities in the current package.

ProcessShipmentReply/CompletedShipme
ntDetail/
Documents the kinds and quantities of all hazardous
CompletedPackageDetails
commodities in the current package.
/HazardousPackageDetail/
Containers/HazardousCommodities
ProcessShipmentReply/CompletedShipme
ntDetail/
The mass points are a calculation used by ADR
CompletedPackageDetails
regulations for measuring the risk of a particular
/HazardousPackageDetail/
hazardous commodity.
Containers/
HazardousCommodities/MassPoints
ProcessShipmentReply/CompletedShipme
ntDetail/
CompletedPackageDetails
Identifies and describes an individual hazardous
/HazardousPackageDetail
commodity.
/Containers/HazardousCommodities/Descr
iption

ProcessShipmentReply/
CompletedShipmentDetail/
CompletedPackageDetails/
HazardousPackageDetail/
Containers/HazardousCommodities/
Description/TunnelRestrictionCode

FedEx Web Services, Developer Guide 2016

There are five categories of tunnel categorization with A
representing the least restrictive and "E" as the most
restrictive. Category "A," as the least restrictive, will not
be sign-posted. Category "E", the most restrictive, only
allows the passage of UN2919, UN3291, UN3331,
UN3359 and UN3373.
The categorization is based on the assumption that in
tunnels there are three major dangers which may cause
numerous victims or serious damage to the tunnel itself.
These are:


Explosions



Release of toxic gas or volatile toxic liquid
266

FedEx Intra-Country Shipping

Element

Description


FedEx Web Services, Developer Guide 2016

Fires

267

FedEx SmartPost Shipping

16 FedEx SmartPost Shipping
FedEx SmartPost® and FedEx SmartPost® Returns each require a service contract. To sign up for FedEx
SmartPost outbound shipping or FedEx SmartPost Returns, contact your FedEx account executive.
FedEx SmartPost helps you consolidate and deliver high volumes of low-weight, non time-critical
business-to-consumer packages using the United States Postal Service (USPS) for final delivery to
residences. This service provides delivery Monday through Saturday to all residential addresses in the
U.S., including P.O. boxes and military APO and FPO destinations.
FedEx SmartPost also offers FedEx SmartPost Returns service, delivery and shipment email notifications
for U.S. outbound shipments, customizable labels, and Future Day shipping.

16.1 FedEx SmartPost Service Details
FedEx SmartPost Service includes the following features:


FedEx SmartPost is available for shipments originating in the 48 contiguous United States only.
Alaska, Hawaii, Puerto Rico, and the U.S. territories are not included as origin points.



The FedEx SmartPost service allows delivery to all 50 American States and territories, including PO
boxes and military locations (Army Post office - APO, Fleet Post Office - FPO, Diplomatic Post Office
- DPO), and Puerto Rico.



FedEx SmartPost supports customer packaging only. Because FedEx SmartPost employs the USPS
for final delivery to residences, packages are subject to USPS restrictions.



Future Day shipping is available for FedEx SmartPost shipments.



Saturday delivery is possible by USPS. No FedEx surcharge applies in this case.



Packages can only be tracked using the FedEx tracking Number or USPS tracking number.



Eligible payment types are Bill Sender/ Recipient/ 3rd Party or Associated Account.



FedEx SmartPost Returns provides a U.S. to U.S. returns service for all shippers with more than 100
returns a day. Once contracted, a shipper can use any service for their outbound shipping and still
use FedEx SmartPost Returns. Both print and email return label options are available. Consumers can
conveniently return packages from all 50 states, Puerto Rico, U.S. territories and military locations
simply by placing it in their mailbox, dropping it off at their local Post Office, at a USPS collection box
or handing it off to a USPS carrier by taking advantage of a free package pickup. Estimated shipping
rates are not available for SmartPost Returns.

Note: A separate account number is given for FedEx SmartPost outbound shipments and FedEx SmartPost Returns.
If a customer is contracted with return services, they need to use the associate account rollup to a national
number.
Note: For SmartPost Shipments, Address Line1 and Address Line2 are limited to 30 characters.

For Standard Mail, Bound Printed Matter, and Media the following dimensions restriction applies:


Dimensions: No more than 84" in combined length and girth (L+2W+2H).



No one dimension greater than 60".



Minimum dimensions are 6" L x 4" W x 1".

FedEx Web Services, Developer Guide 2016

268

FedEx SmartPost Shipping
For Parcel Select the following restrictions apply:


Dimensions: No more than 130" in combined length and girth.



No one dimension can be greater than 60".



Minimum Dimensions are 6" L X 4" W X 1".

For more detailed information about FedEx SmartPost outbound shipping and returns, go to
fedex.com/us/smartpost.

16.1.1 FedEx SmartPost Request Elements
In addition to the elements required for all requests, the following elements are included in the FedEx
SmartPost request:
Table 114. FedEx SmartPost Request Elements
Element

Description

ProcessShipmentRequest
/RequestedShipment
/ServiceType

Required.
Specify SMART_POST for FedEx SmartPost
shipping services.

RequestedShipment
/SmartPostShipmentDetail
/SmartPostShipmentProcessingOptionsRequested

Through this option, an existing SmartPost small
shipper or return shipper can specify to have the
Ground tracking number provided in the shipment
reply. This is a contingency feature in case the
customer requires the Ground tracking number for
internal processes or for tracking SmartPost
shipments.
The Ground tracking number will only be provided
for existing SmartPost small shippers or return
shippers. Customers will have the same reporting
and tracking capabilities as today when they
receive a Ground tracking number. However, the
Ground tracking number will not be printed on the
FXSP shipping label.
Fedex.com provides the same tracking visibility for
SmartPost shipments when using either the
SmartPost tracking number or the Ground tracking
number.
Fedex recommends using fedex.com, rather than
USPS.com, for all tracking activities for SmartPost
shipments.
Valid values:

RequestedShipment
/SmartPostShipmentDetail
/SmartPostShipmentProcessingOptionsRequested
/SmartPostShipmentProcessingOptionType

FedEx Web Services, Developer Guide 2016



GROUND_TRACKING_NUMBER_REQUESTED

269

FedEx SmartPost Shipping

Element

Description

RequestedShipment
/LabelSpecification
/CustomerSpecifiedLabelDetail
/LabelMaskableDataType

Specify the names of data elements/areas which
may be suppressed from printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NU
MBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACC
OUNT_NUMBER

SmartPostDetail

Required.
Specify the appropriate details for a FedEx
SmartPost shipment.

SmartPostDetail
/Indicia

Required.
Specify the indicia type. Available options include:

SmartPostDetail
/AncillaryEndorsement



MEDIA_MAIL



PARCEL_SELECT (1 LB through 70 LBS)



PRESORTED_BOUND_PRINTED_MATTER



PRESORTED_STANDARD (less than 1 LB)



PARCEL_RETURN

Optional.
Specify an endorsement type from the following
valid values:


ADDRESS_CORRECTION



CARRIER_LEAVE_IF_NO_RESPONSE



CHANGE_SERVICE



FORWARDING_SERVICE



RETURN_SERVICE

Note:F or FedEx SmartPost Standard Mail (Presorted
Standard < 1 lb.) shipments with delivery
confirmation, either RETURN SERVICE REQUESTED
or ADDRESS SERVICE REQUESTED is permitted.

SmartPostDetail
/HubID

Required.
Specify the HubID using the four-digit numeric
value. For valid values refer to Appendix AD:
SmartPost Hub IDs.
Note: Include only the numeric HubID value in your
request. HubID 5531 should be used in the FedEx

FedEx Web Services, Developer Guide 2016

270

FedEx SmartPost Shipping

Element

Description
Test Environment.

SmartPostDetail
/CustomerManifestID

Optional.
The CustomerManifestId is used to group FedEx
SmartPost packages onto a manifest for each trailer
that is being prepared.
If you have multiple trailers, you must assign a
Manifest ID to each FedEx SmartPost package as
determined by its trailer. The Manifest ID must be
unique to your account number for a minimum of 6
months and cannot exceed 8 characters in length.
We recommend that you use the day of year, the
trailer ID (a sequential number for that trailer). For
example, if there are 3 trailers that you started
loading on Feb 10, then the 3 Manifest Ids would
be 041001, 041002, 041003 (this example includes
leading zeros on the trailer numbers).
The maximum length is 8 characters.

RequestedShipment
/RequestedPackageLineItems
/PhysicalPackaging

Optional
Provides additional detail on how the customer has
physically packaged this item.

16.1.2 FedEx SmartPost Reply Elements
SmartPost ship replies will include a shipping label image buffer and at least one Tracking ID. Please use
the United States Postal Service (USPS) Tracking ID value. SmartPost outbound ship replies will also
include rate elements with estimated rates. SmartPost Return shipping label replies will not include rate
elements and estimates.
The following SmartPost-specific elements are returned in the FedEx SmartPost ship reply:
Table 115. FedEx SmartPost Reply Elements
Element

Description

ProcessShipmentReply/
CompletedShipmentDetail/UsDomestic

Indicates whether or not this is an intra-U.S.
shipment.

ProcessShipmentReply/
CompletedShipmentDetail/CarrierCode

Indicates the carrier that will be used to deliver this
shipment.

ProcessShipmentReply/
CompletedShipmentDetail/MasterTrackingId

The master tracking number and form ID of this
multiple piece shipment. This information is to be
provided for each subsequent of a multiple piece
shipment.

MasterTrackingId/TrackingIdType

Lists the type of tracking ID. Valid values are:

FedEx Web Services, Developer Guide 2016

271

FedEx SmartPost Shipping

Element

Description


FEDEX



GROUND

 USPS
A USPS tracking number will only return the status
of the package while it is being handled by USPS.
But a FedEx Ground tracking number will return all
the data.
MasterTrackingId/FormId

Describes in detail the type of airbill and shipment
moving through the FedEx system.

MasterTrackingId/UspsApplicationId

For use with Smartpost tracking IDs only.

MasterTrackingId/TrackingNumber

Specify the tracking number of the package.

ProcessShipmentReply/
CompletedShipmentDetail/
ServiceTypeDescription

Description of the FedEx service used for this
shipment. Currently not supported.

ProcessShipmentReply/
CompletedShipmentDetail/
PackagingDescription

Description of the packaging used for this shipment.
Currently not supported.

ProcessShipmentReply/
CompletedShipmentDetail/
OperationalDetail

Specify the shipment level operational information.

ProcessShipmentReply/
CompletedShipmentDetail/
AccessDetail

Used only with pending shipments.

ProcessShipmentReply/
CompletedShipmentDetail/
SmartPostDetail/

Returns FedEx SmartPost shipment account details
including:

FedEx Web Services, Developer Guide 2016



Machineable (indicates whether the shipment
is deemed to be machineable, based on
dimensions, weight, and packaging)



AllowedHubs



MailerId



DistributionCenter



SmartPostId



PickUpCarrier (CarrierCodeType)



AllowedIndicia



AllowedSpecialServices



SmartPostHubId



MaximumTransitTime

272

FedEx SmartPost Shipping

Element

Description

ProcessShipmentReply/
CompletedShipmentDetail/
ShipmentRating

All shipment-level rating data for this shipment,
which may include data for multiple rate types.

ProcessShipmentReply/
CompletedShipmentDetail/
ShipmentDocuments

All shipment-level shipping documents (other than
labels and barcodes).

ProcessShipmentReply/
CompletedShipmentDetail/
AssociatedShipments

The details of any associated shipments.

ProcessShipmentReply/
CompletedShipmentDetail/
CompletedPackageDetails

Package level details about this package.

16.1.3 FedEx SmartPost APO/FPO/DPO
FedEx SmartPost allows customers to ship orders to APO (Army/Air Force Post Office), FPO (Fleet Post
Office) or DPO (Diplomatic/Defense Postal Office) addresses. Include the following element values to
ship to these addresses:
Table 116. FedEx SmartPost APO/FPO/DPO Elements
Element
City

Value

StateOrProvinceCode



APO



FPO



DPO



AA - Armed Forces Americas



AE - Armed Forces Europe



AP - Armed Forces Pacific

Since packages shipped to APO/FPO/DPO are potentially dutiable, the USPS requires that all customers
use Form 2976A when shipping APO/FPO/DPO packages, regardless of weight and value. For more
information on customs and USPS requirements and to complete and print the forms online, refer to the
USPS Website at http://ribbs.usps.gov/index.cfm?page=siteindexa_z.
Example 29:

FedEx SmartPost APO address

StreetLines: PSC 2 box 7629
City: APO
StateOrProvinceCode: AE
PostalCode: 09012
CountryCode: US

The following reply elements would be returned for the FedEx SmartPost APO Address Validation:

FedEx Web Services, Developer Guide 2016

273

FedEx SmartPost Shipping

XXXXXXXXXX

XXXXXXXXX
XXXXXXX

IMPB On Print
Returns

ship
17
0
0

2014-11-21T09:30:47-05:00
REGULAR_PICKUP
SMART_POST
YOUR_PACKAGING

XXXXXXXXX

WSVC
Sender Company
1234567890

FedEx Web Services, Developer Guide 2016

274

FedEx SmartPost Shipping
SMART POST FIVE DIGIT ACCT: 10110
SMART POST FIVE DIGIT ACCT: 10110
SMART POST FIVE DIGIT ACCT: 10110
SMART POST FIVE DIGIT ACCT:
10110
10110
US

XXXXXXXXX

PARCEL RTN SVC
SMARTPOST / RETURNS
1234567890

Recipient Address Line1
Austin
AS
00840
AS

SENDER

XXXXXXXXX

XXXXX
XXXXX
8149871606

SMART POST FIVE DIGIT ACCT:
10110
SMART POST FIVE DIGIT ACCT:
10110
SMART POST FIVE DIGIT ACCT: 10110
SMART POST FIVE DIGIT ACCT:
10110

FedEx Web Services, Developer Guide 2016

275

FedEx SmartPost Shipping
10110
NL

EVENT_NOTIFICATION
RETURN_SHIPMENT

SHIPPER
XXXXX
HTML

es
ES

PRINT_RETURN_LABEL

string

PARCEL_RETURN
CARRIER_LEAVE_IF_NO_RESPONSE
5751
MANIFSETID

COMMON2D
PNG
PAPER_8.5X11_TOP_HALF_LABEL

LIST
1

FedEx Web Services, Developer Guide 2016

276

FedEx SmartPost Shipping

USD
0.00

LB
9

CUSTOMER_REFERENCE
string

16.1.4 FedEx SmartPost Labels
FedEx SmartPost shipments use one of the following two types of labels based on the specified pickup
carrier:


FedEx SmartPost label - FedEx SmartPost is the pickup carrier



FedEx integrated label - FedEx Ground® is the pickup carrier

The pickup carrier type is designated by the FedEx account executive based on the volume requirement
at the time of the contract and is stored on FedEx system.
The FedEx SmartPost label type supports the Customer Reference barcode when
element is used in the Ship request. The FedEx integrated label supports FedEx
Ground barcode below the USPS Delivery Confirmation barcode at the bottom half of the label.
Note:



Ground tracking number and Ground barcode are removed from SmartPost integrated labels.



When FedEx generates the FXSP outbound label, FedEx 2D barcode is added if you do not use a customer
reference barcode. When you enter customer references for their SmartPost outbound shipments, the
SmartPost shipping label will include a customer reference barcode with human readable content.

16.2 FedEx SmartPost Returns Service Details
For an online retailer or other residential shipper, a no-hassle returns process is critical for customer
satisfaction and loyalty. FedEx SmartPost Returns service is an ideal solution because it provides your
recipients with the convenience of U.S. Postal Service ® (USPS®) access points for their returns, as well
as free package pickup from their home or business address.
FedEx Web Services, Developer Guide 2016

277

FedEx SmartPost Shipping
FedEx SmartPost Returns is a contract-only service for customers with high-volume returns (100 average
daily volume) of low-weight residential packages. It’s a cost-effective, reliable solution that utilizes the
strength of the FedEx® network and the access of the USPS. In addition, FedEx SmartPost Returns
provides visibility throughout the returns process to your customer service and operations departments,
as well as to the return shipper.
Note:



FedEx SmartPost Returns does not provide estimated shipping rates when using the Rating or Shipping
Web services.



When FedEx generates FXSP returns label, FedEx 2D barcode is always included. You continue to have the
option to include RMA barcode.

16.2.1 How it Works
When using FedEx SmartPost Returns, you can choose three methods of processing your return labels:


Include pre-printed return labels in your original shipments.



Direct your customers back to your Website to process and print online labels using Process
Shipment operation of the Ship service WSDL.



Send your customers an email that includes a FedEx URL link to the return shipping label for them to
print using CreatePendingShipment of the Open Ship service. You can create a return label that can
be printed using a variation of the Ship web service. Refer to FedEx SmartPost Print Return Labels.

The return shipper then simply puts the label on the package and tenders it at a USPS access point
including any of the 36,000 retail locations or thousands of collection boxes, or even their own mailbox.
They can also call for the free USPS package pickup service. Once your customers’ returns packages are
picked up by the USPS, they’ll be consolidated into larger shipments at local post offices and picked up
by FedEx for shipment to you.
FedEx SmartPost provides U.S. to U.S. returns to all shippers regardless of volume segment and
includes Email Return Labels and Future Day shipment. Shippers can use any FedEx Express or
Competitor outbound service and still contract to use FedEx SmartPost Returns services.

16.2.2 Features


To use the FedEx SmartPost Returns service, shippers must have an account flagged as eligible for
FedEx SmartPost Returns and be U.S. based payors. U.S. Dollars (USD) is the only currency that is
supported for a FedEx SmartPost shipment.



Whenever customers request a return label, they must send in the Returns account number also.



The only packaging type available is the customer’s own packaging.



Eligible payment types are Bill Sender/ Recipient/ 3rd Party or Associated Account.

Note: If a customer has one set of credentials and multiple return locations, they will use the Account Number for
the correct receiving location and a PaymentType of "ACCOUNT" in the Payor section. The address for the
proper receiving location will then print on the SmartPost Return label.



A prepaid USPS integrated return shipping label is provided, which means your customers don’t have
to stand in line at a shipping location to obtain the proper documentation and don’t incur any out-ofpocket expenses.

FedEx Web Services, Developer Guide 2016

278

FedEx SmartPost Shipping


USPS daily pickup options of Monday through Saturday, offering your customers convenient access
for tendering their package at a local post office, a postal collection box or their own mailbox. Return
shippers also can request a free USPS package pickup at www.usps.gov/pickup.



Coverage to every residential address in the U.S., including P.O. boxes and APO/FPO/DPO
destinations.



Transit times of 2 to 7 business days. This means you can quickly and efficiently cycle returned
products back into inventory for faster redeployment into the market — generating revenue and
reducing the effects of product depreciation.



Maximum package weight of 70 lbs.



No residential or Saturday pickup surcharges.



FedEx SmartPost Returns does not provide estimated shipping rates when using the Rating or
Shipping Web services.



Inbound shipment visibility via FedEx InSight®. FedEx InSight email notifications provide timely and
automatic status information about your inbound FedEx SmartPost Returns packages and include an
estimated delivery date assigned when the FedEx SmartPost origin hub receives the package,
enabling you to plan accordingly.



Visibility for your customers through the tracking or RMA number on fedex.com. With an up-to-theminute view of their returns, customers are not calling your customer service department for
shipment-status updates.

Customer reports via FedEx® Reporting Online. Limit of liability is $100.

16.2.3 FedEx SmartPost Print Return Labels
You can create a return label that can be printed using a variation of the Ship web service. The recipient
can then apply this label to the return package as needed and drop the package off at a U.S. Postal
Service drop-off location, or their local mail carrier can pick up the package at the home address. No
charges are assessed until the label is used. In addition, a Returns Merchant Authorization (RMA)
reference number can be included as a reference field in your ship transaction. The RMA number prints
on the label and can be used to track the return package.


FedEx SmartPost® Returns service supports both FedEx SmartPost ® Email Return Labels and FedEx
SmartPost® Print Return Labels. You can request shipment and delivery email notifications.
However, ancillary endorsements are not supported.

For FedEx SmartPost Returns, FedEx Ground integrated print and FedEx SmartPost Email Return Label
options are available.


The maximum number of packages allowed for FedEx SmartPost Print Return Label shipments is
999, and 25 for FedEx SmartPost Email Return Label shipments.



FedEx SmartPost return labels are not available for international destinations.



Dangerous Goods and Hazardous Materials cannot be shipped.



FedEx SmartPost returns does not provide estimated shipping rates when using the Rating or
Shipping web services.



Declared value is not available for FedEx SmartPost return labels. If you wish to declare a value, use
FedEx Express or FedEx Ground return label services instead.



Return labels do not expire.

FedEx Web Services, Developer Guide 2016

279

FedEx SmartPost Shipping


Returns shipments are billed upon the delivery scan.



All label formats supported by FedEx Web Services (laser, thermal) are available for FedEx SmartPost
Returns shipping labels.



FedEx SmartPost Email Return Labels are not available for U.S. territories and Puerto Rico.

16.2.4 FedEx SmartPost Returns Request Elements
Begin your ship request with the basic Ship Request elements as detailed in FedEx Express Freight
Services: U.S under the heading FedEx Express U.S. Coding Details.
Add the following elements in your ProcessShipmentRequest to receive a FedEx SmartPost Return Label
in your ship reply.
Table 117. FedEx SmartPost Returns Request Elements
Element

Description

SpecialServicesRequested/
SpecialServiceTypes

Required
Include the value: RETURN_SHIPMENT.

ReturnShipmentDetail/ReturnType

Required
The type of return shipment being requested.
Valid value: PRINT_RETURN_LABEL.
With this option you can print a return label to be applied to
the box of a return. This option cannot be used to print an
outbound label.

RequestedShipment/
RequestedPackageLineItems/
CustomerReferences/CustomerReferen
ceType

Optional
Include the value: RMA_ASSOCIATION

RequestedShipment/
RequestedPackageLineItems/
CustomerReferences/Value

Optional
Include the value: Number
The RMA number associated with the return shipment.
Including this number in your request allows you to track by
RMA number up to 20 alpha-numeric characters.

ProcessShipmentRequest/
RequestedShipment/ServiceType

Required
Specify SMART_POST for FedEx SmartPost shipping
services.

SmartPostDetail

Required.
Specify the appropriate details for a FedEx SmartPost
shipment.

SmartPostDetail/Indicia

Required.
Specify the indicia type. Available option includes:
PARCEL_RETURN.

SmartPostDetail/HubID

Required.
Specify the HubID. For valid values refer to Appendix AD:
SmartPost Hub IDs.

FedEx Web Services, Developer Guide 2016

280

FedEx SmartPost Shipping

Element

Description
Note: Include only the numeric HubID value in your request.

16.2.5 FedEx SmartPost Email Return Labels
You can use the power of fedex.com to create return shipping labels for FedEx SmartPost ® Returns. The
fedex.com website will email your customer with a link to view and print the label. The customer can
take the package to any local United States Postal Center or have their local mail carrier collect the
package during their normal mail rounds. The package will be returned to your location using FedEx
SmartPost.
You will use the CreatePendingShipment request in OpenShipService web service to trigger fedex.com
to create the appropriate FedEx SmartPost Return Label and notify the customer through an email from
FedEx. You will use the DeletePendingShipment web services in the OpenService WSDL or Schema file
to cancel the label before it expires.
Note: SmartPost Returns does not provide estimated shipping rates when using the Rating or Shipping web service.

16.2.5.1 Delivery Area
FedEx SmartPost Returns Service is available throughout the 50 United States, U.S. territories, APOs,
FPOs and DPOs. FedEx customer emails can be sent to any standard email address.

16.2.5.2 Email Return Labels Coding Details
The following coding details apply to email labels:


The email label is created using elements from the CreatePendingShipmentRequest in the OpenShip
Service WSDL for FedEx SmartPost Returns.



The email label request is canceled using elements from the DeletePendingShipmentRequest in the
OpenShip Service WSDL for FedEx SmartPost Return Labels.



You may request up to 25 email labels to one email address using one request transaction.



Email label URLs expire according to expiration time stamp you specify in your request.



After the customer prints the label, the label does not expire but can be used indefinitely.



The only label format supported is 8-1/2" x 11" plain paper printed on a Laser printer.



A surcharge is added to a returns email label.



The maximum expiration date for an Email Return Label must be greater or equal to the day of the
label request and not greater than 2 years in the future.

FedEx Web Services, Developer Guide 2016

281

FedEx SmartPost Shipping
The following elements are included in a request for the email return label to be a FedEx SmartPost ®
Email Return Label:
Table 118. FedEx SmartPost Email Return Label Request Elements
Element

Description

SmartPostDetail

Required.
Specify the appropriate details for a FedEx SmartPost
shipment.

SmartPostDetail/Indicia

Required.
Specify the indicia type. The value for this transaction is
PARCEL_RETURN.

SmartPostDetail/AncillaryEndorsement

Optional.
Specify an endorsement type from the following valid values:


ADDRESS_CORRECTION



CARRIER_LEAVE_IF_NO_RESPONSE



CHANGE_SERVICE



FORWARDING_SERVICE



RETURN_SERVICE

Note: These services are of little practical use for a return package, but
they will not cause the transaction to fail.

SmartPostDetail/HubId

Required.
Specify the HubID. For valid values refer to Appendix AD:
SmartPost Hub IDs.
Note: Include only the numeric HubID value in your request. HubID
5531 should be used in the FedEx Test Environment.

SmartPostDetail/CustomerManifestId

Optional.
This field is of little practical use for a returns package.
The CustomerManifestId is used to group FedEx SmartPost
packages onto a manifest for each trailer that is being
prepared.
If you have multiple trailers, you must assign a Manifest ID to
each FedEx SmartPost package as determined by its trailer.
The Manifest ID must be unique to your account number for a
minimum of 6 months and cannot exceed 8 characters in
length.
Use the day of year and the trailer ID (a sequential number for
that trailer). For example, if there are 3 trailers that you started
loading on Feb 10, then the 3 Manifest Ids would be 041001,
041002, 041003 (this example includes leading zeros on the
trailer numbers).
The maximum length is 8 characters.

FedEx Web Services, Developer Guide 2016

282

FedEx SmartPost Shipping

Element

Description

RequestedShipment/
RequestedPackageLineItems/
PhysicalPackaging

Optional.
Provides additional detail on how the customer has physically
packaged this item.

16.2.6 FedEx SmartPost Reply Elements
The following elements are returned in the FedEx SmartPost reply:
Table 119. FedEx SmartPost Reply Elements
Element

Description

CompletedShipmentDetail/
OperationalDetail/TransitTime

String.
Standard transit time per origin, destination, and service.

CompletedShipmentDetail/
String.
OperationalDetail/MaximumTransitTime The maximum expected transit time.
CompletedShipmentDetail/
AccessDetail/EmailLabelUrl

The URL the customer will receive in the email from FedEx
to take them to the label that has been generated for them.

CompletedShipmentDetail/
CompletedPackageDetails/
TrackingIds/TrackingIdType

The reply will include tracking numbers for the package. The
TrackingIdType will specify whether a specific Tracking
Number provided is USPS, GROUND or FEDEX.
A UPS tracking number will only return the status of the
package while it is being handled by USPS. But a FedEx
Ground tracking number will return all the data.

CompletedShipmentDetail/
CompletedPackageDetails/
TrackingIds/ TrackingNumber

The reply will usually include two tracking numbers for the
package. The TrackingNumber will show the Tracking
number value. USPS is 22 digits, FedEx is 20 digits.

FedEx Web Services, Developer Guide 2016

283

FedEx SmartPost Shipping
The customer will receive an email from FedEx that uses the data as provided in your request. The email
will look like this:
Figure 2. Notification email

FedEx Web Services, Developer Guide 2016

284

FedEx SmartPost Shipping
Following the link, the user will see a fedex.com screen and use the data you provided in your request.
This screen will allow them to choose which shipping label to display and print:
Figure 3. Fedex.com screen

16.2.7 Customizable Labels
Shippers will be offered a customizable area on thermal labels for FedEx SmartPost and FedEx
SmartPost Returns.
The customizable label size is 4" x 8" which is a 4" x 6" format with an additional 1-1/2 inch area available
for customization. The customizable label can be printed with and without doc-tabs.

FedEx Web Services, Developer Guide 2016

285

FedEx SmartPost Shipping

16.2.8 Future Day Shipping
Customers can process FedEx SmartPost future day shipments in the same way as FedEx Ground. This
includes the same limit on the number of days (10 days) as FedEx Ground future day shipments. For
more information See Future Day Shipping.

16.2.9 Tracking Numbers
Customers can track FedEx SmartPost shipments using:


Customer reference number



Invoice number



P.O. number



Return Merchant Authorization (RMA) number



Tracking number

FedEx Web Services, Developer Guide 2016

286

In-Flight Shipment Service

17 In-Flight Shipment Service
In-Flight Shipment Service provides the capability to request a redirect to hold for an in-flight package.
The redirect to hold capability is supported via Web Services for U.S. destination FedEx Express and
Ground packages - all origins (to a U.S. destination) are supported.
The recipient address specified in the ValidateDeliveryRequest and ProcessDeliveryRequest must match
the recipient address specified for the in-flight package in question.

17.1 In-Flight Shipment Service Details
The service includes the following operations:
1. Validate Delivery Operation: The Validate Delivery operation allows you to confirm whether the inflight package in question may be redirected to be held at the specified FedEx facility, without
actually committing the package to the redirect to hold process. Transactions for this operation are ValidateDeliveryRequest and ValidateDeliveryReply.
2. Process Delivery Operation: The ProcessDelivery operation actually commits the in-flight package
in question to be redirected to the specified FedEx location to be held for pickup. Transactions for
this operation are - ProcessDeliveryRequest and ProcessDeliveryReply.

17.2 In-Flight Shipment Service Coding Details
This section explains the elements present in each of the Requestfollowing tables list out the elements
that are required for coding.

17.2.1 Validate Delivery Request Element Details
Table 120: ValidateDeliveryRequest Elements
Element

Description

actionRequested

Specifies the actions that can be taken on a delivery
option.


ADD



CANCEL


uniqueTrackingNumber\trackingNumber
uniqueTrackingNumber
\trackingNumberUniqueIdentifier
uniqueTrackingNumber\shipDate

MODIFY
You should populate this element in order to correctly
identify the shipment.
Used to distinguish duplicate FedEx tracking numbers.
Date on which package was shipped.

recipientContact

The descriptive data for a point-of-contact person.

recipientContact\contactId

Client provided identifier corresponding to this contact
information.

FedEx Web Services, Developer Guide 2016

287

In-Flight Shipment Service

Element

Description

recipientContact\personName

Identifies the contact person's name.

recipientContact\title

Identifies the contact person's title.

recipientContact\companyName

Identifies the company this contact is associated with.

recipientContact\phoneNumber

Identifies the phone number associated with this contact.

recipientContact\phoneExtension

recipientContact\pagerNumber

Identifies the phone extension associated with this
contact.
Identifies a toll free number, if any, associated with this
contact.
Identifies the pager number associated with this contact.

recipientContact\faxNumber

Identifies the fax number associated with this contact.

recipientContact\eMailAddress

Identifies the email address associated with this contact.

destinationAddress

recipientContact\tollFreePhoneNumber

destinationAddress\streetLines

destinationAddress\city
destinationAddress
\stateOrProvinceCode

destinationAddress\countryCode

Identifying abbreviation for US state, Canada province, etc.
Format and presence of this field will vary, depending on
country.
Identification of a region (usually small) for mail/package
delivery. Format and presence of this field will vary,
depending on country.
The two-letter code used to identify a country.

destinationAddress\countryName

The fully spelt out name of a country.

destinationAddress\residential

Indicates whether this address residential (as opposed to
commercial).
Use this type to indicate that the shipment has to be
redirected to hold.
Valid value: REDIRECT_TO_HOLD_AT_LOCATION
An alphabetic code for a FedEx operating facility.

destinationAddress\postalCode

deliveryRequestDetail\type

deliveryRequestDetail
\redirectToHoldAtLocationDetail
\holdingLocationId
deliveryRequestDetail
\redirectToHoldAtLocationDetail
\holdingLocationNumber
deliveryRequestDetail
\redirectToHoldAtLocationDetail
FedEx Web Services, Developer Guide 2016

A numeric code for a FedEx operating facility.

Contact and Address for the FedEx operating facility.

288

In-Flight Shipment Service

Element

Description

\holdingLocationContactAndAddress
deliveryRequestDetail
\redirectToHoldAtLocationDetail
\comments

Any additional information.

17.2.2 Validate Delivery Reply Elements
Table 121: ValidateDeliveryReply Elements
Element

Description

highestSeverity

Identifies the set of severity values for a Notification.
Valid values are:
 ERROR
 FAILURE
 NOTE
 SUCCESS
 WARNING

notifications

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request.

17.2.3 Process Delivery Request Elements
Table 122: ProcessDeliveryRequest Elements
Element

Description

actionRequested

Specifies the actions that can be taken on a delivery option.


ADD



CANCEL



uniqueTrackingNumber
\trackingNumber
uniqueTrackingNumber
\trackingNumberUniqueIdentifier
uniqueTrackingNumber
\shipDate
recipientContact
recipientContact\contactId
recipientContact\personName

MODIFY
You should populate this element in order to correctly
identify the shipment.
Used to distinguish duplicate FedEx tracking numbers.
Date on which package was shipped.
The descriptive data for a point-of-contact person.
Client provided identifier corresponding to this contact
information.
Identifies the contact person's name.

FedEx Web Services, Developer Guide 2016

289

In-Flight Shipment Service

Element

Description

recipientContact\title

Identifies the contact person's title.

recipientContact\companyName

Identifies the company this contact is associated with.

recipientContact\phoneNumber

Identifies the phone number associated with this contact.

recipientContact\phoneExtension

Identifies the phone extension associated with this contact.

recipientContact
\tollFreePhoneNumber
recipientContact\pagerNumber

Identifies a toll free number, if any, associated with this
contact.
Identifies the pager number associated with this contact.

recipientContact\faxNumber

Identifies the fax number associated with this contact.

recipientContact\eMailAddress

Identifies the email address associated with this contact.

destinationAddress

destinationAddress\streetLines

destinationAddress\city
destinationAddress
\stateOrProvinceCode

destinationAddress\countryCode

Identifying abbreviation for US state, Canada province, etc.
Format and presence of this field will vary, depending on
country.
Identification of a region (usually small) for mail/package
delivery. Format and presence of this field will vary,
depending on country.
The two-letter code used to identify a country.

destinationAddress\countryName

The fully spelt out name of a country.

destinationAddress\residential

destinationAddress\postalCode

deliveryRequestDetail\type

deliveryRequestDetail
\redirectToHoldAtLocationDetail
\ holdingLocationId
deliveryRequestDetail
\redirectToHoldAtLocationDetail
\ holdingLocationNumber
deliveryRequestDetail
\redirectToHoldAtLocationDetail
\ holdingLocationContactAndAddress

A numeric code for a FedEx operating facility.

Contact and Address for the FedEx operating facility.

FedEx Web Services, Developer Guide 2016

290

In-Flight Shipment Service

Element

Description

deliveryRequestDetail
\redirectToHoldAtLocationDetail
\comments

Any additional information.

17.2.4 Process Delivery Reply Elements
Table 123: ProcessDeliveryReply Elements
Element

Description

highestSeverity

Identifies the set of severity values for a Notification.
Valid values are:
 ERROR
 FAILURE
 NOTE
 SUCCESS
 WARNING

notifications

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request.

masterTrackingNumber
packageCount
estimatedDeliveryTimestamp

You should populate this element in order to correctly
identify the shipment.
Projected delivery time based on delivery option requested.

FedEx Web Services, Developer Guide 2016

291

International Shipping

18 International Shipping
18.1 FedEx Express International Shipping
FedEx Web Services offers FedEx Express® international shipping from anywhere-to-anywhere, which
means that you can create shipping transactions both to and from any prescribed country whose service
is supported by FedEx.
See FedEx International Ground Shipping for more information about this service.
See Ship Service for a list of FedEx Express international services available by region.

18.1.1 FedEx Express International Service Details
FedEx international services include FedEx Express, FedEx Ground ®, and all international shipping.
Estimated duties and taxes calculations are now available. Contact your FedEx account executive for
more information.
FedEx International First
FedEx International First® provides delivery in 1 or 2 business days. Check transit times for availability.


Service days are Monday through Friday, with Saturday pickup available in many areas for an
additional charge.



Inbound delivery to select U.S.postal codes from 60 countries in 1 or 2 business days.



Outbound delivery to many destinations in Belgium, England, France, Germany, Italy, the
Netherlands, Spain, and Switzerland as early as 9 a.m. in 2 business days.



Package size and weight up to 150 lbs. each; 108" in length; 130" in length plus girth (L+2W+2H).



Door-to-door, customs-cleared service.
o

Options include Express International Saturday and Dangerous Goods support for Dry Ice
Shipments only.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide. For more information on International Signature Options, see Delivery Signature Options.
FedEx International Priority
FedEx International Priority® provides time-definite delivery, typically in 1, 2, or 3 business days, to major
cities in Europe and Canada, typically in 2 business days. Check transit times for availability.


Service days are Monday through Friday, with Express International Saturday available in many areas.



Available in more than 220 countries and territories.



Package size and weight up to 150 lbs. each; 108" in length; 130" in length plus girth (L+2W+2H).



Door-to-door, customs-cleared service. The European network provides next-business-day delivery
between 38 major European markets. The Asian network gives you next-business-day delivery within
Asia and from Asia to the U.S.
o

Options include Express International Saturday, International Broker Select, Commercial
Destination Control, Dangerous Goods, and Hold at FedEx Location.

FedEx Web Services, Developer Guide 2016

292

International Shipping
For more information on International Signature Options, see Delivery Signature Options.
FedEx International Economy
FedEx International Economy® provides delivery typically in 2 to 5 business days, and in 2 or 3 business
days to Canada, Mexico, and Puerto Rico. Check transit times for availability. The business rules are as
follows:


Service days are Monday through Friday, with Saturday delivery available in countries where
Saturday is a regular business day.



Available in more than 215 countries and territories.



Package size and weight up to 150 lbs. each, 108" in length, 130" in length plus girth (L+2W+2H).



Door-to-door, customs-cleared delivery to major world markets.
o

Options include Express International Saturday, International Broker Select, Dry Ice Shipments
and Dangerous Goods to U.S., Canada and Puerto Rico only.

For more information on International Signature Options, see Delivery Signature Options.
FedEx Europe First
FedEx Europe First® provides intra-European next day, door-to-door, customs-cleared (where applicable)
service with early morning delivery by 9 a.m., 9:30 a.m., or 10 a.m., depending on the destination postal
code.


Days of Operation: Monday through Friday. Pick ups on Friday are delivered on Monday



Delivery Commitment: Depending on the destination postal code, the service delivery commitment
will be either 9 a.m., 9:30 a.m., or 10 a.m.



Origins: Next-day delivery service is available to Europe from the following origin countries: Austria,
Belgium, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Ireland,
Italy, Latvia, Lithunia, Luxembourg, the Netherlands, Norway, Poland, Portugal, Slovak Republic,
Slovenia, Spain, Sweden, Switzerland and United Kingdom.



Destinations: Available to more than 18,000 postal codes in major business centers in Austria,
Belgium, Denmark, France, Germany, Ireland, Italy, Luxembourg, the Netherlands, Spain, Switzerland
and the United Kingdom.



Available packaging:
o
o
o
o
o

FedEx Europe First Customer Own packaging
FedEx Europe First Envelope
FedEx Europe First Pak
FedEx Europe First 10kg Box
FedEx Europe First 25kg Box



Packaging Restrictions: FedEx packaging is available free of charge: FedEx® Envelope, FedEx® Pak,
FedEx® Tube, FedEx® Box, FedEx® 10kg Box, FedEx® 25kg Box. Customer's own packaging is also
accepted. Multiple=piece shipments are allowed.



Size Restrictions: In general, packages up to 274 cm length (108"), 330 cm length and girth combined
(130") [length and girth = length + 2 x height + 2 x width] are accepted.



Weight Restrictions: Packages up to 68 kg are accepted (this can vary by country). As a general rule,
there is no limit per shipment. Dimensional Weight applies to packaging other than FedEx Letter (FL),
FedEx Pak (FP) and single-piece FedEx boxes and tubes.

FedEx Web Services, Developer Guide 2016

293

International Shipping


At what price: A FedEx Europe First delivery fee in addition to your international priority rate. You can
also benefit from the FedEx 10kg Box and FedEx 25kg Box special rates. The extra delivery fee
varies by destination postal code.

18.1.2 FedEx Express International Service Options
The following service options are available for use with FedEx Express international shipping:


Alternate Return Address



Commercial Destination Control



Dangerous Goods



FedEx Express International Saturday



Dry Ice Shipments



Delivery Signature Options



FedEx InSight



FedEx International Broker Select®



FedEx Intra-CountryShipping



Mask Account Number (FedEx International Ground)



Masked Data



Shipment Notification in the Ship Request



Variable Handling Charges

18.1.3 International Packaging Options
In addition to standard FedEx Express packaging, you may also choose a FedEx 10 kg Box or a FedEx 25
kg Box. The weight limit is 22 lb for a FedEx 10 kg Box and 55 lb for a FedEx 25 kg Box. These packaging
options are allowed for FedEx International Priority ® to more than 220 countries and territories.

18.1.4 FedEx Express International Coding Details
Before you begin coding FedEx Express® International shipping options, note the following:


FedEx Express International shipments are created using the ShipService WSDL.



FedEx Express International and Openship allows multiple-package shipping (MPS). MPS Express
International shipments are associated with one another using a package sequence indicator. You
can even do it in one transaction for the same location.
For example, if you ship 5 boxes of baseballs to London, the master package label has a package
sequence indicator of 1 of 5. All other packages associated with this master will have package
sequence indicators of 2 of 5, 3 of 5, etc. The purpose of this type of MPS processing is to ensure
that packages grouped together on one Commercial Invoice travel through the FedEx system
together and arrive at customs at the same time.



You may ship both documents and commodity shipments.



International Freight shipping is available to Puerto Rico.

FedEx Web Services, Developer Guide 2016

294

International Shipping


For shipments to countries that accept an Electronic Commercial Invoice (ECI), FedEx Web Services
uploads your commodity information (entered as part of the Ship request) to that country’s customs
clearance center to expedite clearance requirements.

For a list of countries that accept Electronic Trade Documents, see the Electronic Trade Documents
WSDL Guide.


Use FedEx® Electronic Trade Documents to automatically generate copies of customs documents.
See the Electronic Trade Documents WSDL Guide for more information.



If you are new to international shipping and need assistance with customs rules, documents, and
clearance requirements, go to the Global Trade Manager website that provides the information you
need to reduce the time it takes to clear packages through customs.

18.1.5 International Multiple Package Shipments
You may use FedEx Web Services to tie international packages together that have to clear on a single
Commercial Invoice. To tie international shipments together as a multiple-package shipment (MPS):


The first package in the shipment request is considered the master package. Any shipment-level
information (TotalWeight, PackageCount, SignatureOption, GAA) is included on the master package.
The SequenceID for this package is 1.



In the master package reply, the tracking number assigned to that package is included in the
MasterTrackingID element for all subsequent packages. The SequenceID is also required for each
child package.



When shipping commodities, the entire list of all the commodities in the shipment must be included
in the ship request for each package so the commodity values are calculated correctly.

Note: The maximum number of packages in an MPS request is 200.

This option is available for international C.O.D. multiple-package shipments.
For more information about MPS, see FedEx Express U.S. Multiple-Package Shipments and Open
Shipping.

18.1.6 Document Shipments
Shipment contents that are considered to be non-dutiable are known as document shipments. In addition
to basic elements (including shipper elements) required for all shipping transactions and described in the
Introduction of the FedEx Web Services Developer Guide, the following elements are available to create
a FedEx Express International document shipment:
Note: For FedEx Express International multiple piece shipments (MPS), if one package is a document, then all
packages in the shipment must be documents. This is also true for commodity shipments. All the packages
must be for commodities. Commodity and Document packages cannot be in the same MPS shipment.

Table 124. Recipient Information Elements
Element

Multiple
Description
Occurrence

RequestedShipment/Company

Required if Contact name is blank.

RequestedShipment/Contact

Required if Company name is blank.

FedEx Web Services, Developer Guide 2016

295

International Shipping
Element

Multiple
Description
Occurrence

RequestedShipment/StreetLines

Yes

At least one street address line is required.

RequestedShipment/City

Required.

RequestedShipment/StateOrProvince
Code

Required only if recipient country is U.S. or
Canada, or if EEI applies and country is Mexico
(MX).

RequestedShipment/PostalCode

Required only if recipient country is a postal
aware country.
See Appendix J: Postal-Aware Countries and
Formats section of Web Services Developer
Guide for a list of postal aware countries.

RequestedShipment/UrbanizationCode No

Relevant only to addresses in Puerto Rico,
where multiple addresses within the same
postal code can have the same house number
and street name. When this is the case, the
urbanization code is needed to distinguish
them.

RequestedShipment/CountryCode

Required. Identifies the recipient country.

RequestedShipment/CountryName

The fully spelled out name of a country.

RequestedShipment/PhoneNumber

Required.

TinType/TinNumber

Tax Identification Number. Specify the
Employer Identification Number (EIN).
Required if duties, taxes, and fees are billed to
recipient.

Address/Residential

This element is optional for shipments to the
U.S. and Canada. However, to receive an
accurate rate quote, this element must be
included in the Ship request.

18.1.7 Billing
Table 125. Billing Elements
Element

Multiple
Occurrence

Description

ShippingChargesPayment/ PaymentType

Required.
Valid values:

FedEx Web Services, Developer Guide 2016



ACCOUNT



COLLECT (Ground)

296

International Shipping
Element

Multiple
Occurrence

Description



SENDER



RECIPIENT



THIRD_PARTY

ShippingChargesPayment/Payor/Account
Number

Required if PaymentType element is
SENDER, RECIPIENT or THIRD_PARTY.

Currency

Required.
Note: FedEx will provide currency conversion
using FedEx Web Services. If you enter a
currency other than the currency associated
with your FedEx account number, rate
quotes will be returned based on the
specified currency.

CountryCode

Required.
The country code associated with the
shipper’s FedEx account billing currency
type.

CountryName

Optional.
The fully spelled out name of a country.

CustomerReferenceType

Optional.
This element allows customer-defined
notes to print on the shipping label. The
reference element is also used to track by
reference.
Valid values:


BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRA_REGULATORY_REFERENCE



INVOICE_NUMBER



P_O_NUMBER



RMA_ASSOCIATION



SHIPMENT_INTEGRITY



STORE_NUMBER

Note: You can add up to three references per
shipment. SHIPMENT_INTEGRITY prints
only on the invoice.

FedEx Web Services, Developer Guide 2016

297

International Shipping
Element

Multiple
Occurrence

Description

CustomerReference/Value

Optional.
Reference information to be associated
with the CustomerReferenceType.
For example, if you designate
INVOICE_NUMBER in the
CustomerReferenceType element, the
actual invoice number associated with the
package is included in the
CustomerReference/Value element.

18.1.8 Multiple Piece Shipment Elements
This option is available for FedEx Express U.S. and international multiple-package shipments (MPS),
FedEx Ground U.S. and international MPS, FedEx Express U.S. C.O.D. and international C.O.D. multiplepackage shipments, and FedEx Ground U.S. C.O.D. and international C.O.D. multiple-package shipments.
For more information about MPS, see FedEx Express U.S. Multiple-Package Shipments.
Note: Up to 200 MPS packages can be created for one master shipment.

Table 126. Multiple Piece Shipment Elements
Element

Multiple
Occurrence

Description

PackageCount

Yes

Required for MPS.
Total number of packages in the MPS.

SequenceNumber

Yes

Required if PackageCount is greater than 1.

MasterTrackingID

Yes

Required for MPS.
The MasterTrackingID element is returned for the
first package in an MPS. This element must be
included on all subsequent shipments to tie these
packages together.
Note: The MasterTrackingID element includes the
MasterTrackingNumber and FormID. Both simple
elements are required.

Note: For additional coding details, see FedEx Express U.S. Multiple-Package Shipments.

18.1.9 Shipment/Package Information
Table 127. Shipment/Package Information Elements
Element

Multiple
Description
Occurrence

ServiceType

Required.
Valid Values:


FedEx Web Services, Developer Guide 2016

EUROPE_FIRST_INTERNATIONAL_PRIORITY
(for intra-Europe shipment only).
298

International Shipping
Element

PackagingType

Multiple
Description
Occurrence

Yes



INTERNATIONAL_ECONOMY



INTERNATIONAL_FIRST



INTERNATIONAL_PRIORITY



INTERNATIONAL_ECONOMY_ FREIGHT



INTERNATIONAL_PRIORITY_ FREIGHT

Required.
Valid values:


FEDEX_10KG_BOX



FEDEX_25KG_BOX



FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_PAK



FEDEX_TUBE



YOUR_PACKAGING

PhysicalPackaging

Yes

If you select YOUR_PACKAGING as the package type,
this element is required for packages traveling to and
from the U.S., Canada, and Puerto Rico. This
enumeration rationalizes the former FedEx Express
international "admissibility package" types (based on
ANSI X.12) and the FedEx Freight packaging types.
The values represented are those common to both
carriers.
See Appendix K: Physical Packaging Type Codes
section of Web Services Developer Guide for valid
package descriptions.

Weight

Yes

Required.
Units and Value are included in this element.
Values for the Units element are:


 KG
The Value element must contain the actual package
weight. For multiple-piece shipments (MPS), each
ProcessShipment request must contain the package
Weight.
TotalWeight

FedEx Web Services, Developer Guide 2016

Required for MPS.
The TotalWeight element is submitted for the master
package only, not the subsequent child packages. The
master package (designated as 1 in the PackageCount

299

International Shipping
Element

Multiple
Description
Occurrence
element) contains the total package weight in the
MPS.
Units and Value are included in this element.
Values for the Units element are:


 KG
The Value element must contain the actual package
weight.
CustomerReferenceType

Optional. This element allows customer-defined notes
to print on the shipping label. The reference element
is also used to track by reference.
Valid values are:


BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRACOUNTRY_REGULATORY_REFERENCE



INVOICE_NUMBER



P_O_NUMBER



RMA_ASSOCIATION



SHIPMENT_INTEGRITY



STORE_NUMBER

SHIPMENT_INTEGRITY prints only on the invoice.
Note: Reference information is submitted on the
shipment level. However, you may add up to four
references per shipment.
CustomerReference/Value

Optional. Reference information to be associated with
the CustomerReferenceType. For example, if you
designate INVOICE_NUMBER in the
CustomerReferenceType element, the actual invoice
number associated with the package is included in the
CustomerReference/Value element.

Height

Yes

Optional but recommended if your package type is
CUSTOMER_PACKAGING.

Width

Yes

Optional but recommended if your package type is
CUSTOMER_PACKAGING.

FedEx Web Services, Developer Guide 2016

300

International Shipping
Element

Multiple
Description
Occurrence

Length

Yes

Units

InternationalDocument

Commodity/Description

Optional but recommended if your package type is
CUSTOMER_PACKAGING.
Required if dimensions are specified.
Values are:

Yes

Commodity/CountryOfManufacture Yes



Required.
Values are:


DOCUMENTS_ONLY



NON_DOCUMENTS

A minimum of three characters is required for this
element. Maximum number of characters is 450.
See Appendix L: Customs-Approved Document
Descriptions from Web Services Developer Guide for
more information.
Optional. This is a required field for document only
and commodity shipments.
Country code where document contents were
produced in their final form.
Note: “Multiple countries” (country code 'XX') is not accepted
as a valid country anymore.

InsuredValue/Amount

FedEx liability for each package is limited to $100
USD unless a higher value is declared and paid for.
Use this element if you want to declare a higher
value.
Note: Some countries require a minimum document declared
value of $1USD. For a list of these countries, see
Minimum Customs Value.

For FedEx Express International MPS, the master
package should contain the total declared
value/carriage value. No declared value/carriage value
is added to the subsequent child packages.
Note: "InsuredValue" refers to declared value of the package.

RequestedShipment/
ShipTimeStamp

FedEx Web Services, Developer Guide 2016

Required.
Time of shipment based on shipper’s time zone.
Defaults to CDT.
The date format must be YYYY-MM-DDTHH:MM:SSxx:xx. The time must be in the format: HH:MM:SS
using a 24-hour clock. The date and time are
separated by the letter T, such as 2009-06301

International Shipping
Element

Multiple
Description
Occurrence
26T17:00:00. The UTC offset indicates the number of
hours/minutes such as xx:xx from UTC, such as 200906-26T17:00:00-04:00 is defined as June 26, 2009
5:00 p.m. Eastern Time.
See Appendix M: Time Zones section of Web
Services Developer Guide for more information.

RequestedShipment/Date

Required.
Date of shipment. For FedEx Express international
shipments, this value can be current date or up to 10
days in future.

18.1.10Label Requirements
Table 128. Label Requirements Element
Element

Multiple
Occurrence

Description

LabelSpecification

To identify the type of label format you will receive,
elements in the Label Specification complex type
element should be included in the Ship reply (depending
on your label format). More information about label
printing is provided in Create a Label.

In addition to these elements, you may choose these shipping options for a document shipment:


Alternate Return Address



FedEx Express International (Saturday) (depending on origin/destination pair and service)



FedEx Insight



Hold at FedEx Location (depending on origin/destination pair and service)



International Broker Select



Shipment Notification in the Ship Request

Table 129. Document Shipment Options
Shipping Option

Package vs. Shipment Level

Dangerous Goods

Shipment

Delivery Signature Options

Shipment

Dry Ice

Shipment

Future Day

Shipment

Hold at Location

Shipment

FedEx Web Services, Developer Guide 2016

302

International Shipping
Shipping Option

Package vs. Shipment Level

Inside Delivery

Shipment

Inside Pickup

Shipment

Notification

Shipment

Reference Elements

Package

Saturday Services

Shipment

Variable Handling Charge

Package

18.1.11Commodity Shipments
Shipment contents that are considered to be dutiable are known as commodity shipments. In addition to
the basic elements required for all shipping requests described in the Introduction of the FedEx Web
Services Developer Guide, the following elements are required to create a FedEx Express International
commodity shipment.
When shipping commodities, the entire list of all the commodities in the shipment must be included in
the ship request for each package so the commodity values are calculated correctly.
Note: For FedEx Express International multiple piece shipments, if one package is a commodity shipment, then all
packages in the shipment must contain commodities. Commodity and document shipments cannot be
combined in an multiple piece shipment.

Table 130. Recipient Information Elements
Element

Multiple
Description
Occurrence

RequestedShipment/Company

Required if Contact name is blank.

RequestedShipment/Contact

Required if Company name is blank.

RequestedShipment/StreetLines

Yes

At least one street address line is required.

RequestedShipment/City

Required.

RequestedShipment/StateOrProvi
nceCode

Required only if recipient country is U.S. or Canada,
or if EEI applies and country is Mexico (MX).

RequestedShipment/PostalCode

Required only if recipient country is a postal aware
country.
See Appendix J: Postal-Aware Countries and
Formats section of Web Services Developer Guide
for a list of postal aware countries.

RequestedShipment/Urbanization
Code

Relevant only to addresses in Puerto Rico, where
multiple addresses within the same postal code can
have the same house number and street name.
When this is the case, the urbanization code is
needed to distinguish them.

FedEx Web Services, Developer Guide 2016

303

International Shipping
Element

Multiple
Description
Occurrence

RequestedShipment/CountryCode

Identifies the recipient country code.

RequestedShipment/CountryNam
e

The fully spelled out name of a country.

RequestedShipment/PhoneNumb
er

Required.

TaxpayerIdentification/TinType/

Identifies the category of the taxpayer
identification.
Valid values:


BUSINESS_NATIONAL



BUISNESS_STATE



BUSINESS_UNION



PERSONAL_NATIONAL



PERSONAL_STATE

TinType/TinNumber

Tax Identification Type and Tax Identification
Number. Specify the Employer Identification
Number (EIN). Required if duties, taxes, and fees
are billed to recipient.

Address/Residential

This element is optional for shipments to the U.S.
and Canada. However, to receive an accurate rate
quote, this element must be included in the
ProcessShipment request.

RequestedShipment/ShipTimeSta
mp

Required. Time of shipment based on shipper’s
time zone. Defaults to CDT. The date format must
be YYYY-MM-DDTHH:MM:SS-xx:xx. The time must
be in the format: HH:MM:SS using a 24-hour clock.
The date and time are separated by the letter T
(e.g., 2009-06-26T17:00:00). The UTC offset
indicates the number of hours/minutes (e.g. xx:xx)
from UTC (e.g., 2009-06-26T17:00:00-04:00 is
defined as June 26, 2009 5:00 p.m. Eastern Time).
See Appendix M: Time Zones section of Web
Services Developer Guide for more information
about time zones.

RequestedShipment/Date

TaxpayerIdentification

Required. Date of shipment. For FedEx Express
International shipments, this value can be the
current date or up to 10 days in the future.
TaxpayerIdentification is used in the Party object.
Valid values:

FedEx Web Services, Developer Guide 2016



tinType



number

304

International Shipping
Element

Multiple
Description
Occurrence


usage



effectiveDate



expirationDate

Table 131. Billing Detail Elements
Element

Multiple
Description
Occurrence

TaxpayerIdentification/TinType

Required for non document shipments to Brazil.
Valid values:


Passport Number



Individual Tax ID



Company Tax ID

Note: This type must match the data entered in the
TaxpayerIdentification/Number element.
Note: This element is not required but should be added
for recipient billing of duties, taxes, and fees.

TaxpayerIdentification/Number

ShippingChargesPayment/PaymentT No
ype

Required for shipments to Brazil. Depending on
the TinType submitted, include the tax ID number
for the recipient. Also required if you included the
TaxpayerIdentification/TinType element in the
Ship Request.
Required. Values are:


COLLECT (Ground)



SENDER



RECIPIENT



THIRD_PARTY

AccountNumber

Required.

Currency

Required. FedEx will provide currency conversion
using FedEx Web Services. If you enter a
currency other than the currency associated with
your FedEx account number, rate quotes will be
returned based on the specified currency.

CountryCode

Optional. Country code associated with the
currency.

CountryName

Optional. The fully spelled out name of a country.

FedEx Web Services, Developer Guide 2016

305

International Shipping

18.1.12Multiple-Piece Shipment Elements
This option is available for FedEx Express U.S. and international multiple-package shipments, FedEx
Ground U.S. and international multiple-package shipments, FedEx Express U.S. C.O.D. and international
C.O.D. multiple-package shipments, and FedEx Ground U.S. C.O.D. and international C.O.D. multiplepackage shipments.
For more information about MPS, see FedEx Express U.S. Multiple-Package Shipments (MPS).
Note: The maximum number of packages in an MPS request is 200.

Table 132. Multiple-Piece Shipment Elements
Element

Multiple
Occurrence

Description

PackageCount

Yes

Required for MPS. Total number of packages in the
MPS.

SequenceNumber

Yes

Required if PackageCount is greater than 1.

MasterTrackingID

Yes

Required for MPS. The MasterTrackingID element is
returned for the first package in an MPS. This
element must be included on all subsequent
shipments to tie these packages together.
Note: The MasterTrackingID element includes the
MasterTrackingNumber and FormID. Both simple
elements are required.

Table 133. Shipment/Package Information Elements
Element

Multiple
Description
Occurrence

ServiceType

FedEx Web Services, Developer Guide 2016

Required. Values are:


EUROPE_FIRST_INTERNATIONAL_PRIORITY
(for intra-Europe shipment only)



INTERNATIONAL_ECONOMY



INTERNATIONAL_FIRST



INTERNATIONAL_PRIORITY



INTERNATIONAL_ECONOMY_FREIGHT



INTERNATIONAL_PRIORITY_FREIGHT

306

International Shipping
Element

Multiple
Description
Occurrence

PackagingType

Yes

Required. Values are:


FEDEX_10KG_BOX



FEDEX_25KG_BOX



FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_PAK



FEDEX_TUBE



YOUR_PACKAGING

PhysicalPackaging

Yes

Required for packages traveling to and from the
U.S., Canada, and Puerto Rico.
This enumeration rationalizes the former FedEx
Express international "admissibility package" types
(based on ANSI X.12) and the FedEx Freight
packaging types. The values represented are those
common to both carriers.
See Appendix K: Physical Packaging Type Codes
section of Web Services Developer Guide for valid
package descriptions.

Weight

Yes

Required. Units and Value are included in this
Element. Values for the Units element are:


 KG
The Value element must contain the actual package
weight. For MPS shipments, each ship request
must contain the package Weight.
TotalWeight

Required for multiple-piece shipments (MPS). The
TotalWeight element is submitted for the master
package only, not the subsequent child packages.
The master package, designated as 1 in the
PackageCount element, contains the total package
weight in the MPS shipment.
Units and Value are included in this element. Values
for the Units element are:


 KG
The Value element must contain the actual package
weight.
CustomerReferenceType

FedEx Web Services, Developer Guide 2016

Optional. This element allows customer-defined
notes to print on the shipping label. The reference
element is also used to track by reference.
307

International Shipping
Element

Multiple
Description
Occurrence
Valid values are:


BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRACOUNTRY_REGULATORY_REFERENCE



INVOICE_NUMBER



P_O_NUMBER



RMA_ASSOCIATION



SHIPMENT_INTEGRITY

 STORE_NUMBER
SHIPMENT_INTEGRITY prints only on the invoice.
Note: Reference information is submitted on the shipment
level. However, you may add up to three references
per shipment.

CustomerReference/Value

Optional. Reference information to be associated
with the CustomerReferenceType. For example, if
you designate INVOICE_NUMBER in the
CustomerReferenceType element, the actual
invoice number associated with the package is
included in the CustomerReference/Value element.

Height

Yes

Optional but recommended if your package type is
CUSTOMER_PACKAGING.

Weight

Yes

Optional but recommended your package type is
CUSTOMER_PACKAGING.

Length

Yes

Optional but recommended if your package type is
CUSTOMER_PACKAGING.

Units

FedEx Web Services, Developer Guide 2016

Required if dimensions are specified. Values are:




308

International Shipping
Element

Multiple
Description
Occurrence

InsuredValue/Amount

Optional. You may enter a value in this element to
declare additional value for this shipment. For MPS
shipments, the master package should contain the
total declared value for the shipment. No declared
value is added to subsequent child shipments.
Note: "InsuredValue" refers to declared value of the
package. FedEx does not provide insurance of any
kind.

InternationalDocument

Required. Values are:


DOCUMENTS_ONLY



NON_DOCUMENTS

RequestedShipment/ShipTimeStamp No

Required. Time of shipment based on shipper’s
time zone. Defaults to CDT.
The date format must be YYYY-MMDDTHH:MM:SS-xx:xx. The time must be in the
format: HH:MM:SS using a 24-hour clock. The date
and time are separated by the letter T, such as
2009-06-26T17:00:00. The UTC offset indicates the
number of hours/minutes, for example xx:xx from
UTC, such as 2009-06-26T17:00:00-04:00 is defined
as June 26, 2009 5:00 p.m. Eastern Time.
See Appendix K: Physical Packaging Type Codes
section of Web Services Developer Guide for valid
package descriptions..

RequestedShipment/Date

Required. Date of shipment. For FedEx Express
international shipments, this value can be current
date or up to 10 days in future.

Table 134. Label Requirements Element
Element

Multiple
Occurrence

Description

LabelSpecification

To identify the type of label format you will receive,
elements in the LabelSpecification complex type element
should be included in the Ship reply (depending on your
label format. More information about label printing is
provided in Create a Label.

FedEx Web Services, Developer Guide 2016

309

International Shipping

18.1.13International Clearance Requirements
Table 135. Commodity Shipment Elements
Element

Multiple
Description
Occurrence

TermsOfSale

Optional.
Valid values are:


FCA/FOB (Free Carrier/Free On Board): Seller is
responsible for all costs of delivering goods to
destination. (Default)



CIP/CIF (Costs, Insurance Paid/Carriage Insurance
Freight): Seller is responsible for freight insurance, and
miscellaneous charges to destination.



CPT/C&F (Carriage Paid To/Costs and Freight): Seller is
responsible for cost of freight to destination; buyer is
responsible for insurance.



EXW (Ex Works): Seller makes goods available to buyer.
Buyer is responsible for delivering goods to destination.



DDU (Delivered Duty Unpaid): Seller is responsible for
delivering goods to destination. Buyer is responsible for
clearing goods through Bureau of Customs and Border
Protection.



DDP (Delivered Duty Paid): Seller is responsible for
delivering goods to destination, including duties, taxes,
and miscellaneous fees.



DAP (Delivered at Place): Seller pays for carriage to the
named place, except for costs related to import
clearance, and assumes all risks prior to the point that the
goods are ready for unloading by the buyer.



DAT (Delivered at Terminal): Seller pays for carriage to
the terminal, except for costs related to import clearance,
and assumes all risks up to the point that the goods are
unloaded at the terminal.

FreightCharge/Amount

Required if the Terms of Sale element is either CF or CIF. This
charge must be added to the total customs value amount.

InsuranceCharge/Amount

Required if the Terms of Sale element is CIF. This charge
must be added to the total customs value amount.

RegulatoryControlType

Identities the type of regulatory control.
Valid values are:


EU_CIRCULATION



FOOD_OR_PERISHABLE



NAFTA

FedEx Web Services, Developer Guide 2016

310

International Shipping
Element

Multiple
Description
Occurrence


NOT_APPLICABLE_FOR_LOW_CUSTOMS_VALUE_EXC
EPTION

Note: EU_CIRCULATION is required for shipments between European
Union countries. The EU indicator prints on the shipping label.
Note: FOOD_OR_PERISHABLE is required by the FDA/BTA for food or
perishable items coming to the U.S. and Puerto Rico (except for
shipments from PR to the U.S. or U.S. to PR) containing food
items.

CustomsValue

For MPS shipments, this element must contain the total value
declared to the Bureau of Customs and Border Protection for
all packages in the shipment.

Purpose

Optional. To facilitate customs clearance and to ensure that
duties, taxes, and fees are correctly assessed, enter a valid
purpose. Valid values are:


Sold



Not Sold



Gift



Sample



Repair and Return



Personal Effects

18.1.14Commodity Elements
Note: A maximum of 20 occurrences of commodity line item information is supported in the ShipService WSDL.
Commodity information must be included in the ship request for all packages in an multiple-piece (MPS)
shipment.

Table 136. Commodity Elements
Element

Multiple
Description
Occurrence

Commodity/Name

Name of this commodity.

Commodity/NumberOfPieces

Yes

Required. The total number of packages within
the shipment that contain this commodity (can
be less than or equal to PackageCount).

Commodity/Description

Yes

Required. A minimum of three characters is
required for this element. Maximum number of
characters is 450.
See Appendix H: Vague Commodity
Descriptions section of Web Services

FedEx Web Services, Developer Guide 2016

311

International Shipping
Element

Multiple
Description
Occurrence
Developer Guide for a list of appropriate
commodity names.

Commodity/CountryOfManufacture

Yes

Required. Code of country in which commodity
contents were produced or manufactured in
their final form.
Note: “multiple countries” (country code 'XX') is not
accepted as a valid country anymore.

Commodity/HarmonizedCode

Yes

Optional. To expedite customs clearance,
especially if the Customs Value is greater than
$2,500USD or if a valid U.S. export license is
required, include valid Harmonized Codes for all
commodities.

Commodity/Weight

Required. Total weight of this commodity. One
explicit decimal position. Maximum length is 11
including the decimal.

Commodity/Quantity

Yes

Total quantity of an individual commodity within
the shipment (used in conjunction with
QuantityUnits).
For example, if your MPS contains 10
baseballs, 10 is included in this element as part
of the commodity description of baseballs
assuming that the QuantityUnits value is EA.
Must be included for each commodity.

Commodity/QuantityUnits

Optional. Unit of measure (for example, EA =
each, DZ = dozen) of each commodity in the
shipment.

Commodity/AdditionalMeasures

Yes

Optional. Contains only additional quantitative
information other than weight and quantity to
calculate duties and taxes.

Commodity/UnitPrice

Required.
Customs value for each commodity in the
shipment.

Commodity/CustomsValue

Optional.
Total customs value for this line item. It should
equal the commodity unit quantity times
commodity unit value. Six explicit decimal
positions. The maximum length is 18 including
the decimal.

Commodity/ExiseConditions

Yes

Optional.
Defines additional characteristics of the
commodity used to calculate duties and taxes.

FedEx Web Services, Developer Guide 2016

312

International Shipping
Element

Multiple
Description
Occurrence

Commodity/ExportLicenseNumber

To expedite customs clearance, especially if the
Customs Value is greater than $2,500USD or if
the Foreign Trade Regulations (FTR) number is
not supplied. Applies to U.S. export shipping
only.

Commodity/ExportLicenseExpirationD
ate

Date of expiration. Must be at least one day in
the future. Required only if a commodity is
shipped on a commercial export license and the
export license number is supplied. Applies to
U.S. export shipping only.

Commodity/CIMarksAndNumbers

Yes

An identifying mark or number used on the
packaging of a shipment to help customers
identify a particular shipment.
Required only for the FedEx CI.

Commodity/PartNumber

The part number of the commodity.

Commodity/NaftaDetail

Commodity / Purpose

All data required for this commodity in NAFTA
Certificate of Origin.
This field is used for calculation of duties and
taxes.
Valid values are : BUSINESS and CONSUMER

If the recipient and the importer are not the same, the following importer elements are required:
Table 137. Required element if the recipient and importer are not the same
Element

Multiple
Occurrence

Description

customsClearanceDetail/ImporterofRecord

Required if the recipient and importer are
not the same. The following elements are
included:


AccountNumber



TIN (Tax Payer Identification)



Contact



Address

In addition to the preceding elements, you may also choose from the following shipping options for a
commodity shipment:


Alternate Return Address



FedEx Express International Saturday (depending on origin/destination pair and service)



FedEx International Broker Select

FedEx Web Services, Developer Guide 2016

313

International Shipping


FedEx InSight



Hold at FedEx Location (depending on origin/destination pair and service)



Shipment Notification in the Ship Request

Table 138. Shipping Option and Package vs. Shipment Level
Shipping Option
Dangerous Goods

Package vs. Shipment Level
Shipment

Dry Ice

Shipment

Future Day

Shipment

Hold at Location

Shipment

Inside Delivery

Shipment

Inside Pickup

Shipment

International Traffic in Arms Regulations

Shipment

Reference Elements

Package

Saturday Services

Shipment

Shipment Notification

Shipment

Signature Options

Shipment

Variable Handling Charge

Package

18.1.15International Traffic in Arms Regulations
The International Traffic In Arms Regulations (ITAR) is a set of US government regulations that control
the import and export of defense-related articles and services on the United States Munitions List
(USML). As a US-based carrier, FedEx Express is required to maintain compliance with ITAR regulations.
Likewise, US persons (corporations) worldwide are required to adhere to ITAR regulations. To this end, it
is important that the US person making any export shipment must first determine which type of goods
they are shipping: ITAR Exempt goods or ITAR goods that require a license to transport.
FedEx Express can accept and properly transport two types of ITAR-controlled items
1. ITAR Exempt goods
Note: An exempt good still falls under ITAR regulations, however a license is not required for import or export.

2. Commodities controlled under a State Department License (SDL)
FedEx Express International Priority® (IP) and FedEx Express International Priority® Freight (IPF) can ship
ITAR exempt commodities. Ensure the ITAR special handling option is indicated in your shipping
transaction input, including exemption or license data if applicable.
Refer to http://www.fedex.com/us/international/regulatory-alerts/index.html for specific details on
the various State Department licenses and ITAR exemptions. International Traffic in Arms Regulations
(ITAR) services are included in the ShipService, OpenShip, and RateService WSDLs. The following
elements are required:

FedEx Web Services, Developer Guide 2016

314

International Shipping
Table 200. International Traffic in Arms Regulations Coding Elements
Element
RequestedShipment/ SpecialServicesRequested/
InternationalTrafficInArmsRegulationsDetail

Description
Descriptive data regarding special services
requested by the shipper for this shipment. If the
shipper is requesting a special service which
requires additional data, such as COD, the
special service type must be present in the
specialServiceTypes collection, and the
supporting detail must be provided in the
appropriate sub-object.

RequestedShipment/ SpecialServicesRequested/
InternationalTrafficInArmsRegulationsDetail/
LicenseOrExemptionNumber

The export or license number for the ITAR
shipment.

18.1.16Third Party Consignee
Third Party Consignee is a contractual special service that is available only in conjunction with
International Priority and International Priority Freight services. Restrictions for the Third Party Consignee
service include that the recipient cannot be the importer of record, cannot receive the Commercial
Invoice, and cannot have access to or knowledge of the shipment's customs value and carriage value.
Additional restrictions include that the recipient is not allowed to pay the transportation charges nor the
duties and taxes charges for the shipment.
Third Party Consignee is designed to allow shippers/suppliers to ship directly to an end recipient,
bypassing delivery to the importer of record (the ultimate consignee on the Commercial Invoice) in the
destination country and delivering directly to the end recipient. The customs and carriage values are
masked from the end recipient, speeding delivery and reducing costs for inventory maintenance and
transportation. Only the shipper and the importer of record in the destination country will have access to
the customs and carriage values.
Use ShipmentSpecialServiceType as THIRD_PARTY_CONSIGNEE to identify this service type when
shipping a shipment.

18.1.17Reply Elements
In addition to the standard reply elements for all ship requests, the following Express International
elements are returned:
Table 201. Express International Elements
Element

Description

MasterTrackingID/Tracking Number

Returned for international multiple-piece shipments (MPS).

MasterTrackingID/FormID

Returned for international MPS.

Taxes/TaxType/HST

Returned for Canadian origin shipments.

Taxes/TaxType/GST

Returned for Canadian origin shipments.

Taxes/TaxType/PST

Returned for Canadian origin shipments.

FedEx Web Services, Developer Guide 2016

315

International Shipping
Element

Description

SurchargeType/Offshore

Returned for international shipments.

SurchargeType/EuropeFirst

Returned for intra-Europe shipments using Europe First
service.

RequestedShipment/
CustomsClearanceDetail/
CustomsOptions/CustomsOptionsDetai
l/Type

Details the return reason used for clearance processing of
international dutiable outbound and international dutiable
return shipments.
Valid values are:


COURTESY_RETURN_LABEL: For the outbound
courtesy return label.



EXHIBITION_TRADE_SHOW: For exhibition or tradeshow, outbound and inbound.



FAULTY_ITEM: For faulty item being returned, inbound
only.



FOLLOWING_REPAIR: For repaired or processed item
being sent, outbound only.



FOR_REPAIR: For repair or processing, outbound and
inbound.



ITEM_FOR_LOAN: For loan item, outbound and
inbound.



OTHER: Other reason, outbound and inbound. This type
requires a description.



REJECTED: For rejected merchandise being returned,
inbound.



REPLACEMENT: For replacement being sent, outbound
only.



TRIAL: For use in a trial, outbound and inbound.

RequestedShipment/
Specify additional description about customs options.
CustomsClearanceDetail/
Required when the customs options type is "other."
CustomsOptions/CustomsOptionsDetai
l/Description

18.1.18Reference Elements with Output Location
The ShipService WSDL includes the elements in Appendix AB: Customer Reference Elements.
FedEx Express International (Saturday)
In the ShipService WSDL, you may choose Saturday pickup or Saturday delivery services for your FedEx
Express® International shipments for an additional surcharge.
The following service details apply:

FedEx Web Services, Developer Guide 2016

316

International Shipping


Saturday delivery is available for shipments from the U.S. to select points in Canada for the following
services:
o
o
o

FedEx International Priority ®
FedEx International Economy®
FedEx Freight®



Saturday pickup for international shipments is available for select markets in the United States.



To determine if Saturday services are available for your shipment origin/destination pair, use the
ServiceAvailability WSDL.

Note: Saturday delivery is available in select international destinations that consider Saturday a regular business day.
For these countries, Saturday delivery does not have to be included in the Ship request and no handling fees
are applied.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.1.19Saturday Coding Details
Saturday services are included in the ShipService WSDL. The following elements are required:
Table 203. Saturday Service Request Elements
Element
ShipmentSpecialServicesRequested/SpecialS
erviceTypes

Description
Two elements must be included in the ShipService
WSDL for Saturday services:
Saturday_Delivery: The ship date and service must
equal a Saturday delivery date for this option.
For example, if you choose FedEx International First ®
and your ship date is Thursday, Saturday delivery is not
allowed.
Saturday_Pickup: Your ship date must equal a
Saturday date for this option.

18.2 FedEx Express Freight Services: International
If your FedEx Express® international package exceeds 150 lbs, you must choose one of the FedEx
Express® Freight Services.

18.2.1 FedEx International Priority Freight
FedEx International Priority® Freight provides time-definite delivery, typically in 1, 2 or 3 business days to
most major world markets including the U.S. to Canada:


Service days are Monday through Friday, with Saturday delivery available in countries where
Saturday is a regular business day.



A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment.



Skid or package size and weight: exceeding 70" in height or 119" in length or 80" in width. Individual
packages and/or skids greater than 151 lbs. Skids weighing in excess of 2,200 lbs. require prior
approval by FedEx.

FedEx Web Services, Developer Guide 2016

317

International Shipping


The following special services are allowed (depending on destination location): FedEx Express
International (Saturday), FedEx International Broker, Dangerous Goods, and Hold at FedEx
Location.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.2.2 FedEx International Economy Freight
FedEx International Economy® Freight provides time-definite service, typically within 5 business days,
with flexible pickup and delivery options.


Service days are Monday through Friday, with Saturday delivery available to countries where
Saturday is a regular business day.



Import to the U.S. available from Canada, Puerto Rico, Mexico, and key Asian, Latin American and
European Markets.



Export from the U.S. available to more than 130 countries and territories.



Skid or package size and weight: Exceeding 70" in height or 119" in length or 80" in width. Individual
packages and/or skids greater than 151 lbs. Skids weighing in excess of 2,200 lbs. require prior
approval by FedEx.



Advanced confirmation required. Call 1.800.332.0807 to book your freight shipment.



The following special services are allowed (depending on destination location): FedEx International
Broker, Hold at FedEx Location, Dangerous Goods, and Dry Ice Shipments.

18.2.3 Additional Service Details


Freight must be shrink-wrapped and/or banded to a skid.



Must be palletized, stackable, and able to be lifted by forklift.



Skids exceeding 70" in height or 119" in length or 80" in width require prior approval.



Individual skids of 151 lbs. or more. Skids exceeding 2,200 lbs. require prior approval. Unlimited total
shipment weight.

Note: If you have any questions about services available for your origin or destination pair, use the RateService
WSDL to determine service availability.

18.2.4 FedEx Express Freight Services Coding Details: International
Before coding FedEx Express® Freight Services International:


Freight shipping weight must exceed 150 lbs.



Use the RateService WSDL to determine what freight services are available for your
origin/destination pair.

FedEx Freight international services are included in the ShipService WSDL. In addition to the basic
shipping elements required for a FedEx Express shipment, the following elements are available:
Table 204. International ExpressFreightDetail Elements
Element
ExpressFreightDetail/
BookingConfirmationNumber
FedEx Web Services, Developer Guide 2016

Description
An advance booking number is required for FedEx
International Priority Freight. When you call
318

International Shipping
Element

Description
1.800.332.0807 to book your freight shipment, you will
receive a booking number. This booking number can be
included in the Ship request and prints on the shipping
label.

ExpressFreightDetail/PackingListEnclosed Optional.
If you enclose a packing list with your freight shipment,
this element informs FedEx operations that shipment
contents can be verified on your packing list.

18.2.5 Process Shipment Reply Elements
See the Ship Service section for ProcessShipment reply information.

18.2.6 Dangerous Goods (International Express)
See FedEx Express U.S. Dangerous Goods for more information.

18.2.7 Alcohol Shipping (International Express)
See FedEx Express U.S. Alcohol Shipping for more information.

18.2.8 Future Day Shipping (International Express)
See FedEx Express U.S. Future Day Shipping for more information.

18.2.9 Hold at FedEx Location (International Express)
See FedEx Express U.S. Hold at FedEx Location for more information.

18.2.10Dry Ice Shipments (International Express)
See FedEx Express U.S. Dry Ice Shipments for more information.

18.3 FedEx International Ground Shipping
Use the Shipping service to access the FedEx International Ground ® shipping features. See Shipping
Services by Region for a list of FedEx International Ground services available by region.

18.3.1 FedEx International Ground Service Options
The following service options are available for use with FedEx International Ground shipping:


Alternate Return Address



Commercial Destination Control



Delivery Signature Option



Future Day Shipping



FedEx Ground US COD (Collect On Delivery).



Mask Account Number (FedEx International Ground)

FedEx Web Services, Developer Guide 2016

319

International Shipping


Shipment Notification in the Ship Request



Variable Handling Charges

18.4 FedEx International Ground Service Details
FedEx International Ground is a direct-ship method for you to send single or multi-weight small package
shipments directly from the U.S. to Canada, Canada to the U.S. There are no minimum package
requirements.
Note: In addition to FedEx International Ground service to and from Canada, you may also use FedEx Ground ® to
ship intra-Canada packages. Estimated duties and taxes calculations are now available. Contact your FedEx
account executive for more information.

FedEx International Ground provides day-definite delivery throughout Canada:


Delivery Times: 2-7 business days.



Service Days: Monday through Friday by the end of the business day.



Delivery Area: Canada.



Package Size and Weight: Up to 150 lbs., 108" in length, and 165" in length and girth (L+2W+2H). For
packages weighing 100–150 lbs., specific guidelines must be followed for marking heavy packages.
For more information, go to http://www.fedex.com/us/services/intl/ground.html.



Exceptions: FedEx Ground® cannot deliver to P.O. boxes.



No hazardous materials (except for certain shipments to Canada that contain dry ice or are classified
as Other Regulated Materials — Domestic [ORM-D/Limited Quantity]).



Customs clearance is included for shipments to Canada through our brokerage-inclusive service. A
fee applies. Brokerage-inclusive service may not be available with all electronic shipping solutions.



A CI is needed for all shipments.

Note: To determine actual shipping services and options allowed for your origin/destination pair, use the Service
Availability service.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.4.1 Clearance Requirements
All export documents must be placed in the international document pouch and attached to the FedEx
International Ground package, or the first package in an multiple-piece shipment (MPS). Each shipment
must include:


1 signed copy and 4 originals for Canada, and 1 signed copy and 2 originals for Puerto Rico.



The broker information (including Non-Resident Importer (NRI) designation if applicable) must be on
the Commercial Invoice.



The Commercial Invoice must also have contract details for your recipient, including a phone number.



The recipient is automatically the Importer of Record (IOR) unless otherwise designated on the
Commercial Invoice.

Note: For more information regarding specific clearance requirements for FedEx International Ground shipping, see
your FedEx account executive.

FedEx Web Services, Developer Guide 2016

320

International Shipping

18.4.2 Brokerage and Billing Options Between U.S. and Canada
FedEx Web Services includes a variety of features that will improve your shipping experience and
increase the ease of transborder shipping of FedEx International Ground packages between the U.S. and
Canada.


Brokerage Inclusive Services: Through the new default brokerage-inclusive service option, FedEx
International Ground shipping gives you one point of contact, and initiates regulatory clearance while
your packages are still en route.



Broker Selection Option: If you prefer to use your own broker, you have the option to do so.



Flexible Billing Solutions: You now have the option to bill duties, taxes, and ancillary fees to the
shipper, the recipient, or a third party.

18.5 FedEx International Ground Coding Details
Before you begin coding FedEx International Ground shipping options, note the following:


FedEx International Ground shipments are created using the ShipService WSDL.



The ground collect billing option is also available for the Broker Select Option services.



FedEx International Ground service allows multiple-package shipping so that you can create a single
Commercial Invoice for the multiple-package shipment (MPS).



FedEx Web Services does not generate hard copies of customs documents. However, you may
capture reply elements to create a Commercial Invoice.



A standard CI form can be printed at fedex.com/us/services/createlabels.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.5.1 FedEx International Ground Ship Elements
In addition to basic elements required for all ship transactions as describes in the Introduction of the
FedEx Web Services Developer Guide, the following elements are available to create a FedEx
International Ground shipment.
Table 205. Recipient Information Elements
Element

Multiple
Occurrence

Description

Company

Required

Contact

Required

StreetLines

At least one street address line is required.

StreetLines

Optional

City

Required

StateOrProvinceCode

Required for Canada and U.S.

PostalCode

Required

FedEx Web Services, Developer Guide 2016

321

International Shipping
Element

Multiple
Occurrence

Description

CountryCode

Identifies the recipient country.

CountryName

The fully spelled out name of a country.

Telephone

Required

Residential

Optional. If you ship to a residential address and do not include
the Residential element, your rate quote will be incorrect.

RecipientEIN

Required if duties, taxes, and fees are billed to recipient.

Table 206. Billing Elements
Element

Multiple
Description
Occurrence

ShippingChargesPayment/PaymentType No

Required. Values are:


ACCOUNT



COLLECT (Ground)



SENDER



RECIPIENT



THIRD_PARTY

AccountNumber

Required. Ensures that shipping and customs
charges are billed to the correct account number,
include the AccountNumber element that
corresponds to the BillTo element.

Currency

Required. FedEx will provide currency conversion
using FedEx Web Services. If you enter a currency
other than the currency associated with your
account, rate quotes will be returned based on the
specified currency.

Country

Country code associated with the currency.

CustomerReferenceType

Optional. This element allows you to add reference
information that prints on the shipping label and on
your invoice. Reference information may also be
used to track packages. Values are:

FedEx Web Services, Developer Guide 2016



BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRACOUNTRY_REGULATORY_REFERENCE



INVOICE_NUMBER



P_O_NUMBER
322

International Shipping
Element

Multiple
Description
Occurrence


RMA_ASSOCIATION



SHIPMENT_INTEGRITY

 STORE_NUMBER
SHIPMENT_INTEGRITY prints only on the invoice.
Note: Reference information is submitted on the shipment
level. However, you may add up to three references
per shipment.

CustomerReference/Value

Optional.
Reference information to be associated with the
CustomerReferenceType. For example, if you
designate INVOICE_NUMBER in the
CustomerReferenceType element, the actual
invoice number associated with the package is
included in the CustomerReference/Value element.

18.5.2 Multiple Piece Shipment Elements
Note: Up to 200 multiple piece shipment (MPS) packages may be created for one master shipment.

Table 207. Multiple Piece Shipment Elements
Element

Multiple
Occurrence

Description

PackageCount

Required for MPS.
Total number of packages in the shipment.

SequenceNumber

Required if PackageCount is greater than 1. The
sequence number determines the master package
and is important when shipment level information
is added for that package. The shipment level
information added to a master package applies to
all packages in the shipment.

MasterTrackingID

Required. The MasterTrackingID element is
returned with the first package reply. This element
contains both the MasterTrackingNumber and the
FormID elements. The MasterTrackingID element
must be added to each subsequent ship request
for all other packages in the MPS.

MasterTrackingID/TrackingIDType Package

FedEx Web Services, Developer Guide 2016

Valid values are:


EXPRESS



FREIGHT



GROUND

323

International Shipping
Element

Multiple
Occurrence

Description



USPS



FEDEX

Table 208. Package and Shipment Details Elements
Element

Multiple
Occurrence

Description

ServiceType

Required.
Note: Both residential and commercial shipments use the
FEDEX_GROUND ServiceType.

PackagingType

Yes

Required.
Valid value is YOUR_PACKAGING.
Note: Packages traveling to and from the U.S., Canada, and
Puerto Rico require an additional package description.
Use the PhysicalPackaging element to designate the
package description.

PhysicalPackaging

Yes

Required for packages traveling to and from the
U.S., Canada, and Puerto Rico. This enumeration
rationalizes the former FedEx Express® international
"admissibility package" types (based on ANSI X.12)
and the FedEx Freight packaging types. The values
represented are those common to both carriers.
See Appendix K: Physical Packaging Type Codes
for valid packaging types.

Weight

Yes

Required. Units and Value are included in this
element. Values for the Units element are:


 KG
The Value element must contain the actual package
weight. For multiple-piece shipments (MPS), each
ship request must contain the package weight.
TotalWeight

FedEx Web Services, Developer Guide 2016

Required for MPS. The TotalWeight element is
submitted for the master package only, not the
subsequent child packages. The master package
(designated as 1 in the PackageCount element)
contains the total package weight in the MPS.
Units and Value are included in this element. Values
for the Units element are:




324

International Shipping
Element

Multiple
Occurrence

Description
The Value element must contain the actual package
weight.

Dimensions/Height

Yes

Optional.
Submitted in the Ship request on the package level.

Dimensions/Width

Yes

Optional.
Submitted in the Ship request on the package level.

Dimensions/Length

Yes

Optional.
Submitted in the Ship request on the package level.

Dimensions/Units

Yes

Required if dimensions (Height, Width, Length) are
submitted.
Values are:

InsuredValue/Amount



You may enter a value in this element to declare
additional value for this shipment. For MPS, the
master package should contain the total declared
value for the shipment. No declared value is added
to subsequent child shipments. FedEx does not
provide insurance of any kind.
Note: "InsuredValue" refers to declared value of the
package. FedEx does not provide insurance of any
kind.

RequestedShipment/Date

RequestedShipment/TimeStamp No

FedEx Web Services, Developer Guide 2016

Date of shipment. For FedEx International Ground,
this date can be the current date or up to 10 days in
advance.
Time of shipment based on shipper’s time zone.
Defaults to CDT.
The date format must be YYYY-MMDDTHH:MM:SS-xx:xx. The time must be in the
format: HH:MM:SS using a 24-hour clock. The date
and time are separated by the letter T, such as 200906-26T17:00:00. The UTC offset indicates the
number of hours/minutes, such as xx:xx, from UTC,
such as 2009-06-26T17:00:00-04:00 is defined as
June 26, 2009 5:00 p.m. Eastern Time.
See Appendix H: Vague Commodity Descriptions
section of Web Services Developer Guide for more
information.

325

International Shipping
Table 209. International Ground Label Requirements
Element

Multiple
Occurrence

Description

LabelSpecification

To identify the type of label format you will receive,
elements in the LabelSpecification complex type element
should be included in the ProcessShipment reply,
depending on your label format. For more information about
label printing see Create a Label.

Table 210. Broker Selection Elements
Element

Multiple
Description
Occurrence

CustomsClearanceDetailBrokers/A No
ccountNumber

Optional.
Broker’s valid FedEx account number.

CustomsClearanceDetail/Brokers/
Party/Tins

Optional.
Tax ID number (EIN).

CustomsClearanceDetail/Broker/Ti
nNumber

Corresponding valid Tax ID number; must match
Broker/Tin description.

CustomsClearanceDetail/Brokers/
Type

Specify one of the valid values:


EXPORT



IMPORT

Note: EXPORT is only valid for Freight shipments and
Mexico origin shipments.

CustomsClearanceDetail/Brokers/
Broker

The two broker scenario for Mexico outbound
shipments is optional - two brokers are not a
required entry.

CustomsClearanceDetail/Contact/
PersonName

Required.

CustomsClearanceDetail/Contact/
CompanyName

Required if PersonName is not supplied.

CustomsClearanceDetail/Contact/
PhoneNumber

Required.

CustomsClearanceDetail/Contact/
PhoneExtension

Optional.
Identifies the phone extension associated with this
contact.

CustomsClearanceDetail/Contact/
TollFreePhoneNumber

Optional.
Identifies a toll free number, if any, associated with
this contact.

FedEx Web Services, Developer Guide 2016

326

International Shipping
Element

Multiple
Description
Occurrence

CustomsClearanceDetail/Contact/
PagerNumber

Optional

CustomsClearanceDetail/Contact/
FaxNumber

Optional

CustomsClearanceDetail/Contact/
EmailAddress

Optional

CustomsClearanceDetail/Address/
StreetLines

Optional

CustomsClearanceDetail/Address/
City

Optional

CustomsClearanceDetail/Address/
StateOrProvinceCode

Optional

CustomsClearanceDetail/Address/
PostalCode

Optional

CustomsClearanceDetail/Address/
CountryCode

Optional

CustomsClearanceDetail/Address/
CountryName

Optional.
The fully spelled out name of a country.

18.5.3 Commodity Information
Note: A maximum of 20 occurrences of the commodity line item information is supported in the ShipService WSDL.
Commodity information must be included in the Ship request for all packages in an multiple-piece shipment
(MPS).

Table 211. CommodityInformation Elements
Element

Multiple
Occurrence

Description

Commodity/NumberOfPieces

Yes

Required.
The total number of packages within the shipment
that contain this commodity (can be less than or
equal to PackageCount).

Commodity/Description

Yes

A minimum of three characters is required for this
element. Maximum number of characters is 450.
See Appendix H: Vague Commodity
Descriptions for a list of appropriate commodity
descriptions.

Commodity/CountryOfManufact
ure

Yes

Code of the country in which the commodity
contents were produced or manufactured in their
final form.
Note: “multiple countries” (country code 'XX') is not

FedEx Web Services, Developer Guide 2016

327

International Shipping
Element

Multiple
Occurrence

Description
accepted as a valid country anymore.

Commodity/HarmonizedCode

Yes

Optional.
For efficient customs clearance, a Harmonized
Code should be included for all commodities in a
shipment. For more information regarding
Harmonized Code look-up, go to
fedex.com/GTM.

Commodity/Quantity

Yes

Total quantity of an individual commodity within
this shipment (used in conjunction with
QuantityUnits).
For example, if your MPS contains 10 baseballs, 10
is included in this element as part of the
commodity description of baseballs assuming that
the QuantityUnits value is EA. Must be included for
each commodity.

Commodity/CIMarksandNumber Yes
s

Optional.
An identifying mark or number used on the
packaging of a shipment to help customs identify a
particular shipment.

Commodity/QuantityUnits

Yes

Required.
Unit of measure (for example: EA = each; DZ =
dozen) of each commodity in the shipment.

Commodity/Weight

Yes

Required.
Weight of each commodity.

Commodity/Unit Price

Yes

Required.
Customs value for each piece of a particular
commodity in the shipment.

Commodity/Amount

Yes

Required.
At least one occurrence is required for international
commodity shipments. The Commodity/Amount
must equal the commodity UnitPrice times Units.

Commodity/ExportLicenseNumb No
er

Required only if a commodity is shipped on a
commercial export license.

Commodity/ExportLicenseExpira No
tionDate

Required only if a commodity is shipped on a
commercial export license and the
ExportLicenseNumber element is supplied.

CommercialInvoice/Comments

Yes

A maximum of four occurrences per commodity
may be included.

customsClearanceDetail/NAFTA

For shipments to NAFTA countries (U.S., Canada,
and Mexico), you are required to enter the
appropriate NAFTA information for your shipment.

FedEx Web Services, Developer Guide 2016

328

International Shipping
Element

Multiple
Occurrence

Description
For more information regarding these
requirements, go to
fedex.com/us/customersupport/ftn/faq/nafta.htm
l.

NAFTACommodityDetail

Optional. Specify the NAFTA commodity detail for
the shipment.

NAFTACommodityDetail/Prefere No
nceCriterion

Optional.
Preference for each commodity in the shipment:
A - The good was obtained or produced entirely in a
NAFTA country.
B - The good was produced entirely in a NAFTA
country and satisfies the specific origin that applies
to its tariff classification.

NAFTACommodityDetail/Produc
erDetermination

Optional.
If you are the Producer of the commodity, specify
Yes.
If you are not the producer of the commodity,
select No and indicate whether the certificate is
based on one of the following:
No (1) - Your knowledge of the commodity
No (2) - Written statement from producer
No (3) - Signed certificate from producer

NAFTACommodityDetail/Produc
erId

Identifies the commodity producer when multiple
producers are used in a single shipment.

NAFTACommodityDetail/NetCos No
tMethod

Optional.
The Net cost (NC) method calculates regional value
content (RVC) as a percentage of the net cost to
produce the good.
Net cost represents all costs incurred by the
producer minus promotions, royalties, shipping, and
nonallowable interest costs. Specify one of the
following:
No - Select No if the RVC is not calculated
according to the net cost method.
NC - Select NC if the RVC is calculated according to
the net cost method.

NAFTACommodityDetail/NetCos No
tDateRange

Optional.
Specify NC plus date range if RVC is calculated
according to the net cost method over a period of
time.
Enter the beginning and ending dates of the time
period in a MM/DD/CCYY format or select from the
calendar icons.

Note: In addition to standard ground ship replies, FedEx International Ground transit times are returned in the Ship
reply.

FedEx Web Services, Developer Guide 2016

329

International Shipping

18.5.4 International/NAFTA Information
The following elements apply to U.S. to Canada FedEx International Ground shipments only. They do not
apply to Canada to U.S. FedEx International Ground shipments. For international multiple-piece
shipments, request GAA on the master piece.
Table 212. FedEx International Ground U.S. to Canada NAFTA Elements
Element

Multiple
Occurrence

Description

Print General Agency
Authority (GAA) Form

Optional.
Print the GAA.

GAA Media Type

Optional.
Specify the form for the GAA as PNG or PDF.

Provide GAA Instructions

Optional.
Specify whether to include GAA instructions.

List Clearance Entry Fee
Surcharge

Optional.
Specify the list clearance entry fee surcharge.

Clearance Entry Fee
Surcharge (Discount)

Optional.
Specify the list clearance entry fee surcharge discount.

GAA Form

Optional.
Specify the location of the GAA form.

GAA Form Copies To Print

Optional.
Specify the number of GAA form copies to print.

GAA Instructions

Optional.
Specify the GAA instructions.

GAA Instruction Copies to
Print

Optional.
Specify the number of GAA instruction copies to print.

18.5.5 Reply Elements
In addition to the standard reply elements for all Ship requests, the following FedEx International Ground
elements are returned:
Table 213. International Ground Reply Elements
Element

Description

MasterTrackingID/TrackingNumber

Returned for international multiple piece shipments (MPS).

MasterTrackingID/FormID

Returned for international MPS.

Taxes/TaxType/HST

Returned for Canadian origin shipments.

Taxes/TaxType/GST

Returned for Canadian origin shipments.

Taxes/TaxType/PST

Returned for Canadian origin shipments.

FedEx Web Services, Developer Guide 2016

330

International Shipping
Table 214. International/NAFTA Reply Information
Element

Description

List Clearance Entry Fee Surcharge Returned list clearance entry fee surcharge.
Clearance Entry Fee Surcharge
(Discount)

Returned list clearance entry fee surcharge discount.

GAA (General Agency Authority)
form

Returned location of the GAA form.
Applies only to U.S. to Canada FedEx International Ground
shipments. Does not apply to Canada to U.S. FedEx International
Ground shipments.

GAA Form Copies To Print

Returned number of GAA form copies to print.
Applies to U.S. to Canada FedEx International Ground shipments.
Does not apply to Canada to U.S. FedEx International Ground
shipments.

GAA Instructions

Returned GAA instructions.
Applies only to U.S. to Canada FedEx International Ground
shipments. Does not apply to Canada to U.S. FedEx International
Ground shipments.

GAA Instruction Copies to Print

Returned number of GAA instruction copies to print.
Applies to U.S. to Canada FedEx International Ground shipments.
Does not apply to Canada to U.S. FedEx International Ground
shipments.

18.5.6 Reference Elements with Output Location
The ShipService WSDL includes the elements in Appendix AB: Customer Reference Elements.

18.5.7 Delivery Signature Options (FedEx International Ground)
See Delivery Signature Options for more information.

18.5.8 Future Day Shipping (FedEx International Ground)
See FedEx Express U.S. Future Day Shipping for more information.

18.5.9 FedEx Ground Collect On Delivery (C.O.D.) (International)
See FedEx International Ground Shipping for more information.

18.5.10Alternate Return Address (FedEx International Ground)
See FedEx Express U.S. Alternate Return Address for more information.

18.5.11Mask Account Number (FedEx International Ground)
See FedEx Express U.S. Masked Data for more information.

FedEx Web Services, Developer Guide 2016

331

International Shipping

18.6 FedEx International Broker
FedEx International Broker Select® allows you to designate a specific customs broker other than FedEx
(or our designated broker).

18.6.1 FedEx International Broker Select Service Details
FedEx International Broker Select is available when using the following services to ship to select
countries:


FedEx International Priority ®



FedEx International Economy®



FedEx International Priority ® Freight



FedEx International Economy® Freight



FedEx International Ground® to Canada

Note: FedEx International Broker Select is a contract service. Contact your FedEx account executive for more
information.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.6.2 FedEx International Broker Select Coding Details
Before you begin coding FedEx International Broker Select, you should know the following:


You must contact your FedEx account executive to be enrolled for this service.



Saturday services are not allowed for FedEx International Broker Select.



An additional routing surcharge applies to your FedEx International Broker Select shipments if you
choose to have FedEx complete delivery after customs clearance and if your recipient and customs
broker are served by different FedEx clearance points.

Note: Certain customs limitations may apply for FedEx International Broker Select shipments. Contact FedEx
Express® International Customer Service at 1.800.247.4747 for requirements.

FedEx International Broker Select is requested using the ShipService WSDL. In addition to the basic
shipping elements required for a FedEx Express international shipment, the following elements are
available for FedEx International Broker Select:
Table 216. International Broker Select Elements
Element

Description

CustomsClearanceDetail/Party/Account
Number

Optional.
Broker’s valid FedEx account number.

CustomsClearanceDetail/Party/Tins

Optional. Tax ID Number. EIN (Employer Identification
Number).

CustomsClearanceDetail/Party/Contact

Required.
The descriptive data for a point-of-contact person.

CustomsClearanceDetail/Contact/Contac Optional.
tId
FedEx Web Services, Developer Guide 2016

332

International Shipping
Element

Description
Client provided identifier corresponding to this contact
information.

CustomsClearanceDetail/Contact/Person Required
Name
CustomsClearanceDetail/Contact/Compa Required
nyName
CustomsClearanceDetail/Contact/Phone
Number

Required

CustomsClearanceDetail/Contact/Phone
Extension

Optional.
Identifies the phone extension associated with this contact.

CustomsClearanceDetail/Contact/TollFre
ePhoneNumber

Optional.
Identifies a toll free number, if any, associated with this
contact.

CustomsClearanceDetail/Contact/Pager
Number

Optional

CustomsClearanceDetail/Contact/FaxNu
mber

Optional

CustomsClearanceDetail/Contact/EmailA Optional
ddress
CustomsClearanceDetail/PartyAddress/S Required.
treetLines
Combination of number, street name, etc. At least one line
is required for a valid physical address; empty lines should
not be included.
CustomsClearanceDetail/Address/Street
Lines

Optional.
Additional street lines can be included as needed.

CustomsClearanceDetail/Address/City

Required

CustomsClearanceDetail/Address/State
OrProvinceCode

Required for U.S. or CA

CustomsClearanceDetail/Address/Postal
Code

Optional

CustomsClearanceDetail/Address/Count
ryCode

Required

CustomsClearanceDetail/Address/Count
ryName

Optional.
The fully spelled out name of a country.

FedEx Web Services, Developer Guide 2016

333

International Shipping

18.7 B13A for Canada Export Shipping
The B13A is an export declaration form filed with Canada Customs by the Canadian exporter for all
outbound shipments containing non-restricted goods when the commercial goods are valued at $2,000
CAD or more and the final destination of the goods is a country other than the United States, Puerto
Rico, or the United States Virgin Islands.

18.7.1 B13A Service Details
The following service details apply:


You need to submit and/or declare your Export Declaration (B13A) form to Canada Customs. FedEx
WebServices do not generate this document.



For shipments of documents and commodities, the B13A is required when a shipment exceeds a
customs value of $2,000CAD.



The B13A is also required for shipments of controlled commodities, as defined by Revenue Canada
Customs and related agencies, regardless of the value of the shipment.

Note: If you have questions regarding B13A shipping requirements, go to B13A FAQs for more information.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.7.2 B13A Coding Details
For product and/or commodity shipments: The B13A Filing Option element and associated elements
must be provided for shipments of any value that are consigned to countries other than the United
States, Puerto Rico, or the U.S. Virgin Islands.
For document shipments: The B13A Filing Option element and associated elements must be provided
for shipments consigned to countries other than the United States, Puerto Rico, or the U.S. Virgin Islands
and if the value exceeds:


$1,999.99 CAD



$999.99 USD



$0.00 for any other currency type

Note: The B13A Authorization Code, if submitted, prints on the international shipping label.

Required elements for the B13A export declaration are provided in the ShipService WSDL:
Table 139. B13A Elements
Element

Description

ExportDetail/B13AFilingOption

Required for all FedEx Express® International shipments
outbound from Canada that are not destined to the United
States, U.S. Virgin Islands, or Puerto Rico.
Valid values:

FedEx Web Services, Developer Guide 2016



FEDEX_TO_STAMP



FILED_ELECTRONICALLY



MANUALLY_ATTACHED

334

International Shipping
Element

Description


NOT_REQUIRED



SUMMARY_REPORTING

Note: If MANUALLY_ATTACHED is specified, your manually filed
B13A must be time and date stamped at a Canada Customs
office before you ship. The shipment-status tracking number
must be indicated on the stamped B13A. One original copy
of the stamped B13A must be attached to the shipping
documentation. You are not required to enter the 21character B13A transaction number at the time of shipping.
If FILED_ELECTRONICALLY is specified, your B13A
authorization code must be obtained by submitting your
B13A information using the CAED software. To add the
required shipment-status tracking number to your B13A
declaration, return to the CAED software after you create
your shipping label and update your original B13A declaration
with this information.

ExportDetail/ExportComplianceStatement

General field for exporting country-specific data (such as
B13A for CA, FTSR Exemption or AES Citation for US).

ExportDetail/PermitNumber

If you enter NOT_REQUIRED as the B13AFilingOption,
you may enter a Canada export permit number as well
(optional).

ExportDetail/DestinationControlDetail

Department of Commerce/Department of State
information about this shipment.

18.8 Electronic Export Information
The Electronic Export Information (EEI) is the equivalent electronic version of the Shipper’s Export
Declaration (SED), Department of Commerce (Census Bureau) form 7525-V, which can no longer be
submitted to the U.S. government (as of September 30, 2008). The EEI provides export statistics and
control by reporting all pertinent export data of an international shipment transaction.
The EEI is required by the U.S. Department of Census to obtain statistical data and also by the Bureau of
Industry and Security (BIS) to assist in enforcing export controls. The EEI is required when the total value
of goods classified under any Schedule B number exceeds $2500 USD or the commodities listed require
an export license. This information is mandatory and must be submitted electronically by the exporter or
agent through the Automated Export System (AES) for commodities listed on the Commerce Control List
(CCL).
The EEI is not required for shipments from the U.S. to Canada unless the merchandise is subject to
International Traffic in Arms Regulations (ITAR) or requires an export license or permit. An EEI is not
required for shipment to other U.S. possessions (American Samoa, Baker Island, Commonwealth or the
Northern Mariana Islands, Guam, Howland Islands, Jarvis Island, Johnston Atoll, Kingmen Reef, Midway
Islands, Navassa Island, Palmyra Atoll, and Wake Island) or from the U.S. Virgin Islands to the U.S. or
Puerto Rico.

FedEx Web Services, Developer Guide 2016

335

International Shipping

18.8.1 Where to File
File your EEI information with AESDirect at www.aesdirect.gov because of U.S.Government changes in
the EEI process. This Government-supported website facilitates your filing requirements and provides
you with the appropriate shipper identification for your packages. FedEx will apply this information with
your shipment but will no longer file this information for you.
For more information regarding EEI filing, the following locations are available:


FedEx International Shipping page: fedex.com/us/international



FedEx Global Trade Manager: fedex.com/GTM



AESDirect: www.aesdirect.gov



U.S.Census Bureau: www.census.gov/foreign-trade/

18.8.2 When to File
File an EEI for all shipments from the U.S., Puerto Rico or the U.S. Virgin Islands to foreign destinations.
It is also required for all shipments between the U.S. and Puerto Rico, and from the U.S. or Puerto Rico
to the U.S. Virgin Islands if any of the following apply:


Shipment of merchandise under the same Schedule B commodity number is valued at more than
$2,500 USD and is sent from the same exporter to the same recipient on the same day.

Note: Shipments to Canada from the U.S. are exempt from this requirement



The shipment contains merchandise, regardless of value, that requires an export license or permit.



The merchandise is subject to International Traffic in Arms Regulations (ITAR), regardless of value.



The shipment, regardless of value, is being sent to Cuba, Iran, North Korea, Sudan or Syria.



The shipment contains rough diamonds, regardless of value (HTS 7102.10, 7102.21 and 7102.31).

An EEI is not required for shipments to other U.S. territories (American Samoa, Commonwealth of the
Northern Mariana Islands, Guam, Howland Islands and Wake Island) or from the U.S. Virgin Islands to the
U.S. or Puerto Rico.

18.8.3 U.S. to Canada
The EEI is not required for shipments from the U.S. to Canada except when one of the following apply:


Merchandise is subject to International Traffic in Arms Regulations (ITAR)



Shipment requires an export license or permit



Shipped commodity is rough diamonds.

For more information about Electronic Export Information, go to the FedEx Global Trade Manager site at
fedex.com/GTM.

18.8.4 Information for the EEI
Identify the following information before you complete the Electronic Export Information.


USPPI EIN and ID — if the shipper is a corporation, you’ll need the EIN Employer Identification
Number (Tax ID) of the U.S. principal party in interest. If the shipper is an individual, you’ll need the
person’s social security number.

FedEx Web Services, Developer Guide 2016

336

International Shipping


Information about the relationship of parties to the transaction is required. This information indicates
whether the sender and recipient are subsidiaries or divisions of the same company or are unrelated.



Transportation Reference No. — requires that you supply your FedEx International Air Waybill
number.



Ultimate Consignee — identify the end user of the merchandise you are shipping only if the ultimate
consignee is different from the consignee you entered on your FedEx International Air Waybill.



Country of Ultimate Destination — indicate the country where the shipment will ultimately be used.



D/F/ or M (Domestic or Foreign in AES) — indicate if the commodity was made or manufactured in
the U.S. (D=domestic) or made or manufactured outside the U.S. (F=foreign).



Schedule B Number (Commodity Classification Number in AES) — enter the correct Schedule B or
Harmonized Code number and units. To find this information, go to the FedEx Global Trade Manager
site on fedex.com/gtm or call the U.S. Census Bureau at 1.800.549.0595.



Value — enter the selling price or cost of the merchandise if it has not been sold.



License No./License Exception Symbol/Authorization (License Number/Citation in AES) — enter your
export license number or license exception symbol. To determine if you need to supply this
information, call the U.S. Department of Commerce at 1.202.482.4811 or 1.714.660.0144 in Newport
Beach, California or go to the Bureau of Industry and Security website at www.bis.doc.gov/.

18.8.5 Electronic Export Information Coding Details
Electronic Export Information (EEI) shipments require either an exemption number or an ITN number
(Internal Transaction Number) received from filing your EEI shipment data with AESDirect (go to
www.aesdirect.gov to use this application). Elements for submitting your ITN or EEI exemption number
to FedEx are provided in the ShipService WSDL.
Table 140. ITN or EEI Exemption Number Elements
Element

Description

Sender/Tins/TinType

As the shipper, your tax identification information must be
uploaded to FedEx for EEI shipments. Specify the Employer
Identification Number (EIN).
Valid values:

Sender/Tins/Number



BUSINESS_NATIONAL



BUSINESS_STATE



BUSINESS_UNION



PERSONAL_NATIONAL



PERSONAL_STATE

Specify the Taxpayer Identification/Number with the
corresponding ID number for TinType.

FedEx Web Services, Developer Guide 2016

337

International Shipping

Element

Description

CustomsClearanceDetail/ExportDetail/
ExportComplianceStatement

For shipments requiring an EEI, enter the ITN number
received from AES when you filed your shipment or the FTR
(Foreign Trade Regulations) exemption number.
The proper format for an ITN number is AES
XYYYYMMDDNNNNNN where YYYYMMDD is date and
NNNNNN are numbers generated by the AES.

Note: The ITN or FTR exemption number you submit in the Ship request prints on the international shipping label.

18.9 Commercial Destination Control
For shipments that travel under an ITAR exemption or ITAR license outbound from the U.S., Puerto Rico,
the Virgin Islands, and all other U.S. territories to all other international destinations, the Department of
State Commercial Destination Control Statement (DCS) must be printed on your thermal or laser shipping
label, the Commercial Invoice, and any supporting export documents accompanying these shipments.
FedEx Web Services provide three elements in the ShipService WSDL for you to have the appropriate
DCS on your shipping label.

18.9.1 Commercial Destination Control Service Details
There are two types of Department of State shipments:
1. Exempt: Department of State exempt statements are allowed for all FedEx international services
except FedEx International Ground® shipments to Canada.
2. Licensable: Licensable Department of State shipments are allowed for FedEx International Priority®
and FedEx International Priority® Freight services only.
Note: Shipments from the U.S., Puerto Rico, or the U.S. Virgin Islands to Guam, American Samoa, or Northern
Mariana Islands are excluded from this requirement.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

18.9.2 Commercial Destination Control Coding Details
Required elements for printing the Commerce Destination Control Statement on your shipping label are
provided in the ShipService WSDL:
Table 141. Commerce Destination Control Statement Elements
Element

Description

CustomsClearanceDetail/ExportDetail/
DestinationControlDetail/StatementTypes

Optional
Values are:

FedEx Web Services, Developer Guide 2016



DEPARTMENT_OF_COMMERCE



DEPARTMENT_OF_STATE

338

International Shipping
Element

Description

CustomsClearanceDetail/ExportDetail
/DestinationControlDetail/DestinationCountries

Optional / Required if StatementType is
DEPARTMENT_OF_STATE
Specify DCS shipment destination country. You may
enter up to four country codes in this element. Up to
11 alphanumeric characters are allowed.
See Appendix A: Country Code Tables section of
Web Services Developer Guide for a list of countries.

CustomsClearanceDetail/ExportDetail/
DestinationControlDetail/EndUser

Optional / Required if StatementType is
DEPARTMENT_OF_STATE
Specify the End-user name.

FedEx Web Services, Developer Guide 2016

339

Locations Service

19 Locations Service
The Locations Service WSDL searches for, and returns, the addresses of the nearest FedEx package
drop-off locations, including FedEx Office® Print and Ship Center, Drop Box and Ship and Get Locker
locations.
Use the Locations Service WSDL to request FedEx locations available for FedEx Express® and FedEx
Ground® package drop-off. This transaction searches for and returns the addresses of the nearest FedEx
location. You can also use the Locations service to find FedEx locations that provide Hold at FedEx
Location service.

19.1 Locations Service Details
The Locations Service lets you search for FedEx drop-off locations by address, geographic coordinates, or
phone number.
You can also narrow your search by type of location. One, multiple, or all types of the FedEx locations
listed may be specified in the search request:


FedEx Authorized ShipCenter® locations: Access the FedEx transportation network at over 5,800
independently owned and operated pack and ship locations across the U.S. Stores participating in the
FedEx Authorized ShipCenter program also provide other business services. FedEx Authorized
ShipCenter locations may apply additional charges to the FedEx published rates.



Express Station



Office Location



Self Service Location: Drop off FedEx Express packages (up to 20" x 12" x 6") at a FedEx Express ®
Drop Box. Drop boxes cannot be used for FedEx Ground packages or dangerous goods shipments.



The following Hold-At-Location location types are supported:
o
o
o
o

Drop Box – For FedEx Express packages
Ship and Get Lockers – FedEx Ground and Express packages
Office – FedEx Express and Ground packages
Express Stations – Only Express packages

Additionally, the search request supports an attribute to specify that the locations support FedEx Express
or FedEx Ground Redirect to Hold capability and attributes to specify specific capabilities at the location
such as Accepts Cash, Dangerous Goods Service, Ground Dropoff Service, Home Delivery Dropoff
Service, Open 24 Hours, Returns Services, Same Day City Dropoffs and so on.
The Search Locations Request will also provide a map URL for the locations returned. In addition to the
locations address, the search reply will also return normal hours of operation, exception hours of
operation, location contact information (when available: phone number, fax number, email address),
accepted currency and location holidays for the locations that met the criteria specified in the request.
You may also narrow your search by the following:


Saturday Service available



Packing Service available (most FedEx Office locations): FedEx will pack your shipment for you (at an
extra charge).

FedEx Web Services, Developer Guide 2016

340

Locations Service


Packing Supplies available (anywhere FedEx Express packing materials are supplied; does not include
FedEx Ground materials).



Latest Express drop-off locations: Returns locations with the latest drop-off time near you.



Express drop-off after: Drop a package off after a specific time, such as 5 p.m. Use this element to
search for drop-off locations open after 5 p.m.

Note: The Locations Service WSDL returns up to 25 locations within a 50-mile radius of your address.

19.2 Location Request Coding Details
In addition to the basic request elements required for all transactions as described in the Introduction, the
following elements are available when coding a FedExSearchLocationsRequest:

19.2.1 Search Locations Request Elements
Table 142. SearchLocationsRequest Elements
Element

Description

EffectiveDate

The date.

LocationsSearchCriterion

Required
Specify the criterion that may be used to search for FedEx
locations.
Valid values:


ADDRESS



GEOGRAPHIC_COORDINATES



PHONE_NUMBER

Address

Required
Descriptive data for a physical location. May be used as an actual
physical address (place to which one could go), or as a container of
"address parts" which should be handled as a unit (such as a citystate-ZIP combination within the U.S.).

Address/StreetLines

Combination of number, street name, etc. At least one line is
required for a valid physical address; empty lines should not be
included.

Address/City

Name of city, town, etc.

Address/StateOrProvinceCode

Identifying abbreviations for U.S. state, Canada province, etc.
Format and presence of this element will vary, depending on
country.

Address/PostalCode

Identification of a region (usually small) for mail/package delivery.
Format and presence of this element will vary, depending on
country.

Address/UrbanizationCode

Relevant only to addresses in Puerto Rico.

Address/CountryCode

Required

FedEx Web Services, Developer Guide 2016

341

Locations Service

Element

Description
The two-letter code used to identify a country. Required when
searching by any of the LocationsSearchCriterion, even
PhoneNumber and GeographicCoordinates.

Address/CountryName

The fully spelled out name of a country.

Address/Residential

Indicates whether this address is residential (as opposed to
commercial).

PhoneNumber

Identifies the phone number associated with this contact if the
search criterion is PHONE_NUMBER. Numeric value only, for
example 9015551234. Mobile numbers will not return results.

GeographicCoordinates

Geographic coordinates if the search criterion is
GEOGRAPHIC_COORDINATES. ISO 6709 format, for example
+40.75-074.00/

MultipleMatchesAction

Specify the criterion to be used to return location results when
there are multiple matches. Valid values are:


RETURN_ALL



RETURN_ERROR



RETURN_FIRST

SortDetail

Specify the details on how the location search results will be
sorted in the reply.

SortDetail/Criterion

Specify the criterion to be used to sort the location details. Valid
values are:

SortDetail/Order



DISTANCE



LATEST_EXPRESS_DROPOFF_TIME



LATEST_GROUND_DROPOFF_TIME



LOCATION_TYPE

Specify the sort order of the location details.
Valid values:


HIGHEST_TO_LOWEST



LOWEST_TO_HIGHEST

RequestedReservationDetail

You can check for Ship and Get locker availability for redirect to
Hold of the tracking number identified in the reservation detail.

RequestedReservationDetail/
UniqueTrackingNumber/
TrackingNumber

Search for RTH to a Ship and Get Locker can be requested by
populating this element.

Constraints

Note: You should populate this element in the ReservationDetail in order to
correctly identify the shipment.

Constraints to be applied to location attributes.

FedEx Web Services, Developer Guide 2016

342

Locations Service

Element

Description

Constraints/RadiusDistance

Specify the value and units of the radius around the address to
search for FedEx locations.

Constraints/RadiusDistance/Value

Identifies the maximum distance to return locations for.

Constraints/RadiusDistance/Units

Identifies the unit of measure for the distance value.
Valid values:




Constraints/
ExpressDropOffTimeNeeded

The latest time at which the customer can drop off a package for
being shipped using an Express service.

Constraints/ResultsFilters

Specify the criteria used to filter the results of locations searched.
valid value:

Constraints/
SupportedRedirectToHoldServices



EXCLUDE_LOCATIONS_OUTSIDE_STATE_OR_PROVINCE



EXCLUDE_LOCATIONS_OUTSIDE_COUNTRY

Specify the types of services supported by a FedEx location for
redirect to hold.
Valid values:


FEDEX_EXPRESS



FEDEX_GROUND



FEDEX_GROUND_HOME_DELIVERY

Note: Ship and Get locations can support any of these 3 redirect –to-hold
services (as defined in the FedEx enterprise).

Constraints/
RequiredLocationAttributes

The location attributes Locations Service uses to filter by. If more
than one value is specified, only those locations that have all the
specified attributes will be returned.
The attributes are:


ACCEPTS_CASH



ALREADY_OPEN



COPY_AND_PRINT_SERVICES



DANGEROUS_GOODS_SERVICES



DIRECT_MAIL_SERVICES



EXPRESS_FREIGHT_DROPOFFS



EXPRESS_PARCEL_DROPOFFS



FEDEX_FREIGHT_DROPOFFS



GROUND_DROPOFFS



GROUND_HOME_DELIVERY_DROPOFFS



LOCATION_IS_IN_AIRPORT

FedEx Web Services, Developer Guide 2016

343

Locations Service

Element

Description


NOTARY_SERVICES



OBSERVES_DAY_LIGHT_SAVING_TIMES



OPEN_TWENTY_FOUR_HOURS



PACKAGING_SUPPLIES



PACK_AND_SHIP



PASSPORT_PHOTO_SERVICES



RETURNS_SERVICES



SATURDAY_DROPOFFS



SATURDAY_EXPRESS_HOLD_AT_LOCATION



SIGNS_AND_BANNERS_SERVICE



SONY_PICTURE_STATION



VIDEO_CONFERENCING



WEEKDAY_EXPRESS_HOLD_AT_LOCATION



WEEKDAY_GROUND_HOLD_AT_LOCATION



SAME_DAY_DROPOFFS



SAME_DAY_CITY_DROPOFFS



DROP_BOX



SHIP_AND_GET



CLEARANCE_SERVICES



DOMESTIC_SHIPPING_SERVICES



INTERNATIONAL_SHIPPING_SERVICES

Constraints/ResultsToSkip

A positive number indicating the number of results to skip.

Constraints/ResultsRequested

A positive number indicating the number of results requested.

Constraints/
LocationContentOptions

Specify the options provided for the location.
Valid values:

Constraints/
LocationTypesToInclude



HOLIDAYS



LOCATION_DROPOFF_TIMES



MAP_URL

Specify the type of FedEx facility to include.
Valid values:


FEDEX_FACILITY



FEDEX_FREIGHT_SERVICE_CENTER



FEDEX_GROUND_TERMINAL

FedEx Web Services, Developer Guide 2016

344

Locations Service

Element

Description


FEDEX_HOME_DELIVERY_STATION



FEDEX_SHIPSITE



FEDEX_SMART_POST_HUB

19.2.2 Search Locations Reply Elements
Successful reply data (based on your search criteria) are returned in a SearchLocationsReply:
Table 143. SearchLocationsReply Elements
Element

Description

TotalResultsAvailable

Specify total number of location results that are available.

ResultsReturned

Specify the number of location results returned in this reply.

FormattedAddress

Specify the address formatted to have correct postal code
per USPS standards.

AddressToLocationRelationship

The details about the relationship between the address
requested and the locations returned.

AddressToLocationRelationship
/MatchedAddress

Address as provided in the request.

AddressToLocationRelationship
/MatchedAddressGeographicCoordinates

Specify the geographic coordinates for the matched
address.

AddressToLocationRelationship/
DistanceAndLocationDetails

Specify the distance between the matched address and the
addresses of matched FedEx locations. Also Specify the
details of the FedEx locations.

AddressToLocationRelationship
/DistanceAndLocationDetails
/LocationDetail
/ClearanceLocationDetail

Provides Details about the clearance location.
Valid values:

AddressToLocationRelationship
/DistanceAndLocationDetails
/LocationDetail
/ClearanceLocationDetail

FedEx Web Services, Developer Guide 2016



servicesSupported



consolidationType



clearanceLocationType



specialServicesSupported



clearanceCountries



clearanceRoutingCode

Specify the point of clearance details:


DESTINATION_COUNTRY_CLEARANCE - Specify that
the point of clearance is only for the destination
country.
345

Locations Service

Element
/DistributionClearanceType

AddressToLocationRelationship
/DistanceAndLocationDetails
/LocationDetail
/ClearanceCountryDetail

AddressToLocationRelationship
/DistanceAndLocationDetails
/LocationDetail
/ClearanceCountryDetail
/PackageSpecialServiceType

AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/Attributes

FedEx Web Services, Developer Guide 2016

Description


SINGLE_POINT_OF_CLEARANCE - Indicates that
there is single point of clearance.

Specify the special services supported at the clearance
location for an individual destination country.
Valid values:


clearanceCountry



specialServicesSupported

Package Special Service types.
Valid values:


ALCOHOL



APPOINTMENT_DELIVERY



COD



DANGEROUS_GOODS



DRY_ICE



NON_STANDARD_CONTAINER



PIECE_COUNT_VERIFICATION



PRIORITY_ALERT



SIGNATURE_OPTION

The location attributes Locations Service uses to filter by. If
more than one value is specified, only those locations that
have all the specified attributes will be returned.
The attributes are:


ACCEPTS_CASH



ALREADY_OPEN



CLEARANCE_SERVICES



COPY_AND_PRINT_SERVICES



DANGEROUS_GOODS_SERVICES



DIRECT_MAIL_SERVICES



DOMESTIC_SHIPPING_SERVICES



DROP_BOX



EXPRESS_FREIGHT_DROPOFFS



EXPRESS_PARCEL_DROPOFFS



FEDEX_FREIGHT_DROPOFFS



GROUND_DROPOFFS

346

Locations Service

Element

AddressToLocationRelationships/
DistanceAndLocationDetails/
LocationDetail
/CarrierDetails

Description


GROUND_HOME_DELIVERY_DROPOFFS



INTERNATIONAL_SHIPPING_SERVICES



LOCATION_IS_IN_AIRPORT



NOTARY_SERVICES



OBSERVES_DAY_LIGHT_SAVING_TIMES



OPEN_TWENTY_FOUR_HOURS



PACKAGING_SUPPLIES



PACK_AND_SHIP



PASSPORT_PHOTO_SERVICES



RETURNS_SERVICES



SAME_DAY_CITY_DROPOFFS



SAME_DAY_DROPOFFS



SATURDAY_DROPOFFS



SATURDAY_EXPRESS_HOLD_AT_LOCATION



SHIP_AND_GET



SIGNS_AND_BANNERS_SERVICE



SONY_PICTURE_STATION



VIDEO_CONFERENCING



WEEKDAY_EXPRESS_HOLD_AT_LOCATION



WEEKDAY_GROUND_HOLD_AT_LOCATION

New ServiceType supports the following values:


SAME_DAY



SAME_DAY

SearchLocationsReply
/AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/CarrierDetails
/NormalLatestDropOffDetails
/Overlays
/Type

Valid value: US_WEST_COAST

SearchLocationsReply
/AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/CarrierDetails

Valid value: US_WEST_COAST

FedEx Web Services, Developer Guide 2016

347

Locations Service

Element

Description

/ExceptionalLatestDropOffDetails
/Overlays
/Type
SearchLocationsReply
/AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/CarrierDetails
/EffectiveLatestDropOffDetails
/Overlays
/Type

Valid value: US_WEST_COAST

SearchLocationsReply
/AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/CarrierDetails
/CountryRelationship

Valid values:

AddressToLocationRelationships/
DistanceAndLocationDetails
/LocationDetail
/LocationContactAndAddress
/AddressAncillaryDetail



DOMESTIC



INTERNATIONAL

Additional information about a physical location.

AddressToLocationRelationships
/DistanceAndLocationDetails
/LocationDetail
/LocationContactAndAddress
/Contact
/PhoneNumber

Identifies the phone number associated with this location.
Phone numbers will not be returned for Express Stations
at this point.

SearchLocationsReply
/AddressToLocationRelationships
/DistanceAndLocationDetails
/SupportedRedirectToHoldServices

Specify the types of services supported by a FedEx
location for redirect to hold.
Valid values:

Example 30:



FEDEX_EXPRESS



FEDEX_GROUND



FEDEX_GROUND_HOME_DELIVERY

SearchLocationsRequest

xxxxxxxxxx

FedEx Web Services, Developer Guide 2016

348

Locations Service

XXXX
XXX
XX

locs
1
0
0

YYYY-MM-DD
GEOGRAPHIC_COORDINATES

XXXX

XX
0

XXXX
RETURN_ALL

DISTANCE
LOWEST_TO_HIGHEST

10.0
KM

FedEx Web Services, Developer Guide 2016

349

Locations Service

19.3 UK/GB Locations Support
Customers can identify if UK/GB locations support domestic and/or international shipping using the
following attributes:


INTERNATIONAL_SHIPPING_SERVICES



DOMESTIC_SHIPPING_SERVICES

Note: The above attributes are supported only for UK/GB, but will be expanded to other countries in the future.
These attributes, are ignored if received on a SearchLocations request for any countries other than UK/GB.

If a SearchLocation is requested for any other countries, the error “The location attributes (attr 1 - attrN)
are invalid for {COUNTRY_NAME}” will be returned. If domestic and/or international cutoff times exist for
a UK location, both sets of cutoff times will be returned in the SearchLocations Reply. They will be
differentiated by CarrierDetail/CountryRelationshipType = DOMESTIC or INTERNATIONAL.
Definitions for reply elements:


NormalLatestDropOffDetails means ordinary/normal



ExceptionalLatestDropOffDetails means an exception to the ordinary/normal



EffectiveLatestDropOffDetails takes precedence and reflects current hours

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

FedEx Web Services, Developer Guide 2016

350

Open Shipping

20 Open Shipping
Open Shipping is a highly flexible feature that allows you to create and enter information for a shipment
as it is received throughout the day, rather than entering all of the shipping information only when the
shipment is ready to be processed. The shipment remains “open” for a five-day period and accepts
package additions, deletions or edits during that time. At the end of five days, the shipment must be
confirmed or it will be purged.
Open Ship shipments are often multiple-piece shipments but can also be shipments that contain single
packages, referred to as single-piece shipments.
Note: Open Shipping is limited to 40 packages per shipment.

You may use the OpenShipService WSDL to create an open shipment and add packages to the shipment
over a period of time. This gives you a flexible way to prepare your shipment throughout the day until you
are ready to ship.
This chapter describes the procedure for creating, modifying and deleting an Open Ship shipment using
Web Services and the OpenShip WSDL.

20.1 FedEx Services with Open Ship
You can use the Open Ship shipping method for the following FedEx services:


FedEx Express® intra-U.S. and intra-Canada



FedEx Ground® intra-U.S. and intra-Canada



FedEx Home Delivery®



FedEx SmartPost®



FedEx International Priority ®



FedEx International Priority ® Freight



FedEx International Economy®

Note: You may also use the Open Ship method for Consolidation Services. Refer to Consolidation Services section of
Ship Service for more information. For FedEx SmartPost openship shipments, the confirm action is required
while creating that openship shipment.

20.2 Open Ship Process and Workflow
You can use Open Shipping to create a regular open shipment. An Open Ship shipment typically requires
multiple transactions: one to CREATE the open shipment, one or more to ADD or MODIFY the packages
in the shipment, and one to CONFIRM the open shipment. The table below illustrates the basic work
flow for processing an Open Ship shipment, unless the CONFIRM action type is used.
Table 144. Open Ship Creation
Workflow Item

Description

1. CREATE
Shipment

To CREATE a shipment requires the CreateOpenShipmentRequest transaction
with required shipment information and at least one package defined (Action

FedEx Web Services, Developer Guide 2016

351

Open Shipping

Workflow Item

Description
type = CREATE_PACKAGE or RequestedPackageLineItems information) in the
request for a tracking number to be returned.
A tracking number for the shipment is assigned but no labels are printed for the
Open Ship CREATE shipment transaction.

2 - 4. ADD Piece*
Packages are processed individually by sending an
*not to exceed 40
AddPackagesToOpenShipmentRequest transaction. A unique tracking number
pieces per shipment is returned for each piece (aka package) processed.
Note: Though you can choose to process one package at a time, you can also create and
confirm an openshiment with many packages in one transaction.

5. CONFIRM
Shipment

To CONFIRM the shipment, send the ConfirmOpenShipmentRequest, or use
the CONFIRM action type.
You must ADD a minimum of 1 (one) piece before you can CONFIRM an Open
Ship shipment.
Package labels and all other reports are returned in the CONFIRM shipment
response.

20.3 About Web Services Open Ship Transactions
Open Ship transactions consist of seven steps that perform these functions:
1. CREATE shipment.
2. ADD packages.
3. DELETE packages or MODIFY information about them (optional).
4. MODIFY information about the shipment (optional). You can MODIFY information either for a
package or a shipment, but you must select the correct element depending on what you want to do.
5. CONFIRM shipment.
6. VALIDATE shipment.
7. RETRIEVE package and/or RETRIEVE shipment.

20.3.1 Rules for Open Ship Transactions
Use the OpenShipService WSDL when you want to add multiple packages to a shipment over a period of
time but do not know how many packages you plan to add or when the shipment will be complete.
Using Open Ship gives you the flexibility to create the shipment first and add packages as needed. Read
the rules for Open Ship transactions carefully.
Important: You must complete an Open Ship shipment within five (5) days after the CREATE transaction.
After five (5) days, the entire shipment is deleted.
The following rules apply to Open Ship transactions:


You can use some of the Open Ship operations with each other. For example, you can CREATE a
shipment and CONFIRM the shipment with one transaction (assuming all required information to
ship a package is received), or even MODIFY data, ADD a package, and CONFIRM.



You have 5 days to CONFIRM an Open Ship shipment after a Close (End-of-Day) transaction. After
the 5th day, the entire shipment is deleted if you do not CONFIRM the shipment. Also, if you do not
CONFIRM a shipment on the same day when you CREATE it, or if a Future Day ship date is not

FedEx Web Services, Developer Guide 2016

352

Open Shipping
specified during the CREATE transaction, then you must change the Ship Date to the current day or
later.
Note: The Close is applicable for FedEx Ground and FedEx SmartPost shipments. FedEx Express shipments are
automatically closed and do not require a specific close operation.



To ship a multiple-piece shipment (MPS) to a single consignee, use Open Ship to ADD individual
packages to the shipment Or add multiple packages to the initial CREATE transaction if they are
going to the same recipient.



An Open Ship shipment must have at least one package at all times prior to CONFIRM. If a package
is confirmed and is the only package in the shipment, the entire shipment is confirmed and you
cannot add any more packages to the shipment.

20.4 Create Open Shipment
Use the Create Open Shipment transaction to CREATE Open Ship shipments.
1. Create the shipment by coding a transaction string that includes CreateOpenShipmentRequest
package(s) or as part of a Consolidation that has already been created. See Consolidated Shipping.
2. Define the first package during the CreateOpenShipment transaction using CREATE_PACKAGE or
send the RequestedPackageLineItems information in the CreateOpenShipmentRequest. The
CREATE_PACKAGE provides a package tracking number without providing package information. Add
detailed package information using the ModifyPackageInOpenShipment transaction prior to shipment
CONFIRM.
3. When you create an Open Ship shipment, send all common shipment level information in the original
CreateOpenShipment transaction. Next, add information unique to each package with every new
AddPackageToOpenShipment transaction. This method eliminates duplication of existing data and
increases the processing speed of the transaction. Add the first package during the
CreateOpenShipment transaction.
4. After you CREATE a shipment, you can ADD one or more packages in additional transaction strings
and continue to modify the shipment until you are ready to CONFIRM and ship.
5. There are validation actions to be taken as part of processing CreateOpenShipment,
AddPackageToOpenShipment, ModifyOpenShipment and ModifyPackageInOpenShipment
transactions, either STRONG_VALIDATION, WEAK_VALIDATION, or CONFIRM Shipment.
a.

Strong validation – Full shipment edits: any edit that fails will cause the transaction to fail. If the
transaction is successful, a tracking number may be returned and the transaction will be saved to
the database (committed).
b. Weak validation - Full shipment edits: any edit that fails will return errors but the transaction does
not fail. The tracking number is returned and the transaction is saved in the database if the core
edits are passed. Fix errors with the ModifyRequests transaction using the Index and returned
tracking number.
c. No validation specified – Default behavior is that core shipment edits are applied, which is the
basic set of edits, the tracking number is returned if core edits are passed, and the record is
saved to the database.
Note: Use caution when using the Weak or No validation. The shipment and package information must pass strong
edits before the open shipment can be confirmed.

6. Ensure the RequestedShipment object is included with at least one RequestedPackageLineItem
defined, as described in this table.
FedEx Web Services, Developer Guide 2016

353

Open Shipping
Table 145. Create Open Shipment Request
Element ID

Multiple
Occurrence

Description

AsynchronousProcessing
Options

Optional
This is used to specify processing options related to
synchronous or asynchronous processing.

AsynchronousProcessing
Options/ Options

Yes

Describes the type of options available.
Valid values are:


ALLOW_ASYNCHRONOUS (Recommended)



ASYNCHRONOUS_ONLY



SYNCHRONOUS_ONLY (Default)

Index

Optional
Customer-assigned identifier for this shipment, which
must be unique for stand-alone open shipments.

ConsolidationKey

Optional
If provided, identifies the consolidation to which this
open shipment should be added after successful
creation.

Actions

Yes

Optional
Specify the optional actions to be performed during
the creation of this open shipment.
Valid values are:

RequestedShipment

RequestedShipment/
ConsolidationDetail/
InternationalDistribution
Detail
/SummaryDetail/
DryIceDetail
RequestedShipment/
ShipTimestamp



CONFIRM



CREATE_PACKAGE



STRONG_VALIDATION



WEAK_VALIDATION



TRANSFER

Required
The descriptive data for the shipment being tendered
to FedEx.
Shipment-level totals of dry ice data across all
packages.

FedEx Web Services, Developer Guide 2016

Required
Identifies the date and time the package is tendered
to FedEx.

354

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/
DropoffType

Optional
Identifies the method by which the package is to be
tendered to FedEx. This element does not dispatch a
courier for package pickup.

RequestedShipment/
ServiceType

Required
Identifies the FedEx service to use in shipping the
package.

RequestedShipment/
PackagingType

Required
Identifies the packaging used by the requestor for the
package.

RequestedShipment/
TotalWeight

Optional
The total weight of the shipment.

RequestedShipment/
TotalInsuredValue

Optional
The total amount the shipment is insured for.

RequestedShipment/
TotalDimensions

RequestedShipment/
PreferredCurrency

Optional
This attribute indicates the currency the caller
requests to have used in all returned monetary values
(when a choice is possible).

RequestedShipment/Shipper

Required
Descriptive data identifying the party responsible for
shipping the package.

RequestedShipment/
Recipient

Required
Descriptive data identifying the party receiving the
package.

RequestedShipment/
RecipientLocationNumber

Optional
A unique identifier for a recipient location.

RequestedShipment/Origin

Optional
Physical starting address for the shipment, if different
from shipper's address.

RequestedShipment/SoldTo

Indicates the party responsible for purchasing the
goods shipped from the shipper to the recipient. The
sold to party is not necessarily the recipient or the
importer of record. The sold to party is relevant when
the purchaser, rather than the recipient determines
when certain customs regulations apply.

FedEx Web Services, Developer Guide 2016

355

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment
/ShippingChargesPayment

Required
Descriptive data for the monetary compensation
given
to FedEx for services rendered to the customer.

RequestedShipment/
SpecialServicesRequested

Optional
Special services available at the shipment level for
some or all service types.

RequestedShipment/
ProcessingOptions
Requested

Optional
Specify any custom processing to be applied to this
shipment.

RequestedShipment/
ExpressFreightDetail

Optional
Data applicable to an FedEx Express Freight
shipment.

RequestedShipment/
FreightShipmentDetail

Optional
Data applicable to shipments using
FEDEX_FREIGHT_ECONOMY and
FEDEX_FREIGHT_PRIORITY services.

RequestedShipment/
ConsolidationDetail

Optional
Data applicable to shipments that are a part of a
consolidation.

RequestedShipment/
DeliveryInstructions

Optional
Used with FedEx Ground Home Delivery and FedEx
Freight.

RequestedShipment/
VariableHandling
ChargeDetail

Optional
Details about how to calculate variable handling
charges at the shipment level.

RequestedShipment/
CustomsClearanceDetail

Optional
Customs clearance data, used for both international
and intra-country shipping.

RequestedShipment/
CustomsClearanceDetail/
CustomsOptionsDetail/
CustomsOptionType

FedEx Web Services, Developer Guide 2016

Specify the reason for a global return, as recognized
by Customs.
Valid values are:


COURTESY_RETURN_LABEL: For the outbound
courtesy return label.



EXHIBITION_TRADE_SHOW: For exhibition or
trade-show, outbound and inbound.



FAULTY_ITEM: For faulty item being returned,
inbound only.



FOLLOWING_REPAIR: For repaired or
processed item being sent, outbound only.

356

Open Shipping
Element ID

Multiple
Occurrence

Description



FOR_REPAIR: For repair or processing,
outbound and inbound.



ITEM_FOR_LOAN: For loan item, outbound and
inbound.



OTHER: Other reason, outbound and inbound.
This type requires a description.



REJECTED: For rejected merchandise being
returned, inbound.



REPLACEMENT: For replacement being sent,
outbound only.



TRIAL: For use in a trial, outbound and inbound.

RequestedShipment/
PickupDetail

Optional
The pickup characteristics of a shipment (e.g. for use
in a tag request).

RequestedShipment/
SmartPostDetail

Optional
Specify the characteristics of a shipment pertaining to
FedEx SmartPost services.

RequestedShipment/
BlockInsightVisibility

Optional
If true, only the shipper/payor will have visibility of
this shipment.

RequestedShipment/
ShippingDocument
Specification
/FreightAddressLabelDetail/
DocTabContent/
DocTabContentType

RequestedShipment/
LabelSpecification/
CustomerSpecified
LabelDetail
/LabelMaskableDataType

FedEx Web Services, Developer Guide 2016

Valid values are:


BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001

Names of data elements/areas which may be
suppressed from printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUM
BER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACCO
UNT_NUMBER
357

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/
LabelSpecification

Required
Descriptive data identifying the party responsible for
shipping the package.

RequestedShipment/
LabelSpecification/
LabelFormatType

Yes

Required
Specify the type of label to be returned.

RequestedShipment
/LabelSpecification
/ImageType

Optional
Specify the image format used for a shipping
document.

RequestedShipment/
LabelSpecification/
LabelStockType

Optional
For thermal printer labels this indicates the size of the
label and the location of the doc tab if present.
Valid values are:

RequestedShipment/
ShippingDocument
Specification



PAPER_4X6



PAPER_4X8



PAPER_4X9



PAPER_7X4.75



PAPER_8.5X11_BOTTOM_HALF_LABEL



PAPER_8.5X11_TOP_HALF_LABEL



STOCK_4X6



STOCK_4X6.75_LEADING_DOC_TAB



STOCK_4X6.75_TRAILING_DOC_TAB



STOCK_4X8



STOCK_4X9_LEADING_DOC_TAB



STOCK_4X9_TRAILING_DOC_TAB

Optional
Contains data used to create additional (non-label)
shipping documents.

RequestedShipment/
ShippingDocument
Specification
/CustomDocumentDetail

Data required to produce a custom-specified
document, either at shipment or package level.

CustomDocumentDetail/
Format

Common information controlling document
production.

FedEx Web Services, Developer Guide 2016

358

Open Shipping
Element ID

Multiple
Occurrence

Description

CustomDocumentDetail/
LabelPrintingOrientation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail/
LabelRotation

Applicable only to documents produced on thermal
printers with roll stock.

CustomDocumentDetail/
SpecificationId

Identifies the formatting specification used to
construct this custom document.

CustomDocumentDetail/
CustomDocumentIdentifier

Identifies the individual document specified by the
client.

CustomDocumentDetail/
DocTabContent

If provided, thermal documents will include specified
doc tab content. If omitted, document will be
produced without doc tab content.

CustomDocumentDetail/
CustomLabelDetail

CustomLabelDetail/
CoordinateUnits

Valid values are:


MILS (thousanths of an inch)



PIXELS (device-dependent)

CustomLabelDetail/
TextEntries

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for
thermal labels) or generic font/size (for plain paper
labels).

CustomLabelDetail/
GraphicEntries

Image to be included from printer's memory, or from
a local file for offline clients.

CustomLabelDetail/
BoxEntries

Solid (filled) rectangular area on label.

CustomLabelDetail/
CustomLabelTextBoxEntry

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for
thermal labels) or generic font/size (for plain paper
labels).

CustomLabelTextBoxEntry/
TopLeftCorner

Horizontal and vertical position, relative to left edge of
custom area.

FedEx Web Services, Developer Guide 2016

359

Open Shipping
Element ID

Multiple
Occurrence

Description

CustomLabelTextBoxEntry/
BottomRightCorner

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry/
Position

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry/
Format

Format.

CustomLabelTextBoxEntry/
DataFields

Data fields.

CustomLabelTextBoxEntry/
ThermalFontId

Printer-specific font name for use with thermal printer
labels.

CustomLabelTextBoxEntry/
FontName

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry/
FontSize

Generic font size for use with plain paper labels.

CustomLabelTextBoxEntry/
Rotation

Describes the rotation of an item from its default
orientation.
Valid values are:

CustomLabelDetail/
BarcodeEntries
RequestedShipment/
RateRequestTypes

RequestedShipment
/EdtRequestType



NONE



RIGHT



UPSIDE_DOWN

Constructed string, based on format and zero or more
data fields, printed in specified barcode symbology.
Yes

FedEx Web Services, Developer Guide 2016

Optional
The RateRequestTypes field indicates the type of
rates to be returned.
Valid values is Rates that can be returned are:


LIST – Returns published rates in response



PREFERRED – Returns rates in currency
specified in the PreferredCurrency element.



NONE – Returns no rates in response.

Optional
Specify whether the customer wishes to have
Estimated Duties and Taxes provided with the rate
quotation on this shipment. Only applies with
shipments moving under international services.
360

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/
MasterTrackingId

Optional
Only used with multiple-transaction shipments to
identify the master package in a multi-piece
shipment.

RequestedShipment/
PackageCount

Required
The total number of packages in the entire shipment,
even when the shipment spans multiple transactions.
For OpenShip, this is an estimated number of
packages. The system maintains the actual count as
packages are added and removed from the OpenShip
transaction.

RequestedShipment/
ConfigurationData

Optional
Specify data structures that may be re-used multiple
times with a single shipment.

RequestedShipment/
ManifestDetail/
CustomerReferenceType
RequestedShipment/
RequestedPackageLineItems

This identifies which customer reference element is
used as the manifest ID.

Yes

One or more package-attribute descriptions, each of
which describes an individual package, a group of
identical packages, or (for the total-piece-total-weight
case) common characteristics for all packages in the
shipment.
Note: Not required for CREATE_PACKAGE Action.

Valid values include:

/RequestedShipment/
RequestedPackageLineItem/
ItemDescriptionForClearance

Requestedshipment/
RequestedPackageLineItem/
PackageSpecialServices
Requested
/DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodity
Content
/NetExplosiveDetail

FedEx Web Services, Developer Guide 2016

Weight/Units

 Weight/Value
Required for UAE; Otherwise: Optional - This element
is for the customer to describe the content of the
package for customs clearance purposes. This applies
to intra-UAE, intra-Columbia and intra-Brazil
shipments.
The total mass of the contained explosive
substances, without the mass of any casings, bullets,
shells, etc.

361

Open Shipping
Element ID

Multiple
Occurrence

Requestedshipment/
RequestedPackageLineItem/
PackageSpecialServices
Requested
/DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodity
Content/
NetExplosiveDetail/
NetExplosiveClassification
Type
RequestedShipment/
SpecialServicesRe quested/
PendingShipmentDetail/
EmailLabelDetail

Description
Valid values:

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
ProcessingOptions

RequestedShipment/
SpecialServicesRequested/
RecommendedDocument
Specification/

FedEx Web Services, Developer Guide 2016



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

Describes specific information about the email label
shipment.


Message: Content of the email message



Recipients: EMailRecipient



emailAddress - email address of the recipient



role - role type of the recipient



optionsRequested

 localization
This allows the Email Label originator to specify if the
completer can make modifications to editable
shipment data.
Valid value: ALLOW_MODIFICATIONS
Specify the details about documents that are
recommended to be included with the shipment for
ease of shipment processing and transportation.
Valid values are:


ANTIQUE_STATEMENT_EUROPEAN_UNION



ANTIQUE_STATEMENT_UNITED_STATES



ASSEMBLER_DECLARATION



BEARING_WORKSHEET



FILM_AND_VIDEO_CERTIFICATE



CERTIFICATE_OF_SHIPMENTS_TO_SYRIA



PRINTED_CIRCUIT_BOARD_WORKSHEET



COMMERCIAL_INVOICE_FOR_THE_CARIBBEA
N_COMMON_MARKET



CONIFEROUS_SOLID_WOOD_PACKAGING_M
ATERIAL_TO_THE_PEOPLES_REPUBLIC_OF_C
HINA
362

Open Shipping
Element ID

Multiple
Occurrence

Description



DECLARATION_OF_IMPORTED_ELECTRONIC_
PRODUCTS_SUBJECT_TO_RADIATION_CONTR
OL_STANDARD



DECLARATION_OF_BIOLOGICAL_STANDARDS



ELECTRONIC_INTEGRATED_CIRCUIT_WORKS
HEET



INTERIM_FOOTWEAR_INVOICE



NAFTA_CERTIFICATE_OF_ORIGIN_UNITED_ST
ATES



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_F
RENCH



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_E
NGLISH



NAFTA_CERTIFICATE_OF_ORIGIN_SPANISH



PACKING_LIST



REPAIRED_WATCH_BREAKOUT_WORKSHEET



DECLARATION_FOR_FREE_ENTRY_OF_RETUR
NED_AMERICAN_PRODUCTS



STATEMENT_REGARDING_THE_IMPORT_OF_
RADIO_FREQUENCY_DEVICES



TOXIC_SUBSTANCES_CONTROL_ACT



UNITED_STATES_WATCH_REPAIR_DECLARATI
ON



UNITED_STATES_NEW_WATCH_WORKSHEET



UNITED_STATES_CARIBBEAN_BASIN_TRADE_
PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN
_TEXTILES



RequestedShipment/
ReturnInstructionsDetail
ShippingDocumentFormat/
documentFormatOptions
requested
/Document formatOptions

FedEx Web Services, Developer Guide 2016

UNITED_STATES_CARIBBEAN_BASIN_TRADE_
PARTNERSHIP_ACT_CERTIFICATE_OF_ORIGIN
_NON_TEXTILES
Specify this value to suppress English language if
another language is specified in language code field.
(Default is English)
Valid value: SUPPRESS_ADDITIONAL_LANGUAGES

363

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/
specialServicesRequested
/EtdDetail/
UploadDocumentReference
Detail
RequestedShipment/
specialServicesRequested/
pendingShipmentDetail/
documentReferences/
documentProducer

Details for uploaded documents provided by the
shipment initiator.

Specify details for uploaded documents provided by
the shipment initiator.
Valid values:

RequestedShipment/
specialServicesRequested
/pendingShipmentDetail/
documentReferences/
documentIDProducer

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipment
Processing
OptionsRequested

FedEx Web Services, Developer Guide 2016



CUSTOMER



FEDEX_CAFE



FEDEX_CLS



FEDEX_FIDT



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM

 OTHER
Specify details for uploaded documents provided by
the shipment initiator.
Valid values:


CUSTOMER



FEDEX_CAFE



FEDEX_CSHP



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM

 FEDEX_INET
This option allows an existing SmartPost small
shipper or return shipper to specify, to have the
Ground tracking number provided in the shipment
reply. This is a contingency feature in case the
customer requires the Ground tracking number for
internal processes or for tracking SmartPost
shipments.
The Ground tracking number will only be provided for
existing SmartPost small shippers or return shippers.
Customers will have the same reporting and tracking
capabilities as today when they receive a Ground
tracking number. However, the Ground tracking
number will not be printed on the FXSP shipping
label.
364

Open Shipping
Element ID

Multiple
Occurrence

Description
fedex.comprovides the same tracking visibility for
SmartPost shipments when using either the
SmartPost tracking number or the Ground tracking
number. Fedex recommends using fedex.com, rather
than USPS.com, for all tracking activities for
SmartPost shipments.

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipment
Processing
OptionsRequested/
SmartPostShipment
Processing
OptionType

Valid values:


GROUND_TRACKING_NUMBER_REQUESTED

Table 146. CreateOpenShipmentReply
Element

Multiple
Occurrence

Description

HighestSeverity

Identifies the set of severity values for a Notification.
Valid values are:

Notifications

Yes

FedEx Web Services, Developer Guide 2016



ERROR



FAILURE



NOTE



SUCCESS



WARNING

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.

365

Open Shipping
Element

Multiple
Occurrence

Description



FAILURE — FedEx was unable to process your
transaction at this time due to a system failure.
Please try again later.

Notifications/Severity

Same as "NotificationSeverityType" above

Notifications/Source

Indicates the source of this notification. Combined with
the Code it uniquely identifies this notification.

Notifications/Code

A code that represents this notification. Combined with
the Source it uniquely identifies this notification.

Notifications/Message

Human-readable text that explains this notification.

Notifications/LocalizedMessa
ge

The translated message. The language and locale
specified in the Client detail. Localization is used to
determine the representation. Currently only supported
in a TrackReply.

Notifications/MessageParam
eters

Yes

A collection of name/value pairs that provide specific
data to help the client determine the nature of an error,
or warning, and so on without having to parse the
message string.

TransactionDetail

Descriptive data for the customer transaction. The
Transaction detail from the request is echoed back to
the caller in the corresponding reply.

Version

Identifies the version/level of a service operation
expected by a caller (in each request) and performed by
the callee (in each reply).

JobId

When a shipment is large enough to be processed
asynchronously, the reply will contain a Job ID.
Wait at least a minute and then use the
GetCreateOpenShipmentResults request with the
JobId to find out if the processing is complete and
return the label buffers and maybe paperwork.

AynchronousProcessingResu No
lts

Indicates whether the transaction was processed
synchronously or asynchronously.

ServiceType

List the type of FedEx service associated with the
shipment.

CompletedShipmentDetail

Provides Completed Shipment Details.

CompletedShipmentDetail/
CompletedPackageDetail/
CompletedHazardousPackag
eDetail/
ValidatedHazardousContainer
/ValidatedHazardousCommod
ityContent/
FedEx Web Services, Developer Guide 2016

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.

366

Open Shipping
Element

Multiple
Occurrence

Description

NetExplosiveDetail/
NetExplosiveClassificationTy
pe
Requestedshipment/
RequestedPackageLineItem/
PackageSpecialServicesRequ
ested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityConten
t/
NetExplosiveDetail/
NetExplosiveClassificationTy
pe
CompletedShipmentDetail/U
sDomestic

Valid values:



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

Indicates whether or not this is an intra-U.S. shipment.

CompletedShipmentDetail/Ca No
rrierCode

Indicates the carrier that will be used to deliver this
shipment.

CompletedShipmentDetail/
MasterTrackingId

The master tracking number and form ID of this
multiple piece shipment. This information is to be
provided for each subsequent of a multiple piece
shipment.

CompletedShipmentDetail/
ServiceTypeDescription

Description of the FedEx service used for this
shipment. Currently not supported.

CompletedShipmentDetail/
PackagingDescription

Description of the packaging used for this shipment.
Currently not supported.

CompletedShipmentDetail/
OperationalDetail

Specify shipment level operational information.

CompletedShipmentDetail/Ac Yes
cessDetail

Only used with pending shipments.

CompletedShipmentDetail/Ta No
gDetail

Only used in the reply to tag requests.
The following valid values are returned only for FedEx
Express services:

CompletedShipmentDetail/
SmartPostDetail

FedEx Web Services, Developer Guide 2016



ConfirmationNumber



AccessTime



CutoffTime



Location



DeliveryCommitment

Valid values are:

367

Open Shipping
Element

Multiple
Occurrence

Description



PickUpCarrier — Identifies the carrier that will pick
up the FedEx SmartPost shipment.



Machinable — Indicates whether the shipment is
deemed to be machinable, based on dimensions,
weight, and packaging.

CompletedShipmentDetail/
HazardousShipmentDetail

Computed shipment level information about hazardous
commodities.

CompletedShipmentDetail/
ShipmentRating

All shipment-level rating data for this shipment, which
may include data for multiple rate.

CompletedShipmentDetail/
ConsolidationDetail

Result data for a shipment within a consolidation.

CompletedShipmentDetail/
No
CompletedHoldAtLocationDe
tail

Returns the default holding location information when
HOLD_AT_LOCATION special service is requested and
the client does not specify the hold location address.
Valid values are:


HoldingLocation — Identifies the branded location
name, the hold at location phone number and the
address of the location.



HoldingLocationType — Identifies the type of
FedEx location.

CompletedShipmentDetail/
ExportComplianceStatement

Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

Valid values are:


FolderID — The identifier for all clearance
documents associated with this shipment.



UploadDocumentReferenceDetails

CompletedShipmentDetail/
ShipmentDocuments

Yes

All shipment-level shipping documents (other than
labels and barcodes).

CompletedShipmentDetail/
AssociatedShipments

Yes

The details of any associated shipments.

CompletedShipmentDetail/
PendingShipmentAccessDet
ail/
Accessor Details

Yes

Provides the ability to return multiple sets of Email label
access credentials:

FedEx Web Services, Developer Guide 2016



Role



SHIPMENT_COMPLETOR"



SHIPMENT_INITIATOR"



userId



password
368

Open Shipping
Element

Multiple
Occurrence

Description


AssociatedShipments/Type

emailLabelUrl

Describes the type of associated shipment.
Valid values:


COD_RETURN



DELIVERY_ON_INVOICE_ACCEPTANCE_
RETURN

AssociatedShipments/Sender No

The descriptive data for a person or company entity
doing business with FedEx.

AssociatedShipments/Recipi
ent

The descriptive data for a person or company entity
doing business with FedEx.

AssociatedShipments/Servic
eType

Describes the type of FedEx service.

AssociatedShipments/
PackagingType

Identifies the packaging used by the requestor for the
package. Valid values are:


FEDEX_10KG_BOX



FEDEX_25KG_BOX



FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_PAK



FEDEX_TUBE



YOUR_PACKAGING

AssociatedShipments/Trackin No
gId

Specify the tracking ID for the payment on the return.

AssociatedShipments/
CustomerReferences

Yes

Specify additional customer reference data about the
associated shipment.

AssociatedShipments/
ShipmentOperationalDetail

Specify shipment level operational information.

AssociatedShipments/
PackageOperationalDetail

Specify package level operational information on the
associated shipment. This information is not tied to an
individual outbound package.

AssociatedShipments/Label

All package-level shipping documents (other than labels
and barcodes).

CompletedShipmentDetail/
CompletedCodDetail

Specify the results of processing for the COD special
service.

CompletedShipmentDetail/
CompletedPackageDetails

Yes

Valid values:

FedEx Web Services, Developer Guide 2016



SequenceNumber

369

Open Shipping
Element

Multiple
Occurrence

Description



TrackingIds



GroupNumber — Used with request containing
PACKAGE_GROUPS, to identify which group of
identical packages was used to produce a reply
item.



OversizeClass



PackageRating — All package-level rating data for
this package, which may include data for multiple
rate types.



OperationalDetail



Label



PackageDocuments — All package-level shipping
documents (other than labels and barcodes). For
use in loads after January, 2008.



CodReturnDetail — Specifies the information
associated with this package that has COD special
service in a ground shipment.



SignatureOption — Actual signature option applied,
to allow for cases in which the original value
conflicted with other service features in the
shipment.



HazardousCommodities — Documents the kinds
and quantities of all hazardous commodities in the
current package, using updated hazardous
commodity description data.

ErrorLabels

Yes

Empty unless one or more errors occur during
transaction processing.

Index

Either the Customer-assigned identifier from the
CreateOpenShipmentRequest or the FedEx generated
index.

20.4.1 Create Pending Shipment Request
The function of creating an Email Label (including both returns and non-returns) is accomplished via the
CreatePendingShipmentRequest/Reply in the OpenShip Service WSDL. You must set several attributes
in order to distinguish it from a normal “open” shipment.
The following attributes identify an Email Return Label:


CreatePendingShipmentRequest/Actions [ ] ActionType = “TRANSFER”



CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/SpecialServiceTypes = PENDING_SHIPMENT

FedEx Web Services, Developer Guide 2016

370

Open Shipping


CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/SpecialServiceTypes = RETURN_SHIPMENT



CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = EMAIL
CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = RETURN

The following attributes identify an Email Label (non-return):


CreatePendingShipmentRequest/Actions [ ] ActionType = “TRANSFER”



CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/SpecialServiceTypes = PENDING_SHIPMENT



CreatePendingShipmentRequest
requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = EMAIL

The following elements must be included in the CreatePendingShipmentRequest:
Table 147. CreatePendingShipmentRequest
Element ID

Multiple
Occurrence

Description

AsynchronousProcessing
Options

Optional
This is used to specify processing options related to
synchronous or asynchronous processing.

AsynchronousProcessing
Options /Options

Yes

Describes the type of options available.
Valid values are:


ALLOW_ASYNCHRONOUS (Recommended)



ASYNCHRONOUS_ONLY



SYNCHRONOUS_ONLY (Default)

Index

Optional
Customer-assigned identifier for this shipment, which must
be unique for stand-alone open shipments.

ConsolidationKey

Optional
If provided, identifies the consolidation to which this open
shipment should be added after successful creation.

Actions

Yes

Optional
Specify the optional actions to be performed during the
creation of this open shipment.
Valid values are:


CONFIRM



CREATE_PACKAGE



STRONG_VALIDATION



WEAK_VALIDATION



TRANSFER

FedEx Web Services, Developer Guide 2016

371

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment

Required
The descriptive data for the shipment being tendered to
FedEx.

RequestedShipment/
ShipTimestamp

Required
ShipTimeStamp element identifies the date and time the
package is tendered to FedEx.

RequestedShipment/
DropoffType

Optional
DropoffType element identifies the method by which the
package is to be tendered to FedEx. This element does not
dispatch a courier for package pickup.

RequestedShipment/
ServiceType

Required
ServiceType element identifies the FedEx service to use in
shipping the package.

RequestedShipment/
PackagingType

Required
PackagingType element identifies the packaging used by the
requestor for the package.

RequestedShipment/
TotalWeight

Optional
The element indicates the total weight of the shipment.

RequestedShipment/
TotalInsuredValue

Optional
The element indicates the total amount the shipment is
insured for.

RequestedShipment/
TotalDimensions

Optional
The element indicates the total dimensions of the shipment.

RequestedShipment/
PreferredCurrency

Optional
This element indicates the currency the caller requests to
have used in all returned monetary values (when a choice is
possible).

RequestedShipment/
No
ShipmentAuthorizationDe
tail

This element indicates the currency the caller requests to
have used in all returned monetary values (when a choice is
possible).

RequestedShipment/
No
ShipmentAuthorizationDe
tail/
accountNumber

Provides Identification of a specific FedEx customer account.

RequestedShipment/Ship
per

Required
This element indicates the descriptive data identifying the
party responsible for shipping the package.

RequestedShipment/Reci
pient

Required
Descriptive data identifying the party receiving the package.

RequestedShipment/
No
RecipientLocationNumber

Optional
A unique identifier for a recipient location.

FedEx Web Services, Developer Guide 2016

372

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/Origi No
n

Optional
Physical starting address for the shipment, if different from
shipper's address.

RequestedShipment/Sold
To

Indicates the party responsible for purchasing the goods
shipped from the shipper to the recipient. The sold to party is
not necessarily the recipient or the importer of record. The
sold to party is relevant when the purchaser, rather than the
recipient determines when certain customs regulations apply.

RequestedShipment/
No
ShippingChargesPayment

Required
Descriptive data for the monetary compensation given to
FedEx for services rendered to the customer.

RequestedShipment/
SpecialServicesRequeste
d

Optional
Special services available at the shipment level for some or all
service types.

RequestedShipment/
ProcessingOptionsReque
sted

Optional
Specify any custom processing to be applied to this
shipment.

RequestedShipment/
ExpressFreightDetail

Optional.
Data applicable to an FedEx Express Freight shipment.

RequestedShipment/
FreightShipmentDetail

Optional.
Data applicable to shipments using
FEDEX_FREIGHT_ECONOMY and
FEDEX_FREIGHT_PRIORITY services.

RequestedShipment/
ConsolidationDetail

Optional.
Data applicable to shipments that are a part of a
consolidation.

RequestedShipment/
DeliveryInstructions

Optional.
Used with FedEx Ground Home Delivery and FedEx Freight.

RequestedShipment/
VariableHandlingChargeD
etail

Optional.
Details about how to calculate variable handling charges at
the shipment level.

RequestedShipment/
CustomsClearanceDetail

Optional.
Customs clearance data, used for both international and intracountry shipping.

RequestedShipment/
PickupDetail

Optional.
The pickup characteristics of a shipment (e.g. for use in a tag
request).

RequestedShipment/
SmartPostDetail

Optional.
Specify the characteristics of a shipment pertaining to FedEx
SmartPost services.

RequestedShipment/

Optional.

FedEx Web Services, Developer Guide 2016

373

Open Shipping
Element ID

Multiple
Occurrence

BlockInsightVisibility

Description
If true, only the shipper/payor will have visibility of this
shipment.

RequestedShipment/
LabelSpecification

Required.
Descriptive data identifying the party responsible for shipping
the package.

RequestedShipment/
LabelSpecification/
LabelFormatType

Yes

Required.
Specify the type of label to be returned.

RequestedShipment/
LabelSpecification/
ImageType

Optional.
Specify the image format used for a shipping document.

RequestedShipment/
LabelSpecification/
LabelStockType

Optional.
For thermal printer labels this indicates the size of the label
and the location of the doc tab if present.
Valid values:


PAPER_4X6



PAPER_4X8



PAPER_4X9



PAPER_7X4.75



PAPER_8.5X11_BOTTOM_HALF_LABEL



PAPER_8.5X11_TOP_HALF_LABEL



STOCK_4X6



STOCK_4X6.75_LEADING_DOC_TAB



STOCK_4X6.75_TRAILING_DOC_TAB



STOCK_4X8



STOCK_4X9_LEADING_DOC_TAB



STOCK_4X9_TRAILING_DOC_TAB

RequestedShipment/
ShippingDocument
Specification

Optional.
Contains data used to create additional (non-label) shipping
documents.

RequestedShipment/
RateRequestTypes

Yes

Optional.
Indicates the type of rates to be returned.
Valid values:


LIST – Returns published rates in response



PREFERRED – Returns rates in currency specified in the
PreferredCurrency element.



NONE – Returns no rates in response.

FedEx Web Services, Developer Guide 2016

374

Open Shipping
Element ID

Multiple
Occurrence

Description

RequestedShipment/
EdtRequestType

Optional.
Specify whether the customer wishes to have Estimated
Duties and Taxes provided with the rate quotation on this
shipment. Only applies with shipments moving under
international services.

RequestedShipment/
MasterTrackingId

Optional.
Only used with multiple-transaction shipments to identify the
master package in a multi-piece shipment.

RequestedShipment/
PackageCount

Required.
The total number of packages in the entire shipment, even
when the shipment spans multiple transactions. For
OpenShip, this is an estimated number of packages. The
system maintains the actual count as packages are added and
removed from the OpenShip transaction.

RequestedShipment/
ConfigurationData

Optional.
Specify data structures that may be re-used multiple times
with a single shipment.

RequestedShipment/
ManifestDetail/
CustomerReferenceType
RequestedShipment/
RequestedPackageLineIt
ems

This identifies which customer reference field is used as the
manifest ID.
Yes

Required.
One or more package-attribute descriptions, each of which
describes an individual package, a group of identical
packages, or (for the total-piece-total-weight case) common
characteristics for all packages in the shipment.
Note: Not required for CREATE_PACKAGE Action.

Valid values include:

CreateOpenShipmentReq No
uest/
RequestedShipment/
RequestedPackageLineIt
em/
ItemDescriptionForCleara
nce
RequestedShipment/
No
SpecialServicesRequeste
d/
PendingShipmentDetail/
EmailLabelDetail

Weight/Units

Describes specific information about the email label
shipment.


Message: Content of the email message



Recipients: EMailRecipient



emailAddress - email address of the recipient



role - role type of the recipient

FedEx Web Services, Developer Guide 2016

375

Open Shipping
Element ID

Multiple
Occurrence

RequestedShipment/
No
SpecialServicesRequeste
d/
PendingShipmentDetail/
Processing Options
RequestedShipment/
No
SpecialServicesRequeste
d/
RecommendedDocument
Specification

Description

 optionsRequested localization
ALLOW MODIFICATIONS
This allows the Email Label originator to specify if the
completer can make modifications to editable shipment data

Specify the details about documents that are recommended
to be included with the shipment for ease of shipment
processing and transportation.
Valid values:


ANTIQUE_STATEMENT_EUROPEAN_UNION



ANTIQUE_STATEMENT_UNITED_STATES



ASSEMBLER_DECLARATION



BEARING_WORKSHEET



FILM_AND_VIDEO_CERTIFICATE



CERTIFICATE_OF_SHIPMENTS_TO_SYRIA



PRINTED_CIRCUIT_BOARD_WORKSHEET



COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COM
MON_MARKET



CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL
_TO_THE_PEOPLES_REPUBLIC_OF_CHINA



DECLARATION_OF_IMPORTED_ELECTRONIC_PRODU
CTS_SUBJECT_TO_RADIATION_CONTROL_STANDAR
D



DECLARATION_OF_BIOLOGICAL_STANDARDS



ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET



INTERIM_FOOTWEAR_INVOICE



NAFTA_CERTIFICATE_OF_ORIGIN_UNITED_STATES



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_FRENCH



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_ENGLISH



NAFTA_CERTIFICATE_OF_ORIGIN_SPANISH



PACKING_LIST



REPAIRED_WATCH_BREAKOUT_WORKSHEET



DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_A
MERICAN_PRODUCTS



STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_F
REQUENCY_DEVICES

FedEx Web Services, Developer Guide 2016

376

Open Shipping
Element ID

Multiple
Occurrence

Description



TOXIC_SUBSTANCES_CONTROL_ACT



UNITED_STATES_WATCH_REPAIR_DECLARATION



UNITED_STATES_NEW_WATCH_WORKSHEET



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNE
RSHIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNE
RSHIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES
Shipment-level totals of dry ice data across all packages.

RequestedShipment/
SpecialServicesRequeste
d/
ShipmentDryIceDetail
RequestedShipment/
ReturnInstructionsDetail/
ShippingDocumentForma
t/
documentFormatOptions
requested
/Document
formatOptions
RequestedShipment/
specialServicesRequeste
d/
EtdDetail/
UploadDocument
ReferenceDetail
RequestedShipment/
specialServicesRequeste
d/
pendingShipmentDetail/
documentReferences/
documentProducer

Valid Value: SUPPRESS_ADDITIONAL_LANGUAGES
This value will suppress English language if another language
is specified in language code field. (Default is English)

Details for uploaded documents provided by the shipment
initiator

Specify details for uploaded documents provided by the
shipment initiator.
Valid values:

RequestedShipment
No
/specialServicesRequeste
d/
pendingShipmentDetail/



CUSTOMER



FEDEX_CAFE



FEDEX_CLS



FEDEX_FIDT



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM

 OTHER
Specify details for uploaded documents provided by the
shipment initiator.
Valid values:


FedEx Web Services, Developer Guide 2016

CUSTOMER
377

Open Shipping
Element ID

Multiple
Occurrence

documentReferences/
documentIDProducer

Description



FEDEX_CAFE



FEDEX_CSHP



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM



FEDEX_INET

The following elements must be included in the CreatePendingShipmentReply:
Table 148. Create Pending Shipment Reply
Element

Multiple
Occurrence

Description

HighestSeverity

Identifies the highest severity encountered when
performing the request. Valid values in order from high
to low are:

Notifications

Notifications/Severity

Yes

FedEx Web Services, Developer Guide 2016



FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.



FAILURE — FedEx was unable to process your
transaction at this time due to a system failure.
Please try again later.

Same as "NotificationSeverityType" above

378

Open Shipping
Element

Multiple
Occurrence

Description

Notifications/Source

Indicates the source of this notification. Combined with
the Code it uniquely identifies this notification.

Notifications/Code

A code that represents this notification. Combined with
the Source it uniquely identifies this notification.

Notifications/Message

Human-readable text that explains this notification.

Notifications/LocalizedMessa
ge

The translated message. The language and locale
specified in the Client detail. Localization is used to
determine the representation. Currently only supported
in a TrackReply.

Notifications/MessageParam
eters

Yes

A collection of name/value pairs that provide specific
data to help the client determine the nature of an error,
or warning, and so on without having to parse the
message string.

TransactionDetail

Descriptive data for the customer transaction. The
Transaction detail from the request is echoed back to
the caller in the corresponding reply.

Version

Identifies the version/level of a service operation
expected by a caller (in each request) and performed by
the callee (in each reply).

JobID

—

AynchronousProcessingResu No
lts

Indicates whether the transaction was processed
synchronously or asynchronously.

ServiceType

List the type of FedEx service associated with the
shipment.

CompletedShipmentDetail

Provides Completed Shipment Details.

CompletedShipmentDetail/
UsDomestic

Indicates whether or not this is an intra-U.S. shipment.

CompletedShipmentDetail/
CarrierCode

Indicates the carrier that will be used to deliver this
shipment.

CompletedShipmentDetail/
MasterTrackingId

The master tracking number and form ID of this
multiple piece shipment. This information is to be
provided for each subsequent of a multiple piece
shipment.

CompletedShipmentDetail/
ServiceTypeDescription

Description of the FedEx service used for this
shipment. Currently not supported.

CompletedShipmentDetail/
PackagingDescription

Description of the packaging used for this shipment.
Currently not supported.

CompletedShipmentDetail/
OperationalDetail

Specify shipment level operational information.

FedEx Web Services, Developer Guide 2016

379

Open Shipping
Element

Multiple
Occurrence

Description

CompletedShipmentDetail/Ac Yes
cessDetail

Only used with pending shipments.

CompletedShipmentDetail/Ta No
gDetail

Only used in the reply to tag requests.
The following valid values are returned only for FedEx
Express services:

CompletedShipmentDetail/
SmartPostDetail



ConfirmationNumber



AccessTime



CutoffTime



Location



DeliveryCommitment

Valid values:


PickUpCarrier — Identifies the carrier that will pick
up the FedEx SmartPost shipment.



Machinable — Indicates whether the shipment is
deemed to be machinable, based on dimensions,
weight, and packaging.

CompletedShipmentDetail/
HazardousShipmentDetail

Computed shipment level information about hazardous
commodities.

CompletedShipmentDetail/
ShipmentRating

All shipment-level rating data for this shipment, which
may include data for multiple rate.

CompletedShipmentDetail/
ConsolidationDetail

Result data for a shipment within a consolidation.

CompletedShipmentDetail/
No
CompletedHoldAtLocationDe
tail

Returns the default holding location information when
HOLD_AT_LOCATION special service is requested and
the client does not specify the hold location address.
Valid values are:


HoldingLocation — Identifies the branded location
name, the hold at location phone number and the
address of the location.



HoldingLocationType — Identifies the type of
FedEx location.

CompletedShipmentDetail/
ExportComplianceStatement

Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

Valid values:

FedEx Web Services, Developer Guide 2016



FolderID — The identifier for all clearance
documents associated with this shipment.



UploadDocumentReferenceDetails

380

Open Shipping
Element

Multiple
Occurrence

Description

CompletedShipmentDetail/
ShipmentDocuments

Yes

All shipment-level shipping documents (other than
labels and barcodes).

CompletedShipmentDetail/
AssociatedShipments

Yes

The details of any associated shipments.

CompletedShipmentDetail/
PendingShipmentAccessDet
ail/
Accessor Details

Yes

Provides the ability to return multiple sets of Email label
access credentials:

AssociatedShipments/Type



Role



SHIPMENT_COMPLETOR



SHIPMENT_INITIATOR"



userId



password



emailLabelUrl

Describes the type of associated shipment.
Valid values:


COD_RETURN



DELIVERY_ON_INVOICE_ACCEPTANCE_
RETURN

AssociatedShipments/Sender No

The descriptive data for a person or company entity
doing business with FedEx.

AssociatedShipments/Recipi
ent

The descriptive data for a person or company entity
doing business with FedEx.

AssociatedShipments/Servic
eType

Describes the type of FedEx service.

AssociatedShipments/
PackagingType

Identifies the packaging used by the requestor for the
package.
Valid values:

AssociatedShipments/Trackin No
gId

FedEx Web Services, Developer Guide 2016



FEDEX_10KG_BOX



FEDEX_25KG_BOX



FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_PAK



FEDEX_TUBE



YOUR_PACKAGING

Specify the tracking ID for the payment on the return.

381

Open Shipping
Element

Multiple
Occurrence

Description

AssociatedShipments/
CustomerReferences

Yes

Specify additional customer reference data about the
associated shipment.

AssociatedShipments/
ShipmentOperationalDetail

Specify shipment level operational information.

AssociatedShipments/
PackageOperationalDetail

Specify package level operational information on the
associated shipment. This information is not tied to an
individual outbound package.

AssociatedShipments/Label

All package-level shipping documents (other than labels
and barcodes).

CompletedShipmentDetail/
CompletedCodDetail

Specify the results of processing for the COD special
service.

CompletedShipmentDetail/
CompletedPackageDetails

Yes

Valid values are:

FedEx Web Services, Developer Guide 2016



SequenceNumber



TrackingIds



GroupNumber — Used with request
PACKAGE_GROUPS, to identify which group of
identical packages was used to produce a reply
item.



OversizeClass



PackageRating — All package-level rating data for
this package, which may include data for multiple
rate types.



OperationalDetail



Label



PackageDocuments — All package-level shipping
documents (other than labels and barcodes). For
use in loads after January, 2008.



CodReturnDetail — Specifies the information
associated with this package that has COD special
service in a ground shipment.



SignatureOption — Actual signature option applied,
to allow for cases in which the original value
conflicted with other service features in the
shipment.



HazardousCommodities — Documents the kinds
and quantities of all hazardous commodities in the
current package, using updated hazardous
commodity description data.

382

Open Shipping
Element

Multiple
Occurrence

Description

ErrorLabels

Yes

Empty unless one or more errors occur during
transaction processing.

Index

Either the Customer-assigned identifier from the
CreateOpenShipmentRequest or the FedEx generated
index.

20.5 Route and Time-in-Transit Transaction
Web Services returns FedEx Express routing or FedEx Ground time-in-transit information in the
ConfirmOpenShipmentReply transaction.

20.6 Rate Open Ship Shipment Transaction
Rates are available for an Open Ship shipment with the ConfirmOpenShipment transaction. Use the
RateRequestTypes element to request LIST rates, in addition to your account rates, in the reply.

20.7 Add Piece Transaction
Web Services first creates a master Open Ship shipment and then allows you to add pieces (aka
packages) to the "open" shipment.
You must add the first package to the shipment in the initial CreateOpenShipRequest when you CREATE
the Open Ship shipment, and you can add additional pieces in a separate ADD piece
AddPackagesToOpenShipmentRequest. You can send a separate ADD piece transaction for each of your
packages as you prepare your shipment throughout the day. You can send in multiple pieces within the
ADD transaction provided the total number of packages for the shipment do not exceed the Open
Shipping package limit.
You will receive the labels during the ConfirmOpenShipment transaction.
To ADD a piece (aka package) to an Open Ship shipment use the elements described in the table.
Table 149. Add Packages To Open Shipment Request
Element

Multiple
Description
Occurrence

UserDetail

Optional.

Index

Required. Either the Customer-assigned identifier or the
FedEx generated identifier of the open shipment where
the package(s) are to be added.

Actions

Yes

Optional. Specify the actions to be performed during the
add piece transaction. Valid values are:

FedEx Web Services, Developer Guide 2016



STRONG_VALIDATION



WEAK_VALIDATION

383

Open Shipping
Element

Multiple
Description
Occurrence

RequestedPackageLineItem

Yes

Required. Defines the elements of the package to be
added.

RequestedPackageLineItem/
SequenceNumber

Yes

Optional. Used only with individual packages as a unique
identifier of each requested package. Will be adjusted at
the shipment level as pieces are added or deleted.

RequestedPackageLineItem/
GroupNumber

Yes

Optional. Used only with package groups as a unique
identifier of each group of identical packages.

RequestedPackageLineItem/
GroupPackageCount

Yes

Optional. Used only with package groups as a count of
packages within a group of identical packages. The
package count added to existing package count on the
shipment cannot exceed Open Ship package limit.

RequestedPackageLineItem/
VariableHandlingChargeDetail

Yes

Optional. Only used for individual packages. Details about
how to calculate variable handling charges at the
shipment level.

RequestedPackageLineItem/
InsuredValue

Yes

Optional. Only used for individual packages and package
groups to indicate the insured value of the package.

RequestedPackageLineItem/
Weight

Yes

Required. For individual packages and package groups.

RequestedPackageLineItem/
Dimensions

Yes

Optional. The dimensions of this package and the unit
type used for the measurements. Valid measurements
are whole numbers greater than zero.
Valid values are:


Length



Width



Height



Units

RequestedPackageLineItem/
PhysicalPackaging

Yes

Optional. Provides additional detail on how the customer
has physically packaged this item. Required for packages
moving under international and SmartPost services.

RequestedPackageLineItem/
ItemDescription

Yes

Optional. Human-readable text describing the package.

RequestedPackageLineItem/
CustomerReferences

Yes

Optional.
Specify additional customer reference data about the
associated shipment.

RequestedPackageLineItem/
SpecialServicesRequested

Yes

Optional.
Descriptive data regarding special services requested by
the shipper for this package. If the shipper is requesting a
special service which requires additional data, such as
C.O.D., the special service type must be present in the
ShipmentSpecialServicesRequested/SpecialServiceTypes

FedEx Web Services, Developer Guide 2016

384

Open Shipping
Element

Multiple
Description
Occurrence
collection, and the supporting detail must be provided in
the appropriate sub-object. For example, to request
C.O.D., "COD" must be included in the
SpecialServiceTypes collection and the CodDetail object
must contain the required data.

RequestedPackageLineItem/
ContentRecords

Yes

Optional.
Only used for individual packages and
PACKAGE_GROUPS.
Valid values:


PartNumber



ItemNumber



ReceivedQuantity



Description

RequestedPackageLineItem/
Commodities

Yes

May only be used with shipment processing option of
PACKAGE_LEVEL_COMMODITIES and one of the
international distribution services.

RequestedPackageLineItems/
PackageSpecialServices
Requested
/AlcoholDetail

Yes

Specify details for package containing alcohol

RequestedPackageLineItems/
PackageSpecialServicesReques
ted/
AlcoholDetail/AlcoholRecipient
Type

Yes

Specify the recipient type that the recipient of the alcohol
shipment has.
Valid values are:

RequestedPackageLineItem/
PackageSpecialServicesRequ
ested
/DangerousGoodsDetail/
UploadedTrackingNumber



CONSUMER



LICENSEE

UploadedTrackingNumber element is used to identify an
instance of an uploaded dangerous goods handling unit.
This element is required only if you have already
validated DG data using the FedEx provided Dangerous
Goods / Hazardous Materials information upload option.

RequestedPackageLineItem/
PackageSpecialServicesRequ
ested
/DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent
/
NetExplosiveDetail

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.

Requestedshipment/
RequestedPackageLineItem/

Valid values:

FedEx Web Services, Developer Guide 2016



NET_EXPLOSIVE_CONTENT

385

Open Shipping
Element

Multiple
Description
Occurrence

PackageSpecialServicesRequ
ested
/DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent
/
NetExplosiveDetail/
NetExplosiveClassificationTyp
e



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

20.8 Returned Add Piece Fields
The AddPackagesToOpenShipmentReply to an Open Ship ADD package transaction includes the tracking
number of the newly added package.
Table 150. AddPackagesToOpenShipmentReply
Element

Multiple
Occurrence

Description

JobId

Optional.

ServiceType

Optional. Description of the FedEx service
type for the particular shipment.

CompletedShipmentDetail

Provides all of the returned information
about a shipment/package(s).

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

The total mass of the contained explosive
substances, without the mass of any
casings, bullets, shells, etc.

CompletedPackageDetail/
CompletedHazardousPackageDetail/
ValidatedHazardousContainer/
ValidatedHazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType
ErrorLabels

The total mass of the contained explosive
substances, without the mass of any
casings, bullets, shells, etc.

Yes

FedEx Web Services, Developer Guide 2016

Optional.
Empty unless one or more errors occur
during transaction processing.

386

Open Shipping

20.9 Modify Piece Transaction
To modify information about a package in an Open Ship shipment, including the Master piece, which is
the first package added, you must include the fields listed in Table 145 in a
ModifyPackageInOpenShipmentRequest.
Table 151. ModifyPackageInOpenShipmentRequest
Element

Multiple
Description
Occurrence

UserDetail

Optional.

Index

Required.
Customer-assigned identifier for this shipment (must be
unique for stand-alone open shipments.

Actions

Yes

Optional.
Specify the optional actions to be performed during the
modification of packages in Open Shipment.
Valid values: STRONG_VALIDATION

TrackingId

Required.
The Tracking ID of the package being modified.

TrackingId/TrackingIdType

Optional.
Describes the type of tracking ID.

TrackingId/FormId

Optional.
Describes in detail the type of airbill and shipment moving
through the FedEx system.

TrackingId/UspsApplicationId

Optional.
For use with SmartPost tracking IDs only.

TrackingId/TrackingNumber

Optional.

RequestedPackageLineItem

Optional.
This class rationalizes RequestedPackage and
RequestedPackageSummary from previous interfaces.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
UploadedTrackingNumber

UploadedTrackingNumber element is used to identify an
instance of an uploaded dangerous goods handling unit.
This element is required only if you have already validated
DG data using the FedEx provided Dangerous Goods /
Hazardous Materials information upload option.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

FedEx Web Services, Developer Guide 2016

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.

387

Open Shipping
Element

Multiple
Description
Occurrence

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:


NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

RequestedPackageLineItem/
SequenceNumber

Optional.
Used only with individual packages as a unique identifier
of each requested package.
Will be adjusted at the shipment level as pieces are
added or deleted.

RequestedPackageLineItem/
GroupNumber

Optional.
Used only with package groups, as a unique identifier of
each group of identical packages.

RequestedPackageLineItem/
GroupPackageCount

Optional.
Used only with package groups, as a count of packages
within a group of identical packages.
The package count added to exiting package count on the
shipment cannot exceed Open Ship package limit.

RequestedPackageLineItem/
TrackingIds

Yes

Used only for INDIVIDUAL_PACKAGES.

RequestedPackageLineItem/
VariableHandlingChargeDetail

Optional.
Only used for individual packages.
Details about how to calculate variable handling charges
at the shipment level.

VariableHandlingChargeDetail/
FixedValue

Optional.

VariableHandlingChargeDetail/
PercentValue

Optional.
Actual percentage (10 means 10%, which is a multiplier
of 0.1)

VariableHandlingChargeDetail/
RateElementBasis

Optional.
Select the value from a set of rate data to which the
percentage is applied.

VariableHandlingChargeDetail/
RateTypeBasis

Optional.
Select the type of rate from which the element is to be
selected.

RequestedPackageLineItem/
InsuredValue

Optional.
Only used for individual packages and package groups.

RequestedPackageLineItem/
Weight

Required.
Only used for individual packages and package groups.

FedEx Web Services, Developer Guide 2016

388

Open Shipping
Element

Multiple
Description
Occurrence

RequestedPackageLineItem/
Dimensions

Optional.
The dimensions of this package and the unit type used
for the measurements. Valid measurements are whole
numbers greater than zero.
Valid values:


Length



Width



Height



Units

RequestedPackageLineItem/
PhysicalPackaging

Optional.
Provides additional detail on how the customer has
physically packaged this item.
Required for packages moving under international and
SmartPost services.

RequestedPackageLineItem/
ItemDescription

Optional.
Human-readable text describing the package.

RequestedPackageLineItem/
CustomerReferences

Yes

Optional.
Specify additional customer reference data about the
associated shipment.

RequestedPackageLineItem/
SpecialServicesRequested

Optional.
Only used for individual packages.
Descriptive data regarding special services requested by
the shipper for this shipment. If the shipper is requesting
a special service which requires additional data, such as
C.O.D., the special service type must be present in the
ShipmentSpecialServicesRequested/SpecialServiceTypes
collection, and the supporting detail must be provided in
the appropriate sub-object.
For example, to request C.O.D., "COD" must be included
in the SpecialServiceTypes collection and the CodDetail
object must contain the required data.

RequestedPackageLineItems/
SpecialServicesRequested/
DangerousGoodsDetail/
UploadedTrackingNumber
SpecialHandlingDetail

UploadedTrackingNumber element is used to identify an
instance of an uploaded dangerous goods handling unit.
This element is required only if you have already validated
DG data using the FedEx provided Dangerous Goods /
Hazardous Materials information upload option.
No

FedEx Web Services, Developer Guide 2016

Optional. Specify the condition of a package when it was
received at a FedEx location.

389

Open Shipping
Element

Multiple
Description
Occurrence

RequestedPackageLineItem/
ContentRecords

Yes

RequestedPacakgeLineItem/
Commodities

Yes

Optional. Only used for individual packages and package
groups.
Valid values are:


PartNumber



ItemNumber



ReceivedQuantity



Description

May only be used with shipment processing option of
PACKAGE_LEVEL_COMMODITIES and one of the
international distribution services.

Table 67. ModifyPackageInOpenShipmentReply
Element

Multiple
Description
Occurrence

HighestSeverity

Notifications

Yes

FedEx Web Services, Developer Guide 2016

Identifies the set of severity values for a Notification.
Valid values are:


ERROR



FAILURE



NOTE



SUCCESS



WARNINGS

Includes the descriptive data detailing the status of a
submitted transaction. Includes the severity of the
notification, which indicates success or failure or some
other information about the request.
Valid values are:


SUCCESS — Your transaction succeeded with no
other applicable information.



NOTE — Additional information that may be of
interest to you about your transaction.



WARNING — Additional information that you need
to know about your transaction that you may need
to take action on.



ERROR — Information about an error that occurred
while processing your transaction.

390

Open Shipping
Element

Multiple
Description
Occurrence


FAILURE — FedEx was unable to process your
transaction at this time due to a system failure.
Please try again later.

Notifications/Severity

Same as HighestSeverity types above.

Notifications/Source

Indicates the source of this notification. Combined with
the Code it uniquely identifies this notification.

Notifications/Code

A code that represents this notification. Combined with
the Source it uniquely identifies this notification.

Notifications/Message

Human-readable text that explains this notification.

Notifications/
LocalizedMessage

The translated message. The language and locale
specified in the Client detail. Localization is used to
determine the representation. Currently only
RequestedShipment/ supported in a TrackReply.

Notifications/
MessageParameters

A collection of name/value pairs that provide specific
data to help the client determine the nature of an error
(or warning, and so on) without having to parse the
message string.

JobId

—

CompletedShipmentDetail

Provides Completed Shipment Details.

CompletedShipmentDetail/
HazardousShipmentDetail/
DryIceDetail

Shipment-level totals of dry ice data across all packages.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.

FedEx Web Services, Developer Guide 2016

391

Open Shipping
Element

Multiple
Description
Occurrence

RequestedPackageLineItem/
PackageSpecialServicesRequested
/DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:
 NET_EXPLOSIVE_CONTENT
 NET_EXPLOSIVE_MASS
 NET_EXPLOSIVE_QUANTITY
 NET_EXPLOSIVE_WEIGHT

CompletedShipmentDetail/
UsDomestic

Indicates whether or not this is an intra-US shipment.

CompletedShipmentDetail/
CarrierCode

Indicates the carrier that will be used to deliver this
shipment.

CompletedShipmentDetail/
MasterTrackingId

Only used with multiple-transaction shipments to
identify the master package in a multi-piece shipment.

CompletedShipmentDetail/
ServiceTypeDescription

Description of the FedEx service used for this shipment.
Currently not supported.

CompletedShipmentDetail/
PackagingDescription

Description of the packaging used for this shipment.
Currently not supported.

CompletedShipmentDetail/
OperationalDetail

Description of the operational details of the shipment.

CompletedShipmentDetail/
AccessDetail

Only used with pending shipments.

CompletedShipmentDetail/
TagDetail

Only used in the reply to tag requests.
The following valid values are, as of June 2007, returned
only for FedEx Express services:

CompletedShipmentDetail/
SmartPostDetail

FedEx Web Services, Developer Guide 2016



ConfirmationNumber



AccessTime



CutoffTime



Location



DeliveryCommitment

Valid values are:


PickUpCarrier — Identifies the carrier that will pick
up the SmartPost shipment.



Machinable — Indicates whether the shipment is
deemed to be machinable, based on dimensions,
weight, and packaging.
392

Open Shipping
Element

Multiple
Description
Occurrence

CompletedShipmentDetail/
HazardousShipmentDetail

Computed shipment level information about hazardous
commodities.

CompletedShipmentDetail/
ShipmentRating

All shipment-level rating data for this shipment, which
may include data for multiple rate.

CompletedShipmentDetail/
ConsolidationDetail

Result data for a shipment within a consolidation.

CompletedShipmentDetail/
CompletedHoldAtLocationDetail

Returns the default holding location information when
HOLD_AT_LOCATION special service is requested and
the client does not specify the hold location address.
Valid values are:


HoldingLocation — Identifies the branded location
name, the hold at location phone number and the
address of the location.



HoldingLocationType — Identifies the type of
FedEx location.

CompletedShipmentDetail/
ExportComplianceStatement

Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

Valid values are:

CompletedShipmentDetail/
ShipmentDocuments

Yes

CompletedShipmentDetail/
AssociatedShipments

Yes

AssociatedShipmentDetail/Type

CompletedShipmentDetail/
CompletedCodDetail

FedEx Web Services, Developer Guide 2016



FolderID — The identifier for all clearance
documents associated with this shipment.



UploadDocumentReferenceDetails

All shipment-level shipping documents (other than labels
and barcodes).

Describes the type of associated shipment.
Valid values are:


COD_RETURN



DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN

Specify the results of processing for the COD special
service.

393

Open Shipping
Element

Multiple
Description
Occurrence

CompletedShipmentDetail/
CompletedPackageDetails

Yes

ErrorLabels

Yes

FedEx Web Services, Developer Guide 2016

Valid values are:


SequenceNumber



TrackingIds



GroupNumber — Used with request containing
PACKAGE_GROUPS, to identify which group of
identical packages was used to produce a reply
item.



OversizeClass



PackageRating — All package-level rating data for
this package, which may include data for multiple
rate types.



OperationalDetail



Label



PackageDocuments — All package-level shipping
documents (other than labels and barcodes). For
use in loads after January, 2008.



CodReturnDetail — Specify the information
associated with this package that has COD special
service in a ground shipment.



SignatureOption — Actual signature option applied,
to allow for cases in which the original value
conflicted with other service features in the
shipment.



HazardousCommodities — Documents the kinds
and quantities of all hazardous commodities in the
current package, using updated hazardous
commodity description data.

Empty unless one or more errors occur during
transaction processing.

394

Open Shipping

20.10 Delete Piece Transaction
To delete one or more packages from an Open Ship shipment, delete the piece before you CONFIRM
using the DeletePackagesFromOpenShipmentRequest.
Table 152. DeletePackagesFromOpenShipmentRequest
Element

Multiple
Occurrence

Description

UserDetail

Optional.

Index

Required.
Customer-assigned identifier for this shipment (must be
unique for stand-alone open shipments.

TrackingId

Yes

Required. The Tracking ID of the package.

TrackingId/TrackingIdType

Optional.

TrackingId/FormId

Optional.

TrackingId/UspsApplicationId

Optional. For use with SmartPost tracking IDs only.

TrackingId/TrackingNumber

Optional.

New Master and child tracking numbers are assigned for Express C.O.D. shipments and packages when
a piece is deleted prior to a CONFIRM transaction.
If the Master package is deleted, the Master tracking number is reassigned to the next package in
sequence in the shipment. All sequence numbers are decreased by the number of deleted packages.
For example, if the original sequence is 1-3, 2-3, 3-3, and the third piece is deleted prior to a CONFIRM,
the revised sequence numbers are 1-2, 2-2.

20.11 Delete Shipment Transaction
To delete an entire Open Ship shipment prior to a CONFIRM transaction, you must submit a
DeleteOpenShipmentRequest.
To delete an Open Ship shipment prior to a CONFIRM, you must specify the Open Ship index assigned
to the shipment when it was created. The shipment to be deleted is identified based on the index
identifier you supply.
Table 153. DeleteOpenShipmentRequest
Element

Multiple
Occurrence

Description

UserDetail

Optional.

Index

Required.
Customer-assigned identifier for this shipment (must be
unique for stand-alone open shipments.

TrackingIDs

FedEx Web Services, Developer Guide 2016

Tracking IDs of the package to be deleted. The tracking
IDs are for the same package to support the use case
where a package can have more than one type of
395

Open Shipping
Element

Multiple
Occurrence

Description
tracking ID, such as package shipped with the SmartPost
service.
Valid values:


EXPRESS



FEDEX



FREIGHT



GROUND



INTERVAL



UNKNOWN



USPS

20.12 Confirm Shipment Transactions
The CONFIRM transaction validates the shipment and package information for the respective Open
Shipment index. The system returns Route, Time-in-Transit, Rate Quote and required shipping document
information, including labels for the packages.
Confirm a shipment and print labels, as described in the following sections.
1. CREATE shipment (and ADD Piece #1)
2. ADD Piece #2
3. ADD Piece #3
4. ADD Piece #4
5. ADD Piece #X
6. CONFIRM Shipment

20.12.1Confirm Open Ship Shipment
After you add all packages to an Open Ship shipment, you may CONFIRM the shipment by passing in the
elements in the ConfirmOpenShipmentRequest.
STRONG_VALIDATION will be performed on the shipment and all package information for the open
shipment referenced in the CONFIRM transaction. Errors need to fixed using the MODIFY transactions
before the CONFIRM transaction will produce the labels.
Table 154. ConfirmOpenShipmentRequest
Element

Multiple
Description
Occurrence

AsynchronousProcessingOptions

Optional. This is used to specify processing options
related to synchronous or asynchronous
processing.

AsynchronousProcessingOptions

Yes

Describes the type of options available.

FedEx Web Services, Developer Guide 2016

396

Open Shipping
Element

Multiple
Description
Occurrence

/Options

Valid values:


ALLOW_ASYNCHRONOUS (Recommended)



ASYNCHRONOUS_ONLY



SYNCHRONOUS_ONLY

Index

Required. Customer-assigned identifier for this
shipment (must be unique for stand-alone open
shipments, or unique within consolidation if
consolidation key is provided.

LabelSpecification

Optional. Description of shipping label to be
returned in the reply.

RequestedShipment/
LabelSpecification/
CustomerSpecifiedLabelDetail
/LabelMaskableDataType

Names of data element/areas which may be
suppressed from printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NU
MBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACC
OUNT_NUMBER

RequestedShipment/
LabelSpecification/
LabelFormatType

Yes

Required.
Specify the type of label to be returned.

RequestedShipment/
LabelSpecification/
ImageType

Optional.
Specify the image format used for a shipping
document.

RequestedShipment/
LabelSpecification
/LabelStockType

Optional.
For thermal printer labels this indicates the size of
the label and the location of the doc tab if present.
Valid values:

FedEx Web Services, Developer Guide 2016



PAPER_4X6



PAPER_4X8



PAPER_4X9



PAPER_7X4.75



PAPER_8.5X11_BOTTOM_HALF_LABEL



PAPER_8.5X11_TOP_HALF_LABEL



STOCK_4X6
397

Open Shipping
Element

Multiple
Description
Occurrence

RequestedShipment/
ShippingDocumentSpecification/
FreightAddressLabelDetail
/DocTabContent
/DocTabContentType



STOCK_4X6.75_LEADING_DOC_TAB



STOCK_4X6.75_TRAILING_DOC_TAB



STOCK_4X8



STOCK_4X9_LEADING_DOC_TAB



STOCK_4X9_TRAILING_DOC_TAB

Valid values:


BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001

ShippingDocumentSpecification

Optional.
Contains data used to create additional (non-label)
shipping documents.

ShippingDocumentSpecification/
ShippingDocumentTypes

Yes

Optional.
Indicates the types of shipping documents
requested by the shipper.

ShippingDocumentSpecification/
CertificateOfOrigin

Optional.

ShippingDocumentSpecification/
CommercialInvoiceDetail

Optional.

ShippingDocumentSpecification/
CustomDocumentDetail

Data required to produce a custom-specified
document, either at shipment or package level.

ShippingDocumentSpecification/
CustomPackageDocumentDetail

Yes

Optional.
Specify the production of each package-level
custom document (the same specification is used
for all packages).

ShippingDocumentSpecification/
CustomShipmentDocumentDetail

Yes

Optional.
Specify the production of a shipment-level custom
document.

ShippingDocumentSpecification/
ExportDeclarationDetail

Optional.

ShippingDocumentSpecification/
GeneralAgencyAgreementDetail

Optional.

ShippingDocumentSpecification/
NaftaCertificateOfOriginDetail

Optional.

ShippingDocumentSpecification

Optional. S

FedEx Web Services, Developer Guide 2016

398

Open Shipping
Element

Multiple
Description
Occurrence

/Op900Detail

pecify the production of the OP-900 document for
hazardous materials packages.

ShippingDocumentSpecification/
DangerousGoodsShippers
DeclarationDetail

Optional.
Specify the production of the 1421-C document for
dangerous goods shipment.

ShippingDocumentSpecification/
FreightAddressLabelDetail

Optional.

ShippingDocumentSpecification/
ReturnInstructionsDetail

Optional.
Specify the production of the return instructions
document.

ShippingDocumentSpecification/
ReturnedShippingDocumentType

FedEx Web Services, Developer Guide 2016



AUXILIARY_LABEL



CERTIFICATE_OF_ORIGIN



COD_AND_DELIVERY_ON_INVOICE



ACCEPTANCE_RETURN_2_D_BARCODE



COD_AND_DELIVERY_ON_INVOICE



_ACCEPTANCE_RETURN_LABEL



COD_RETURN_2_D_BARCODE



COD_RETURN_LABEL



COMMERCIAL_INVOICE



CUSTOM_PACKAGE_DOCUMENT



CUSTOM_SHIPMENT_DOCUMENT



DANGEROUS_GOODS_SHIPPERS



DECLARATION



DELIVERY_ON_INVOICE_ACCEPTANCE



RETURN_2_D_BARCODE



DELIVERY_ON_INVOICE_ACCEPTANCE



RETURN_LABEL



ETD_LABEL



EXPORT_DECLARATION



FREIGHT_ADDRESS_LABEL



GENERAL_AGENCY_AGREEMENT



GROUND_BARCODE



NAFTA_CERTIFICATE_OF_ORIGIN



OP_900
399

Open Shipping
Element

RateRequestTypes

EdtRequestType

Multiple
Description
Occurrence

Yes



OUTBOUND_2_D_BARCODE



OUTBOUND_LABEL



PRO_FORMA_INVOICE



RECIPIENT_ADDRESS_BARCODE



RECIPIENT_POSTAL_BARCODE



RETURN_INSTRUCTIONS



TERMS_AND_CONDITIONS



USPS_BARCODE

Optional. Indicates the type of rates to be returned.
Rates that can be returned are:



LIST – Returns published rates in response



PREFERRED – Returns rates in currency
specified in the PreferredCurrency element.



NONE – Returns no rates in response.

Optional. Specify whether the customer wishes to
have Estimated Duties and Taxes provided with the
rate quotation on this shipment. Only applies with
shipments moving under international services.
Specify the order in which the labels will be
returned. Valid values are:

LabelSpecification/LabelOrderType No



SHIPPING_LABEL_FIRST



SHIPPING_LABEL_LAST

Table 155. ConfirmOpenShipmentReply
Element

Multiple
Description
Occurrence

HighestSeverity

Notifications

Yes

FedEx Web Services, Developer Guide 2016

Identifies the highest severity encountered
when performing the request.
Valid values:


FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the
status of a submitted transaction. Includes the
400

Open Shipping
Element

Multiple
Description
Occurrence
severity of the notification, which indicates
success or failure or some other information
about the request.
Valid values are:


SUCCESS — Your transaction succeeded
with no other applicable information.



NOTE — Additional information that may
be of interest to you about your
transaction.



WARNING — Additional information that
you need to know about your transaction
that you may need to take action on.



ERROR — Information about an error that
occurred while processing your
transaction.



FAILURE — FedEx was unable to process
your transaction at this time due to a
system failure. Please try again later.

TransactionDetail

Descriptive data for the customer transaction.
The Transaction detail from the request is
echoed back to the caller in the corresponding
reply.

JobId

—

AsynchronousProcessingResults

This indicates whether the transaction was
processed synchronously or asynchronously.

CompletedShipmentDetail

Provides Completed Shipment Details.

CompletedShipmentDetail/
HazardousShipmentDetail/DryIceDetail

Shipment-level totals of dry ice data across all
packages.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

The total mass of the contained explosive
substances, without the mass of any casings,
bullets, shells, etc.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:

FedEx Web Services, Developer Guide 2016



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

401

Open Shipping
Element

Multiple
Description
Occurrence

ErrorLabels

Yes

Empty unless one or more errors occur during
transaction processing.

Table 156. GetConfirmOpenShipmentResultsRequest
Element

Multiple
Description
Occurrence

HighestSeverity

Notifications

Yes

Identifies the highest severity encountered
when performing the request.
Valid values:


FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status
of a submitted transaction. Includes the severity
of the notification, which indicates success or
failure or some other information about the
request.
Valid values are:


SUCCESS — Your transaction succeeded
with no other applicable information.



NOTE — Additional information that may
be of interest to you about your
transaction.



WARNING — Additional information that
you need to know about your transaction
that you may need to take action on.



ERROR — Information about an error that
occurred while processing your transaction.



FAILURE — FedEx was unable to process
your transaction at this time due to a
system failure. Please try again later.

Notifications/Severity

Optional.
The severity of this notification. This can indicate
success or failure or some other information
about the request.
See Notifications element for valid values.

Notifications/Source

Optional.

FedEx Web Services, Developer Guide 2016

402

Open Shipping
Element

Multiple
Description
Occurrence
Indicates the source of this notification.
Combined with the Code it uniquely identifies
this notification

Notifications/Code

Optional.
A code that represents this notification.
Combined with the Source it uniquely identifies
this notification.

Notifications/Message

Optional.
Human-readable text that explains this
notification.

Notifications/ LocalizedMessage

Optional.
The translated message. The language and
locale specified in the ClientDetail. Localization
are used to determine the representation.
Currently only supported in a TrackReply.

Notifications/ MessageParameters

Yes

Optional.

CompletedShipmentDetail

Optional.
Provides reply information specific to the Open
Shipment.

CompletedShipmentDetail/UsDomesti
c

Optional.
Indicates whether or not this is an intra-U.S.
shipment.

CompletedShipmentDetail/CarrierCod
e

Optional.
Indicates the carrier that will be used to deliver
this shipment.

CompletedShipmentDetail/MasterTrac No
kingId

Optional.
The master tracking number and form ID of this
multiple piece shipment. This information is to
be provided for each subsequent of a multiple
piece shipment.

CompletedShipmentDetail/
ServiceTypeDescription

Optional.
Description of the FedEx service used for this
shipment. Currently not supported.

CompletedShipmentDetail/
PackagingDescription

Optional.
Description of the packaging used for this
shipment. Currently not supported.

CompletedShipmentDetail/Operational No
Detail

Optional.
Specify shipment level operational information.

CompletedShipmentDetail/AccessDet
ail

Provides the ability to return multiple sets of
Email label access credentials in the
CreateOpenShipment reply

Yes

FedEx Web Services, Developer Guide 2016

403

Open Shipping
Element

Multiple
Description
Occurrence

CompletedShipmentDetail/TagDetail

CompletedShipmentDetail/SmartPost
Detail

Optional.
Only used in the reply to tag requests.
The following valid values are returned only for
FedEx Express services:


ConfirmationNumber



AccessTime



CutoffTime



Location



DeliveryCommitment

Optional.
Valid values:


PickUpCarrier — Identifies the carrier that
will pick up the FedEx SmartPost
shipment.



Machinable — Indicates whether the
shipment is deemed to be machinable,
based on dimensions, weight, and
packaging.

CompletedShipmentDetail/
HazardousShipmentDetail

Optional.
Computed shipment level information about
hazardous commodities.

CompletedShipmentDetail/ShipmentR
ating

Optional.
All shipment-level rating data for this shipment,
which may include data for multiple rate.

CompletedShipmentDetail/
ConsolidationDetail

Optional.
Result data for a shipment within a
consolidation.

CompletedShipmentDetail/
CompletedHoldAtLocationDetail

Optional.
Returns the default holding location information
when HOLD_AT_LOCATION special service is
requested and the client does not specify the
hold location address.
Valid values are:

CompletedShipmentDetail/
ExportComplianceStatement

FedEx Web Services, Developer Guide 2016



HoldingLocation — Identifies the branded
location name, the hold at location phone
number and the address of the location.



HoldingLocationType — Identifies the type
of FedEx location.

Optional.

404

Open Shipping
Element

Multiple
Description
Occurrence
Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

Optional.
Valid values:


FolderID — The identifier for all clearance
documents associated with this shipment.



UploadDocumentReferenceDetails

CompletedShipmentDetail/
ShipmentDocuments

Yes

Optional.
All shipment-level shipping documents (other
than labels and barcodes).

CompletedShipmentDetail/
AssociatedShipments

Yes

Optional.
The details of any associated shipments.

CompletedShipmentDetail/
CompletedCodDetail

Optional.
Specify the results of processing for the COD
special service.

CompletedShipmentDetail/
CompletedPackageDetails

Yes

Optional.
Valid values:

FedEx Web Services, Developer Guide 2016



SequenceNumber



TrackingIds



GroupNumber — Used with request
containing PACKAGE_GROUPS, to
identify which group of identical packages
was used to produce a reply item.



OversizeClass



PackageRating — All package-level rating
data for this package, which may include
data for multiple rate types.



OperationalDetail



Label



PackageDocuments — All package-level
shipping documents (other than labels and
barcodes). For use in loads after January,
2008.



CodReturnDetail — Specify the
information associated with this package
that has COD special service in a ground
shipment.

405

Open Shipping
Element

ErrorLabels

Multiple
Description
Occurrence

Yes



SignatureOption — Actual signature
option applied, to allow for cases in which
the original value conflicted with other
service features in the shipment.



HazardousCommodities — Documents
the kinds and quantities of all hazardous
commodities in the current package, using
updated hazardous commodity description
data.

Optional.
Empty unless one or more errors occur during
transaction processing.

20.12.2Confirming Open Ship and Printing Labels
A label for each piece is returned as a result of the CONFIRM transaction.
Open Ship has one print label option: Print-At-The-End (PATE). All labels print at the end after the
shipment is confirmed.
For FedEx Express U.S. C.O.D. shipments, a C.O.D. Return Label is returned with the label of the last
package in the shipment.

20.12.3Asynchronous Processing
The Asynchronous Processing Option in the OpenShip WSDL lets you specify the manner in which the
shipment artifacts are returned. The shipment artifacts are shipping labels and all associated documents,
such as Commercial Invoice, Certification of Origin, NAFTA Certificate of Origin, Export Declaration and
so on.
Specify the shipment artifacts to be returned using only one of the following options:


ALLOW_ASYNCHRONOUS - Allows for immediate, synchronous processing when possible and
asynchronous processing if the transaction times out. If the time out limit is reached, then any
results may be retrieved later. If the transaction processes within the asynchronous limits, then the
results will be contained in the standard reply.



ASYNCHRONOUS_ONLY - Restricts the transaction to asynchronous processing and any results
must be retrieved at a later time.



SYNCHRONOUS_ONLY - Restricts the transaction to synchronous processing only. If the time out
limit is reached, then an error is returned in the reply.

If shipment artifacts are to be processed asynchronously, then the reply transaction, either
CreateOpenShipmentReply, ModifyOpenShipmentReply or ConfirmOpenShipmentReply, will contain the
identifier, which is the JobId, by which the deferred shipment artifacts must be identified in the
subsequent retrieval request.
Specifically, if the initial transaction that requests asynchronous processing is the
CreateOpenShipmentRequest, then the JobId that is returned in the CreateOpenShipmentReply must
FedEx Web Services, Developer Guide 2016

406

Open Shipping
then be inserted in the corresponding GetCreateOpenShipmentResultsRequest to identify the desired,
deferred artifacts. The deferred artifacts are then returned in the GetCreateOpenShipmentResultsReply
transaction. This same sequence applies to the ModifyOpenShipmentRequest,
ModifyOpenShipmentReply, GetModifyOpenShipmentResultsRequest transactions and the
ConfirmOpenShipmentRequest, ConfirmOpenShipmentReply,
GetConfirmOpenShipmentResultsRequest transactions.
Table 157. RetrieveJobResultsRequest
Element

Multiple
Description
Occurrence

JobId

Optional. Specify the job under which the desire artifacts are
stored.

Filters

Yes

Optional. Specify the filters to be used for retrieving artifacts.

Filters/AccessReference

Optional.

Filters/Type

Optional.

Filters/ReferenceId

Optional.

Table 158. Retrieve Job Results Reply
Element

Multiple
Description
Occurrence

HighestSeverity

Notifications

Yes

FedEx Web Services, Developer Guide 2016

The element identifies the highest severity
encountered when performing the request.
Valid values are:


FAILURE



ERROR



WARNING



NOTE



SUCCESS

The element includes the descriptive data detailing
the status of a submitted transaction. Includes the
severity of the notification, which indicates success
or failure or some other information about the
request.
Valid values are:


SUCCESS – Your transaction succeeded with
no other applicable information.



NOTE – Additional information that may be of
interest to you about your transaction.

407

Open Shipping

Element

Multiple
Description
Occurrence


WARNING – Additional information that you
need to know about your transaction that you
may need to take action on.



ERROR – Information about an error that
occurred while processing your transaction.



FAILURE – FedEx was unable to process your
transaction at this time due to a system
failure. Please try again later.

Notifications/Severity

The element Specify the severity of the notification.
This can indicate success or failure or some other
information about the request.
See Notifications element for valid values.

Notifications/Source

The element indicates the source of the
notification. Combined with the Code it uniquely
identifies the notification

Notifications/Code

A code that represents this notification. Combined
with the Source it uniquely identifies this
notification.

Notifications/Message

Human-readable text that explains this notification.

Notifications/LocalizedMessage

The translated message. The language and locale
specified in the ClientDetail. Localization are used
to determine the representation. Currently only
supported in a TrackReply.

Notifications/MessageParameters

Yes

A collection of name/value pairs that provide
specific data to help the client determine the nature
of an error (or warning, etc.) without having to
parse the message string.

/MessageParameters/Id

Identifies the type of data contained in Value (e.g.
SERVICE_TYPE, PACKAGE_SEQUENCE, etc.).

/MessageParameters/Value

The value of the parameter (e.g.
PRIORITY_OVERNIGHT, 2, etc.).

TransactionDetail

Contains the CustomerTransactionID that was sent
in the request.

TransactionDetail/
CustomerTransactionId

Free form text to be echoed back in the reply. Used
to match requests and replies.

TransactionDetail/Localization

Governs data payload language/translations
(contrasted with ClientDetail.localization, which
governs Notification.localizedMessage language
selection).

FedEx Web Services, Developer Guide 2016

408

Open Shipping

Element

Multiple
Description
Occurrence

/Locationalization/LanguageCode

Two-letter code for language (e.g. EN, FR, etc.).

/Locationalization/LocaleCode

Two-letter code for the region (e.g. us, ca, etc.).

Version

The version of this reply.

Artifacts

Yes

Shipping labels and all associated documents.

Artifacts/AccessReference

Artifacts/HighestSeverity

Artifacts/Notifications

/Notifications/Severity

Yes

Identifies the highest severity encountered when
performing the request.
Valid values:


FAILURE



ERROR



WARNING



NOTE



SUCCESS

Includes the descriptive data detailing the status of
a submitted transaction. Includes the severity of
the notification, which indicates success or failure
or some other information about the request.
Valid values are:


SUCCESS — Your transaction succeeded
with no other applicable information.



NOTE — Additional information that may be
of interest to you about your transaction.



WARNING — Additional information that you
need to know about your transaction that you
may need to take action on.



ERROR — Information about an error that
occurred while processing your transaction.



FAILURE — FedEx was unable to process
your transaction at this time due to a system
failure. Please try again later.

The severity of this notification. This can indicate
success or failure or some other information about
the request.
Valid values are:


FedEx Web Services, Developer Guide 2016

SUCCESS — Your transaction succeeded
with no other applicable information.

409

Open Shipping

Element

Multiple
Description
Occurrence


NOTE — Additional information that may be
of interest to you about your transaction.



WARNING — Additional information that you
need to know about your transaction that you
may need to take action on.



ERROR — Information about an error that
occurred while processing your transaction.



FAILURE — FedEx was unable to process
your transaction at this time due to a system
failure. Please try again later.

/Notifications/Source

Indicates the source of this notification. Combined
with the Code it uniquely identifies this notification.

/Notifications/Code

A code that represents this notification. Combined
with the Source it uniquely identifies this
notification.

/Notifications/Message

Human-readable text that explains this notification.

/Notifications/LocalizedMessage

No.

The translated message. The language and locale
specified in the ClientDetail. Localization are used
to determine the representation. Currently only
supported in a TrackReply.

/Notifications/MessageParameters

Yes

A collection of name/value pairs that provide
specific data to help the client determine the nature
of an error (or warning, etc.) without having to
parse the message string.

Type

Identifies the type of artifact.

Format

Specify the format of the artifact.

FormatSpecification

Identifies the schema or specific format definition
used for the artifact.

ReferenceId

Specify a reference to the artifact that follows the
naming convention defined for file storage.

Parts

Yes

Parts/SequenceNumber

Specify the sequence of this part of the artifact.

Parts/Contents

Specify the contents of this retrieved artifact part.

FedEx Web Services, Developer Guide 2016

410

Open Shipping

20.13 Open Ship Print Options
Open Ship has one print label option, Print-At-The-End (PATE) that prints all labels at the end after the
shipment is confirmed.

20.13.1Open Ship Print-At-The-End
You can choose to print labels for packages in your Open Ship shipment at the end, when you CONFIRM
the shipment.

20.14 Email Labels
Create either an Email Label (non-return) or an Email Return Label using the OpenShipService
CreatePendingShipment Request. Cancel either of these requests using the OpenShipService
DeletePendingShipment Request.
The Email Label option allows you to email a return label directly to your customer. Your customer can
then print the label, apply it to the package, and call for pickup or drop the package off at the nearest
FedEx drop-off location. For your customer’s convenience, the email also includes links for scheduling a
pickup and finding drop-off locations in the area. The email for Email Return Labels also contains a
barcode that mobile customers can take to a FedEx Office location to have the label printed.
Email Label supports 1-25 packages in a single request.
The following attributes of requestedShipment are used to identify an Email Return Label:


requestedShipment/SpecialServicesRequested/SpecialServiceTypes = PENDING_SHIPMENT



requestedShipment/SpecialServicesRequested/SpecialServiceTypes = RETURN_SHIPMENT



requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = EMAIL



requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = RETURN

The following attributes of requestedShipment are used to identify an Email Label (non-return):


requestedShipment/SpecialServicesRequested/SpecialServiceTypes = PENDING_SHIPMENT



requestedShipment/SpecialServicesRequested/PendingShipmentDetail/Type = EMAIL

20.14.1Email Label Service Details
The following service details apply to email labels:

20.14.2Delivery Area
Available for FedEx First Overnight®, FedEx First Overnight® Freight, FedEx Priority Overnight®, FedEx
Standard Overnight®, FedEx 2Day®, FedEx 2Day® A.M., FedEx Ground®, FedEx Home Delivery®, FedEx
2Day® Freight, and FedEx 3Day® Freight throughout the 50 United States and international shipments.

20.14.3Exceptions
FedEx Express Saver® and FedEx 1Day® Freight services are not available.
Dangerous Goods and HazMat cannot be shipped.

FedEx Web Services, Developer Guide 2016

411

Open Shipping

20.14.4Additional Information
Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location
and Redirect To Hold.
The maximum declared value is $1,000USD for FedEx First Overnight, FedEx Priority Overnight, FedEx
Standard Overnight, and FedEx 2Day.
The maximum declared value is $50,000USD for FedEx 2Day Freight and FedEx 3Day Freight.
The maximum declared value is $100USD for FedEx Ground and FedEx Home Delivery.

20.14.5Email Label Coding Details
The following coding details apply to email labels:


The email label is created using elements from the CreatingPendingShipmentRequest in the
OpenShipService WSDL for FedEx Ground or FedEx Express shipments. Requirements that apply to
ground and express shipments also apply to email labels.



The email label request is canceled using elements from the DeletePendingShipmentRequest in the
OpenshipService WSDL for FedEx Ground or FedEx Express shipments. Requirements that apply to
FedEx Ground and FedEx Express shipments also apply to email labels.



You may request up to 25 email labels to one email address using one request transaction.



Email label URLs expire according to your expiration time stamp.



After the customer prints the label, the label does not expire but can be used indefinitely.



A FedEx Ground Manifest is not required for an email label.



The only label format supported is laser (or plain paper).



A surcharge is added to a return email label. No surcharge is applied to a non-return email label.



The maximum expiration date for an Email Label (non-return) must be greater or equal to the day of
the label request and not greater than 30 days in the future.



The maximum expiration date for an Email Return Label must be greater or equal to the day of the
label request and not greater than 2 years in the future.



A Returns shipment can be associated to an Outbound shipment using the ReturnAssociation
element.

20.14.6Email Return Label Elements
In addition to the basic FedEx Ground or FedEx Express shipping elements required to request an Email
Return Label, the following elements must be included in the CreatePendingShipmentRequest:
Table 159. Email Return Label Elements
Element

Description

RequestedShipment/SpecialServicesR Required. Specify the type of special service.
equested/
Valid values for a Email Return Label are:
SpecialServiceTypes
1 PENDING_SHIPMENT
2 RETURNS_CLEARANCE
3 RETURN_SHIPMENT

FedEx Web Services, Developer Guide 2016

412

Open Shipping

Element

Description

RequestedShipment/SpecialServicesR Optional. Allows customers to direct the signed return receipt
equested/
to a different address.
DeliveryOnInvoiceAcceptanceDetail
RequestedShipment/SpecialServicesR Required.
equested/
Specify the Return Type.
ReturnShipmentDetail
Include the following value: PENDING
RequestedShipment/SpecialServicesR Optional. Return Materials Authorization Reason. You may
equested/
enter a reason for the return authorization associated with this
ReturnShipmentDetail/Rma/Reason
Email Return Label.
RequestedShipment/SpecialServicesR Required. Include the phone number for the merchant, such as
equested/
a general customer service phone number.
ReturnShipmentDetail/ReturnEmailDe
tail/
MerchantPhoneNumber
RequestedShipment/SpecialServicesR
equested/
ReturnShipmentDetail/ReturnEmailDe
tail/
AllowedSpecialServices

Optional. Allow specific special services for the end-user.
Valid values:


SATURDAY_DELIVERY



SATURDAY_PICKUP

RequestedShipment/SpecialServicesR Optional. Describes the data for the outbound shipment
equested/
associated with the return.
ReturnShipmentDetail/ReturnAssociati
on
RequestedShipment/SpecialServicesR Required.
equested/
Specify the Pending Shipment Type.
PendingShipmentDetail
Include the value: EMAIL
RequestedShipment/SpecialServicesR
equested/
PendingShipmentDetail/ExpirationDat
e

Required.
Specify the Email Return Label expiration date: for example,
2012-12-31.
The maximum expiration date for an Email Return Label must
be greater or equal to the day of the label request and not
greater than 2 years in the future.

RequestedShipment/SpecialServicesR Required. Email address of the end-user to be notified of the
equested/
return label. This element has a 200-character maximum.
PendingShipmentDetail/EmailLabelDe
tail/
NotificationEmailAddress
RequestedShipment/SpecialServicesR Optional. Notification message included in the email to the
equested/
end-user.
PendingShipmentDetail/EmailLabelDe
tail/
NotificationMessage
RequestedShipment/RequestedPacka
geLineItems/

Optional. A maximum of 40 characters is accepted in this
element. This element allows customer-defined notes to print

FedEx Web Services, Developer Guide 2016

413

Open Shipping

Element

Description

CustomerReferences/CustomerRefer
enceType

on the shipping label. For a RMA number, use the following
value:
RMA_ASSOCIATION
If specified, the package can also be tracked by this value.

20.14.7Email Label (non-return) Elements
In addition to the basic FedEx Express or FedEx Ground shipping elements required to request an email
label, the following elements must be included in the CreatePendingShipmentRequest:
Table 160. Email Label (non-return) Elements
Element

Description

RequestedShipment/SpecialServices
Requested/
SpecialServiceTypes

Required. Specify the type of special service.
Include the following value for an Email Label:
PENDING_SHIPMENT

RequestedShipment/SpecialServices
Requested/
PendingShipmentDetail

Required. Specify the pending shipment type.
Include the following value:
EMAIL

RequestedShipment/SpecialServices
Requested/
PendingShipmentDetail/ExpirationDat
e

Required. Specify the email label expiration date: for example,
2009-01-31.
The maximum expiration date for an Email Label (non-return)
must be greater or equal to the day of the label request and not
greater than 30 days in the future.

RequestedShipment/SpecialServices
Requested/
PendingShipmentDetail/EmailLabelD
etail/ NotificationEmailAddress

Required. Email address of the end-user to be notified of the
label.

RequestedShipment/SpecialServices
Requested/
PendingShipmentDetail/EmailLabelD
etail/
NotificationMessage

Optional. Notification message included in the email to the end
user (200-character maximum).

RequestedShipment/SpecialServices Optional. PackageCount and TotalWeight elements for Dry Ice
Requested/
shipments.
PendingShipmentDetail/ShipmentDry
IceDetail
RequestedShipment/SpecialServices
Requested/
PendingShipmentDetail/
HomeDeliveryPremiumDetail

Optional. Special service elements for FedEx Ground Home
Delivery shipments.

FedEx Web Services, Developer Guide 2016

414

Open Shipping

20.14.8Cancel Email Label Elements
In addition to the basic FedEx Express or FedEx Ground shipping elements required to request an email
label, the following element must be included in the DeletePendingShipmentRequest: Cancel Email
Label Elements
The following information is required to cancel an Email Return Label using a DeletePendingShipment
Web Service Request:
Table 161. Cancel Email Label Elements
Element

Required

Description

DeletePendingShipment

Required

The web service inside the OpenShip Service WSDL
file used to cancel all Email Return Labels

WebAuthenticationDetail/ParentC Required
redential

The value for the primary authentication credential for
a specific account.
Note: This element is available only for Compatible
Providers.

WebAuthenticationDetail/UserCr
edential/Key

Required

The value for the Key was provided by FedEx upon
your request. It is an alphanumeric mixed-case string.

WebAuthenticationDetail/UserCr
edential/Password

Required

The value for the Password was provided by FedEx
upon your request. It is an alphanumeric mixed-case
string.

ClientDetail/AccountNumber

Required

The FedEx Express nine-digit meter number that was
provided by FedEx upon your request.

ClientDetail/MeterNumber

Required

The FedEx Express meter number that was provided
by FedEx upon your request.

Version/ServiceId

Required

The value is “ship".

Version/Major

Required

The current value is "7".

Version/Intermediate

Required

The current value is "0".

Version/Minor

Required

The current value is "0".

TrackingId/TrackingIdType

Required

Required.
A Tracking number is required to cancel a specific
package. Specify type of tracking id.
Valid values are:
 GROUND

USPS

FEDEX

FedEx Web Services, Developer Guide 2016

415

Open Shipping

Element

Required

Description

TrackingId/TrackingNumber

Optional
and/or
Required

Required. The Tracking number for the active
package you wish to cancel.

20.15 Email Return Label Elements
Basic information is required in a CreatePendingShipment Request:
Note: Name and address elements in the CreatePendingShipment request will appear in the email the customer
receives from FedEx, but won't be on the shipping label.

Table 162. CreatePendingShipment Basic Returns Email Label Request Elements
Element

Description

CreatePendingShipment

Required
The web service inside the Ship Service WSDL file used to create
all Email Return Labels.

WebAuthenticationDetail/ParentCre Required
dential
The value for the primary authentication credential for a specific
account.
Note: This element is available only for Compatible Providers.
WebAuthenticationDetail/UserCred
ential/Key

Required
The value for the Key was provided by FedEx upon your request. It
is an alphanumeric mixed-case string.

WebAuthenticationDetail/UserCred
ential/Password

Required
The value for the Password was provided by FedEx upon your
request. It is an alphanumeric mixed-case string.

ClientDetail/AccountNumber

Required
The FedEx Express nine-digit meter number that was provided by
FedEx upon your request.

ClientDetail/MeterNumber

Required
The FedEx Express meter number that was provided by FedEx
upon your request.

Version/ServiceId

Required
The value is “ship”.

Version/Major

Required
The current value is "15".

Version/Intermediate

Required
The current value is "0".

Version/Minor

Required
The current value is "0".

FedEx Web Services, Developer Guide 2016

416

Open Shipping

Element

Description

RequestedShipment/ServiceType

Required
For this transaction the valid value is SMART_POST.

RequestedShipment/Shipper/Conta
ct/PersonName

Optional and/or Required
Required if Contact name is blank.

RequestedShipment/Shipper/Conta
ct/CompanyName

Optional and/or Required
Required if Company name is blank.

RequestedShipment/Shipper/Conta
ct/PhoneNumber

Required
Shipper phone number. Numeric only.

RequestedShipment/Shipper/Conta
ct

Optional and/or Required
There are additional elements available. They are optional.

RequestedShipment/Shipper/Addre Optional and/or Required
ss/StreetLines
At least one street address line is required. This is a multiple
occurrence element.
RequestedShipment/Shipper/Addre Required
ss/City
Shipper city.
RequestedShipment/Shipper/Addre Required
ss/
Please refer to Appendix B for a list of State Codes.
StateOrProvinceCode
RequestedShipment/Shipper/Addre Required
ss/
Shipper postal code.
PostalCode
RequestedShipment/Shipper/Addre Required
ss/CountryCode
Valid value - US.
RequestedShipment/Shipper/Addre Optional
ss/CountryName
The fully spelled out name of a country.
RequestedShipment/Shipper/Addre Optional and/or Required
ss
There are additional elements available. They are optional.
RequestedShipment/Recipient/Con
tact

Optional
The descriptive data for a point-of-contact person.

RequestedShipment/Recipient/Con
tact/ContactId

Optional
Client provided identifier corresponding to this contact information.

RequestedShipment/Recipient/Con
tact/PersonName

Optional and/or Required
Required if Contact name is blank.

RequestedShipment/Recipient/Con
tact/Title

Optional
Identifies the contact person's title.

RequestedShipment/Recipient/Con
tact/
CompanyName

Optional and/or Required
Required if Company name is blank.

RequestedShipment/Recipient/Con
tact/

Required.
Recipient phone number. Numeric only.

FedEx Web Services, Developer Guide 2016

417

Open Shipping

Element

Description

PhoneNumber
RequestedShipment/Recipient/Con
tact/
PhoneExtension

Optional
Identifies the phone extension associated with this contact.

RequestedShipment/Recipient/Con
tact/
TollFreePhoneNumber

Optional
Identifies a toll free number, if any, associated with this contact.

RequestedShipment/Recipient/Con
tact/FaxNumber

Optional
Identifies the fax number associated with this contact.

RequestedShipment/Recipient/Con
tact/EmailAddress

Optional
Identifies the email address associated with this contact.

RequestedShipment/Recipient/Add
ress/StreetLines

Optional and/or Required
At least one street address line is required. This is a multiple
occurrence element.

RequestedShipment/Recipient/Add
ress/City

Required
Recipient city.

RequestedShipment/Recipient/Add
ress/
StateOrProvinceCode

Required
Refer to Appendix B for a list of State Codes.

RequestedShipment/Recipient/Add
ress/
PostalCode

Required
Recipient postal code.

RequestedShipment/Recipient/Add
ress/
CountryCode

Required
Valid value - US.

RequestedShipment/Recipient/Add
ress/
CountryName

Optional
The fully spelled out name of a country.

RequestedShipment/Recipient/Add
ress

Optional and/or Required
There are additional elements available. They are optional.

In addition to the basic shipping elements, the following elements in Table 157 must be included in the
CreatePendingShipmentRequest to trigger an Email Return Label through fedex.com:
Table 163. CreatePendingShipment Request Returns Email Label Through FedEx Elements
Element

Description

RequestedShipment/
SpecialServicesRequested/
SpecialServiceTypes

Required.
Specify the type of special service. Both of these Service
Types must be included for a returns email label:


PENDING_SHIPMENT



RETURN_SHIPMENT

FedEx Web Services, Developer Guide 2016

418

Open Shipping

Element

Description

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/ReturnType

Required
Specify the Return Type. Use the following value:

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/ReturnEmailDet
ail/ MerchantPhoneNumber

Required
Include the phone number for the merchant, such as a general
customer service phone number.
Max 10 characters, numeric-only string.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/Type

Required.
Specify the Pending Shipment Type. Include the following
value:



PENDING

RequestedShipment/
Required.
SpecialServicesRequested/
Specify the email label expiration date: for example, 2009-01PendingShipmentDetail/ExpirationDate 31.
The maximum expiration date for an Email Return Label must
be greater or equal to the day of the label request and not
greater than 2 years in the future.
RequestedShipment/
Required.
SpecialServicesRequested/
Email address of the end-user to be notified of the return label.
PendingShipmentDetail/EmailLabelDet This element has a 200-character maximum.
ail/ NotificationEmailAddress
RequestedShipment/
Optional
SpecialServicesRequested/
Notification message included in the email to the end-user.
PendingShipmentDetail/EmailLabelDet
ail/ NotificationMessage

20.15.1Open Shipping Useful Tips
The following three methods can be processed asynchronously:


CreateOpenShipmentRequest



ModifyOpenShipmentRequest



ConfirmOpenShipmentRequest

For synchronous processing, a transaction should have either 40 packages/shipment or 10 or less
commodities in a shipment.
Note: These limits are subjected to change. If the transaction exceeds these limits and if the request has
SYNCHRONOUS_ONLY option for AsynchronousProcessingOptions element, then the transaction would fail.
In this case, AsynchronousProcessingOptions element should have ALLOW_ASYNCHRONOUS value.

When using ALLOW_ASYNCHRONOUS value for AsynchronousProcessingOptions element, the system
will decide if the transaction will have to be processed synchronously or a synchronously. As a best
practice, make sure that you code to check for the reply which contains either
“SYNCHRONOUSLY_PROCESSED” or “ASYNCHRONOUSLY_PROCESSED”.

FedEx Web Services, Developer Guide 2016

419

Open Shipping
If the transaction is asynchronously processed, then the reply only confirms that the request is queued
successfully for async processing. The shipment itself might not be successfully processed and so the
corresponding get result method will have to be used to check if the shipments were processed
successfully.
For example, for ConfirmOpenShipmentRequest use getConfirmOpenShipmentResultsRequest.
With a CreateOpenShipmentRequest, when processing SYNCHRONOUS_ONLY, make sure that the
number of packages is less than 40 and the packages should all be added before confirming.
Best practice to process large number of packages asynchronously, when there are more number of
packages in a shipment, is to run them using multiple transactions, with each transaction having
manageable number of packages say 50 or 100 and set disposition type as STORED to store the labels.
These labels can then be retrieved using retrieveJobResults.

FedEx Web Services, Developer Guide 2016

420

Pickup Service

21 Pickup Service
The Pickup Service WSDL allows you to schedule a courier to pick up a shipment, cancel a pickup
request, or check for pickup availability. Use the Pickup Service to schedule courier pickup of a shipment
at the location specified in the transaction.

21.1 Pickup Service Details
21.1.1 FedEx Express® Pickup Requests


The time that your packages will be ready to be picked up must be no later than the postal code
cutoff time for your location. The cutoff time can be retrieved with the PickupAvailability request.



The length of time from when your packages will be ready to the time at which the courier will no
longer be able to enter the premises to pick up the packages must be no less than the "access time",
which can also be retrieved with the PickupAvailability request.



FedEx Express pickup can be scheduled for the current or next business day.



The maximum number of packages for a single pickup request is 99.



If you already have a regular scheduled pickup, it is not necessary to schedule a one-time pickup or
add another regular scheduled pickup.



You cannot change a pickup request. To change a request, you must delete the original request and
enter a new request.



FedEx systems now supports domestic UK Pickup functionality.

For more information about your cut-off time, call FedEx Customer Service at 1.800.GoFedEx
1.800.463.3339.

21.1.2 FedEx Ground® Pickup Requests


Pickup can be scheduled for the next business day or any business day up to 2 weeks in advance.



Maximum number of packages for a single pickup request is 99.



If you already have a regular scheduled pickup, it is not necessary to schedule a one-time pickup or
add another regular scheduled pickup.



Pickup at a residential address is available for an additional surcharge.



You cannot change a pickup request. To change a request, you must delete the original request and
enter a new request.

21.1.3 General information


To request a pickup for a different country, include the Country element with the appropriate country
code where you would like FedEx to pick up your shipment.



If you need to schedule a pickup for both FedEx Express (including intra-Mexico shipping) and FedEx
Ground packages, you are required to schedule one pickup for each of the carriers individually.



If your total package weight exceeds 150 lbs., contact FedEx Customer Service for assistance.

FedEx Web Services, Developer Guide 2016

421

Pickup Service


If your pickup location is in a remote area, make sure your packages are ready earlier to
accommodate remote pickup schedule.



Always include the latest time your package can be picked up (or your company’s close time).



Saturday pickup service is offered in select locations worldwide for your FedEx Express packages.
Saturday drop-off is also available at many FedEx locations. Use the FedEx Web Services Locations
Service WSDL to receive a list of Saturday drop-off locations.



For FedEx Ground and FedEx Express pickups, you may request an alternate pickup address other
than the shipping location attached to your FedEx account number. An additional surcharge applies.



If you want a regular FedEx Express or FedEx Ground pickup service, contact your FedEx account
executive.



Pick up can be scheduled for FedEx SameDay® within Mexico and FedEx SameDay® City within
Mexico City and the southern Mexican States. For additional details please refer to FedEx_SameDay
section of Ship Service.

New options have been added to support domestic UK pickup as mentioned below:


FEDEX_DISTANCE_DEFERRED



FEDEX_NEXT_DAY_EARLY_MORNING



FEDEX_NEXT_DAY_MID_MORNING



FEDEX_NEXT_DAY_AFTERNOON



FEDEX_NEXT_DAY_END_OF_DAY



FEDEX_NEXT_DAY_FREIGHT

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

21.2 LTL Freight Pickup Special Services
CreatePickupRequest has several special service types that can be setup in
FreightPickupDetail/LineItems. Some of these Special Services are only for LTL, some for small parcels
and some are for both. The ones marked 'For Freight Shipments' in the shipment special service type
valid values in the table below relate to LTL freight pickup.
Table 164. FreightPickupDetail/LineItems
Element
FreightPickupDetail/LineItems/
ShipmentSpecialServicesRequested/
ShipmentSpecialServiceType

Description


BLIND_SHIPMENT - Freight shipment to be handled as blind
shipment.



BROKER_SELECT_OPTION



CALL_BEFORE_DELIVERY - For Freight shipments.



COD



CUSTOM_DELIVERY_WINDOW - Freight shipment has nonstandard delivery date/range.

FedEx Web Services, Developer Guide 2016

422

Pickup Service

Element

Description


CUT_FLOWERS



DANGEROUS_GOODS - Freight shipment contains
hazardous materials.



DELIVERY_ON_INVOICE_ACCEPTANCE



DETENTION - Freight shipment delayed prior to loading or
unloading.



DO_NOT_BREAK_DOWN_PALLETS - For Freight
shipments.



DO_NOT_STACK_PALLETS - For Freight shipments.



DRY_ICE



EAST_COAST_SPECIAL



ELECTRONIC_TRADE_DOCUMENTS - Electronic Trade
Documents for international parcel shipments.



EVENT_NOTIFICATION



EXCLUSIVE_USE - Freight shipment requires exclusive use
of equipment.



EXHIBITION_DELIVERY - Freight shipment delivery address
is for amusement park, trade show, fair, etc.



EXHIBITION_PICKUP - Freight shipment pickup address is
for amusement park, trade show, fair, etc.



EXPEDITED_ALTERNATE_DELIVERY_ROUTE - For Custom
Critical use only.



EXPEDITED_ONE_DAY_EARLIER - For Custom Critical use
only.



EXPEDITED_SERVICE_MONITORING_AND_DELIVERY - For
Custom Critical use only.



EXPEDITED_STANDARD_DAY_EARLY_DELIVERY - For
Custom Critical use only.



EXTRA_LABOR - Express Freight shipment requires
additional labor at load or unload.



EXTREME_LENGTH - Freight shipment contains shipping
unit or piece with excessive length.



FEDEX_ONE_RATE



FLATBED_TRAILER - Freight shipment requires flatbed
trailer.



FOOD - For Freight shipments.

FedEx Web Services, Developer Guide 2016

423

Pickup Service

Element

Description


FREIGHT_GUARANTEE - Freight shipment has date or date
and time delivery guarantee.



FREIGHT_TO_COLLECT - For Pitstop India



FUTURE_DAY_SHIPMENT



HOLD_AT_LOCATION



HOLIDAY_DELIVERY - For Pitstop India



HOLIDAY_GUARANTEE - Freight shipment to be delivered
on holiday.



HOME_DELIVERY_PREMIUM



INSIDE_DELIVERY



INSIDE_PICKUP



INTERNATIONAL_CONTROLLED_EXPORT_SERVICE



INTERNATIONAL_MAIL_SERVICE



INTERNATIONAL_TRAFFIC_IN_ARMS_REGULATIONS



LIFTGATE_DELIVERY - Freight shipment requires liftgate at
delivery address.



LIFTGATE_PICKUP - Freight shipment requires liftgate at
pickup address.



LIMITED_ACCESS_DELIVERY - Freight shipment to be
delivered at address with limited access.



LIMITED_ACCESS_PICKUP - Freight shipment to be picked
up at address with limited access.



MARKING_OR_TAGGING - Freight shipment to include
marking or tagging of pieces.



NON_BUSINESS_TIME - Freight shipment to include
services performed during non-business hours and/or days.



PALLET_SHRINKWRAP - Freight shipment to include
shrinkwrapping of pallets by FedEx Freight.



PALLET_WEIGHT_ALLOWANCE - Freight shipment to be
rated with standard allowance for pallets.



PALLETS_PROVIDED - Freight shipment to include pallets
provded by FedEx Freight.



PENDING_COMPLETE



PENDING_SHIPMENT



PERMIT - Freight shipment to include permit obtained by
FedEx.

FedEx Web Services, Developer Guide 2016

424

Pickup Service

Element

Description


PHARMACY_DELIVERY



POISON - For Freight shipments.



PORT_DELIVERY - Freight shipment to include delivery to a
port.



PORT_PICKUP - Freight shipment to include pickup at a
port.



PRE_DELIVERY_NOTIFICATION - Freight shipment requires
notification to consignee prior to delivery.



PROTECTION_FROM_FREEZING - Freight shipment
requires protection from freezing temperatures.



REGIONAL_MALL_DELIVERY - Freight shipment to be
delivered at major regional shopping mall.



REGIONAL_MALL_PICKUP - Freight shipment to be picked
up at major regional shopping mall.



RETURN_SHIPMENT



RETURNS_CLEARANCE - Special clearance requested for
international returns shipment.



RETURNS_CLEARANCE_SPECIAL_ROUTING_REQUIRED



SATURDAY_DELIVERY



SATURDAY_PICKUP



SHIPMENT_ASSEMBLY - Freight shipment to include
assembly services.



SORT_AND_SEGREGATE - Freight shipment to include
sorting and/or segregating services.



SPECIAL_DELIVERY - For Pitstop India



SPECIAL_EQUIPMENT - Freight shipment to include use of
special equipment.



STORAGE - Freight shipment to include storage by carrier.



SUNDAY_DELIVERY - For Pitstop India



THIRD_PARTY_CONSIGNEE



TOP_LOAD - For Freight shipments.



USPS_DELIVERY - Freight shipment to include delivery by
US Postal Service.



USPS_PICKUP - Freight shipment to include pickup by US
Postal Service.



WEIGHING - Freight shipment to include weighing.

FedEx Web Services, Developer Guide 2016

425

Pickup Service
Note:
Below are examples of when and why a SpecialServicesType needs to be specified in a LTL freight request:
* FOOD value is selected when shipment has food items. This is required for Freight so that this shipment is not
moved with other shipments that may potentially contain poison. The same is applied for POISON service so
that it cannot be moved with FOOD shipments.

TOP_LOAD value is selected when shipment is delicate and that needs to be kept at the top – so that other
shipments are not stacked on this to avoid damage.

DO_NOT_BREAK_DOWN_PALLETS value is selected if restacking of pallets may be required for a load shifted to
put the truck back in balance or if an inspection may be needed due to freight being miss-represented and not
classified correctly.

21.3 Pickup Service Request Elements
In addition to the elements required for all requests, the following elements are included in the Pickup
Service request
Table 165. Pickup Service Request Elements
Element

Description

AssociatedAccountNumber

Optional.
This is the account number that will be invoiced for the
pickup. The order of precedence is
AssociatedAccountNumber (if there is one specified) and
then ClientDetail/AccountNumber. Putting the account
number in both elements (if same) is fine, but not
necessary.

TrackingNumber

Specify the tracking number to be used for processing a
pickup for a return shipment. Optional.

OriginDetail/UseAccountAddress

This element is required if you want to have the package
picked up at a different address than the one associated
with the shipper account. Valid values are:
True — Use shipper Address
False — User Alternate Address
If you enter N, the PickupLocation element is required.

OriginDetail/PickupLocation

This element is required for alternate pickup addresses.
Valid elements are:

OriginDetail/PackageLocation

FedEx Web Services, Developer Guide 2016



Contact



Address

Provides a location description where the courier/driver
will pick up the package.
PickupServiceBuildingLocationType valid values are:


FRONT



NONE



SIDE

426

Pickup Service

Element

Description


OriginDetail/BuildingPartCode

REAR

Describes the package location building type for the
pickup:


APARTMENT



BUILDING



DEPARTMENT



FLOOR



ROOM



SUITE

OriginDetail/BuildingPartDescription

Accompanies the BuildingPartCode to describe the
package pickup location. Entries can be an apartment
number, suite number, etc.

OriginDetail/ReadyTimestamp

Identifies the date and time the package will be ready for
pickup by FedEx. The time must be no later than the
CutOffTime, which can be discovered with the
PickupAvailabilityRequest. FedEx Express pickup can be
scheduled for the current or next business day.
The date format must be YYYY-MM-DDTHH:MM:SS.
The time must be in the format: HH:MM:SS using a 24hour clock.
The date and time are separated by the letter T, such as
2015-03-25T09:30:00.
The time is local to the pickup postal code.
Do not include a TZD (time zone designator) as it will be
ignored.

OriginDetail/CompanyCloseTime

Required. Identifies the latest time at which the driver can
gain access to pick up the package(s). The time between
the ReadyTimestamp and the CompanyCloseTime must
not be less than the AccessTime, which is present in the
PickupAvailabilityRequest.
The time must be in the format: HH:MM:SS using a 24hour clock, such as 17:30:00. The time is local to the
pickup postal code.
Do not include a TZD (time zone designator) as it will be
ignored.

PickupServiceRequest/PackageCount

Total number of packages that make up the dispatch
request.

PickupServiceRequest/TotalWeight

Total weight of packages that make up the dispatch
request.

PickupServiceRequest/CarrierCode

FedEx operating company (FedEx Express, FedEx
Ground) performing the pickup.

FedEx Web Services, Developer Guide 2016

427

Pickup Service

Element

Description

PickupServiceRequest/OversizePackageC
ount

Identifies the number of oversize packages that are
tendered to FedEx Ground. For more information about
oversize package requirements, see the electronic FedEx
Service Guide.

PickupServiceRequest/CourierRemarks

Any additional information that the courier needs to
perform your pickup should be included in the reply
request.

PickupServiceRequest/CommodityDescrip
tion

Required for international APAC customers only. Provides
area for any additional commodity description. Element is
limited to 20 characters since P2D and Cosmos restrict
the commodity description to 20 characters.

CreatePickupRequest/PickupServiceCateg
ory

Specify the service category for the pickup being
scheduled. Valid values are:

CreatePickupRequest/FreightPickupDetai
l/LineItems/
SpecialServicesRequested/ShipmentDryI
ceDetail ProcessingOptions/Options



SAME_DAY



SAME_DAY_CITY



FEDEX_DISTANCE_DEFERRED



FEDEX_NEXT_DAY_EARLY_MORNING



FEDEX_NEXT_DAY_MID_MORNING



FEDEX_NEXT_DAY_AFTERNOON



FEDEX_NEXT_DAY_END_OF_DAY



FEDEX_NEXT_DAY_FREIGHT

SHIPMENT_LEVEL_DRY_ICE_ONLY
This option Specify that dry ice information is only
applicable at the shipment level. Package level dry ice
information would not apply.

Note: Dispatch requests should be limited to one request per day unless you add packages that exceed the
dimensions or weight for the original request.

If you want to schedule a FedEx Express Freight dispatch, the following additional elements are required.
Table 166. ExpressFreightDetail Elements
Element

Description

ExpressFreightDetail/Service

Valid FedEx Freight service type.

ExpressFreightDetail/BookingNumber

All freight shipments required an advanced booking number
from FedEx. This booking number is also required for freight
dispatch requests.

ExpressFreightDetail/Dimensions

Length, width, and height of freight shipment to be picked
up.

ExpressFreightDetail/TruckType

Type of truck required for pickup.
Valid values are:

FedEx Web Services, Developer Guide 2016

428

Pickup Service

Element

Description

ExpressFreightDetail/TrailerSize

Example 31:



Drop_Trailer_Agreement



Liftgate



Tractor_Trailer_Access

Trailer size required for dispatch.
Valid values are:


TRAILER_28_FT



TRAILER_48_FT



TRAILER_53_FT

CreatePickup Request

XXXXXXXXXX

XXXXXXXXX
XXXXXXX
12345

EN
ES

Create Express
Pickup

FedEx Web Services, Developer Guide 2016

429

Pickup Service
ES

disp
11
0
0

FEDEX_EXPRESS
XXXXXXXXX

XXXXXXXX
XXXXXXX
XXX
XXXXXX
XXXXXXXXXX
XXXXXXXX
XXXXXXXXXX
XXXXXXXXXX
XXXXX

XXXXX
XXXXX
XXXXX
City
XX
XXXX
XX

FRONT
DEPARTMENT
BuildingPartDescription
YYYY-MM-DDT00:00:00

FedEx Web Services, Developer Guide 2016

430

Pickup Service
00:00:00
COS
SuppliesRequested

FEDEX_NEXT_DAY_EARLY_MORNING

DANGEROUS_GOODS

ADR
BATTERY

LB
1.0

FDXE
1
Remarks
TEST ENVIRONMENT - PLEASE DO NOT PROCESS
PICKUP
DOMESTIC

21.4 Pickup Service Reply Elements
The following elements are returned in the Pickup Service reply:
Table 167. PickupServiceReply Elements
Element

Description

DispatchConfirmationNumber

FedEx returns a dispatch confirmation number for a successful
dispatch request. This number must be used if you need to cancel the
dispatch.

FedEx Web Services, Developer Guide 2016

431

Pickup Service

Element

Description

Location

The FedEx station ID receiving an FedEx Express dispatch request.

Message

This message provides information regarding the success or failure of
the dispatch request.
Note: Dispatch requests may fail if you enter an insufficient time window
between Package Ready and Business Close. If you have questions about
pickup times, contact your regional FedEx Support Hotline.

PRP Control Number

If you have contracted with FedEx to use the Package Return Program
(PRP), the PRP control number is required in your dispatch request.
For more information about PRP, go to
fedex.com/us/services/options/returns/prp.html.

21.5 Pickup Service Country Codes
Table 168. Pickup Service Country Codes
Code Country

Code

Country

United Arab Emirates

Ireland

Netherlands Antilles

Israel

Argentina

India

Austria

Italy

Australia

Jamaica

Aruba

Japan

Barbados

St. Kitts/Nevis

Belgium

South Korea

Bulgaria

Kuwait

Bahrain

Cayman Islands

Bermuda

St. Lucia

Brazil

Sri Lanka

Bahamas

Luxembourg

Canada

Martinique

Switzerland

Mexico

Chile

Malaysia

Colombia

Netherlands

Costa Rica

New Zealand

Czech Republic

Panama

FedEx Web Services, Developer Guide 2016

432

Pickup Service

Code Country

Code

Country

Germany

Philippines

Denmark

Poland

Dominican Republic

Puerto Rico

Ecuador

Sweden

Egypt

Singapore

Spain

El Salvador

Finland

Turks & Caicos Islands

France

Trinidad/Tobago

United Kingdom

Taiwan

Grenada

United States

Guadeloupe

Uruguay

Guatemala

St. Vincent

Hong Kong

Venezuela

Honduras

British Virgin Islands

Hungary

U.S. Virgin Islands

Indonesia

China

21.6 Cancel Pickup Service Details
Use the Cancel Pickup Service to cancel a pickup request.
You may cancel a FedEx Express or FedEx Ground pickup if the request package ready time has not
already been met. See Cancel Pickup Request/Reply Coding Details for FedEx Freight. For more
detailed information about the services offered by FedEx, see the electronic FedEx Service Guide.

21.6.1 Cancel Pickup Service Coding Details
In addition to the basic service elements required for most transactions (AuthenticationDetail and
ClientDetail), the following elements are required to cancel a Pickup Service request:
Table 169. CancelPickup Service Request Elements
Element

Description

DispatchConfirmationNumber

This number is received from FedEx in your dispatch reply and is
required for canceling a dispatch request.

ScheduledDate

Indicates the date the dispatch occurs.

Location

The location information for the FedEx station handling the dispatch
is returned in the dispatch reply. This information is required to
cancel an FedEx Express dispatch.

FedEx Web Services, Developer Guide 2016

433

Pickup Service

Element

Description

CourierRemarks

Any additional information for the FedEx courier regarding the
dispatch cancellation.

If you enter an invalid dispatch confirmation number or this number does not match the location and/or
scheduled date of the dispatch, you will receive an error notification. If the FedEx courier has already
been dispatched to your pickup location, the dispatch cannot be canceled and the CancelPickup Service
reply will return a failure notification.
Example 32:

CancelPickup Service Request

XXXXXXXXXX

XXXXXXXXXX
XXXXXXXXXX

EN
US

CancelPickupRequest_v9

EN
US

disp
11

FedEx Web Services, Developer Guide 2016

434

Pickup Service
0
0

FDXE
XX
2015-03-16
NQAA
Preet

CASH

BUSINESS_NATIONAL
XXXXXXXXXX
string

KR1059
NAME
Mr.
Company name
1111111111
1111111111
1111111111
1111111111

10 FED EX PKWY
FEDEX PARK
DENVER ADDRESS LINE 3
COLLIERVILLE
TN
38019
US

FEDEX_EXPRESS
XXXXXXXXXX

FedEx Web Services, Developer Guide 2016

435

Pickup Service

USD
220000

TXT
Radhika

21.6.2 Cancel Pickup Request/Reply Coding Details for FedEx Freight
In addition to the basic service elements required for most transactions (AuthenticationDetail and
ClientDetail), the following elements are required to cancel a Pickup request for a FedEx Freight
shipment:
Table 170. CancelPickupRequest Elements
Element

Description

CarrierCode

Identifies the FedEx service operating company (transportation) that
was sent the pickup that is being canceled.
Valid values are:


FDXC



FDXE



FDXG



FXCC



FXFR



FXSP

PickupConfirmationNumber

Identifies the pickup confirmation number that is being canceled. The
pickup confirmation number was returned to the client when the
pickup was requested.

ScheduledDate

Identifies the scheduled date for the pickup that is being canceled.
The scheduled date was provided by the client when the pickup was
requested.

EndDate

Identifies the end date for the pickup that is being canceled.

Location

Identifies the FedEx location identifier responsible for processing the
package pickup that is being canceled. The FedEx location identifier
was returned to the client when the pickup was requested. Required
for Express service type.

FedEx Web Services, Developer Guide 2016

436

Pickup Service

Element

Description

Remarks

Identifies comments the customer wants to convey to the FedEx
courier regarding the package pickup.

ShippingChargesPayment

Includes the descriptive data for the monetary compensation given to
FedEx for services rendered to the customer.

Reason

Identifies the reason for canceling the pickup request.

ContactName

Identifies the name of the person that requested pickup cancellation.

PhoneNumber

Identifies the phone number of the person that requested pickup
cancellation.

PhoneExtension

Identifies the phone extension of the person that requested pickup
cancellation.

The CancelPickupReply element returns the descriptive data to a client in response to a
CancelPickupRequest. The following elements are returned in a Cancel Pickup reply for a FedEx Freight
shipment:
Table 171. CancelPickupReply Elements
Element

Description

HighestSeverity

Identifies the highest severity encountered when performing the
request.
Valid values in order from high to low are:

Notifications



FAILURE



ERROR



WARNING



NOTE



SUCCESS

SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know about
your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction at this
time due to a system failure. Please try again later.

FedEx Web Services, Developer Guide 2016

437

Pickup Service

Element

Description

TransactionDetail

Includes descriptive data that governs data payload
language/translations. The TransactionDetail from the request is
echoed back to the caller in the corresponding reply.

Version

Identifies the version/level of a service operation expected by a caller
(in each request) and performed by the callee (in each reply).

Message

Includes a Human readable message from the dispatch system.

21.6.3 Pickup Availability Coding Details
Use Pickup Availability to obtain cutoff and access time required to request and schedule a pickup and
pickup based on the specified area. You may check pickup availability for either FedEx Express or FedEx
Ground shipments. See Pickup Availability Request/Reply Coding Details for FedEx Freight.
In addition to the basic service elements required for most transactions (AuthenticationDetail and
ClientDetail), the following elements are available for a PickupAvailability request:
Table 172. PickupAvailability Elements
Element

Description

PackageReadyTime

Optional.
Identifies the time the package will be ready for pickup by FedEx.
The time must be in the format: HH:MM:SS using a 24-hour clock,
such as 09:30:00. The time is local to the pickup postal code.
Do not include a TZD (time zone designator) as it will be ignored.
Note: The Package Ready Time does equate to the time the driver should arrive
for the package.

CustomerCloseTime

Optional.
Identifies the latest time at which the driver will be able to gain
access to pick up the package(s).
The time must be in the format: HH:MM:SS using a 24-hour clock,
such as 17:30:00. The time is local to the pickup postal code.
Do not include a TZD (time zone designator) as it will be ignored.

DispatchDate

Optional.
Specify the date for package pickup.
The date format must be YYYY-MM-DD such as 2015-03-25.

StreetLines

Optional.
Specify if a street address line(s) is required.

City

Optional.
Specify the pickup city.

StateOrProvinceCode

Required only if recipient country is U.S. or Canada, or if SED applies
and country is Mexico (MX).

FedEx Web Services, Developer Guide 2016

438

Pickup Service

Element

Description

PostalCode

Required for FedEx Ground shipments if recipient country is a postal
aware country.
See Appendix J: Postal-Aware Countries and Formats for a list of
postal aware countries.

UrbanizationCode

Optional. Relevant only to addresses in Puerto Rico, where multiple
addresses within the same postal code can have the same house
number and street name. When this is the case, the urbanization
code is needed to distinguish them.

CountryCode

Required.
For a list of valid codes, see Appendix A: Country Code Tables.

CountryName

Required. The fully spelled out name of a country.

PickupRequestType

Required. Request type valid values are:

Carriers

PickupShipmentAttributes
/dimensions



SAME_DAY



FUTURE_DAY

Required. FedEx service (FedEx Express, FedEx Ground) performing
the pickup. Valid values are:


FDXG



FDXE

Optional. Descriptive information about the package dimensions.

PickupShipmentAttributes/wei Optional. Descriptive information about the package weight.
ght

21.6.4 Pickup Availability Request/Reply Coding Details for FedEx
Freight
In addition to the basic service elements required for most transactions (AuthenticationDetail,
ClientDetail, TransactionDetail, and AccountNumber), the following elements are required to request
availability of pickup for a FedEx Freight shipment:
Table 173. PickupAvailabilityRequest Elements
Element

Description

PickupAddress

Includes descriptive data for a physical location. May be used as an
actual physical address (place to which one could go), or as a
container of "address parts" which should be handled as a unit, such
as a city-state-ZIP combination within the U.S.

FedEx Web Services, Developer Guide 2016

439

Pickup Service

Element

Description

PickupRequestType

Describes the relationship between the date on which a dispatch
occurs and the date on which it is created (scheduled) by means of a
CourierDispatchRequest.


FUTURE_DAY means that the dispatch date is later than the date
on which it is created. If FUTURE_DAY is included, then Options
with ScheduleDay of FUTURE_DAY will be included in the reply



SAME_DAY means that the dispatch is to occur on the date on
which it is created. If SAME_DAY is included, then Options with
ScheduleDay of SAME_DAY will be included in the reply.

DispatchDate

Identifies the dispatch date (in the local time zone) for the pickup
whose availability is being requested. The date format must be YYYYMM-DD such as 2015-03-25.

NumberOfBusinessDays

Identifies the number of business days to consider when checking
availability.

PackageReadyTime

Optional. Identifies the time the package will be ready for pickup by
FedEx. The time must be in the format: HH:MM:SS using a 24-hour
clock, such as 09:30:00. The time is local to the pickup postal code.
Do not include a TZD (time zone designator) as it will be ignored.
Note: The Package Ready Time does equate to the time the driver should arrive
for the package.

CustomerCloseTime

Optional. Identifies the latest time at which the driver will be able to
gain access to pick up the package(s).
The time must be in the format: HH:MM:SS-xx:xx using a 24-hour
clock, such as 17:30:00. The UTC offset indicates the number of
hours/minutes, such as xx:xx, from UTC; for example, 17:30:00-06:00
is defined as 5:30 p.m. Central Time. The time is local to the pickup
postal code.

Carriers

Identifies the FedEx carrier(s) for which availability is requested.
Valid values are:

ShipmentAttributes
Example 33:



FDXC



FDXE



FDXG



FXCC



FXFR



FXSP

Includes descriptive information about the shipment.

PickupAvailabilityRequest

FedEx Web Services, Developer Guide 2016

440

Pickup Service

XXXXXXXXXX
XXXXXXXXXX

XXXXXXXX
XXXXXXX

EN
ES

Ground Pickup
Availability

EN
ES

disp
11
0
0

SHIPPER ADDRESS5555 LeeeINE 1
Collierville
TN
XXXXX
XX
1

FedEx Web Services, Developer Guide 2016

441

Pickup Service

FUTURE_DAY
YYYY-MM-DD
3
00:00:00
00:00:00
FDXG

FEDEX_GROUND
YOUR_PACKAGING

12
12
12
IN

LB
150.0

21.6.5 Pickup Availability Reply Elements
The PickupAvailabilityReply element returns the descriptive data to a client in response to a
PickupAvailabilityRequest. The following elements are returned in a Pickup Availability reply for a FedEx
Freight shipment:
Table 174. Pickup Availability Reply Elements
Element

Description

HighestSeverity

Identifies the highest severity encountered when performing the
request. Valid values in order from high to low are:


FAILURE



ERROR



WARNING



NOTE



SUCCESS

FedEx Web Services, Developer Guide 2016

442

Pickup Service

Element

Description

Notifications

SUCCESS — Your transaction succeeded with no other
applicable information.



NOTE — Additional information that may be of interest to you
about your transaction.



WARNING — Additional information that you need to know
about your transaction that you may need to take action on.



ERROR — Information about an error that occurred while
processing your transaction.



FAILURE — FedEx was unable to process your transaction at
this time due to a system failure. Please try again later.

TransactionDetail

Includes descriptive data that governs data payload
language/translations. The TransactionDetail from the request is
echoed back to the caller in the corresponding reply.

Version

Identifies the version/level of a service operation expected by a caller
(in each request) and performed by the callee (in each reply).

RequestTimeStamp

Identifies the point in time when the request was processed.

Options

Identifies the options for picking up the shipment.

Options/Carrier

The carrier to which the PickupScheduleOption applies

Options/Description

Descriptive information about the shipment

Options/ScheduleDay
PickupRequestType

Tells whether this option describes a dispatch created on the
dispatch date (SAME_DAY), or on a prior date (FUTURE_DAY).

Options/Available

True if this pickup option is available.

Options/PickupDate

Identifies the date (in the postal code's time zone) to which this
PickupScheduleOption refers.

Options/CutOffTime

Identifies the latest allowed ready time for a postal code. The time is
local to the pickup postal code. It includes a TZD (time zone
designator) for FedEx Freight requests.

Options/AccessTime

Identifies the minimum required length of the window of time
between the ReadyTime and CustomerCloseTime.

FedEx Web Services, Developer Guide 2016

443

Pickup Service

Element

Description

Options/ResidentialAvailable
Options/ CountryRelationship

CloseTimeType



DOMESTIC



INTERNATIONAL

Identifies whether the close time is specified by the customer or is
the default time. Valid values are:


CUSTOMER_SPECIFIED



DEFAULT

CloseTime

Identifies the close time corresponding to the specified
CloseTimeType.

LocalTime

Identifies the local time of the service center that will service the
pickup.

21.7 Express Tag Availability
Before creating a Process Tag request, you can use the Express Tag Availability Request from the Pickup
Service WSDL to check valid access/pickup times and ready times for Express services only. In addition
to the standard AuthenticiationDetail and Client detail elements required for all services, the following
element is required:
Table 175. ExpressTagAvailabilityRequest Element
Element
ExpressTagAvailabilityRequest

Description
The following elements are required:


OriginAddress



ReadyDateTime. This element must contain the date and time
the package will be ready for pickup.



Packaging



Service

In addition to transaction details and error conditions, the ExpressTagAvailabilityReply returns the
following information:
Table 176. ExpressTagAvailabilityReply Elements
Element

Description

AccessTime

This is the minimum time window that must be allocated for the
FedEx courier to make the pickup. 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.

FedEx Web Services, Developer Guide 2016

444

Pickup Service

Element

Description
Note: Access time requirements vary by postal code.

ReadyTime

The latest time a FedEx courier can pick up the FedEx ExpressTag®
package.
Note: Ready times vary by postal code.

Availability

Indicates the FedEx ExpressTag service availability at the shipper
postal code indicated in the Request.
Valid responses are:


NEXT_DAY_AVAILABLE



SAME_DAY_AND_NEXT_DAY_AVAILABLE

FedEx Web Services, Developer Guide 2016

445

Rate Services

22 Rate Services
Use the RateService WSDL to request pre-ship rating information and to determine estimated or
courtesy billing quotes. Time in Transit can be returned with the rates if it is specified in the request.
Depending on how a rate request is structured, the reply will return in different structures. These
structures have two different names.
RateRequest WSDL provides a rate response on a single service.

22.1 RateRequest
RateRequest wsdl provides a rate response on a single service.
Note: A rate request does not return route or service availability. All rate quotes are estimates only and may differ
from the actual invoiced amount.

22.2 Rate Available Services/Rate Shopping
A Rate Available Services request will provide a list of available services from one request. Rates are
returned for each service on the list.
Note: A Rate Available Services request does not return route information, but does check service availability and
returns only those services that are actually available.

22.2.1 Rate Service Details
The Rate and Rate Available Services operations provide a shipping rate quote for a specific service
combination depending on the origin and destination information supplied in the request. The following
details apply:


Discount rates are available for all services and origin/destination pairs.



FedEx list rates are available for FedEx Express®, FedEx Ground®, FedEx SmartPost® and FedEx
Freight® services. When list rates are requested, both account specific rates and standard list rates
are returned.

Note: List rates are not available for all FedEx Freight accounts.



FedEx Freight shipper accounts can only request rates from origin at shipper address. FedEx Freight
Bill To accounts can request rates from origins other than shipper address.



Time in transit may be returned with the rates if it is specified in the request.



The Rate operation returns the rate for the origin and destination by requested service. You will not
receive service checking to validate whether that service is actually available for your ship date and
origin/destination pair.



The Rate Available Services operation returns the rate for the origin and destination for all available
services.

Note: Only valid services are returned.



Rate and Rate Available Services for FedEx Express shipments support intra-Mexico shipping.

FedEx Web Services, Developer Guide 2016

446

Rate Services


Rating is available for FedEx SmartPost Shipping. See FedEx SmartPost Request Elements for more
details. SmartPost outbound ship replies will also include rate elements with estimated rates.
SmartPost Return shipping label replies will not include rate elements and estimates.



This quote is an estimate and may differ from the actual invoiced amount.



Rate shopping, service-specific commitment and rate information may also be specified.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

22.2.2 Rate Coding Details
When requesting a rate quote:


Include as much detail as possible about your shipment. The RateService WSDL provides elements
to identify your shipment, including shipping option elements. This information is important for
calculating the correct shipping costs with surcharges.



Use the optional RateRequestTypes element to have list rates returned with account specific rates. If
you choose LIST as the element value, you receive both account specific and list rates, in addition to
rate quotes generated via FedEx electronic solutions.



For Rate (a single service), specify the service to ensure rate data for the service and shipment data
input is returned. For Rate Available Services (multiple services returned), do not include the
ServiceType. The system will then return a list of services.



For Rate, specify the carrier by using CarrierCode. For Rate Available Services, specify the carrier to
ensure rate data for all services for the carrier and the shipment data combination are returned, or do
not specify a CarrierCode to receive all available services from all carriers in the return.



Use the optional ReturnTransitAndCommit element to include transit time information in the reply.
FedEx Express information will include the day and date the package will be delivered, based on the
ship date you specified. The FedEx Ground response will describe the number of business days
required for the package delivery.



Use ConsolidationKey to identify the consolidation to which an open shipment should be added after
successful creation. You must specify the ConsolidationKey Type, Index, and Date in the
RateRequest, in addition to the standard elements, to enable this. The ConsolidationKey elements
are the only consolidation-specific elements which must be specified in the RateRequest. The
RateReply will return rate and shipment data in the RateReplyDetails array for all CRNs associated
with the specified consolidation.

Note: Starting in v16, the "RATED_*" RateType in the rate reply structure has been removed.

Table 177. RateRequest Elements
Element

Description

RateRequest/
ReturnTransitAndCommit

Optional
Allows the caller to specify that the transit time and commit data
are to be returned in the reply. Valid values include:

RateRequest/



TRUE



FALSE

Optional

FedEx Web Services, Developer Guide 2016

447

Rate Services
Element

Description

CarrierCodesCarrierCodeType

Candidate carriers for rate-shopping. This element is only
considered if RequestedShipment/ServiceType is omitted.

RateRequest/
VariableOptionsServiceOptionType

Optional
Contain zero or more service options whose combinations are to
be considered when replying with available services. Specify if
Saturday delivery is required. Valid value is
SATURDAY_DELIVERY.
Note: If you specify SATURDAY_DELIVERY for VariableOptions, you will get
both Saturday Delivery options and regular options for all services
where Saturday delivery is an option. Do not specify
SATURDAY_DELIVERY for SpecialServices or it will only return any
applicable Saturday Delivery options.

RateRequest/ConsolidationKey

Uniquely identifies a consolidation, which is a logical container of a
collection of shipments.

ConsolidationKey/Type

Specify the type of consolidation.
Valid options are:


INTERNATIONAL_GROUND_DIRECT_DISTRIBUTION



INTERNATIONAL_GROUND_DISTRIBUTION



TRANSBORDER_DISTRIBUTION

ConsolidationKey/Index

Unique consolidation shipment identifier assigned when the
consolidation was created.

ConsolidationKey/Date

Specifies the date when the consolidation was created.

RateRequest/RequestedShipment

Required
Specify the shipment for which a rate quote (or rate-shopping
comparison) is desired.

RateRequest/requestedShipment/
specialServicesRequested/
shipmentDryIceDetail

Indicates Shipment-level totals of dry ice data across all packages.

RateRequest/requestedShipment/
specialServicesRequested/
shipmentDryIceDetail/
packageCount

Optional
Total number of packages in the shipment that contain dry ice.
Required if shipmentDryIceDetail is used in the RateRequest

RateRequest/requestedShipment/
specialServicesRequested/
shipmentDryIceDetail/
totalweight

Optional
Total shipment dry ice weight for all packages.
Required if shipmentDryIceDetail is used in the RateRequest

RateRequest/requestedShipment/
specialServicesRequested/
shipmentDryIceDetail/
processingOptions

Optional
This option specifies that dry ice information is only applicable at
the shipment level. Package level dry ice information would not
apply.

FedEx Web Services, Developer Guide 2016

448

Rate Services
Element

Description
Valid Value: SHIPMENT_LEVEL_DRY_ICE_ONLY
Required if shipmentDryIceDetail is used in the RateRequest

RateRequest/requestedShipment/
specialServicesRequested/
EventNotificationDetail

Optional
This replaces EmailNotificationDetail.

RequestedShipment/
ShipTimestamp

Optional
The date format must be YYYY-MM-DDTHH:MM:SS-xx:xx.
The time must be in the format: HH:MM:SS using a 24-hour clock.
The date and time are separated by the letter T, such as 2009-0626T17:00:00).
The UTC offset indicates the number of hours/minutes, such as
xx:xx from UTC, such as 2009-06-26T17:00:00-04:00 is defined as
June 26, 2009 5:00 p.m. Eastern Time.

RequestedShipment/DropoffType

Optional
Identifies the method by which the package is to be tendered to
FedEx.This element does not dispatch a courier for package
pickup.

RequestedShipment/ServiceType

Optional
Identifies the FedEx service to use in shipping the package for a
rate request.

RequestedShipment/
PackagingType

Optional
Identifies the packaging used by the requestor for the package.
See PackagingType for list of valid enumerated values.

RequestedShipment/TotalWeight

Optional
Identifies the total weight of the shipment being conveyed to
FedEx.
This is only applicable to International shipments and should be
used on the first package of a multiple piece shipment. This value
contains 1 explicit decimal position.

RequestedShipment/
TotalInsuredValue

Optional
Total insured amount.

RequestedShipment/
PreferredCurrency

Optional
Indicates the currency the caller requests to have used in all
returned monetary values (when a choice is possible).

RequestedShipment/
ShipmentAuthorizationDetail

Optional
Specifies details about the party responsible for the shipment.

RequestedShipment/
ShipmentAuthorizationDetail/accou
ntNumber

Optional
Identification of a specific FedEx customer account.

RequestedShipment/Shipper

Required
The descriptive data for the physical location from which the
shipment originates.

FedEx Web Services, Developer Guide 2016

449

Rate Services
Element

Description

RequestedShipment/Recipient

Required
The descriptive data for the physical location to which the
shipment is destined.

RequestedShipment/
RecipientLocationNumber

Optional
A unique identifier for a recipient location.

RequestedShipment/Origin

Optional
Physical starting address for the shipment, if different from
shipper’s address.

RequestedShipment/SoldTo

Optional
Indicates the party responsible for purchasing the goods shipped
from the shipper to the recipient. The sold to party is not
necessarily the recipient or the importer of record. The sold to
party is relevant when the purchaser, rather than the recipient
determines when certain customs regulations apply.

RequestedShipment/
ShippingChargesPayment

Optional
Descriptive data indicating the method and means of payment to
FedEx for providing shipping services.

SpecialServicesRequested/
ShipmentSpecialServiceType

Optional
Identifies the collection of special services requested by the
shipper and offered by FedEx.
If the shipper requests a special service requiring additional data
(such as C.O.D.), the special service type must be present in the
SpecialServiceTypes collection, and the supporting detail must be
provided in the appropriate sub-object (such as CodDetail).
If the customer is not shipping any special services and they
include this element, a warning will be returned.
To avoid the warning, omit this element.
Valid values are:


BROKER_SELECT_OPTION



CALL_BEFORE_DELIVERY



COD



CUSTOM_DELIVERY_WINDOW



DANGEROUS_GOODS



DO_NOT_BREAK_DOWN_PALLETS



DO_NOT_STACK_PALLETS



DRY_ICE



EAST_COAST_SPECIAL



ELECTRONIC_TRADE_DOCUMENTS



EVENT_NOTIFICATION

FedEx Web Services, Developer Guide 2016

450

Rate Services
Element

Description


EXTREME_LENGTH



FOOD



FEDEX_ONE_RATE



FREIGHT_GUARANTEE



FREIGHT_TO_COLLECT



FUTURE_DAY_SHIPMENT



HOLD_AT_LOCATION



HOME_DELIVERY_PREMIUM



INSIDE_DELIVERY



INSIDE_PICKUP



INTERNATIONAL_CONTROLLED_EXPORT_ SERVICE



INTERNATIONAL_TRAFFIC_IN_ARMS_ REGULATIONS



LIFTGATE_DELIVERY



LIFTGATE_PICKUP



LIMITED_ACCESS_DELIVERY



LIMITED_ACCESS_PICKUP



PENDING_SHIPMENT



PHARMACY_DELIVERY



POISON



PROTECTION_FROM_FREEZING



RETURNS_CLEARANCE



RETURN_SHIPMENT



SATURDAY_DELIVERY



SATURDAY_PICKUP



TOP_LOAD



THIRD_PARTY_CONSIGNEE

RequestedShipment/
ExpressFreightDetail

Optional
Details specific to an Express freight shipment.

RequestedShipment/
FreightShipmentDetail

Optional
Data applicable to shipments using FEDEX_FREIGHT_PRIORITY
and FEDEX_FREIGHT_ECONOMY services.

RequestedShipment/
DeliveryInstructions

Optional
Used with Ground Home Delivery and Freight.

FedEx Web Services, Developer Guide 2016

451

Rate Services
Element

Description

RequestedShipment/
VariableHandlingChargeDetail

Optional
Details about how to calculate variable handling charges at the
shipment level.

Requested shipment/
CustomsClearanceDetail

Optional
Information about this package that only applies to an international
(export) shipment.

RequestedShipment/
CustomsClearanceDetail/
CustomsOptionsDetail/
CustomsOptionType

Specify the reason for a global return, as recognized by Customs.
Valid values are:


COURTESY_RETURN_LABEL: For the outbound courtesy
return label.



EXHIBITION_TRADE_SHOW: For exhibition or trade-show,
outbound and inbound.



FAULTY_ITEM: For faulty item being returned, inbound only.



FOLLOWING_REPAIR: For repaired or processed item being
sent, outbound only.



FOR_REPAIR: For repair or processing, outbound and
inbound.



ITEM_FOR_LOAN: For loan item, outbound and inbound.



OTHER: Other reason, outbound and inbound. This type
requires a description.



REJECTED: For rejected merchandise being returned,
inbound.



REPLACEMENT: For replacement being sent, outbound only



TRIAL: For use in a trial, outbound and inbound.

CustomClearanceDetail/
DutiesPayment

Optional
Descriptive data indicating the method and means of payment to
FedEx for providing shipping services.

CustomsClearanceDetail/
Commodities/CustomsValue

Optional
Used to calculate Argentina and Dominican Republic export taxes.

RequestedShipment/
PickupDetail

Optional
For use in “process tag” transaction.

PickupDetail/ReadyDateTime

Optional
Specify the time and date the package will be ready for pickup.

PickupDetail/
LatestPickupDateTime

Optional
Specify the last possible pickup time and date.

PickupDetail/CourierInstructions

Optional
Specify any courier instructions.

FedEx Web Services, Developer Guide 2016

452

Rate Services
Element

Description

PickupDetail/RequestType

Optional
Specify the request type.

PickupDetail/RequestSource

Optional
Specify the request source.

RequestedShipment/
SmartPostDetail

Optional
Details specific to FedEx SmartPost shipments.

RequestedShipment/
BlockInsightVisibility

Optional
If true, only the shipper/payor will have visibility of this shipment.

RequestedShipment/
ReturnInstructionsDetail
ShippingDocumentFormat/
documentFormatOption
srequested/ Document
formatOptions

SUPPRESS_ADDITIONAL_LANGUAGES
This value will suppress English language if another language is
specified in language code field. (Default is English)

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
EmailLabelDetail

Describes specific information about the emaillabel shipment.
Message: Content of the email message
Recipients: EMailRecipient
emailAddress - email address of the recipient
role - role type of the recipient
optionsRequested localization

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
ProcessingOptions

ALLOW MODIFICATIONS
This allows the Email Label originator to specify if the completor
can make modifications to editable shipment data.

RequestedShipment/
SpecialServicesRequested/
RecommendedDocument
Specification



ANTIQUE_STATEMENT_EUROPEAN_UNION



ANTIQUE_STATEMENT_UNITED_STATES



ASSEMBLER_DECLARATION



BEARING_WORKSHEET



FILM_AND_VIDEO_CERTIFICATE



CERTIFICATE_OF_SHIPMENTS_TO_SYRIA



PRINTED_CIRCUIT_BOARD_WORKSHEET'



COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMON
_MARKET



CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO_
THE_PEOPLES_REPUBLIC_OF_CHINA



DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS_
SUBJECT_TO_RADIATION_CONTROL_STANDARD



DECLARATION_OF_BIOLOGICAL_STANDARDS

FedEx Web Services, Developer Guide 2016

453

Rate Services
Element

RequestedShipment/
LabelSpecification/
LabelOrderType

RequestedShipment/
specialServicesRequested/
pendingShipmentDetail/
documentReferences/
documentProducer

Description


ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET



INTERIM_FOOTWEAR_INVOICE



NAFTA_CERTIFICATE_OF_ORIGIN_UNITED_STATES



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_FRENCH



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_ENGLISH



NAFTA_CERTIFICATE_OF_ORIGIN_SPANISH



PACKING_LIST"



REPAIRED_WATCH_BREAKOUT_WORKSHEET"



DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMERI
CAN_PRODUCTS"



STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FREQ
UENCY_DEVICES



TOXIC_SUBSTANCES_CONTROL_ACT"



UNITED_STATES_WATCH_REPAIR_DECLARATION



UNITED_STATES_NEW_WATCH_WORKSHEET"



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHI
P_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERSHI
P_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES

Specify the order in which the labels will be returned.
Valid values are:


SHIPPING_LABEL_FIRST



SHIPPING_LABEL_LAST

Specify details for uploaded documents provided by the shipment
initiator.
Valid values:


CUSTOMER



OTHER

RequestedShipment/
specialServicesRequested/
pendingShipmentDetail/
documentReferences/
documentIdProducer

Specify details for uploaded documents provided by the shipment
initiator.
Valid values: CUSTOMER

RequestedShipment/
RequestedPackageLineItem/
ItemDescriptionForClearance

Required for UAE; Otherwise: Optional - This element is for the
customer to describe the content of the package for customs

FedEx Web Services, Developer Guide 2016

454

Rate Services
Element

Description
clearance purposes. This applies to intra-UAE, intra-Columbia and
intra-Brazil shipments.

RequestedShipment/
The total mass of the contained explosive substances, without the
RequestedPackageLineItem/
mass of any casings, bullets, shells, etc.
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail
Requestedshipment/
RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:

ShippingDocumentSpecification/
ReturnedShippingDocumentType

Valid values:



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT



AUXILIARY_LABEL



CERTIFICATE_OF_ORIGIN



COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_



RETURN_2_D_BARCODE



COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETUR
N_LABEL



COD_RETURN_2_D_BARCODE



COD_RETURN_LABEL



COMMERCIAL_INVOICE



CUSTOM_PACKAGE_DOCUMENT



CUSTOM_SHIPMENT_DOCUMENT



DANGEROUS_GOODS_SHIPPERS_DECLARATION



DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BAR
CODE



DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL



ETD_LABEL



EXPORT_DECLARATION



FREIGHT_ADDRESS_LABEL



GENERAL_AGENCY_AGREEMENT



GROUND_BARCODE

FedEx Web Services, Developer Guide 2016

455

Rate Services
Element

Description


NAFTA_CERTIFICATE_OF_ORIGIN



OP_900



OUTBOUND_2_D_BARCODE



OUTBOUND_LABEL



PRO_FORMA_INVOICE



RECIPIENT_ADDRESS_BARCODE



RECIPIENT_POSTAL_BARCODE



RETURN_INSTRUCTIONS



TERMS_AND_CONDITIONS



USPS_BARCODE

ShippingDocumentSpecification
ShippingDocumentTypes

RequestedShipment/
RateRequestType

Valid values:


CERTIFICATE_OF_ORIGIN



COMMERCIAL_INVOICE



CUSTOM_PACKAGE_DOCUMENT



CUSTOM_SHIPMENT_DOCUMENT



CUSTOMER_SPECIFIED_LABELS



DANGEROUS_GOODS_SHIPPERS_DECLARATION



EXPORT_DECLARATION



FREIGHT_ADDRESS_LABEL



GENERAL_AGENCY_AGREEMENT



LABEL



NAFTA_CERTIFICATE_OF_ORIGIN



OP_900



PRO_FORMA_INVOICE



RETURN_INSTRUCTIONS"

Optional
Indicates the type of rates to be returned.
Valid values:


LIST — Returns standard list in response.



PREFERRED — Returns rates in currency specified in the
PreferredCurrency element.



NONE — Returns account specific rates in response.

Note1: If no value or a value of NONE is included, the RateRequest returns

FedEx Web Services, Developer Guide 2016

456

Rate Services
Element

Description
the account specific rates by default. If you include the LIST value, the
RateRequest will return both list and account rates within the
response.
Note2: A preferred currency is available for both account and list rates.
Include just the PREFERRED value to receive a preferred currency for
an account rate. Include both the PREFERRED and LIST values to
receive a preferred currency for both standard list and account
specific rates within the response. The preferred currency is not
returned if the requested currency is already present within the rate
response.

RequestedShipment/
CustomerSelectedActualRateType

Optional
Specify the type of rate the customer wants to have used as the
actual rate type.

RequestedShipment/
EditRequestType

Optional
Specify whether the customer wishes to have Estimated Duties
and Taxes provided with the rate quotation on this shipment. Only
applies with shipments moving under international services.

RequestedShipment/
PackageCount

Optional
The total number of packages in the entire shipment. The
maximum number of packages in one rate request is 100.

RequestedShipment/
RequestedPackageLineItems

Optional
One or more package-attribute descriptions, each of which
describes an individual package, a group of identical packages, or
(for the total-piece-total-weight case) common characteristics of
packages in the shipment.

22.2.3 Rating for Multiple-Package Shipment
This option is available for FedEx Express U.S. and international multiple-package shipments (MPS),
FedEx Ground® U.S. and international multiple-package shipments, FedEx Express U.S. C.O.D. and
international C.O.D. multiple-package shipments, and FedEx Ground U.S. C.O.D. and international C.O.D.
multiple-package shipments.
The maximum number of packages in one rate request is 100.
For more information about MPS, see FedEx Express U.S. Multiple-Package Shipments in Ship Service.
Note: Package level rates are not returned for Express International shipments. This applies to single and multipackage shipments.

Table 178. RateReply Elements
Element

Description

HighestSeverity

Required
Identifies the highest severity encountered when performing the
request. Valid values are:

FedEx Web Services, Developer Guide 2016

457

Rate Services

Element

Notifications

Description


FAILURE



ERROR



WARNING



NOTE



SUCCESS

Required
Includes the descriptive data detailing the status of a submitted
transaction. Includes the severity of the notification, which indicates
success or failure or some other information about the request.
Valid values are:


SUCCESS – Your transaction succeeded with no other
applicable information.



NOTE – Additional information that may be of interest to you
about your transaction.



WARNING – Additional information that you need to know
about your transaction that you may need to take action on.



ERROR – Information about an error that occurred while
processing your transaction.



FAILURE – FedEx was unable to process your transaction at
this time due to a system failure. Please try again later.

TransactionDetail

Contains the CustomerTransactionID that was sent to the request.

TransactionDetail
/CustomerTransactionId

Free form text to be echoed back in the reply. Used to match
requests and replies.

TransactionDetail
/Localization

Governs data payload language/translations (contrasted with
ClientDetail.localization, which governs
Notification.localizedMessage language selection).

Version

Required
The version of this reply.

RateReplyDetails

Each element contains all rate data for a single service. If service
was specified in the request, there will be a single entry in this
array; if service was omitted in the request, there will be a separate
entry in this array for each service being compared.
Valid values:

RateReplyDetails
/ReturnedRateType



PAYOR_ACCOUNT_PACKAGE



PAYOR_ACCOUNT_SHIPMENT



PAYOR_LIST_PACKAGE



PAYOR_LIST_SHIPMENT



PREFERRED_ACCOUNT_PACKAGE

FedEx Web Services, Developer Guide 2016

458

Rate Services

Element

RateReplyDetails
/ratedShipmentDetails
RateReplyDetails /
ratedShipmentDetails /
shipmentRateDetail
RateReplyDetails
/ratedShipmentDetails
/shipmentRateDetail
/totalAncillaryFeesAndTaxes
RateReplyDetails
/ratedShipmentDetails
/shipmentRateDetail
/totalDutiesTaxesAndFees
RateReplyDetails
/ratedShipmentDetails
/shipmentRateDetail
/ancillaryFeesAndTaxes
RateReplyDetails /
ratedShipmentDetails /
shipmentRateDetail /
AncillaryFeeAndTax/type

Description


PREFERRED_ACCOUNT_SHIPMENT



PREFERRED_LIST_PACKAGE

 PREFERRED_LIST_SHIPMENT
This class groups the shipment and package rating data for a
specific rate type for use in a rating reply, which groups result data
by rate type.

Identifies the total amount of the shipment-level fees and taxes that
are not based on transportation charges or commodity-level
estimated duties and taxes.
The total of the totalDutiesAndTaxes plus the
totalAncillaryFeesAndTaxes.

Identifies the shipment-level fees and taxes that are not based on
transportation charges or commodity-level estimated duties and
taxes.


CLEARANCE_ENTRY_FEE



GOODS_AND_SERVICES_TAX



HARMONIZED_SALES_TAX

Note: CLEARANCE_ENTRY_FEE is removed from Surcharge Type, and is
available under AncillaryFeeandTax array

RateReplyDetails
/ratedShipmentDetails
/shipmentRateDetail
/AncillaryFeeAndTax
/description
RateReplyDetails
/ratedShipmentDetails
/shipmentRateDetail
/AncillaryFeeAndTax
/amount
CompletedShipmentDetail
/PendingShipmentAccessDetail
/Accessor Details

Required
Provides the ability to return multiple sets of Email label access
credentials:


role



SHIPMENT_COMPLETOR

FedEx Web Services, Developer Guide 2016

459

Rate Services

Element

Description


SHIPMENT_INITIATOR



userId



password



emailLabelUrl

22.2.4 FedEx Freight Priority and FedEx Freight Economy
You can obtain list and negotiated rates, in addition to transit time information, for FedEx Freight ® Priority
and FedEx Freight® Economy from the RateService WSDL. The following request elements are specific
to FedEx Freight shipments
Table 179. FedEx Express Freight RateRequest Elements
Element

Description

ReturnTransitAndCommit

Optional
Allows the caller to specify that the transit time and commit
data are to be returned in the reply.
Valid values are:


TRUE



FALSE

CarrierCodes

Optional
Candidate carriers for rate-shopping use case. This element is
only considered if RequestedShipment/ServiceType is omitted.

RequestedShipment

Required
The shipment for which a rate quote (or rate-shopping
comparison) is desired.

RequestedShipment
/ShipTimestamp

Optional
The ship time and date.
The format is YYYY-MM-DDThh:mm:ssTZD (e.g. "1997-0716T19:20:30+01:00") or
YYYY-MM-DDThh:mm:ss.s*TZD (e.g. "1997-0716T19:20:30.274+01:00").
The fractional seconds portion is optional.

RequestedShipment
/DropoffType

Optional
Identifies the method by which the package is to be tendered
to FedEx. This element does not dispatch a courier for package
pickup.

RequestedShipment
/ServiceType

Optional
Identifies the type of service the rate quote is for. Choose
either:


FEDEX_FREIGHT_ECONOMY



FEDEX_FREIGHT_PRIORITY

FedEx Web Services, Developer Guide 2016

460

Rate Services

Element

Description

RequestedShipment
/PackagingType

Optional
Identifies the packaging used by the requestor for the package.
Valid values:


YOUR_PACKAGING



FEDEX_10KG_BOX



FEDEX_25KG_BOX



FEDEX_BOX



FEDEX_ENVELOPE



FEDEX_EXTRA_LARGE_BOX



FEDEX_LARGE_BOX



FEDEX_MEDIUM_BOX



FEDEX_PAK



FEDEX_SMALL_BOX



FEDEX_TUBE

RequestedShipment
/TotalWeight

Optional
Total weight of the shipement.

RequestedShipment
/TotalInsuredValue

Optional
Total amount the shipment is insured for.

RequestedShipment
/PreferredCurrency

Optional
Indicates the currency the caller requests to have used in all
returned monetary values, when a choice is possible.

RequestedShipment
/Shipper

Required
Descriptive data identifying the party responsible for shipping
the package. Shipper and Origin should have the same address.

Shipper
/AccountNumber

Optional
The FedEx account number associated with this transaction.

Shipper
/Address

Optional
Descriptive data for a physical location. May be used as an
actual physical address (place to which one could go), or as a
container of "address parts" which should be handled as a unit
(such as a city-state-ZIP combination within the U.S.).

Address
/StreetLines

Required
Combination of number, street name, and so on. At least one
line is required for a valid physical address; empty lines should
not be included.

Address
/City

Required
Indicates the Name of city, town, and so on.

Address

Required

FedEx Web Services, Developer Guide 2016

461

Rate Services

Element

Description

/StateOrProvinceCode

Identifying abbreviation for U.S. state, Canadian province, etc.
Format and presence of this element will vary, depending on
country.

Address
/PostalCode

Optional
Identification of a region (usually small) for mail/package
delivery. Format and presence of this element will vary,
depending on country.

Address
/CountryCode

Required
The two-letter code used to identify a country.

Address
/CountryName

Optional
The fully spelled out name of a country.

RequestedShipment
/Recipient

Required
Descriptive data identifying the party receiving the package.

Recipient
/Address

Required
Descriptive data identifying the recipient's address which
includes: StreetLines, City, StateOrProvinceCode, PostalCode
and CountryCode.

RequestedShipment
/RecipientLocationNumber

Optional
A unique identifier for a recipient location.

RequestedShipment/Origin

Optional
Physical starting address for the shipment, if different from
shipper's address.

RequestedShipment
/ShippingChargesPayment

Optional
The descriptive data for the monetary compensation given to
FedEx for services rendered to the customer.

ShippingChargesPayment
/PaymentType

Optional
Identifies the method of payment for a service.

ShippingChargesPayment
/Payor

Optional
Descriptive data identifying the party responsible for payment
for a service.

Payor
/ResponsibleParty

Optional
The descriptive data for a person or company entity doing
business with FedEx.

ResponsibleParty
/AccountNumber

Optional
The FedEx account number associated with this transaction.

RequestedShipment
/SpecialServicesRequested

Optional
Identifies the special services the caller is requesting with this
shipment.

RequestedShipment
/FreightShipmentDetail

Required
Includes required shipment data to obtain rates for FedEx
Freight shipments.

FedEx Web Services, Developer Guide 2016

462

Rate Services

Element

Description

FreightShipmentDetail
/FedExFreightAccountNumber

Optional
Account number used with FedEx Freight services.

FreightShipmentDetail
Optional
/FedExFreightBillingContactAndAddres Billing address used to validate FedEx Freight account on the
s
bill of lading. Required valid values for address are:

FreightShipmentDetail
/Role



StreetLines



City



StateOrProvinceCode



PostalCode

Required
Indicates the role of the party submitting the transaction.
Valid values are:


CONSIGNEE



SHIPPER

FreightShipmentDetail
/LineItem

Optional
Details of the commodities in the shipment.

LineItem
/FreightClass

Required
Freight class for this line item.
Valid values are:


CLASS_050



CLASS_055



CLASS_060



CLASS_065



CLASS_070



CLASS_077_5



CLASS_085



CLASS_092_5



CLASS_100



CLASS_110



CLASS_125



CLASS_150



CLASS_175



CLASS_200



CLASS_250



CLASS_300

FedEx Web Services, Developer Guide 2016

463

Rate Services

Element

LineItem
/Packaging

Description


CLASS_400



CLASS_500

Optional
Physical packaging type for this commodity or freight class.
Valid values are:


BAG



BARREL



BASKET



BOX



BUCKET



BUNDLE



CARTON



CASE



CONTAINER



CRATE



CYLINDER



DRUM



ENVELOPE



HAMPER



OTHER



PAIL



PALLET



PIECE



REEL



ROLL



SKID



TANK



TUBE

LineItem
/Description

Optional
Customer-provided description for this commodity or freight
class.

LineItem
/Weight

Optional
Weight for this commodity or freight class.

FreightShipmentLineItem

Optional

FedEx Web Services, Developer Guide 2016

464

Rate Services

Element

Description

/Dimensions

The dimensions of this package and the unit type used for the
measurements. Valid measurements are whole numbers
greater than zero.
Valid values are:


Length



Width



Height



Units

FreightShipmentLineItem
/Volume

Optional
Volume (cubic measure) for this commodity or freight class.

RequestedShipment
/RateRequestTypes

Optional
Indicates the type of rates to be returned.
Valid values are:


LIST — Returns standard list rates in response.



PREFERRED — Returns rates in currency specified in the
PreferredCurrency element.



NONE — Returns account-specific rates in response.

RequestedShipment
/PackageCount

Optional
The total number of packages in the entire shipment (even
when the shipment spans multiple transactions).

RequestedShipment
/RequestedPackageLineItems

Optional
One or more package-attribute descriptions, each of which
describes an individual package, a group of identical packages,
or (for the total-piece-total-weight case) common characteristics
all packages in the shipment.

The following reply elements are specific to FedEx Freight shipments:
Table 180. FedEx Freight Reply Shipment Elements
Element

Description

ServiceType

Identifies the type of service used to ship
the package.
Valid FedEx Freight options are:

ReplyDetails/FREIGHT_GUARANTEE

FedEx Web Services, Developer Guide 2016



FEDEX_FREIGHT_ECONOMY



FEDEX_FREIGHT_PRIORITY

Specify how the freight has been
guaranteed for delivery.
Valid FedEx Freight values are:


GUARANTEED_DATE



GUARANTEED_MORNING
465

Rate Services

Element

Description


GUARANTEED_TIME

ReplyDetails/FLATBED_TRAILER

Specify the surcharge for a flatbed trailer.

SurchargeType/INSIDE_PICKUP

Specify the Surcharge for inside pickup
option.

SurchargeType/INSIDE_DELIVERY

Surcharge for inside delivery option.

SurchargeType/EXHIBITION

Surcharge for option.

SurchargeType/EXTRA_SURFACE_HANDLING_CHARGE

Surcharge for all Intra-India shipments with
the XS service option.

SurchargeType/EXTREME_LENGTH

Surcharge for option.

SurchargeType/FLATBED

Surcharge for option.

SurchargeType/FREIGHT_GUARANTEE

Surcharge for option.

SurchargeType/LIFTGATE_DELIVERY

Surcharge for option.

SurchargeType/LIFTGATE_PICKUP

Surcharge for option.

SurchargeType/LIMITED_ACCESS_DELIVERY

Surcharge for option.

SurchargeType/LIMITED_ACCESS_PICKUP

Surcharge for option.

SurchargeType/PROTECTION_FROM_FREEZING

Surcharge for option.

SurchargeType/PRE_DELIVERY_NOTIFICATION

Surcharge for option.

SurchargeType/REGIONAL_MALL_DELIVERY

Surcharge for option.

SurchargeType/REGIONAL_MALL_PICKUP

Surcharge for option.

SurchargeType/OVER_DIMENSION

Surcharge for option.

SurchargeType/TARP

Surcharge for option.

SurchargeType/METRO_DELIVERY

Surcharge for option.

SurchargeType/METRO_PICKUP

Surcharge for option.

SurchargeType/ISLAND_DELIVERY

Surcharge for option.

SurchargeType/ISLAND_PICKUP

Surcharge for option.

RateDiscountType

The type of rate discount.
Valid values are:

FedEx Web Services, Developer Guide 2016



BONUS



COUPON



EARNED



OTHER



VOLUME

466

Rate Services

22.2.5 Possible Surcharges
This table lists possible surcharges returned in the Rate reply for applicable FedEx service options:
Table 181. Rate Reply Possible Surcharges for FedEx Service Options
Possible Surcharges
Clearance Entry Fee Surcharge (Discount) for international shipping
COD
Dangerous_Goods
Email_Label
Exhibition
Export
Extreme_Length
FICE (FedEx International Controlled Export)
Fedex_Tag
Flatbed
Freight_Guarantee
Fuel
GST (Goods and Services tax for Canadian origin)
HST (Harmonized sales tax for Canadian origin)
Hazardous_Materials
Home_Delivery_Appointment
Home_Delivery_Evening
Home_Delivery_Date_Certain
Inside_Delivery
Inside_Pickup
Insured_Value — FedEx declared-value charges are returned in this element.
Island_Delivery
Island_Pickup
FedEx Web Services, Developer Guide 2016

467

Rate Services

Possible Surcharges
Liftgate_Delivery
Liftgate_Pickup
Limited_Access_Delivery
Limited_Access_Pickup
List Clearance Entry Fee Surcharge for international shipping
Metro_Delivery
Metro_Pickup
Non_Standard_Container
Offshore
Out_Of_Delivery_Area
Out_Of_Pickup_Area
Other
Overdimension
Oversize
Pre_Delivery_Notification
Protection_From_Freezing
PST (Provincial sales tax for Canadian origin)
Regional_Mall_Delivery
Regional_Mall_Pickup
Residential
Return_Label
Saturday_Delivery
Saturday_Pickup
Signature_Option
Tarp

FedEx Web Services, Developer Guide 2016

468

Rate Services

Possible Surcharges
TotalCustomerCharge — Contains the discounted account-specific freight charge plus the variable
handling charge amount.
Transmit_Service_Fee
VariableHandlingCharges — If you specify additional handling charges in the rate quote, charges are
returned in the Rate reply.
VAT
Note: Surcharge value for SurchargeType CLEARANCE_ENTRY_FEE is now considered as ancillary fee, and is
reported under AncillaryFeeAndTax. It is no longer included in Transportation charges. See Surcharges and
Discounts for more information about surcharges and rate calculations.

22.2.6 Rate Surcharge Return
Surcharges are returned in the Rate reply and in the Ship reply as follows:


Total surcharge



Total taxes (for Canadian origin shipments)



Total discounts



Itemized surcharge

22.3 Surcharges and Discounts
Your shipment may incur fees in addition to the base shipping rate depending on the service options you
choose. The following are descriptions of those fees that are returned in the rate quote.
Table 182. Surcharges and Discounts Rate Quote
Surcharge

Description

Applicable Services

Additional Handling
For FedEx Express, shipment measures
Dimension Surcharge greater than 60" in length but equal to or less
than 108" in length.
For FedEx Ground, shipment measures
greater than 60" in length but equal to or less
than 108"

FedEx Priority Overnight®,
FedEx Standard Overnight®,
FedEx 2Day®, FedEx Express
Saver®, FedEx Ground®, FedEx
International Ground®

Additional Handling
Weight Surcharge

For FedEx Ground or FedEx Express,
shipment has an actual weight of greater
than 70 lbs.

FedEx Priority Overnight, FedEx
Standard Overnight, FedEx
2Day, FedEx Express Saver,
FedEx Ground, FedEx
International Ground

Additional Handling
Packaging Surcharge

For FedEx Express, shipment is not fully
encased in an outer shipping container
and/or is encased in packing material other
than corrugated cardboard.

FedEx Priority Overnight, FedEx
Standard Overnight, FedEx
2Day, FedEx Express Saver,
FedEx Ground, FedEx
International Ground

FedEx Web Services, Developer Guide 2016

469

Rate Services

Surcharge

Description

Applicable Services

For FedEx Ground, shipment is not fully
encased in an outer shipping container
and/or is encased in packing material other
than corrugated cardboard.
FedEx International Priority ®,
FedEx International Priority ®
Freight, FedEx International
Economy®, FedEx International
Economy® Freight

Broker Select Option

A fee applies to B13A for Canada Export
Shipping shipment if you choose to have
FedEx complete the delivery after customs
clearance and if your recipient and customs
broker are served by different FedEx
clearance points.
See B13A_for_Canada_Export_Shipping in
Ship Service for more information.

Courier Pickup
Charge

A charge applies when you request a pickup.
This charge does not apply if you drop off
your package at a FedEx shipping location or
if you have regular scheduled pickups.

Dangerous Goods

FedEx assesses a surcharge on each
package containing dangerous-goods
materials. For intra-Canada shipments this
surcharge is also based on the type of
service provided.

FedEx Express, FedEx Priority
Overnight, FedEx First
Overnight®, FedEx First
Overnight® Freight, FedEx
2Day, FedEx 2Day®A.M., FedEx
Freight, FedEx International
Economy and FedEx
International Economy Freight

Declared Value

FedEx liability for each package is limited to
$100USD unless a higher value is declared
and paid for. For each package exceeding
$100USD in declared value, an additional
amount is charged.

FedEx Express and FedEx
Ground shipments

Delivery Area
Surcharge

A delivery area surcharge applies to
shipments destined for select U.S. postal
codes. (This surcharge does not apply to
FedEx Ground Multiweight® shipments.) In
addition, a delivery area surcharge applies to
FedEx Express shipments destined for areas
in Alaska that are remote, sparsely
populated, or geographically difficult to
access.

FedEx Priority Overnight, FedEx
Standard Overnight, FedEx
2Day, FedEx Express Saver,
FedEx Ground, FedEx Home
Delivery®

Dimensional Weight

Dimensional weight is calculated by
FedEx Express and FedEx
multiplying the length by width and by height Ground shipments
of each package in inches and dividing the
total by 166 (for all shipments within the U.S.
and FedEx Express shipments between the
U.S. and Puerto Rico) or 139 (for all U.S.
export and U.S. import-rated international

FedEx Web Services, Developer Guide 2016

470

Rate Services

Surcharge

Description

Applicable Services

shipments). If the dimensional weight
exceeds the actual weight, charges may be
assessed based on the dimensional weight.
If the chargeable weight of a FedEx Ground
package exceeds 150 lbs., a prorated perpound rate will be used.
Dimensions of one-half inch or greater are
rounded up to the next whole number;
dimensions less than one-half inch are
rounded down. The final calculation is
rounded up to the next whole pound.
Dimensional weight applies per package or
per shipment to all FedEx Express U.S.
shipments in customer packaging, and per
shipment to all FedEx Express international
shipments and U.S.-to-Puerto Rico
shipments in customer packaging.
Shipments in FedEx packaging may be
subject to dimensional-weight pricing. FedEx
Ground applies dimensional weight to all
shipments.
Duties and Taxes

Duties and taxes, including goods and
services tax (GST) and value-added tax (VAT)
may be assessed on the contents of the
shipment.

FedEx® Collect on
Delivery (C.O.D.)

If you request FedEx to obtain payment from FedEx Express and FedEx
the recipient at the time the shipment is
Ground shipments
delivered, an additional surcharge is applied.

FedEx Ground®
Electronic C.O.D.
(E.C.O.D.)

A charge applies when you direct FedEx to
collect payment from your recipient and
deposit it directly into your bank account.

FedEx Ground shipments

FedEx® Delivery
Signature Options

FedEx provides five options when you need
a signature upon delivery: Indirect Signature
Required, Direct Signature Required, Adult
Signature Required, Service Default and No
Signature Required.
Indirect Signature Required is allowed to
U.S. residential addresses only.
Direct Signature Required is allowed to U.S.
addresses and when shipping via FedEx
Ground to Canadian addresses.
Adult Signature Required is allowed to U.S.
addresses.

FedEx Express shipments to
U.S. addresses and FedEx
Ground shipments to U.S. and
Canadian addresses

FedEx Web Services, Developer Guide 2016

FedEx Express International
package and freight service

471

Rate Services

Surcharge

Description

Applicable Services

Depending upon the service associated with
the shipment (the default signature option
varies per service), the courier will perform
the default request for signature collection.
FedEx Email Return
Label

A charge applies in addition to shipping
charges once the recipient uses the return
label. This service is only available for U.S.
shipments.

FedEx First Overnight, FedEx
Priority Overnight, FedEx
Standard Overnight, FedEx
2Day, FedEx 2Day A.M., FedEx
Ground, FedEx 2Day® Freight,
FedEx 3Day® Freight

FedEx ExpressTag®

A charge applies in addition to shipping
charges when FedEx picks up the package
for return at your recipient’s location. This
service is only available for intra-U.S. and
intra-United Kingdom shipments.

FedEx Priority Overnight, FedEx
Standard Overnight, FedEx
2Day

FedEx Ground®
Alternate Address
Pickup

FedEx may provide pickup service to an
address other than the shipping location
associated with the FedEx Ground account
number.

FedEx Ground (U.S. and
Canada)

FedEx Ground® Call
Tag

A charge applies in addition to shipping
charges when FedEx picks up the packages
for return at your recipient’s location. This
service is only available for U.S. shipments.

FedEx Ground, FedEx Home
Delivery

FedEx Home Delivery You can choose FedEx Home Delivery
Convenient Delivery
convenient delivery options:
Options
 FedEx Date Certain Home Delivery®


FedEx Evening Home Delivery®



FedEx Appointment Home Delivery®

FedEx Home Delivery

FedEx International
Controlled Export
(FICE)

A charge applies when you select FICE for
FedEx International Priority,
shipments moving under a U.S. State
FedEx International Priority
Department (DSP) license or under U.S.
Freight
Drug Enforcement Administration permits
36, 236, and 486. This charge also applies for
inbound shipments moving under a
transportation and exportation customs form
(CF7512) from a foreign trade zone or
bonded warehouse.

FedEx® Print Return
Label

A charge applies in addition to shipping
charges once the recipient has used the
return label. This service is available for intraU.S. and international shipments.

FedEx Web Services, Developer Guide 2016

FedEx First Overnight, FedEx
Priority Overnight, FedEx
Standard Overnight, FedEx
2Day, FedEx 2Day A.M., FedEx
Ground, FedEx 2Day Freight,
FedEx 3Day Freight
472

Rate Services

Surcharge

Description

Applicable Services

Inside Delivery/Inside
Pickup Charge

When requested, FedEx may move
shipments to positions beyond the adjacent
loading area.

FedEx Freight

FedEx Freight Special When requested, a surcharge will be applied
Services
to the FedEx Freight special services. For a
list of these surcharges, see Intra-Canada
Express Service.
Oversize Charge

FedEx Freight

FedEx Express: The maximum limits for
FedEx Ground and FedEx
FedEx Express U.S. packages are 150 lbs.
Home Delivery
and 119" in length and 165" in length and
girth (L+2W+2H). Packages that weigh 150
lbs. or less and exceed 108" in length or 130"
in length and girth are considered “oversize”
packages. Oversize packages are rated
based on the greater of the package’s actual
rounded weight or dimensional weight.
FedEx Ground: A package weighing 150 lbs.
or less and measuring greater than 130" in
length and girth is classified as an oversize
package. The shipping charges for an
oversize package are based on the greater of
the package’s actual rounded weight or its
dimensional weight.
FedEx Home Delivery: The shipping charge
for any package with a dimensional weight
of greater than 70 lbs. is the same as a
FedEx Ground package of the corresponding
dimensional weight being shipped under the
same circumstances.

Residential Surcharge A residential package surcharge applies to
shipments to a home or private residence,
including locations where a business is
operated from a home.

FedEx Express, FedEx Ground,
FedEx International Ground
(Canada only), FedEx Freight,
FedEx International Premium®

Rural Delivery (Alaska A surcharge applies for delivery to select
and Hawaii)
rural postal codes in Alaska and Hawaii.

FedEx Ground U.S.

Saturday Delivery/
Saturday Pickup

Saturday Service is available for an additional
charge depending on the package service
type and origin/destination pair.

FedEx Priority Overnight, FedEx
First Overnight Freight, FedEx
2Day, FedEx 2Day A.M., FedEx
International Priority, FedEx
1Day® Freight, FedEx 2Day
Freight

Dry Ice Surcharge

A surcharge will be applied for dry-ice
packaging.

FedEx International Priority,
FedEx International Economy,
and FedEx International
Economy Freight services

FedEx Web Services, Developer Guide 2016

473

Rate Services

Surcharge

Description

Applicable Services

Fuel Surcharge

The fuel surcharge percentage for FedEx
Express services is subject to monthly
adjustment based on a rounded average of
the U.S. Gulf Coast (USGC) spot price for a
gallon of kerosene-type jet fuel.
The fuel surcharge percentage for FedEx
Ground services is subject to monthly
adjustment based on a rounded average of
the national U.S. on-highway average price
for a gallon of diesel fuel.

FedEx Express, FedEx Freight,
FedEx Ground, and FedEx
Home Delivery

Note: For more information about FedEx terms and conditions, including surcharges, go to
fedex.com/us/services/terms/.

22.3.1 FedEx Discount Programs
The following discount programs are offered by FedEx and are calculated in your rate quote:
Table 183. FedEx Discount Programs
Discount Program

Description

FedEx Ground
Multiweight

FedEx Ground Multiweight is ideal for multiple-package shipments moving as
one unit to the same destination on the same day. This pricing option allows
you to combine packages for a multiweight rate. Pricing is based on the
combined weight of your packages.

Earned Discounts
Pricing Program

The Earned Discounts Pricing Program awards discounts when you meet
predetermined revenue levels and/or shippingcriteria. You earn additional
discounts as you increase shipping activity or due to specific shipment
characteristics. Earned discounts are also available for FedEx SmartPost
Surcharges and Discounts Rate Quote shipping.

BONUS

This is based on whether packages are regularly picked up by FedEx or
dropped off by you or zones or origin-destination zip codes or the shipment
date.

COUPON

This is offered at the time of invoice creation.

EARNED

This is offered based on the volume of shipment you have already done with
FedEx.

VOLUME

This is offered based on your commitment of volume with FedEx.

OTHER

Any other discount offered to you apart from the above categories.

Note: For more information on pricing programs, contact your FedEx account executive.

FedEx Web Services, Developer Guide 2016

474

Rate Services

22.4 FedEx One Rate
As part of the FedEx One Rate offering, new FedEx white packaging is introduced for your use.

22.4.1 FedEx One Rate Packaging
The FedEx Packaging Types that are valid/available with the One Rate pricing option are the following:


FEDEX_ENVELOPE



FEDEX_SMALL_BOX



FEDEX_MEDIUM_BOX



FEDEX_LARGE_BOX



FEDEX_EXTRA_LARGE_BOX



FEDEX_PAK



FEDEX_TUBE

Your own packaging is not available for the One Rate pricing option.

22.4.2 New Packaging for Non-One Rate
The new FedEx Packaging Types that are valid/available with the non-One Rate or traditional weightbased pricing option are the following:


FEDEX_SMALL_BOX



FEDEX_MEDIUM_BOX



FEDEX_LARGE_BOX



FEDEX_EXTRA_LARGE_BOX

22.4.3 Maximum Weight for New FedEx Packaging
The maximum allowable weights for the New FedEx Packaging (referenced below) are:


FEDEX_SMALL_BOX



FEDEX_MEDIUM_BOX



FEDEX_LARGE_BOX



FEDEX_EXTRA_LARGE_BOX

For U.S. domestic traditional weight-based Express shipment:

20 lb/9 kg

For U.S. outbound traditional weight-based Express shipment:

40 lb/18 kg

For U.S. domestic Express One Rate shipment:

10 lb/4.5 kg (Envelope)

For U.S. domestic Express One Rate shipment:

50 lb/22.68 kg (all other)

22.4.4 How to Specify One Rate Pricing
To specify FedEx One Rate Pricing Option in the Web Service Transaction, perform the following steps:
1. Specify the "FEDEX_ONE_RATE" ShipmentSpecialService.
2. Specify one of the following Packaging Types:
FedEx Web Services, Developer Guide 2016

475

Rate Services
Table 184. Packaging Types
Packaging Type

Maximum Weight LB

Maximum Weight KG

FEDEX_SMALL_BOX

22.68

FEDEX_MEDIUM_BOX

22.68

FEDEX_LARGE_BOX

22.68

FEDEX_EXTRA_LARGE_BOX

22.68

FEDEX_PAK

22.68

FEDEX_TUBE

22.68

FEDEX_ENVELOPE

4.5

3. Specify a U.S. origin and a U.S. destination.
Note: Intra-Hawaii shipments are not allowed for One Rate pricing.

4. Specify one of the following FedEx Express services:
o
o
o
o
o
o

FIRST_OVERNIGHT
PRIORITY_OVERNIGHT
STANDARD_OVERNIGHT
2_DAY
2_DAY_AM
EXPRESS_SAVER

*Note: Web Services clients can request both One Rate and weight-based (non-One Rate) rates in a single
RateRequest by specifying "FEDEX_ONE_RATE" as a ServiceOptionType in the RateRequest.variableOptions.

22.4.5 Express Saver Service and FedEx Packaging
Weight-Based Express Saver Now Available with FedEx Packaging:
Packages can now be shipped using the Express Saver service for a weight-based rate in the following
FedEx packaging;


FEDEX_SMALL_BOX



FEDEX_MEDIUM_BOX



FEDEX_LARGE_BOX



FEDEX_EXTRA_LARGE_BOX



FEDEX_TUBE

Previously, only your own packaging was allowed for the Express Saver service.

22.5 Variable Handling Charges
If your shipping operation charges handling fees in addition to shipping charges, FedEx Web Services
allow you to add these handling fees to your total shipment charge. These charges are returned in the
FedEx Web Services, Developer Guide 2016

476

Rate Services
Ship reply and can be configured to print on the 4" x 6" thermal label Doc-Tab. See Canada Export
International for more information.
Note: Variable handling charges display as an individual itemized amount and follow shipments across FedEx
systems.

22.5.1 Variable Handling Coding Details
The elements required to add variable handling charges to your shipment rate quote are provided in the
ShipService WSDL. The following table contains variable handling elements:
Table 185.Variable Handling Elements
Element

Requirements

VariableHandlingChargeDetail/
RateTypeBasisType/RateTypeBasis

The rate type.
Valid values:

VariableHandlingChargeDetail/
RateElementBasisType/RateElementBasis

VariableHandlingChargeDetail

FedEx Web Services, Developer Guide 2016



ACCOUNT: Uses the customer’s account rate as the
basis for the handling calculation.



LIST: Uses the FedEx List rate as the basis for the
handling calculation.

Required
The charge upon which the variable handling amount is
calculated.
Valid values:


BASE_CHARGE: This value is the base transportation
charge.



NET_CHARGE_EXCLUDING_TAXES: This value is
the net freight plus surcharges and taxes.



NET_CHARGE_EXCLUDING_TAXES: This value is
the net freight plus surcharges.



NET_FREIGHT: This value is the base charge less
discounts.

Required
Valid values:


FIXED_AMOUNT: This value is used if you want to
add a fixed handling charge to all shipments.



PERCENTAGE_OF_NET_CHARGE: This value is used
if you want to have a variable handling charge
calculated on the entire net charge of the shipment,
including all surcharges.



PERCENTAGE_OF_NET_CHARGE_EXCLUDING_
TAXES: This value is used if you are a Canada-origin
shipper and want to exclude Canadian taxes from the
variable handling charge net percentage.



PERCENTAGE_OF_NET_FREIGHT: This value is
used if you want to have the variable handling charge
477

Rate Services

Element

Requirements
calculated as a percentage of the net freight charge,
excluding any other surcharges levied on the
shipment.

VariableHandlingChargeDetail/FixedValue

Conditional
If you choose FIXED_AMOUNT as the ChargeType, this
element allows you to enter the fixed value of the
handling charge. The element allows entry of 7 characters
before the decimal and 2 characters following the
decimal. For example: if you want to enter a fixed
handling amount of $5.00, enter 5.00 in the FixedValue
element.

VariableHandlingChargeDetail/PercentValue

Conditional
If you choose one of the percentage handling charges in
the VariableHandlingChargeType element, this element
allows you to enter the percent value of the handling
charge to be calculated. The element allows entry of 7
characters before the decimal and 2 characters following
the decimal.
For example, if you want to enter a variable handling
amount of 10%, enter 10.00 in the PercentValue element.

VariableHandlingCharges/
VariableHandlingCharge

Optional
The variable handling charge amount calculated based on
the requested variable handling charge detail.

Note: Variable handling charges may be processed at shipment level or package level except for Express multiple
piece shipments, which must be processed at the Shipment level.

FedEx Web Services, Developer Guide 2016

478

Returns Shipping

23 Returns Shipping
Returns are available for intra-country and international shipping in a variety of areas wherever existing
FedEx Express and FedEx Ground services are available. You can associate or "link" an outbound
shipment with a return shipment using the tracking numbers. When processing your global return
package with FedEx automation, you'll need to provide a reason for that return for customs clearance
purposes, on both the outbound and return shipments, when processing your package. Identify your
package as a return and include the return type. Select the correct return reason from the table below.
Table 186. Return Types
OUTBOUND
What's the reason for
including a return label?

RETURN
What's the reason for the
return?

When to use

Courtesy Return Label

Rejected Merchandise

Select these two reasons when you're
including a return label for your customer in
your shipment, but typically don't expect
returns.

For Exhibition/Trade Show

Exhibition/Trade Show
Returns

Select these two reasons when the goods
you're shipping are for a show, exhibition,
trade show or event.

Item for Loan

Return of Loaned Item

Select these two reasons when the goods
you're shipping are for temporary use by the
recipient to be returned to you in an
unaltered state.

For Repair/Processing

Repair/Processing Returns

Select these two reasons when the goods
you're shipping will be either repaired or
otherwise processed before being returned
to you. Processing can include things like
modification, incorporation, or treatment of
some kind.

Items for Use in a Trial

Trial Returns

Select these two reasons when the goods
you're shipping are for a trial and will be
returned to you.

Replacement

Faulty Item Being Sent

Select these two reasons when you're
shipping a replacement item in advance of
receiving a faulty item back.

Temporary Export — Other Return — Other

Select these two reasons when none of the
other reasons listed apply. When you select
these reasons , you'll have the ability to
state your exact reason for the return.

Following
Repair/Processing

Select this reason when the recipient of the
goods previously sent you the item for
repair; however, they had not previously
shipped with FedEx.

N/A

FedEx Web Services, Developer Guide 2016

479

Returns Shipping
Once the return shipment is generated, you can track it through available tracking applications, thus
increasing visibility timeframe.
You have the capability of creating associated outbound and return shipments:


on different shipping platforms



with a destination different from the origin of the associated outbound shipment (which includes the
possibility of returning to a different country)



with an origin different from the destination of the associated outbound shipment

FedEx® Returns solutions provide two methods of processing return labels: FedEx Return Labels and
FedEx Return Tags.


FedEx Return Label solutions let you either generate Print Return or Email Return labels or use preprinted labels (Billable Stamps and Ground Package Returns Program).
o

FedEx Print Return label — Create and print a return label, then include it either in the original
shipment to your customer or in a separate correspondence. Your customer can then apply this
label to the package as needed and drop it off at the nearest FedEx drop-off location.
FedEx Email Return label — Email your customers a password-protected fedex.com URL that
they can access to print a return label directly from their computer. The customer receives an
email with a link to the label, then prints the label, applies it to the package, and drops it off at
the nearest FedEx drop-off location. See Email Return Label Elements section of Open
Shipping.
Printed return labels do not expire and are valid for transportation use anytime. However, if the
label is more than 255 days old, then the customer will not be able to track the shipment, even
though the label is still usable.



FedEx Return Tag solutions (FedEx Express® Tag and FedEx Ground® Call Tag) provide return labels
generated by FedEx at the time of package pickup. You arrange for FedEx to create and deliver
return shipping labels to your customer and collect the item for return. Your customer simply needs
to have the package ready for pickup when the FedEx Express® courier arrives. A shipping label and
a customer receipt will be printed on-site.



You can also schedule the pickup; for FedEx Express; the pickup is on the same day or the next
business day, Monday through Friday. FedEx makes one pickup attempt as part of the service.



For FedEx Ground, the pickup is the next business day and up to 10 business days in advance.
Business days are Monday through Friday for commercial pickups, and Tuesday through Saturday for
residential pickups. FedEx makes three pickup attempts as part of the service.



You can also print return instructions to include with your outbound shipments using the
ReturnInstructionsDetail.

This section describes how to create and delete FedEx Express and FedEx Ground return tag requests
and how to include a FedEx Express or FedEx Ground return label in your Ship request.
For more information on shipping labels see Create a Label.

23.1 Global Returns
FedEx Global Returns program expands the current Returns Product Portfolio by developing a global
returns solution across all regions (Asia Pacific, Europe, the Middle East & Africa, Latin America & the
Caribbean, US and Canada) and within regions for domestic returns. This will facilitate returns
documentation process, providing an outbound/inbound solution and offering a complete bundle of
FedEx Web Services, Developer Guide 2016

480

Returns Shipping
portfolio options. It also supports returns back to the original origin, returns to a new location or an intracounty return, where available.
It provides the ability for a merchant to request an email return label and trade documents for
international and non-US Domestic return shipments and make them available to the return shipper.
Many of the enhancements introduced also apply to US Domestic Email Return Label shipments,
including, but not limited to: Return instructions, Merchant notifications, Merchant documents, and an
extended expiration period (2 years).
The web service transaction updates related to Global Returns can be found in the RateRequest/Reply
Elements, CreateOpenShipment Request/Reply Elements, ProcessShipment Reply, and
UploadDocumentsRequest transaction tables.

23.2 FedEx Return Tags
FedEx creates and delivers a return shipping label to your customer and collects the item for return. Your
customer needs to have the package ready for pickup when the FedEx driver arrives. Use the
ShipService WSDL to create and delete Return Tag requests for FedEx Express and FedEx Ground
shipments.
Before creating a Return Tag for FedEx Express shipments, you can use Express Tag Availability from
the ReturnTagService WSDL to check valid pickup times.

23.2.1 Return Tag Service Details
For FedEx Ground, up to three pickup attempts, and for FedEx Express, one pickup attempt will be made
for a Return Tag request before the request is canceled.
The following service details apply to Return Tags.
1. Delivery Area
a.
b.
c.
d.

Available for FedEx deliveries throughout the 50 United States.
FedEx Express and FedEx Ground return tag labels are not available for international shipments.
Both commercial and residential locations are allowed.
Intra-country returns are also available. Refer to FedEx Intra-Country Shipping for a list of
countries that support intra-country shipping services.

2. Exceptions
a. No transborder service to or from Canada and Puerto Rico.
b. Hazardous Materials FedEx Ground U.S., Dry Ice Shipments , Dangerous Goods cannot be
shipped.
3.

Additional Information
a. Additional service options include residential pickup.
b. The maximum declared value is $25,000USD.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

23.2.2 Return Tag Coding Details
The following coding details apply to Return Tags:


You may request one Return Tag pickup in a single transaction.

FedEx Web Services, Developer Guide 2016

481

Returns Shipping


You may request up to 99 pieces in a multiple-piece Return Tag transaction.



No Ground manifest is required.



FedEx® Express Tag shipments can be associated to an outbound shipment via the Return
association element.



FedEx Ground® Call Tag shipments can be associated to an outbound shipment via the RMA
element.

23.2.2.1 ProcessTagRequest Elements
In addition to the basic shipping elements required to request a Return Tag, the following elements must
be included in the ProcessTagRequest:
Table 187. Process Tag Request Elements
Element

Description

RequestedShipment/Shipper

Required.
Pickup location information, including contact name, company,
address, etc.
Note: This element also includes the Residential element. If you are
requesting a Return Tag pickup for a residential address, you must
include this element for correct surcharge calculation.

RequestedShipment/Recipient

Required.
Package delivery destination information, including contract
name, company, address, etc.
Note: This element also includes the Residential element. If you are
requesting a Return Tag package delivery to a residential address,
you must include this element for correct surcharge calculation.

RequestedShipment/
ShippingChargesPayment

Required.
Valid elements for the PaymentType are:


SENDER



THIRD_PARTY

Note: The Payor/ResponsibleParty/AccountNumber element is required.

RequestedShipment/
SpecialServicesRequested/
SpecialServicesTypes

Required.
Special Services Type: RETURN_SHIPMENT

RequestedShipment
/SpecialServicesRequested/
ReturnShipmentDetail/ReturnType

Required.
Return Type: FEDEX_TAG

RequestedShipment/
ShipmentSpecialServicesRequested
/
ReturnShipmentDetail/Rma/Reason

Optional.
Customer-provided reason for the return.

FedEx Web Services, Developer Guide 2016

482

Returns Shipping

Element

Description

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnAssociation/TrackingNumber

Optional.
This is the tracking number for the outbound shipment
associated with this return. FedEx® ExpressTag shipments are
associated by the ReturnAssociation element only.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnAssociation/Shipdate

Optional.
This is the ship date for the outbound shipment associated with
the return.
Note: Does not apply to FedEx Ground® Call Tags.

RequestedShipment/
PickupDetail/ReadyDateTime

Required.
The earliest time the package will be ready for pickup. The time
entry must be between 08:00:00 and 18:00:00. The date and
time information must be in the format YYYY-MMDDHH:MM:SS.

RequestedShipment/
PickupDetail/LatestPickupDateTime

Required.
The latest time the package can be picked up by the carrier. This
can also represent the business close time. Required for
commercial/business pickup locations. The date and time
information must be in the format YYYY-MM-DDHH:MM:SS.
The date component must be in the format YYYY-MM-DD, such
as 2006-06-26. The time component must be in the format
HH:MM:SS using a 24-hour clock, such as 11:00 a.m. is
11:00:00, 5:00 p.m. is 17:00:00.
The date and time are separated by the letter T, such as 200606-26T17:00:00).
There is also a UTC offset component indicating the number of
hours and minutes from UTC, such as 2006-06-26T17:00:000400 is June 26, 2006 5:00 p.m. Eastern Time. The time entry
must be between 08:00:00 and 18:00:00.

RequestedShipment/PickupDetail/
CourierInstructions

Optional.
Additional instructions to the FedEx courier, such as package
location or directions, may be added to your request.

RequestedShipment/
ShippingDocumentSpecification/
CustomDocumentDetail

Data required to produce a custom-specified document, either at
shipment or package level.

CustomDocumentDetail/Format

Common information controlling document production.

CustomDocumentDetail/
LabelPrintingOrientation

Applicable only to documents produced on thermal printers with
roll stock.

CustomDocumentDetail/LabelRotati
on

Applicable only to documents produced on thermal printers with
roll stock.

CustomDocumentDetail/Specificatio Identifies the formatting specification used to construct this
nId
custom document.

FedEx Web Services, Developer Guide 2016

483

Returns Shipping

Element

Description

CustomDocumentDetail/
CustomDocumentIdentifier

Identifies the individual document specified by the client.

CustomDocumentDetail/DocTabCon If provided, thermal documents will include specified doc tab
tent
content. If omitted, document will be produced without doc tab
content.
CustomDocumentDetail/
CustomLabelDetail

This allows the customer to define how custom information is to
be positioned and formatted on a custom label or the
customizable portion of a shipping label, and what the custom
information should be.

CustomLabelDetail/CoordinateUnits

Valid values are:


MILS (thousanths of an inch)



PIXELS (device-dependent)

CustomLabelDetail/TextEntries

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

CustomLabelDetail/GraphicEntries

Image to be included from printer's memory, or from a local file
for offline clients.

CustomLabelDetail/BoxEntries

Solid (filled) rectangular area on label.

CustomLabelDetail/
CustomLabelTextBoxEntry

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

CustomLabelTextBoxEntry/
TopLeftCorner

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/
BottomRightCorner

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/Position

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/Format

Format.

CustomLabelTextBoxEntry/DataFiel
ds

Data fields.

CustomLabelTextBoxEntry/
ThermalFontId

Printer-specific font name for use with thermal printer labels.

CustomLabelTextBoxEntry/FontNa
me

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry/FontSize

Generic font size for use with plain paper labels.

FedEx Web Services, Developer Guide 2016

484

Returns Shipping

Element

Description

CustomLabelTextBoxEntry/Rotation

Describes the rotation of an item from its default orientation.
Valid values are:


NONE



RIGHT



UPSIDE_DOWN

CustomLabelDetail/BarcodeEntries

Constructed string, based on format and zero or more data
fields, printed in specified barcode symbology.

RequestedShipment/
ShippingDocumentSpecification
/ReturnInstructionsDetail

Optional.
Specify the production of the return instructions document.

ShippingDocumentSpecification/
ReturnInstructionsDetail/Format

Optional.
Specify characteristics of a shipping document to be produced.

ShippingDocumentSpecification/
Optional.
ReturnInstructionsDetail/CustomTex Specify additional customer provided text to be inserted into the
t
return document.
RequestedShipment/PackageCount

Required.
This element is required if you want to process a multiplepackage shipment. FedEx allows up to 99 pieces in a single
transaction.

RequestedShipment/
RequestedPackageLineItems

Required.
An array of individual package attributes.


Single piece tag requests will have one
RequestedPackageLineItem.



Multiple piece tag requests will have multiple
RequestedPackageLineItems.



RequestedPackageLineItems cannot exceed 99.

RequestedShipment/
RequestedPackageLineItems/
SpecialServicesRequested/
DangerousGoodsDetail/
UploadedTrackingNumber

UploadedTrackingNumber element is used to identify an
instance of an uploaded dangerous goods handling unit. This
element is required only if you have already validated DG data
using the FedEx provided Dangerous Goods / Hazardous
Materials information upload option.

ProcessShipmentRequest/
RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail

Descriptive data required for a FedEx shipment containing
dangerous materials. This element isrequired when
SpecialServiceType .DANGEROUS_GOODS or
HAZARDOUS_MATERIAL is present in the SpecialServiceTypes
collection.

ProcessShipmentRequest/
RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail/

Total number of packages in the shipment that contain dry ice.

FedEx Web Services, Developer Guide 2016

485

Returns Shipping

Element

Description

packageCount
ProcessShipmentRequest/
RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail/ totalWeight

Total shipment dry ice weight for all packages.

ProcessShipmentRequest/
RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail/
processingOptions

SHIPMENT_LEVEL_DRY_ICE_ONLY
This option Specify that dry ice information is only applicable at
the shipment level. Package level dry ice information would not
apply

RequestedShipment/
Optional.
RequestedPackageLineItems/Insure This is the declared value for an individual package. Use this
dValue
element if you want to declare a higher value.
Note: InsuredValue refers to declared value of the package. InsuredValue
element includes currency and amount.

RequestedShipment/
RequestedShipment/
RequestedPackagesLineItems/
InsuredValue/Amount

Optional. FedEx liability for each package is limited to $100USD
unless a higher value is declared and paid for. Use this element if
you want to declare a higher value.
Note: "InsuredValue" refers to declared value of the package.

RequestedShipment/
Required.
RequestedPackageLineItems/Weigh Weight element includes units and value.
t
RequestedShipment/
RequestedPackagesLineItems/
Weight/Value

Required.
If you include the PackageCount element in your request, the
Weight/Value element must equal the total weight of the
packages to be picked up.

RequestedShipment/
RequestedPackageLineItems/
ItemDescription

Optional.
The text describing the package.

RequestedShipment/
RequestedPackagesLineItems/
CustomerReferences/
CustomerReferenceType

Optional.
A maximum of 40 characters is accepted in this element. This
element allows customer-defined notes to print on the shipping
label.
Use RMA_ASSOCIATION to associate outbound and return
shipments by the RMA Number.

RequestedShipment/
RequestedPackagesLineItems/
CustomerReferences/Value

Optional.
A maximum of 40 characters is accepted in this element. This
element allows customer-defined notes to print on the shipping
label.
Note: A maximum of 20 characters is accepted for the
RMA_ASSOCIATION CustomerReferenceType.

FedEx Web Services, Developer Guide 2016

486

Returns Shipping

Element

Description

RequestedShipment/
RequestedPackageLineitems/
CustomerReferences/
CustomerReferenceType

Optional. Specify where to print the customer reference value.
Valid values:

ShippingDocumentSpecification
/FreightAddressLabelDetail/
DocTabContent
/DocTabContentType



BILL_OF_LADING



CUSTOMER_REFERENCE



DEPARTMENT_NUMBER



ELECTRONIC_PRODUCT_CODE



INTRACOUNTRY_REGULATORY_REFERENCE



INVOICE_NUMBER



P_O_NUMBER



RMA_ASSOCIATION



SHIPMENT_INTEGRITY



STORE_NUMBER

Valid values:


BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001

RequestedShipment/
RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

The total mass of the contained explosive substances, without
the mass of any casings, bullets, shells, etc.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer
/HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:

RequestedShipment/
LabelSpecification/
CustomerSpecifiedLabelDetail/
LabelMaskableDataType

Names of data elements/areas which may be suppressed from
printing on labels.



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT



CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER



SECONDARY_BARCODE

FedEx Web Services, Developer Guide 2016

487

Returns Shipping

Element

Description


SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMB
ER

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested

Through this option, an existing SmartPost small shipper or
return shipper can specify to have the Ground tracking number
provided in the shipment reply. This is a contingency feature in
case the customer requires the Ground tracking number for
internal processes or for tracking SmartPost shipments. The
Ground tracking number will only be provided for existing
SmartPost small shippers or return shippers.
Customers will have the same reporting and tracking capabilities
as today when they receive a Ground tracking number.
However, the Ground tracking number will not be printed on the
FXSP shipping label.
fedex.com provides the same tracking visibility for SmartPost
shipments when using either the SmartPost tracking number or
the Ground tracking number.
Fedex recommends using fedex.com, rather than USPS.com,
for all tracking activities for SmartPost shipments.

Requestedshipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested/
SmartPostShipmentProcessing
OptionType

Valid value:


GROUND_TRACKING_NUMBER_REQUESTED

23.2.2.2 Delete Tag Request
If the package has not yet been picked up by the carrier, then the ReturnTag request can be deleted
using the DeleteTagRequest process method of the Ship WSDL. In addition to the standard
AuthenticationDetail and ClientDetail elements required for all services, the following elements are
required for a DeleteTagRequest:
Table 188. DeleteTagRequest Elements
Element

Description

DeleteTagRequest/DispatchLocationId

Optional.
Required to cancel FedEx Express Tags. Only used for tags
which had FedEx Express services.

DeleteTagRequest/DispatchDate

Required.
Specify the date that the dispatch was requested.
Format: YYYY-MM-DD.

DeleteTagRequest/Payment

Required.

FedEx Web Services, Developer Guide 2016

488

Returns Shipping

Element

Description
If the original ProcessTagRequest specified third-party
payment, then the delete request must contain the same
pay type and payor account number for security purposes.

DeleteTagRequest/ConfirmationNumber

Required.
This number is returned in the DeleteTagReply. To identify
the Tag request you want to delete, this number must be
included.

23.2.3 Express Tag Availability
Before creating a Process Tag request, you can use the ExpressTagAvailabilityRequest from the
ReturnTagService WSDL to check valid access/pickup times and ready times for Express services only.
In addition to the standard AuthenticiationDetail and Client detail elements required for all services, the
following element is required:
Table 189. ExpressTagAvailabilityRequest Element
Element

Description

ExpressTagAvailabilityRequest

The following elements are required:


ReadyDateTime - This element must contain the date and
time the package will be ready for pickup (Format: YYYY-MMDDTHH:MM:SS, Example: 2014-02-10T12:00:00).



OriginAddress



Service – FedEx Express services only



Packaging

In addition to transaction details and error conditions, the ExpressTagAvailabilityReply returns the
following information:
Table 190. Express Tag Availability Reply Elements
Element

Description

AccessTime

This is the minimum time window that must be allocated for the FedEx courier
to make the pickup. 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.
Note: Access time requirements vary by postal code.

ReadyTime

The latest time a FedEx courier can pick up the FedEx ExpressTag ® package.
Note: Ready times vary by postal code.

Availability

Indicates the FedEx ExpressTag service availability at the shipper postal code
indicated in the Request.
Valid values:


NEXT_DAY_AVAILABLE

FedEx Web Services, Developer Guide 2016

489

Returns Shipping

Element

Description


SAME_DAY_AND_NEXT_DAY_AVAILABLE

23.3 FedEx Print Return Label
FedEx Print Return Label is ideal for retail products, legal documents, pharmaceuticals, and
warranty/repair services.
Use the ProcessShipmentRequest transaction to print a return label and include it in the original
shipment to your customer, or send it separately. To use the print return label, your customer simply
prepares their package for shipping and applies the return label. Then they may tender the FedEx
Express® U.S. or international package, FedEx Ground ® package or FedEx International Ground® package
to FedEx by scheduling a pickup, using a regular scheduled pickup, or visiting a FedEx dropoff location.
Alternatively, FedEx SmartPost® returns (for daily average volume of over 100) may be tendered to any
USPS access point, including the shipper's mailbox.
In addition, a Returns Material Authorization (RMA) reference number can be included in your ship
transaction. The RMA number prints on the label and your FedEx invoice and can be used to track the
return package. FedEx Express, FedEx Ground, and FedEx SmartPost return labels are interchangeable,
regardless of the original shipping service. For example, you can send the original shipment using a
FedEx Express service, but include a FedEx Ground return label as part of your packing documents.

23.3.1 FedEx Print Return Label Service Details
The following service details apply to FedEx Express and FedEx Ground return labels:


In the U.S., printed return labels are available for FedEx First Overnight®, FedEx Priority Overnight®,
FedEx Standard Overnight®, FedEx 2Day®, FedEx 2Day® A.M., FedEx Ground®, FedEx Home
Delivery®, FedEx 2Day® Freight, and FedEx 3Day® Freight throughout the 50 United States.



FedEx Express Saver® and FedEx 1Day® Freight services are not available.



For international destinations, printed return labels are available for FedEx International First ®, FedEx
International Priority®, FedEx International Economy®, FedEx International Priority ® Freight, FedEx
International Economy® Freight and FedEx International Ground®.



Additional service options include Saturday Service, Dry Ice Shipments, and Hold at FedEx Location.



Dangerous Goods and Hazardous Materials cannot be shipped.



The maximum declared value is
o
o
o

$1,000USD for FedEx First Overnight, FedEx Priority Overnight, FedEx Standard Overnight, and
FedEx 2Day.
$50,000USD for FedEx 2Day Freight and FedEx 3Day Freight.
$100USD for FedEx Ground and FedEx Home Delivery.

For more detailed information about the services offered by FedEx, see the electronic FedEx Service
Guide.

FedEx Web Services, Developer Guide 2016

490

Returns Shipping

23.4 FedEx Express/Ground Return Label Coding
Details
The following coding details apply to FedEx Express and Ground return labels:


The system automatically generates customized instructions for the return shipper, which can be
included with the shipment labels and/or generated separately.



You can identify the specific reason for the return of the shipment using the
CustomsOptionDetail/CustomsOptionsType element.



Customs clearance documents must be generated by country to ensure shipments are captured and
processed correctly.



Printed return labels do not expire and are valid for transportation use anytime. However, if the label
is more than 255 days old, then the customer will not be able to track the shipment, even though the
label is still usable.



Returns shipments are billed upon the delivery scan.



Returns packages are available in FedEx InSight® after the possession scan is received by FedEx
systems.



Returns shipments can be deleted using DeleteShipment until a Close is performed, either by using
the Close Service for FedEx Ground or the end-of-day Close performed at FedEx for FedEx Express
shipments. After the shipping day is closed, returns shipments cannot be canceled.



All label formats supported by FedEx Web Services (laser and thermal) are available for Returns
shipping labels.



You can associate Express outbound and return shipments together using the
SpecialServicesRequested/ReturnShipmentDetail/ReturnAssociation/TrackingNumber element. This
allows you to track both shipments at the same time using the Returns Merchant Authorization
number (RMA) or tracking number. For Ground, you can only associate outbound and return
shipments together by using the CustomerReferenceType of RMA_ASSOCIATION.



You can also specify a return and outbound shipping email label. See Email Label section of Ship
Service for more information.

You can override the shipper address information for a returns shipment by using the Alternate Return
Address feature. See Alternate Return Address section of Ship Service for more information.


You can direct the signed return receipt to a different address.



Rate quotes are included in the reply for a returns shipment.



Return shipments must be processed as a single piece shipment. Multiple piece shipments are not
supported.

23.4.1 Print Return Label Elements
Ensure you are including the return documentation and labels inside the package for your customer. Only
the outbound documentation and labels go inside the pouch on the outside of the box.
Include the following elements in your ProcessShipmentRequest to receive a return label in your Ship
reply:

FedEx Web Services, Developer Guide 2016

491

Returns Shipping
Table 191. Print Return Label Elements
Element

Description

RequestedShipment
/ShipmentSpecialServicesRequested/
SpecialServiceTypes

Optional
The types of all special services requested for the enclosing
shipment (or other shipment-level transaction). Valid values:


RETURNS_CLEARANCE



RETURN_SHIPMENT

RequestedShipment/
ShipmentSpecialServicesRequested/
DeliveryOnInvoiceAcceptanceDetail

Optional
Allows customers to direct the signed return receipt to a
different address.

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/ReturnType

Required
The type of return shipment being requested. The valid
value is PRINT_RETURN_LABEL. With this option you can
print a return label to insert into the box of an outbound
shipment. This option cannot be used to print an outbound
label.

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/Rma

Optional
Return Merchant Authorization (RMA)
If the RMA element is included in the Ship request, the
return Reason description may be entered. This element
allows you to enter up to 60 alpha-numeric characters.

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/ReturnEmailDetail

Optional
Describes specific information about the email label
shipment. You can also specify a return and outbound email
label. For more information, see Email Labels section of
Open Shipping.

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/ReturnAssociation

Optional
Specify the data for the outbound shipment associated with
the return.

RequestedShipment/
ShippingDocumentSpecification
/ReturnInstructionsDetail

Optional
Specify the production of the return instructions document.

RequestedShipment
/ShippingDocumentSpecification/
ReturnInstructionsDetail/Format

Optional
Specify the format of the Return Instructions shipping
document.

RequestedShipment/
ShippingDocumentSpecification/
ReturnInstructionsDetail/CustomText

Optional
Specify the additional customer provided text to be inserted
into the return document.

FedEx Web Services, Developer Guide 2016

492

Returns Shipping

23.5 Alternate Return Address
FedEx Web Services offer an alternate return address option that allows you to override your shipper
address and print a different address on the shipping label. For example, if you send a package that is
undeliverable, you may use this option to display your returns processing facility address so that FedEx
will return the package to that address instead of your shipping facility address.

23.5.1 Alternate Return Address Coding Details
The elements required to override your shipper address are provided in the ShipService WSDL. This table
contains alternate return address request elements:
Table 192. Alternate Return Request Elements
Element

Description

LabelSpecification/PrintedLabelOrigin/
Contact

Optional
If present, this contact information will replace the return
address information on the label. The descriptive data for a
point-of-contact person.

LabelSpecification/PrintedLabelOrigin/
Address

Optional
If present, this address information will replace the return
address information on the label. The descriptive data for a
physical location.

FedEx Web Services, Developer Guide 2016

493

Ship Service

24 Ship Service
Use the ShipService WSDL to process and submit various shipping requests to FedEx, such as FedEx
Express® and FedEx Ground® U.S and international shipments as well as Return shipments. Each
shipping request will contain descriptive information for each shipment. The ShipService WSDL also
offers you a service to validate your shipping requests prior to actually submitting a true shipment to
FedEx.
Refer to the following sections for information about the respective shipping services:


FedEx Express U.S.Shipping



FedEx Intra-Country Shipping



FedEx Ground U.S.Shipping



FedEx Express International Shipping



FedEx International Ground Shipping

24.1 Shipping Services by Region
This table outlines available FedEx shipping services by region:
Table 193. Shipping Services by Region
Region

FedEx
Express
U.S.

FedEx Express
International

FedEx
FedEx
Ground U.S International
Ground

Intra-Country
Service*

United States

Canada

Asian Pacific
countries
(APAC)

Europe, Middle
East and Africa
(EMEA)

Latin American
countries (LAC)

Note 1: Intra-country indicates shipping service within a specific country or region. Refer to FedEx Express
International Shipping section of Ship Service for a list of countries that support intra-country shipping services.
Note 2: Billing to a Venezula (VE) account for VE inbound shipments and Third party billing to a VE account for non VE
shipments is not be available.

FedEx Web Services, Developer Guide 2016

494

Ship Service

24.2 Ship Service Coding Basics
This section describes the Web Services elements needed to create, cancel, and validate shipments.

24.2.1 Create Shipment Using Process Shipment Request
The ProcessShipmentRequest requires the RequestedShipment complex element, which is made up of
the following elements.
Table 194. Requested Shipment Elements
Element

Description

ShipTimestamp

Required
Identifies the date and time the package is tendered to FedEx.
Both the date and time portions of the string are expected to be
used. The date should not be a past date or a date more than 10
days in the future. The time is the local time of the shipment
based on the shipper's time zone.
The date format must be YYYY-MM-DDTHH:MM:SS-xx:xx. The
time must be in the format: HH:MM:SS using a 24-hour clock.
The date and time are separated by the letter T, such as 2009-0626T17:00:00. The UTC offset indicates the number of
hours/minutes, such as xx:xx, from UTC; for example, 2009-0626T17:00:00-04:00 is defined as June 26, 2009 5:00 p.m. Eastern
Time.
See the Developer Guide Appendix "Time Zones" for more
information about time zones.

DropoffType

Required
Identifies the method by which the package is to be tendered to
FedEx. This element does not dispatch a courier for package
pickup. See DropoffType for list of valid enumerated values.

ServiceType

Required
Identifies the FedEx service to use in shipping the package. See
ServiceType for list of valid enumerated values.

PackagingType

Required
Identifies the packaging used by the requestor for the package.
See PackagingType for list of valid enumerated values.

ManifestDetail

This identifies which customer reference element used as the
manifest ID. This element is required in order to close by
reference.

TotalWeight

Identifies the total weight of the shipment being conveyed to
FedEx. This is only applicable to International shipments and
should only be used on the first package of a multiple-package
shipment.

TotalInsuredValue

Total insured value amount.

FedEx Web Services, Developer Guide 2016

495

Ship Service
Element

Description

PreferredCurrency

Indicates the currency the caller requests to have used in all
returned monetary values (when a choice is possible). Used in
conjunction with the RateRequest Types element

RequestedShipment/
ShipmentAuthorizationDetail

Specify details about the entity responsible for the shipment.

RequestedShipment/
ShipmentAuthorizationDetail/
accountNumber

Provides details about a specific FedEx customer account.

Shipper

Required
Descriptive data identifying the party responsible for shipping the
package. Shipper and Origin should have the same address.

Recipient

Required
Descriptive data identifying the party receiving the package.

RecipientLocationNumber

A unique identifier for a recipient location.

Origin

Identifies the shipment’s physical starting address if different
from the shipper.

SoldTo

Indicates the party responsible for purchasing the goods shipped
from the shipper to the recipient. The sold to party is not
necessarily the recipient or the importer of record. The sold to
party is relevant when the purchaser, rather than the recipient
determines when certain customs regulations apply.

ShippingChargesPayment

Required
Descriptive data indicating the method and means of payment to
FedEx for providing shipping services.

SpecialServicesRequested

Descriptive data regarding special services requested by the
shipper for this shipment. If the shipper is requesting a special
service which requires additional data, such as C.O.D., the special
service type must be present in the
ShipmentSpecialServicesRequested/ SpecialServiceTypes
collection, and the supporting detail must be provided in the
appropriate sub-object.
For example, to request C.O.D., "COD" must be included in the
SpecialServiceTypes collection and the CodDetail object must
contain the required data.

ExpressFreightDetail

Details specific to a FedEx Express Freight® shipment (i.e. FedEx
First Freight, FedEx 1Day, 2Day, and 3Day Freight).

FreightShipmentDetail

Details specific to a FedEx Freight LTL shipment (i.e. FedEx
Priority and Economy Freight).

DeliveryInstructions

Used with FedEx Home Delivery® and FedEx Freight.

FedEx Web Services, Developer Guide 2016

496

Ship Service
Element

Description

VariableHandlingChargeDetail

Details about how to calculate variable handling charges at the
shipment level.

CustomsClearanceDetail

Information about this package that only applies to an
international (export) shipment or return.

PickupDetail

For use in “process tag” transaction.

SmartPostDetail

Details specific to FedEx SmartPost shipments.

BlockInsightVisibility

If true, only the shipper/payor will have visibility of this shipment.

LabelSpecification

Required
Details about the image type, printer format, and label stock for
label. Can also specify customer specific details such as doc-tab
content, regulatory labels, and mask data on the label.

ShippingDocumentSpecification

Contains all data required for additional (non-label) shipping
documents to be produced with a specific shipment.

ShippingDocumentSpecification/Cus Data required to produce a custom-specified document, either at
tomDocumentDetail
shipment or package level.
CustomDocumentDetail/Format

Common information controlling document production.

CustomDocumentDetail/
LabelPrintingOrientation

Applicable only to documents produced on thermal printers with
roll stock.

CustomDocumentDetail/
LabelRotation

Applicable only to documents produced on thermal printers with
roll stock.

CustomDocumentDetail/
SpecificationId

Identifies the formatting specification used to construct this
custom document.

CustomDocumentDetail/
CustomDocumentIdentifier

Identifies the individual document specified by the client.

CustomDocumentDetail/
DocTabContent

If provided, thermal documents will include specified doc tab
content. If omitted, document will be produced without doc tab
content.

CustomDocumentDetail/
CustomLabelDetail

This allows the customer to define how custom information is to
be positioned and formatted on a custom label or the
customizable portion of a shipping label, and what the custom
information should be.

CustomLabelDetail/CoordinateUnits

Valid values are:


MILS (thousanths of an inch)



PIXELS (device-dependent)

FedEx Web Services, Developer Guide 2016

497

Ship Service
Element

Description

CustomLabelDetail/TextEntries

Constructed string, based on format and zero or more data fields,
printed in specified printer font (for thermal labels) or generic
font/size (for plain paper labels).

CustomLabelDetail/GraphicEntries

Image to be included from printer's memory, or from a local file
for offline clients.

CustomLabelDetail/BoxEntries

Solid (filled) rectangular area on label.

CustomLabelDetail/
CustomLabelTextBoxEntry

Constructed string, based on format and zero or more data fields,
printed in specified printer font (for thermal labels) or generic
font/size (for plain paper labels).

CustomLabelTextBoxEntry/
TopLeftCorner

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/
BottomRightCorner

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/Position

Horizontal and vertical position, relative to left edge of custom
area.

CustomLabelTextBoxEntry/Format

Format

CustomLabelTextBoxEntry/
DataFields

Data fields

CustomLabelTextBoxEntry/
ThermalFontId

Printer-specific font name for use with thermal printer labels.

CustomLabelTextBoxEntry/
FontName

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry/
FontSize

Generic font size for use with plain paper labels.

CustomLabelTextBoxEntry/
Rotation

Describes the rotation of an item from its default orientation.
Valid values are:


NONE



RIGHT



UPSIDE_DOWN

CustomLabelDetail/BarcodeEntries

Constructed string, based on format and zero or more data fields,
printed in specified barcode symbology.

ShippingDocumentSpecification/
FreightAddressLabelDetail/
DocTabContent/
DocTabContentType

Valid values are:


BARCODED



CUSTOM



MINIMUM



STANDARD

FedEx Web Services, Developer Guide 2016

498

Ship Service
Element

Description


RateRequestTypes

ZONE001

Indicates the type of rates to be returned. Valid values are:


LIST — Returns published rates in response



PREFERRED — Returns rates in currency specified in the
PreferredCurrency element



NONE — Returns no rates in response.

EdtRequestType

Specify whether the customer wishes to have Estimated Duties
and Taxes provided with the rate quotation on this shipment. Only
applies with shipments moving under international services.

MasterTrackingId

Used when requesting child pieces in a multiple-package
shipment (MPS). The master tracking information will be returned
in reply from the first package requested for a multiple-package
shipment. That master tracking information is then inserted into
the requests for each additional package requested for that
multiple-package shipment.

PackageCount

Required
For an MPS, this is the total number of packages in the shipment.

ConfigurationData

Specify data structures that may be re-used multiple times with a
single shipment.

RequestedPackageLineItems

One or more package-attribute descriptions, each of which
describes an individual package, a group of identical packages, or
(for the total-piece-total-weight case) common characteristics of
packages in the shipment.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

The total mass of the contained explosive substances, without
the mass of any casings, bullets, shells, etc.

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:

ReturnInstructionsDetail/
ShippingDocumentFormat/
documentFormatOptionsrequested/
Document formatOptions

The value will suppress English language if another language is
specified in language code field. (Default is English)
Valid value: SUPPRESS_ADDITIONAL_LANGUAGES



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

FedEx Web Services, Developer Guide 2016

499

Ship Service
Element

Description

SpecialServicesRequested/Pe
ndingShipmentDetail/
EmailLabelDetail

Describes specific information about the email label shipment.

SpecialServicesRequested/
PendingShipmentDetail/
ProcessingOptions
SpecialServicesRequested/
RecommendedDocument
Specification



Message: Content of the email message



Recipients: EMailRecipient



emailAddress - email address of the recipient



role - role type of the recipient



optionsRequested localization

ALLOW_MODIFICATIONS
This allows the Email Label originator to specify if the completer
can make modifications to editable shipment data.
Valid values:


ANTIQUE_STATEMENT_EUROPEAN_UNION



ANTIQUE_STATEMENT_UNITED_STATES



ASSEMBLER_DECLARATION



BEARING_WORKSHEET



FILM_AND_VIDEO_CERTIFICATE



CERTIFICATE_OF_SHIPMENTS_TO_SYRIA



PRINTED_CIRCUIT_BOARD_WORKSHEET



COMMERCIAL_INVOICE_FOR_THE_CARIBBEAN_COMMO
N_MARKET



CONIFEROUS_SOLID_WOOD_PACKAGING_MATERIAL_TO
_THE_PEOPLES_REPUBLIC_OF_CHINA



DECLARATION_OF_IMPORTED_ELECTRONIC_PRODUCTS
_SUBJECT_TO_RADIATION_CONTROL_STANDARD



DECLARATION_OF_BIOLOGICAL_STANDARDS"



ELECTRONIC_INTEGRATED_CIRCUIT_WORKSHEET



INTERIM_FOOTWEAR_INVOICE



NAFTA_CERTIFICATE_OF_ORIGIN_UNITED_STATES



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_FRENCH



NAFTA_CERTIFICATE_OF_ORIGIN_CANADA_ENGLISH



NAFTA_CERTIFICATE_OF_ORIGIN_SPANISH



PACKING_LIST



REPAIRED_WATCH_BREAKOUT_WORKSHEET



DECLARATION_FOR_FREE_ENTRY_OF_RETURNED_AMER
ICAN_PRODUCTS

FedEx Web Services, Developer Guide 2016

500

Ship Service
Element

specialServicesRequested/
pendingShipmentDetail/
documentReferences/
documentProducer

specialServicesRequested/
pendingShipmentDetail/
documentReferences/
documentIdProducer

LabelSpecification/
LabelOrderType

Description


STATEMENT_REGARDING_THE_IMPORT_OF_RADIO_FRE
QUENCY_DEVICES



TOXIC_SUBSTANCES_CONTROL_ACT



UNITED_STATES_WATCH_REPAIR_DECLARATION



UNITED_STATES_NEW_WATCH_WORKSHEET



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERS
HIP_ACT_CERTIFICATE_OF_ORIGIN_TEXTILES



UNITED_STATES_CARIBBEAN_BASIN_TRADE_PARTNERS
HIP_ACT_CERTIFICATE_OF_ORIGIN_NON_TEXTILES

Specify details for uploaded documents provided by the shipment
initiator.
Valid values:


CUSTOMER



FEDEX_CAFE



FEDEX_CLS



FEDEX_FIDT



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM



OTHER

Specify details for uploaded documents provided by the shipment
initiator.
Valid values:


CUSTOMER



FEDEX_CAFE



FEDEX_CSHP



FEDEX_FXRS



FEDEX_GSMW



FEDEX_GTM



FEDEX_INET

Specify the order in which the labels will be returned. Valid
values:


SHIPPING_LABEL_FIRST



SHIPPING_LABEL_LAST

FedEx Web Services, Developer Guide 2016

501

Ship Service
Element

Description

ShippingDocumentSpecification/
ReturnedShippingDocumentType



AUXILIARY_LABEL



CERTIFICATE_OF_ORIGIN



COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETUR
N_2_D_BARCODE



COD_AND_DELIVERY_ON_INVOICE_ACCEPTANCE_RETUR
N_LABEL



COD_RETURN_2_D_BARCODE



COD_RETURN_LABEL



COMMERCIAL_INVOICE



CUSTOM_PACKAGE_DOCUMENT



CUSTOM_SHIPMENT_DOCUMENT



DANGEROUS_GOODS_SHIPPERS_DECLARATION



DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_2_D_BA
RCODE



DELIVERY_ON_INVOICE_ACCEPTANCE_RETURN_LABEL



ETD_LABEL



EXPORT_DECLARATION



FREIGHT_ADDRESS_LABEL



GENERAL_AGENCY_AGREEMENT



GROUND_BARCODE



NAFTA_CERTIFICATE_OF_ORIGIN



OP_900



OUTBOUND_2_D_BARCODE



OUTBOUND_LABEL



PRO_FORMA_INVOICE



RECIPIENT_ADDRESS_BARCODE



RECIPIENT_POSTAL_BARCODE



RETURN_INSTRUCTIONS



TERMS_AND_CONDITIONS



USPS_BARCODE



CERTIFICATE_OF_ORIGIN



COMMERCIAL_INVOICE



CUSTOM_PACKAGE_DOCUMENT

ShippingDocumentSpecification/Shi
ppingDocumentTypes

FedEx Web Services, Developer Guide 2016

502

Ship Service
Element

RequestedPackageLineItem/
ItemDescriptionForClearance

LabelSpecification/
CustomerSpecifiedLabelDetail/
LabelMaskableDataType

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested

Description


CUSTOM_SHIPMENT_DOCUMENT



CUSTOMER_SPECIFIED_LABELS



DANGEROUS_GOODS_SHIPPERS_DECLARATION



EXPORT_DECLARATION



FREIGHT_ADDRESS_LABEL



GENERAL_AGENCY_AGREEMENT



LABEL



NAFTA_CERTIFICATE_OF_ORIGIN



OP_900



PRO_FORMA_INVOICE



RETURN_INSTRUCTIONS

Required for UAE; Otherwise: Optional – This element is for the
customer to describe the content of the package for customs
clearance purposes. This applies to intra-UAE, intra-Columbia and
intra-Brazil shipments.
Names of data elements/areas which may be suppressed from
printing on labels.


CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMB
ER

Through this option, an existing SmartPost small shipper or return
shipper can specify to have the Ground tracking number provided
in the shipment reply. This is a contingency feature in case the
customer requires the Ground tracking number for internal
processes or for tracking SmartPost shipments.
The Ground tracking number will only be provided for existing
SmartPost small shippers or return shippers. Customers will have
the same reporting and tracking capabilities as today when they
receive a Ground tracking number. However, the Ground tracking
number will not be printed on the FXSP shipping label.
fedex.com provides the same tracking visibility for SmartPost
shipments when using either the SmartPost tracking number or
the Ground tracking number.
Fedex recommends using fedex.com, rather than USPS.com, for
all tracking activities for SmartPost shipments.

FedEx Web Services, Developer Guide 2016

503

Ship Service
Element

Description

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested/
SmartPostShipmentProcessing
OptionType

Valid values:

Example 34:



GROUND_TRACKING_NUMBER_REQUESTED

Process Shipment Request

XXXXXXXXXX

XXXXXXXXXX
XXXXXXX
string
Syntel
WSGW
3100
WAPI123
SHIPENT
B123
SHIPENT
INT123
US
ENTERPRISE

string

FedEx Web Services, Developer Guide 2016

504

Ship Service

EN
en

ProcessShip_Basic

ship
17
0
0

YYYY-MM-DDT15:46:24-06:00
REGULAR_PICKUP
INTERNATIONAL_PRIORITY
YOUR_PACKAGING

XXXXXXXXX

Sender_Name
SndrConnm
XXXXXXXXXX

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
38117
US

SHIP TO CONTACT NAME
SHIP TO RECIPIENT CMPNY
XXXXXXXXXX

FedEx Web Services, Developer Guide 2016

505

Ship Service
abc@syntelinc.com

TC021 JAN14 US
IP - CuPack - US to BE
City
BE
1410
BE

JAN14 CL
SndrConnm
XXXXXXXXXX

Shipper Address Line 1
Shipper Address Line 2
City
TN
XXXXX
US

SENDER

XXXXXXXXX

JAN14 CL
SndrConnm
XXXXXXXXXX

Shipper Address Line 1
Shipper Address Line 2
City

FedEx Web Services, Developer Guide 2016

506

Ship Service
TN
XXXXX
US

XXXXXXXXX

JAN14 CL
SndrConnm
XXXXXXXXXX

Shipper Address Line 1
Shipper Address Line 2
Memphis
TN
XXXXX
US

SENDER

XXXXXXXXXX

Sender_Name
SndrConnm
XXXXXXXXXX

Shipper Address Line 1
Shipper Address Line 2
City
TN
XXXXX

FedEx Web Services, Developer Guide 2016

507

Ship Service
US

DOCUMENTS_ONLY

USD
100

Special Instructions
string

CUSTOMER_REFERENCE
TC#053

FOB

BOOKS
1
Books
US

LB
30

1
EA

USD
10.00

USD
100

FedEx Web Services, Developer Guide 2016

508

Ship Service
COMMON2D
ZPLII
STOCK_4X6.75_LEADING_DOC_TAB

LIST
1

USD
100

LB
30

20
15
20
IN

CUSTOMER_REFERENCE
TC#053

24.3 Delete Shipment
The Delete Shipment feature allows you to delete packages that have not already been tendered to
FedEx. FedEx services offering this feature are FedEx Express®, FedEx Ground® and FedEx Custom
Critical®.
Note: This feature does not apply to Return Tag Services, FedEx Express and FedEx Ground Return Labels, and
Email Return Label options.

24.3.1 Delete Shipment Coding Details
FedEx Web Services, Developer Guide 2016

509

Ship Service
The following elements can be used to delete a package or shipment:
Table 195. Delete Shipment Coding Details Elements
Element

Required Description

WebAuthenticationDetail

Yes

Descriptive data to be used in authentication of the sender’s
identity (and right to use FedEx Web Services).

ClientDetail

Yes

Descriptive data identifying the client submitting the
transaction.

TransactionDetail

Descriptive data for this customer transaction. The
TransactionDetail from the request is echoed back to the caller
in the corresponding reply.

Version

Yes

Identifies the version/level of a service operation expected by a
caller (in each request) and performed by the callee (in each
reply).

ShipTimestamp

The timestamp of the shipment request.

TrackingId

Complex type element that contains information about the
package being deleted.

TrackingId/TrackingIDType

Yes

Valid values are:


EXPRESS



FEDEX



GROUND



USPS

Note: Canceling a shipment is not supported for Freight. You must call
FedEx to cancel and/or update a previously scheduled Freight
shipment.

TrackingID/
TrackingNumber

Yes

The tracking number value to be deleted.
The tracking number assigned to the package. Delete
requirements for multiple-package shipments are as follows:


For FedEx Express international multiple-package
shipments, if you enter the master tracking number, all
packages associated with this shipment are deleted. If
you attempt to delete one package in a shipment, the
label sequence number will be incorrect and you may
experience clearance issues in customs if you cannot
account for all packages in the shipment.



For FedEx International Ground® multiple-package
shipments, if you enter any tracking number associated
with the master shipment, all packages associated with
the shipment are deleted.



For FedEx Ground U.S. multiple-package shipments, you
may enter a single tracking number to delete one package
in the shipment. Since FedEx Ground U.S. multiple-

FedEx Web Services, Developer Guide 2016

510

Ship Service
Element

Required Description
package shipments labels are not associated with
sequential numbers (1 of 2, 2 of 2), you do not need to
delete the entire shipment.


DeletionControl

Yes

For FedEx Express C.O.D. multiple-package shipments,
enter any tracking number in the shipment to delete the
entire shipment. For FedEx Ground® C.O.D. multiplepackage shipments, you must delete each individual
package.

Determines the type of deletion to be performed in relation to
package level versus shipment level. Valid options are:


DELETE_ALL_PACKAGES



DELETE_ENTIRE_CONSOLIDATION



DELETE_ONE_PACKAGE



LEGACY

If you are unable to delete the package or shipment, you will receive an error condition. This error
condition indicates that:


For FedEx Ground shipments, a close has already been performed for that tracking number.



For FedEx Express shipments, the package has already been tendered to FedEx.



You have entered an invalid account number or meter number.



The account number and meter number, while valid, are not associated with one another or with the
tracking number.



You entered an invalid tracking number. This applies to FedEx Ground shipments only. FedEx
Express accepts any number with the correct amount of digits.

Example 35:

DeleteShipmentRequest

XXXXXXXXXX

FedEx Web Services, Developer Guide 2016

511

Ship Service

XXXXXXXXXX
XXXXXXX
string
Syntel
WSGW
3100
WAPI123
SHIPENT
B123
SHIPENT
INT123
US
ENTERPRISE

string

EN
en

Delete Shipment

ship
17
0
0

YYYY-MM-DDT09:30:47-05:00

EXPRESS
0201
XXXXXXXXXXXX

DELETE_ALL_PACKAGES

FedEx Web Services, Developer Guide 2016

512

Ship Service

24.4 Process Shipment Reply
The following may be returned in a Process Shipment Reply.
Table 196. Process Shipment Reply Elements
Element

Description

HighestSeverity

Required
Identifies the highest severity encountered when performing the
request.
Valid values:

Notifications



FAILURE



ERROR



WARNING



NOTE



SUCCESS

Required
Includes the descriptive data detailing the status of a submitted
transaction. Includes the severity of the notification, which
indicates success or failure or some other information about the
request. Valid values are:


SUCCESS – Your transaction succeeded with no other
applicable information.



NOTE – Additional information that may be of interest to you
about your transaction.



WARNING – Additional information that you need to know
about your transaction that you may need to take action on.



ERROR – Information about an error that occurred while
processing your transaction.



FAILURE – FedEx was unable to process your transaction at
this time due to a system failure. Please try again later.

JobId

—

CompletedShipmentDetail

The reply payload. All of the returned information about this
shipment/package.

CompletedShipmentDetail/UsDom
estic

Indicates whether or not this is an intra-U.S. shipment.

CompletedShipmentDetail/CarrierC Indicates the carrier that will be used to deliver this shipment.
ode

FedEx Web Services, Developer Guide 2016

513

Ship Service
Element

Description

CompletedShipmentDetail/MasterT The master tracking number and form id of this multiple piece
rackingId
shipment. This information is to be provided for each subsequent
of a multiple piece shipment.
CompletedShipmentDetail/
ServiceTypeDescription

Description of the FedEx service used for this shipment. Currently
not supported.

CompletedShipmentDetail/
PackagingDescription

Description of the packaging used for this shipment. Currently not
supported.

CompletedShipmentDetail/
OperationalDetail

Specify shipment level operational information.

CompletedShipmentDetail/Access
Detail

Used only with pending shipments.

CompletedShipmentDetail/TagDeta Only used in the reply to tag requests.
il
CompletedShipmentDetail/
HazardousShipmentDetail

Computed shipment level information about hazardous
commodities.

ProcessTagReply/
CompletedShipmentDetail/
HazardousShipmentDetail/DryIceD
etail
CompletedShipmentDetail/
ShipmentRating

All shipment-level rating data for this shipment, which may include
data for multiple rate types.

CompletedShipmentDetail/
CompletedHoldAtLocationDetail

Returns the default holding location information when
HOLD_AT_LOCATION special service is requested and the client
does not specify the hold location address.

CompletedShipmentDetail/
ExportComplianceStatement

Returns any defaults or updates applied to
RequestedShipment.exportDetail.ExportComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

Valid values are:


FolderId — The identifier for all clearance documents
associated with this shipment.



UploadDocumentReferenceDetails

CompletedShipmentDetail/
ShipmentDocuments

All shipment-level shipping documents (other than labels and
barcodes).

CompletedShipmentDetail/
AssociatedShipments

Provides the customer with the Delivery on Invoice Acceptance
data.

CompletedShipmentDetail/
CompletedCodDetail

Specify the results of processing for the COD special service.

CompletedShipmentDetail/
CompletedPackageDetails

Package level details about this package.

FedEx Web Services, Developer Guide 2016

514

Ship Service
Element

Description

/CompletedPackageDetails/
SequenceNumber

The package sequence number of this package in a multiple piece
shipment.

/CompletedPackageDetails/Trackin
gIds

The tracking number and form id for this package.

/CompletedPackageDetails/GroupN Used with request containing PACKAGE_GROUPS, to identify
umber
which group of identical packages was used to produce a reply
item.
/CompletedPackageDetails/Oversiz
eClass

Oversize class for this package.

/CompletedPackageDetails/Packag
eRating

All package-level rating data for this package, which may include
data for multiple rate types.

/PackageRating/ActualRateType

This rate type identifies which entry in the following array is
considered as presenting the "actual" rates for the package.

/PackageRating/EffectiveNetDiscou The "list" net change minus "actual" net change.
nt
/PackageRating/PackageRateDetail
s

Each element of this field provides package-level rate data for a
specific rate type.

/PackageRating/PackageRateDetail/ Type used for this specific set of rate data.
RateType
/PackageRating/PackageRateDetail/ Indicates which weight was used.
RatedWeightMethod
/PackageRating/PackageRateDetail/ INTERNAL FEDEX USE ONLY.
MinimumChargeType
/PackageRating/PackageRateDetail/ The weight that was used to calculate the rate.
BillingWeight
/PackageRating/PackageRateDetail/ The oversie weight of this package (if the package is oversize).
OversideWeight
/PackageRating/PackageRateDetail/ The Transportation charge only (prior to any discounts applied) for
BaseCharge
this package.
/PackageRating/PackageRateDetail/ The sum of all discounts on this package.
TotalFreightDiscounts
/PackageRating/PackageRateDetail/ This package's baseCharge - totalFreightDiscounts.
NetFreight
/PackageRating/PackageRateDetail/ The sume of all surcharges on the package.
TotalSurcharges
/PackageRating/PackageRateDetail/ The package's netFreight + totalSurcharges (not including
NetFedExCharge
totalTaxes).
/PackageRating/PackageRateDetail/ The sum of all taxes on this package.
TotalTaxes
FedEx Web Services, Developer Guide 2016

515

Ship Service
Element

Description

/PackageRating/PackageRateDetail/ The package's netFreight + totalSurcharges + totalTaxes.
NetCharge
/PackageRating/PackageRateDetail/ The total sum of all rebates applied to this package.
TotalRebates
/PackageRating/PackageRateDetail/ All rate discounts that apply to this package.
FreightDiscounts
/PackageRating/PackageRateDetail/ All rebates that apply to this package.
Rebates
/PackageRating/PackageRateDetail/ All surcharges that apply to this package (either because of
Surcharges
characteristics of the package itself, or because it is carrying pershipment surcharges for the shipment of which it is a part).
/Surcharges/SurchargeType

The type of surcharge applied to the shipment.
Valid values:


ADDITIONAL_HANDLING



ANCILLARY_FEE



APPOINTMENT_DELIVERY



BROKER_SELECT_OPTION



CANADIAN_DESTINATION



CLEARANCE_ENTRY_FEE

(Note: this value is now considered as ancillary fee, and will be reported
under AncillaryFeeAndTax.)



COD



CUT_FLOWERS



DELIVERY_AREA



DELIVERY_CONFIRMATION



DELIVERY_ON_INVOICE_ACCEPTANCE



DOCUMENTATION_FEE



DRY_ICE



EMAIL_LABEL



EUROPE_FIRST



EXCESS_VALUE



EXHIBITION



EXPORT



EXTRA_SURFACE_HANDLING_CHARGE



EXTREME_LENGTH

FedEx Web Services, Developer Guide 2016

516

Ship Service
Element

Description


FEDEX_INTRACOUNTRY_FEES



FEDEX_TAG



FICE



FLATBED



FREIGHT_GUARANTEE



FREIGHT_ON_VALUE



FREIGHT_TO_COLLECT



FUEL



HOLD_AT_LOCATION



HOME_DELIVERY_APPOINTMENT



HOME_DELIVERY_DATE_CERTAIN



HOME_DELIVERY_EVENING



INSIDE_DELIVERY



INSIDE_PICKUP



INSURED_VALUE



INTERHAWAII



LIFTGATE_DELIVERY



LIFTGATE_PICKUP



LIMITED_ACCESS_DELIVERY



LIMITED_ACCESS_PICKUP



METRO_DELIVERY



METRO_PICKUP



NON_MACHINABLE



OFFSHORE



ON_CALL_PICKUP



OTHER



OUT_OF_DELIVERY_AREA



OUT_OF_PICKUP_AREA



OVERSIZE



OVER_DIMENSION



PIECE_COUNT_VERIFICATION



PRE_DELIVERY_NOTIFICATION

FedEx Web Services, Developer Guide 2016

517

Ship Service
Element

Description


PRIORITY_ALERT



PROTECTION_FROM_FREEZING



REGIONAL_MALL_DELIVERY



REGIONAL_MALL_PICKUP



REROUTE



RESCHEDULE



RESIDENTIAL_DELIVERY



RESIDENTIAL_PICKUP



RETURN_LABEL



SATURDAY_DELIVERY



SATURDAY_PICKUP



SIGNATURE_OPTION



TARP



THIRD_PARTY_CONSIGNEE



TRANSMART_SERVICE_FEE

/Surcharges/Level

Identifies whether the surcharge is assessed at the PACKAGE or
SHIPMENT level.

/Surcharges/Description

The data describing the surcharge.

/Surcharges/Amount

Required
The amount of the surcharge applied to the shipment.

/PackageRating/PackageRateDetail/ All taxes applicable (or distributed to) this package.
Taxes
/PackageRating/
PackageRateDetail/
VariableHandlingCharges

The variable handling charges calculated based on the type variable
handling charges requested.

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails

Each element of this field provides shipment-level rate totals for a
specific rate type.

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails /
totalAncillaryFeesAndTaxes

Identifies the total amount of the shipment-level fees and taxes
that are not based on transportation charges or commodity-level
estimated duties and taxes.

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails /
totalDutiesTaxesAndFees

The total of the totalDutiesAndTaxes plus the
totalAncillaryFeesAndTaxes.

FedEx Web Services, Developer Guide 2016

518

Ship Service
Element

Description

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails /
ancillaryFeesAndTaxes

Identifies the shipment-level fees and taxes that are not based on
transportation charges or commodity-level estimated duties and
taxes.

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails /
AncillaryFeeAndTax/type



CLEARANCE_ENTRY_FEE



GOODS_AND_SERVICES_TAX



HARMONIZED_SALES_TAX

Note: CLEARANCE_ENTRY_FEE is removed from Surcharge Type, and is
available under AncillaryFeeandTax array

CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails /
AncillaryFeeAndTax/ description
CompletedShipmentDetail /
ShipmentRating /
ShipmentRateDetails / amount
/CompletedPackageDetails/
OperationalDetail

Specify package level operational information.

/CompletedPackageDetails/Label

The label image or printer commands to print the label.

/CompletedPackageDetails/
PackageDocuments

All package-level shipping documents (other than labels and
barcodes). For use in loads after January 2008.

/CompletedPackageDetails/
CodReturnDetail

Specify the information associated with this package that has COD
special service in a ground shipment.

/CompletedPackageDetails/
SignatureOption

Actual signature option applied, to allow for cases in which the
original value conflicted with other service features in the
shipment.

/CompletedPackageDetails/
DryIceWeight

Descriptive data required for a FedEx shipment containing dry ice.
Descriptive data includes Weight and Units in KGs. This element is
required when SpecialServiceType DRY_ICE is present in the
SpecialServiceTypes collection at the package level.

/CompletedPackageDetails/
HazardousPackageDetail

Documents the kinds and quantities of all hazardous commodities
in the current package, using updated hazardous commodity
description data.

/CompletedPackageDetail/Complet The total mass of the contained explosive substances, without the
edHazardousPackageDetail/Validat mass of any casings, bullets, shells, etc.
edHazardousContainer/ValidatedHa
zardousCommodityContent/NetExp
losiveDetail
RequestedPackageLineItem/

Valid values:

FedEx Web Services, Developer Guide 2016

519

Ship Service
Element
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Description


NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

ErrorLabels

Empty unless one or more errors occur during transaction
processing.

CompletedShipmentDetail/
PendingShipmentAccessDetail/
AccessorDetails

Required
Provides the ability to return multiple sets of Email label access
credentials:


Role



SHIPMENT_COMPLETOR



SHIPMENT_INITIATOR



userId



password



emailLabelUrl

24.5 Validate Shipment
Validate Shipment is part of the Shipping service that allows customers to validate the accuracy of a
shipment request prior to actually submitting the shipment transaction.
This feature allows businesses that receive shipping orders from end-user customers to validate the
shipment information prior to submitting a create shipment transaction to FedEx and printing a label. If
for any reason the information needs to be edited or changed, it can be done while the end-user is still
available to confirm the changes.

24.5.1 Validate Shipment Request Elements
In addition to the basic request elements required for all operations, the following elements are required
for when coding a ValidateShipmentRequest:
Table 197. Validate Shipment Request Elements
Element

Description

RequestedShipment

Required
Describe ship information you wish to validate. For
information on RequestedShipment elements, see Ship
Service Coding Basics.

RequestedShipment/
SpecialServicesRequested/
ShipmentDryIceDetail

FedEx Web Services, Developer Guide 2016

520

Ship Service

Element

Description

RequestedShipment/
RequestedPackageLineItems/
SpecialServicesRequested/
DangerousGoodsDetail/
UploadedTrackingNumber

UploadedTrackingNumber element is used to identify an
instance of an uploaded dangerous goods handling unit. This
element is required only if you have already validated DG
data using the FedEx provided Dangerous Goods /
Hazardous Materials information upload option.

RequestedShipment/
ShippingDocumentSpecification/
FreightAddressLabelDetail/
DocTabContent/DocTabContentType

Valid values are:


BARCODED



CUSTOM



MINIMUM



STANDARD



ZONE001

RequestedShipment/
ShippingDocumentSpecification
/CustomDocumentDetail
CustomDocumentDetail/Format

Data required to produce a custom-specified document,
either at shipment or package level.

CustomDocumentDetail/
LabelPrintingOrientation

Applicable only to documents produced on thermal printers
with roll stock.

CustomDocumentDetail/
LabelRotation

Applicable only to documents produced on thermal printers
with roll stock.

CustomDocumentDetail/
SpecificationId

Identifies the formatting specification used to construct this
custom document.

CustomDocumentDetail/
CustomDocumentIdentifier

Identifies the individual document specified by the client.

CustomDocumentDetail/
DocTabContent

If provided, thermal documents will include specified doc tab
content. If omitted, document will be produced without doc
tab content.

CustomDocumentDetail/
CustomLabelDetail

This allows the customer to define how custom information
is to be positioned and formatted on a custom label or the
customizable portion of a shipping label, and what the
custom information should be.

CustomLabelDetail/CoordinateUnits

Valid values are:

Common information controlling document production.



MILS (thousanths of an inch)



PIXELS (device-dependent)

CustomLabelDetail/TextEntries

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

CustomLabelDetail/GraphicEntries

Image to be included from printer's memory, or from a local
file for offline clients.

FedEx Web Services, Developer Guide 2016

521

Ship Service

Element

Description

CustomLabelDetail/BoxEntries

Solid (filled) rectangular area on label.

CustomLabelDetail/
CustomLabelTextBoxEntry

Constructed string, based on format and zero or more data
fields, printed in specified printer font (for thermal labels) or
generic font/size (for plain paper labels).

CustomLabelTextBoxEntry/
TopLeftCorner

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry/
BottomRightCorner

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry/Position

Horizontal and vertical position, relative to left edge of
custom area.

CustomLabelTextBoxEntry/Format

Format

CustomLabelTextBoxEntry/DataFields

Data fields

CustomLabelTextBoxEntry/
ThermalFontId

Printer-specific font name for use with thermal printer labels.

CustomLabelTextBoxEntry/FontName

Generic font name for use with plain paper labels.

CustomLabelTextBoxEntry/FontSize

Generic font size for use with plain paper labels.

CustomLabelTextBoxEntry/Rotation

Describes the rotation of an item from its default orientation.
Valid values are:


NONE



RIGHT



UPSIDE_DOWN

CustomLabelDetail/BarcodeEntries

Constructed string, based on format and zero or more data
fields, printed in specified barcode symbology.

RequestedShipment/
LabelSpecification/
CustomerSpecifiedLabelDetail/
LabelMaskableDataType

Names of data elements/areas which may be suppressed
from printing on labels.

FedEx Web Services, Developer Guide 2016



CUSTOMS_VALUE



DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER



SECONDARY_BARCODE



SHIPPER_ACCOUNT_NUMBER



TERMS_AND_CONDITIONS



TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_N
UMBER

522

Ship Service

Element

Description

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested

Through this option, an existing SmartPost small shipper or
return shipper can specify to have the Ground tracking
number provided in the shipment reply. This is a contingency
feature in case the customer requires the Ground tracking
number for internal processes or for tracking SmartPost
shipments.
The Ground tracking number will only be provided for
existing SmartPost small shippers or return shippers.
Customers will have the same reporting and tracking
capabilities as today when they receive a Ground tracking
number. However, the Ground tracking number will not be
printed on the FXSP shipping label.
fedex.com provides the same tracking visibility for
SmartPost shipments when using either the SmartPost
tracking number or the Ground tracking number.
Fedex recommends using fedex.com, rather than
USPS.com, for all tracking activities for SmartPost
shipments.

RequestedShipment/
SmartPostShipmentDetail/
SmartPostShipmentProcessing
OptionsRequested/
SmartPostShipmentProcessing
OptionType
RequestedShipment/
RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer/
HazardousCommodityContent/
NetExplosiveDetail

Valid values:

RequestedPackageLineItem/
PackageSpecialServicesRequested/
DangerousGoodsDetail/
DangerousGoodsContainer
/HazardousCommodityContent/
NetExplosiveDetail/
NetExplosiveClassificationType

Valid values:



GROUND_TRACKING_NUMBER_REQUESTED

The total mass of the contained explosive substances,
without the mass of any casings, bullets, shells, etc.



NET_EXPLOSIVE_CONTENT



NET_EXPLOSIVE_MASS



NET_EXPLOSIVE_QUANTITY



NET_EXPLOSIVE_WEIGHT

24.5.2 ValidateShipmentReply Data
Successful reply data are returned in a ValidateShipmentReply.

FedEx Web Services, Developer Guide 2016

523

Ship Service

24.6 FedEx One Rate
FedEx One Rate is the Legal and Brand approved name for the new one rate shipping portfolio based on
Six Express Service options, combined with sev