Web Services Developer Guide Global - FedEx

FedEx Web Services 2019

Developer Guide

Table of Contents

Table of Contents

1 Introduction ...................................................................................................................................... 16 1.1 Document Overview ................................................................................................................... 17 1.2 Printing All or Part of This Guide ................................................................................................ 18 1.3 Web Services, WSDL, and SOAP Overview .............................................................................. 18 1.4 Implementing FedEx Web Services ........................................................................................... 23 1.5 Understanding the XML Schema................................................................................................ 23 1.6 Implementation Process ............................................................................................................. 29 1.7 Samples ...................................................................................................................................... 32

2 Address Validation Service ............................................................................................................ 33 2.1 The Address Validation Operation.............................................................................................. 33 2.2 Address Validation Service Details............................................................................................. 34 2.3 How FedEx Address Validation Works....................................................................................... 34 2.4 Tips for Using the Address Validation Tool ................................................................................ 35 2.5 Address Results.......................................................................................................................... 35 2.6 Address Classification ................................................................................................................ 35 2.7 Address Matching Results .......................................................................................................... 36 2.8 Address Validation Coding Details ............................................................................................. 37

3 Close Service Shipment.................................................................................................................. 46 3.1 Close Service Operations ........................................................................................................... 46 3.2 Close Service Coding Details ..................................................................................................... 47 3.3 FedEx Ground Reports............................................................................................................... 50 3.4 FedEx SmartPost Close Shipment Service Details .................................................................... 51

4 Consolidation Services ................................................................................................................... 54 4.1 Single Shipment Through Customs............................................................................................ 55 4.2 Single Point of Clearance ........................................................................................................... 56 4.3 Multiple-Piece Freight Shipments............................................................................................... 56 4.4 Transaction Rules....................................................................................................................... 56 4.5 Non FedEx Trade Networks Customs Broker ............................................................................ 58 4.6 Shipping Service Options ........................................................................................................... 59 4.7 Creating Consolidation Shipments ............................................................................................. 62 4.8 Requesting Consolidation Services............................................................................................ 91 4.9 Consolidation Services Labels ................................................................................................... 91 4.10 Ground Commercial Invoice ..................................................................................................... 91 4.11 Consolidated Commercial Invoice ............................................................................................ 92 4.12 International DirectDistribution (IDD) Service........................................................................... 94 4.13 Useful Tips Consolidation Services Transactions .................................................................... 95

5 Country Service ............................................................................................................................... 96 5.1 Country Service Coding Details.................................................................................................. 96

6 Create a Label .................................................................................................................................. 98 6.1 Thermal Labels ........................................................................................................................... 98

FedEx Web Services, Developer Guide 2019

2

Table of Contents

6.2 Doc-Tab Configuration ............................................................................................................. 103 6.3 Laser Labels ............................................................................................................................. 107 6.4 Custom Labels.......................................................................................................................... 112 6.5 Portable Network Graphic (PNG) Label ................................................................................... 120 6.6 Label Review Checklist ............................................................................................................ 124 7 Dangerous Goods and HazMat .................................................................................................... 126 7.1 Dangerous Goods (FedEx Express)......................................................................................... 126 7.2 Hazardous Materials (FedEx Ground U.S.).............................................................................. 135 7.3 Dry Ice Shipments .................................................................................................................... 141 8 FedEx Dangerous Goods Data Service ....................................................................................... 142 8.1 Dangerous Goods Data Service Coding Basics....................................................................... 142 8.2 DGDS Sample Codes............................................................................................................... 156 8.3 DG Shipping using DG Data Upload Mode .............................................................................. 174 9 Electronic Trade Documents ........................................................................................................ 176 9.1 FedEx ETD Service Details ...................................................................................................... 176 9.2 UploadDocumentsRequest Elements....................................................................................... 177 9.3 UploadDocumentsReply Elements........................................................................................... 178 9.4 Upload Images.......................................................................................................................... 180 9.5 Ship Request Elements ............................................................................................................ 181 9.6 Ship Reply Elements ................................................................................................................ 182 10 FedEx Express U.S. Shipping .................................................................................................... 184 10.1 FedEx Express U.S. Service Details ...................................................................................... 184 10.2 FedEx Express U.S. Coding Details....................................................................................... 187 10.3 FedEx Express U.S. Multiple-Package Shipments ................................................................ 190 10.4 Group Multiple Piece Shipments ............................................................................................ 192 11 FedEx Express Freight Services: U.S ....................................................................................... 193 11.1 Express Freight Service Business Rules ............................................................................... 193 11.2 FedEx Express Freight Services Coding Details.................................................................... 195 12 FedEx Freight Services ............................................................................................................... 196 12.1 FedEx Freight Service Features............................................................................................. 196 12.2 FedEx Freight Service Details ................................................................................................ 197 12.3 FedEx Freight Priority ............................................................................................................. 198 12.4 FedEx Freight Economy ......................................................................................................... 198 12.5 FedEx Freight Box .................................................................................................................. 199 12.6 Custom Delivery Date Options ............................................................................................... 199 12.7 Inside Pickup Service Option.................................................................................................. 199 12.8 Freight Special Services ......................................................................................................... 199 12.9 FedEx Freight Rates and Surcharges .................................................................................... 200 12.10 FedEx Freight Coding Details............................................................................................... 201 13 FedEx Ground U.S. Shipping ..................................................................................................... 210 13.1 FedEx Ground U.S. Service Details ....................................................................................... 210 13.2 FedEx Ground U.S. Coding Details........................................................................................ 211

FedEx Web Services, Developer Guide 2019

3

Table of Contents

13.3 FedEx Home Delivery Convenient Delivery ........................................................................... 216 13.4 FedEx Home Delivery Service Details.................................................................................... 217 14 FedEx Intra-Country Shipping.................................................................................................... 219 14.1 Services and Service Areas ................................................................................................... 219 14.2 Intra-Country Services Overview............................................................................................ 220 14.3 Special Service Options ......................................................................................................... 222 14.4 Rules for Colombia ................................................................................................................. 227 14.5 Rules for India......................................................................................................................... 227 14.6 Rules for Mexico ..................................................................................................................... 234 14.7 Rules for The United Kingdom ............................................................................................... 235 15 FedEx SmartPost Shipping ........................................................................................................ 238 15.1 FedEx SmartPost Service Details .......................................................................................... 238 15.2 FedEx SmartPost Returns Service Details............................................................................. 253 16 In-Flight Shipment Service ......................................................................................................... 260 16.1 In-Flight Shipment Service Details ......................................................................................... 260 16.2 In-Flight Shipment Service Coding Details ............................................................................. 260 17 International Shipping................................................................................................................. 266 17.1 FedEx Express International Shipping ................................................................................... 266 17.2 FedEx Express Freight Services: International ...................................................................... 287 17.3 FedEx International Ground Shipping .................................................................................... 288 17.4 FedEx International Broker ..................................................................................................... 300 17.5 B13A for Canada Export Shipping.......................................................................................... 302 17.6 Electronic Export Information ................................................................................................. 303 17.7 Commercial Destination Control............................................................................................. 305 18 Locations Service ........................................................................................................................ 307 18.1 Locations Service Details ....................................................................................................... 307 18.2 Location Request Coding Details ........................................................................................... 308 18.3 UK/GB Locations Support ...................................................................................................... 318 19 Open Shipping ............................................................................................................................. 320 19.1 FedEx Services with Open Ship ............................................................................................. 320 19.2 Open Ship Process and Workflow.......................................................................................... 320 19.3 About OpenShip Transactions................................................................................................ 321 19.4 Create Open Shipment ........................................................................................................... 322 19.5 Route and Time-in-Transit Transaction .................................................................................. 356 19.6 Add Piece Transaction ........................................................................................................... 356 19.7 Returned Add Piece Fields ..................................................................................................... 358 19.8 Modify Piece Transaction ....................................................................................................... 366 19.9 Delete Piece Transaction ....................................................................................................... 380 19.10 Delete Shipment Transaction ............................................................................................... 380 19.11 Confirm Shipment Transactions ........................................................................................... 381 19.12 Open Ship Print Options ....................................................................................................... 404 19.13 Email Labels ......................................................................................................................... 404

FedEx Web Services, Developer Guide 2019

4

Table of Contents

19.14 Open Shipping Useful Tips ................................................................................................... 413 20 Pickup Service ............................................................................................................................. 414

20.1 Pickup Service Details ............................................................................................................ 414 20.2 LTL Freight Pickup Special Services...................................................................................... 415 20.3 Pickup Service Request Elements ......................................................................................... 416 20.4 Pickup Service Reply Elements.............................................................................................. 420 20.5 Pickup Service Country/Territory Codes ................................................................................ 420 20.6 Cancel Pickup Service Details................................................................................................ 421 20.7 Express Tag Availability ......................................................................................................... 431 21 Rate Services ............................................................................................................................... 433 21.1 RateRequest........................................................................................................................... 433 21.2 Rate Available Services/Rate Shopping................................................................................. 433 21.3 Surcharges and Discounts ..................................................................................................... 451 21.4 FedEx One Rate ..................................................................................................................... 455 21.5 Variable Handling Charges..................................................................................................... 457 22 Returns Shipping......................................................................................................................... 459 22.1 Global Returns........................................................................................................................ 460 22.2 FedEx Return Tags ................................................................................................................ 461 22.3 FedEx Print Return Label ....................................................................................................... 471 22.4 FedEx Express/Ground Return Label Coding Details ............................................................ 471 22.5 Alternate Return Address ....................................................................................................... 472 23 Ship Service ................................................................................................................................. 474 23.1 Shipping Services by Region.................................................................................................. 474 23.2 Ship Service Coding Basics ................................................................................................... 475 Delete Shipment ............................................................................................................................. 484 23.3 ProcessShipmentReply .......................................................................................................... 486 23.4 Validate Shipment................................................................................................................... 498 23.5 FedEx One Rate ..................................................................................................................... 505 23.6 Shipment Notification.............................................................................................................. 507 23.7 Future Day Shipping ............................................................................................................... 509 23.8 Masked Data........................................................................................................................... 510 24 Special Services .......................................................................................................................... 511 24.1 Alcohol Shipping ..................................................................................................................... 511 24.2 Delivery Signature Options ..................................................................................................... 516 24.3 FedEx Priority Alert Options ................................................................................................... 517 24.4 Saturday Service .................................................................................................................... 519 24.5 FedEx Express Collect on Delivery (C.O.D.).......................................................................... 520 24.6 FedEx Ground U.S. Collect On Delivery (C.O.D.).................................................................. 525 24.7 Ground E.C.O.D. .................................................................................................................... 532 24.8 Hold at Location...................................................................................................................... 532 24.9 Shipping Document Service ................................................................................................... 535 25 Tracking and Visibility Services................................................................................................. 550

FedEx Web Services, Developer Guide 2019

5

Table of Contents

25.1 Tracking Shipments ................................................................................................................ 550 25.2 Signature Proof of Delivery (SPOD) ....................................................................................... 566 25.3 Notification .............................................................................................................................. 574 25.4 FedEx InSight ......................................................................................................................... 580 26 Validation Availability And Commitment Service .................................................................... 581 26.1 Service Availability.................................................................................................................. 581 Appendix ........................................................................................................................................... 590 Appendix A: Country/Territory Code Tables................................................................................... 590 Appendix B: States and Provinces ................................................................................................. 598 Appendix C: Currency Codes ......................................................................................................... 602 Appendix D: SmartPost Hub IDs .................................................................................................... 603 Appendix E: Web Services and Service IDs .................................................................................. 603 Appendix F: Test Server Mock Tracking Numbers......................................................................... 604 Appendix G: Harmonized System Code......................................................................................... 604 Appendix H: Vague Commodity Descriptions ................................................................................ 609 Appendix I: Waybill Legal Terms and Conditions ........................................................................... 627 Appendix J: Postal-Aware Countries/Territories and Formats ....................................................... 627 Appendix K: Physical Packaging Type Codes ............................................................................... 628 Appendix L: Customs-Approved Document Descriptions .............................................................. 628 Appendix M: Time Zones................................................................................................................ 629 Appendix N: Minimum Customs Value Countries/Territories ......................................................... 630 Appendix O: Error Code Messages ................................................................................................ 631 Appendix P: Countries/Territories Accepting Electronic Trade Documents ................................... 815 Appendix Q: Track Service Scan Codes ........................................................................................ 818 Appendix R: Maximum Field Lengths ............................................................................................. 870 Appendix S: Label Types and Samples.......................................................................................... 871 Appendix T: FedEx Express Special Handling Codes ................................................................... 908 Appendix U: Sample Shipping Documents..................................................................................... 908 Appendix V: Track Special Handling Types ................................................................................... 919 Appendix W: Customer Reference Elements ................................................................................. 921 Appendix X: Service Types ............................................................................................................ 925 Appendix Y: IPD/IED/IDF Supported Countries/Territories ............................................................ 927 Glossary ............................................................................................................................................ 929

FedEx Web Services, Developer Guide 2019

6

List of Tables

List of Tables

Table 1. WSDL Elements .................................................................................................................................. 19 Table 2. XML Schema Diagrams....................................................................................................................... 24 Table 3. Common Required Request Elements ................................................................................................ 26 Table 4. Transaction Status............................................................................................................................... 27 Table 5. TransactionDetail Elements................................................................................................................. 27 Table 6. VersionId Elements ............................................................................................................................. 28 Table 7. Sender Information .............................................................................................................................. 28 Table 8. Requirements and Resources for Corporate Developers ................................................................... 31 Table 9. Requirements and Resources for Commercial Developers ................................................................ 31 Table 10. Countries/Territories that support Address Validation....................................................................... 33 Table 11. Address Matching Results................................................................................................................. 36 Table 12. AddressValidationRequest Elements ................................................................................................ 37 Table 13. AddressValidationReply Elements .................................................................................................... 38 Table 14: List of Address Attributes................................................................................................................... 41 Table 15. CloseService Operations................................................................................................................... 46 Table 16. GroundCloseRequest Elements ........................................................................................................ 47 Table 17. GroundCloseWithDocumentsRequest Elements .............................................................................. 48 Table 18. GroundCloseServiceWithDocumentReply Elements ........................................................................ 49 Table 19. PrintingGroundReports Elements...................................................................................................... 50 Table 20. FedEx SmartPost Close Service Elements ....................................................................................... 52 Table 21. FedEx Consolidation Services At-A-Glance...................................................................................... 54 Table 22. FedEx International DirectDistribution Services - Express and Ground Services............................. 55 Table 23. Broker Elements ................................................................................................................................ 58 Table 24. FedEx Express and FedEx Ground Services Allowed by Package Type ......................................... 59 Table 25. FedEx Express Special Services Allowed by Service Type - I.......................................................... 60 Table 26. FedEx Express Special Services Allowed by Service Type - II......................................................... 60 Table 27. FedEx Ground Special Services Allowed by Service Type ............................................................... 61 Table 28. Consolidation Shipment Creation ...................................................................................................... 62 Table 29. DeleteOpenConsolidationRequest .................................................................................................... 63 Table 30. ConfirmConsolidationRequest........................................................................................................... 64 Table 31. ConfirmConsolidationReply ............................................................................................................... 71 Table 32. GetConfirmConsolidationResultsRequest ......................................................................................... 77 Table 33. GetConfirmConsolidationResultsReply ............................................................................................. 78 Table 34. ValidatePostalRequest Elements ...................................................................................................... 96 Table 35. ValidatePostalReply Elements .......................................................................................................... 96 Table 36. ThermalLabel Elements..................................................................................................................... 99 Table 37. Number of Thermal Labels Printed Per U.S. Service...................................................................... 101 Table 38. Number of Thermal Labels Printed Per U.S. Export Intn'l Service.................................................. 101 Table 39. Number of Thermal Labels Printed Per Intra-Canada Service........................................................ 102 Table 40. Number of Thermal Labels Printed Per Canada Export International Service................................ 102 Table 41. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments ................... 102 Table 42. Doc-Tab Configuration Elements .................................................................................................... 103 Table 43. Doc-Tab Prefix (Non-Rate Data) ..................................................................................................... 104 Table 44. Doc-Tab Prefix (Rate Data) ............................................................................................................. 104 Table 45. WebServices Elements ................................................................................................................... 108 Table 46. Number of Thermal Labels Printed Per U.S. Service...................................................................... 110 Table 47. Number of Thermal Labels Printed Per U.S. Export International Service ..................................... 110 Table 48. Number of Thermal Labels Printed Per Intra-Mexico Service ......................................................... 111 Table 49. Number of Thermal Labels Printed Per Intra-Canada Service........................................................ 111 Table 50. Number of Thermal Labels Printed Per Canada Export Int'l Service .............................................. 111 Table 51. Number of Thermal Labels Printed Per Philippines and Thailand inbound shipments ................... 111 Table 52. Custom Label Elements for Text ..................................................................................................... 113 Table 53. Custom Label Elements for Graphics.............................................................................................. 118 Table 54. Net Explosive Mass Error Information ............................................................................................. 128 Table 55. Dangerous Goods Coding Details Elements................................................................................... 130 Table 56. Hazardous Materials Reply Elements ............................................................................................. 140 Table 57. List Dangerous Goods Request Elements ...................................................................................... 142

FedEx Web Services, Developer Guide 2019

7

List of Tables

Table 58. ListDangerousGoodsReply Elements ............................................................................................. 143 Table 59. ValidateDangerousGoodsRequest Elements.................................................................................. 144 Table 60. ValidateDangerousGoodsReply Elements ...................................................................................... 147 Table 61. Upload Dangerous Goods Request Elements ................................................................................ 149 Table 62. Upload Dangerous Goods Reply Elements..................................................................................... 149 Table 63. AddDangerousGoodsHandlingUnitRequest Elements.................................................................... 150 Table 64. AddDangerousGoodsHandlingUnitReply Elements ........................................................................ 150 Table 65. ModifyDangerousGoodsShipmentRequest Elements ..................................................................... 151 Table 66. ModifyDangerousGoodsShipmentReply Elements ......................................................................... 151 Table 67. Modify Dangerous Goods Handling Unit Request Elements .......................................................... 152 Table 68. ModifyDangerousGoodsHandlingUnitReply Elements.................................................................... 152 Table 69. RetrieveDangerousGoodsRequest Elements ................................................................................. 153 Table 70. RetrieveDangerousGoodsReply Elements...................................................................................... 153 Table 71. DeleteDangerousGoodsRequest Elements .................................................................................... 154 Table 72. DeleteDangerousGoodsReply Elements......................................................................................... 154 Table 73. DeleteDangerousGoodsHandlingUnitRequest Elements................................................................ 155 Table 74. DeleteDangerousGoodsHandlingUnitReply Elements .................................................................... 155 Table 75. Electronic Trade Documents Request Elements............................................................................. 177 Table 76. Electronic Trade Documents Reply Elements................................................................................. 178 Table 77. Upload Image Request Elements.................................................................................................... 180 Table 78. Upload Image Reply Elements ........................................................................................................ 180 Table 79. Electronic Trade Documents Request Elements............................................................................. 181 Table 80. Electronic Trade Documents Reply Elements................................................................................. 182 Table 81. Recipient Information Elements....................................................................................................... 187 Table 82. Shipment/Package Information Elements ....................................................................................... 188 Table 83. Label Requirements Elements ........................................................................................................ 189 Table 84. Multiple Piece Shipment Request Elements ................................................................................... 190 Table 85. Multiple Piece Shipment Reply Elements........................................................................................ 191 Table 86. U.S. Express Freight Detail Elements ............................................................................................. 195 Table 87. FreightRequest Elements ................................................................................................................ 201 Table 88. Optional Pickup Request Elements ................................................................................................. 206 Table 89. Freight Reply Elements ................................................................................................................... 206 Table 90. Recipient Information Elements....................................................................................................... 211 Table 91. Billing Elements ............................................................................................................................... 212 Table 92. Multiple-Package Shipment Elements............................................................................................. 213 Table 93. Package and Shipment Details Elements ....................................................................................... 214 Table 94. LabelSpecification Element ............................................................................................................. 215 Table 95. Package vs. Shipment Level Shipping Options............................................................................... 216 Table 96. Home Delivery Convenient Delivery Options Elements .................................................................. 216 Table 97. Canadian Services .......................................................................................................................... 219 Table 98. Europe, the Middle East and Africa Services and Service Areas ................................................... 219 Table 99. Latin America and the Caribbean Services and Service Areas ...................................................... 220 Table 100. Latin America and the Caribbean Special Service Options .......................................................... 222 Table 101. Europe, the Middle East and Africa Special Service Options ....................................................... 223 Table 102. India Special Service Options ....................................................................................................... 225 Table 103. Freight to Collect with Intra-Country Shipping............................................................................... 226 Table 104. Colombia Package Limitations ...................................................................................................... 227 Table 105. Intra-Country Shipping Weights and Dimension Limits ................................................................. 229 Table 106. ProcessShipmentRequest ............................................................................................................. 229 Table 107. Intra-India Shipping Surcharge Reply Element ............................................................................. 234 Table 108. Mexico Package Limitations .......................................................................................................... 234 Table 109. Intra-Mexico Request Elements .................................................................................................... 234 Table 110. Intra-UK Request Elements........................................................................................................... 236 Table 111. Intra-UK Reply Elements ............................................................................................................... 236 Table 112. FedEx SmartPost Request Elements ............................................................................................ 239 Table 113. FedEx SmartPost Reply Elements ................................................................................................ 249 Table 114. FedEx SmartPost APO/FPO/DPO Elements ................................................................................ 250 Table 115. FedEx SmartPost Returns Request Elements .............................................................................. 255 Table 116. FedEx SmartPost Email Return Label Request Elements ............................................................ 256

FedEx Web Services, Developer Guide 2019

8

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download