Tmp_Wf6MDz Prop Dev Guide

PropDevGuide

PropDevGuide

User Manual:

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

DownloadTmp_Wf6MDz Prop Dev Guide
Open PDF In BrowserView PDF
2013

Developer Guide

Legal and Copyright Notices
Payment

Confidential and Proprietary

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.

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.

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

© 2012 - 2013 FedEx. FedEx and the FedEx logo are registered service marks.
All rights reserved. Unpublished.

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

FedEx Web Services, Developer Guide

2

Contents
About This Guide .......................................................................... 15
Document Organization ................................................................................. 16
Resources ...................................................................................................... 16
Support .......................................................................................................... 16

1 Introduction ............................................................................... 17
Document Overview ...................................................................................... 18
Printing All or Part of This Guide ................................................................. 20
Web Services, WSDL, and SOAP Overview ................................................ 20
Implementing FedEx Web Services .............................................................. 25
Understanding the XML Schema ................................................................. 26
Implementation Process ................................................................................ 30

2 Rate Services ............................................................................ 33
Rate ............................................................................................................... 34
Rate Available Services/Rate Shopping ...................................................... 34
Surcharges and Discounts ............................................................................ 43
Samples ......................................................................................................... 46
Error Messages ............................................................................................. 47

3 Package Movement Information Service ............................ 48
Service Availability ....................................................................................... 49
Postal Code Inquiry ....................................................................................... 50
Samples ......................................................................................................... 51
Error Messages ............................................................................................. 51

4 Tracking and Visibility Services ............................................ 52
Tracking Shipments ....................................................................................... 53

Signature Proof of Delivery (SPOD) ............................................................. 65
Notification .................................................................................................... 69
FedEx InSight ................................................................................................. 73
Samples ......................................................................................................... 73
Error Messages ............................................................................................. 74

5 Global Ship Address Service ................................................. 75
Global Ship Address ..................................................................................... 76

6 Pickup Service .......................................................................... 81
Pickup ............................................................................................................ 82
Cancel Pickup Service ................................................................................... 86
Pickup Availability ......................................................................................... 88
Samples ......................................................................................................... 91
Error Messages ............................................................................................. 91

7 Close Shipment ......................................................................... 92
FedEx Ground Close Ship Day Service Details ........................................... 93
FedEx SmartPost Close Shipment Service Details ...................................... 95

8 Address Validation Service .................................................... 98
Address Validation Request ......................................................................... 99
Address Validation Service Details .............................................................. 99
How FedEx Address Validation Works ........................................................ 99
Tips on Getting Accurate Address Matches ............................................. 100
Address Results .......................................................................................... 100
Address Validation Coding Details ............................................................ 100
Notification .................................................................................................. 103
FedEx Web Services, Developer Guide

3

Contents
Mapping Enterprise Address Service Changes ......................................... 103
Mapping Enterprise Address Service Residential Status ......................... 104
Mapping Enterprise Address Service DeliveryPointValidation ................. 104
Mapping Enterprise Address Service Changes ......................................... 104
Known Service Issue .................................................................................. 105

11 Returns Shipping ................................................................... 146

9 Open Shipping ......................................................................... 109

12 Creating a Label .................................................................... 156

FedEx Services with Open Ship ................................................................. 110
Open Ship Process and Workflow ............................................................. 110
About Web Services Open Ship Transactions .......................................... 110
Create Open Shipment ............................................................................... 111
Route and Time-in-Transit Transaction ...................................................... 117
Rate Open Ship Shipment Transaction ...................................................... 118
Add Piece Transaction ................................................................................ 118
Modify Piece Transaction ........................................................................... 119
Delete Piece Transaction ............................................................................ 124
Delete Shipment Transaction ..................................................................... 124
Confirm Shipment Transactions ................................................................. 125
Open Ship Print Options ............................................................................. 130

Thermal Labels ............................................................................................ 157
Doc-Tab Configuration ................................................................................ 160
Laser Labels ................................................................................................ 166
Custom Labels ............................................................................................. 169
PNG Label .................................................................................................... 177
Label Review Checklist ............................................................................... 177

10 Ship Service ........................................................................... 131
Shipping Services by Region ...................................................................... 132
Ship Service Coding Basics ........................................................................ 132
Delete Shipment ......................................................................................... 136
Process Shipment Reply ............................................................................. 138
Validate Shipment ....................................................................................... 142
Email Labels ................................................................................................ 142

FedEx Return Tags ...................................................................................... 148
FedEx Express / FedEx Ground Printed Return Label ................................ 152
Alternate Return Address ........................................................................... 154
Samples ....................................................................................................... 155

13 FedEx Express U.S. Shipping .............................................. 180
FedEx Express U.S. Service Options .......................................................... 181
Express U.S. Service Details ...................................................................... 181
FedEx Express U.S. Coding Details ............................................................ 183
FedEx Express U.S. Multiple-Package Shipments .................................... 186
Group Multiple Piece Shipments ............................................................... 187

14 FedEx Express Freight Services: U.S. ............................... 189
FedEx Express Freight Services Details ..................................................... 190
FedEx Express Freight Services Coding Details ........................................ 191

15 Delivery Signature Services ................................................ 193
Delivery Signature Service Details ............................................................ 194
Delivery Signature Coding Rules ................................................................ 194
FedEx Web Services, Developer Guide

4

Contents
16 FedEx Priority Alert Options ................................................ 196

23 Hold at FedEx Location ........................................................ 226

FedEx Priority Alert Service Details ........................................................... 197

Hold at FedEx Location Service Details ..................................................... 227
Samples ....................................................................................................... 228

17 Saturday Service ................................................................... 199
Saturday Ship and Delivery Service Details .............................................. 200
Saturday Ship and Delivery Coding Details .............................................. 200

18 FedEx Express Collect on Delivery (C.O.D.) ..................... 201
Express C.O.D. Service Details ................................................................... 202
FedEx Express C.O.D. Coding Details ........................................................ 202
Single C.O.D. Shipments ............................................................................ 202
Multiple Piece Shipment C.O.D. Request Elements .................................. 204
Multiple Piece Shipment C.O.D. Reply Elements ...................................... 205

19 FedEx Ground U.S. Collect On Delivery (C.O.D.) ............. 207
FedEx Ground C.O.D. Coding Details ......................................................... 208
Ground E.C.O.D. ........................................................................................... 213

20 Dangerous Goods .................................................................. 214
Dangerous Goods Service Details .............................................................. 215
Dangerous Goods Coding Details .............................................................. 216

21 Hazardous Materials (FedEx Ground U.S.) ....................... 219
Hazardous Materials Service Details ......................................................... 220
Hazardous Materials Coding Details ......................................................... 220

22 Alcohol Shipping .................................................................... 224
Alcohol Shipping Coding Details ................................................................ 225

24 Dry Ice Shipments ................................................................. 229
Dry Ice Service Details ............................................................................... 230
Dry Ice Coding Details ................................................................................ 230

25 Shipment Notification in the Ship Request ...................... 232
Shipment Notification Coding Details ....................................................... 233

26 Variable Handling Charges .................................................. 235
Variable Handling Coding Details .............................................................. 236

27 Masked Data .......................................................................... 238
Masked Data Coding Details ..................................................................... 239
Samples ....................................................................................................... 239
Error Messages ........................................................................................... 239

28 Future Day Shipping ............................................................. 240
Future Day Service Details ......................................................................... 241
Future Day Coding Details .......................................................................... 241

29 FedEx Ground U.S. Shipping ............................................... 243
FedEx
FedEx
FedEx
FedEx

Ground U.S. Service Details ............................................................ 244
Ground U.S. Service Options ........................................................... 244
Ground U.S. Coding Details ............................................................. 244
Home Delivery Service Details ........................................................ 250

FedEx Web Services, Developer Guide

5

Contents
30 FedEx SmartPost Shipping .................................................. 251

FedEx Express International Coding Details .............................................. 298

FedEx SmartPost Service Details ............................................................... 252
FedEx SmartPost Returns Service Details ................................................. 256

34 FedEx Express International (Saturday) ............................ 313

31 FedEx Freight Services ......................................................... 267
FedEx Freight Service Features .................................................................. 268
FedEx Freight Service Details ..................................................................... 269
FedEx Freight Priority .................................................................................. 270
FedEx Freight Economy ............................................................................... 270
Custom Delivery Date Options ................................................................... 270
Inside Pickup Service Option ...................................................................... 270
FedEx Freight Rates and Surcharges ......................................................... 271
FedEx Freight Coding Details ..................................................................... 271

32 FedEx Intra-Country Shipping ............................................. 278
Services and Service Areas ...................................................................... 279
Intra-Country Services Overview ................................................................ 281
Special Service Options .............................................................................. 283
Colombia ...................................................................................................... 287
India ............................................................................................................. 287
Mexico ......................................................................................................... 290
United Kingdom ........................................................................................... 291

33 FedEx Express International Shipping ............................... 295
FedEx Express International Service Details ............................................. 296
FedEx Express International Service Options ............................................ 297
International Packaging Options ................................................................ 298

Saturday Service Details ............................................................................ 314
Saturday Coding Details ............................................................................. 314

35 FedEx Express Freight Services: International ................ 315
FedEx International Priority Freight ............................................................ 316
FedEx International Economy Freight ......................................................... 316
Additional Service Details .......................................................................... 316
FedEx Express Freight Services Coding Details: International ................. 316
Dangerous Goods (International Express) .................................................. 317
Alcohol Shipping (International Express) ................................................... 317
Future Day Shipping (International Express) ............................................. 317
Hold at FedEx Location (International Express) ......................................... 317
Dry Ice Shipments (International Express) ................................................. 317

36 FedEx International Ground Shipping ................................ 318
FedEx International Ground Service Options ............................................. 319
FedEx International Ground Service Details .............................................. 319
FedEx International Ground Coding Details ............................................... 320
Delivery Signature Services (FedEx International Ground) ....................... 327
Future Day Shipping (FedEx International Ground) ................................... 327
FedEx Ground Collect On Delivery (C.O.D.) (International) ....................... 327
Alternate Return Address (FedEx International Ground) ........................... 328
Mask Account Number (FedEx International Ground) ............................... 328

FedEx Web Services, Developer Guide

6

Contents
37 FedEx International Broker Select ..................................... 329

A Country Code Tables ............................................................. 360

FedEx International Broker Select Service Details .................................... 330
FedEx International Broker Select Coding Details .................................... 330

A .................................................................................................................. 362
B ................................................................................................................... 362
C ................................................................................................................... 362
D .................................................................................................................. 363
E ................................................................................................................... 363
F ................................................................................................................... 363
G .................................................................................................................. 364
H .................................................................................................................. 364
I .................................................................................................................... 364
J ................................................................................................................... 365
K ................................................................................................................... 365
L ................................................................................................................... 365
M ................................................................................................................. 365
N .................................................................................................................. 366
O .................................................................................................................. 366
P ................................................................................................................... 366
Q .................................................................................................................. 366
R ................................................................................................................... 367
S ................................................................................................................... 367
T ................................................................................................................... 368
U .................................................................................................................. 368
V ................................................................................................................... 368
W ................................................................................................................. 368
Y ................................................................................................................... 369
Z ................................................................................................................... 369

38 Electronic Export Information ............................................. 332
Where to File .............................................................................................. 333
When to File ............................................................................................... 333
U.S. to Canada ............................................................................................ 334
Information for the EEI ............................................................................... 334
Electronic Export Information Coding Details ............................................ 334

39 Commercial Destination Control ......................................... 336
Commercial Destination Control Service Details ...................................... 337
Commercial Destination Control Coding Details ....................................... 337

40 B13A for Canada Export Shipping ..................................... 338
B13A Service Details .................................................................................. 339
B13A Coding Details ................................................................................... 339

41 Shipping Document Service ................................................ 341
Shipping Document Service Details ........................................................... 342

42 Upload Images ....................................................................... 353
Upload Image Service Details .................................................................... 354

43 FedEx Electronic Trade Documents .................................. 355
FedEx ETD Details ....................................................................................... 356

FedEx Web Services, Developer Guide

7

Contents
B U.S. State Codes ..................................................................... 370
C Canada Province Codes ........................................................ 373
D Mexico State Codes .............................................................. 375
E United Arab Emirates (UAE) State Code Table ................ 377
F Currency Codes ...................................................................... 379
G Harmonized Tariff Unit of Measure Codes ....................... 382
H Vague Commodity Descriptions .......................................... 386
I Waybill Legal Terms and Conditions .................................. 402
J Postal-Aware Countries and Formats ................................ 404
K Physical Packaging Type Codes ......................................... 406
L Customs-Approved Document Descriptions ..................... 408
M Time Zones .............................................................................. 411
N Minimum Customs Value ...................................................... 413
O Error Code Messages ............................................................ 415
Chained SSL Certificate Error Messages .................................................. 416
Close Service Error Messages ................................................................... 417
Electronic Trade Documents Error Messages ........................................... 418
GlobalShipAddress Service Error Messages ............................................. 418

Package Movement Information Service Error Messages ........................ 421
Pickup Service Error Messages .................................................................. 432
Rate Service Error Messages ..................................................................... 470
Ship Service and Open Shipping Error Messages .................................... 487
FedEx SmartPost Shipping Error Messages .............................................. 526
SPOD Error Messages ................................................................................ 526
Track Service Error Messages .................................................................... 527

P Countries Accepting Electronic Trade Documents ......... 537
Q Track Service Scan Codes ................................................... 540
R Maximum Field Lengths ........................................................ 589
S FedEx Express Plain Paper Label Samples ...................... 591
Layout Requirements for Multiple-Piece Shipment Master Label ........... 593
Font Requirements for Multiple-Piece Shipment Master Label ............... 594
International Multiple Piece Shipment Child Label .................................. 595
C.O.D. Return Label (ASTRA Block) ........................................................... 596
Priority Saturday Delivery Label (ASTRA Block) ........................................ 596
FedEx 1Day Freight Saturday Delivery Label ............................................. 596
2Day Saturday Delivery .............................................................................. 597
2Day Delivery .............................................................................................. 597
Priority Alert Delivery ................................................................................. 598
FedEx Express Domestic Inaccessible Dangerous Goods with Dry
Ice and Adult Signature Required .............................................................. 599
Requirements for International Single Piece Label ................................... 600
FedEx International Priority Label with Broker Select Option .................. 601
FedEx Web Services, Developer Guide

8

Contents
International Single Piece Label with Electronic Trade Documents ........ 602

T FedEx Express Thermal Label Samples ............................. 603
U FedEx Ground Plain Paper Labels ...................................... 605
Label Layout Requirements ....................................................................... 606
United States Home Delivery 1D Barcode Label ...................................... 607
Return Label ................................................................................................ 608
HazMat Label .............................................................................................. 609
C.O.D. Return Label .................................................................................... 610
FedEx International Ground Label .............................................................. 611

V FedEx Ground Thermal Label Samples .............................. 612
Layout Requirements for FedEx Ground U.S. Label .................................. 613
Font Requirements for FedEx Ground U.S. Label ...................................... 614
Layout and Font Requirements for FedEx Home Delivery U.S. Label ...... 614
FedEx Ground U.S. C.O.D. Inbound Shipping Label .................................. 615
FedEx Ground U.S. C.O.D. Outbound Payment Label ................................ 616
FedEx Ground U.S. E.C.O.D. Second Label ................................................ 616
FedEx Ground U.S. C.O.D. with Guaranteed Funds Label ......................... 617
FedEx Ground U.S. C.O.D. with Guaranteed Funds Second Label ........... 618
FedEx Ground Hold at Location Return Thermal Label with 1D Barcode 618
FedEx Home Delivery U.S. 1D Barcode Label with ORM-D ..................... 619

FedEx Ground U.S. Third-Party with FedEx Return Manager Label ......... 619
FedEx International Ground Label with Third-Party Billing and
C.O.D. with Guaranteed Funds ................................................................... 620
FedEx Ground U.S. Label with Doc-Tab ..................................................... 620

W FedEx SmartPost Label Samples ........................................ 621
FedEx
FedEx
FedEx
FedEx

SmartPost Returns Label ................................................................. 622
Ground Thermal SmartPost Label (Large Shipper) ......................... 622
Integrated Label (Small Shipper) ..................................................... 622
Ground SmartPost Returns Label .................................................... 623

X Sample Shipping Documents ............................................... 624
Bill of Lading ............................................................................................... 626
Commercial Invoice ..................................................................................... 626
Certificate of Origin .................................................................................... 627
FedEx Ground Pickup Manifest .................................................................. 627
NAFTA COO ................................................................................................. 628
OP-900 ......................................................................................................... 628
OP-950 ......................................................................................................... 629
Pro Forma Invoice ....................................................................................... 629

Y Glossary .................................................................................... 630

FedEx Web Services, Developer Guide

9

Tables
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.

RateRequest Elements .................................................................... 35
RateReply Elements ........................................................................ 38
FedEx Freight RateRequest Shipment Elements ........................... 38
FedEx Freight Reply Shipment Elements ....................................... 41
Rate Reply Possible Surcharges for FedEx Service Options ......... 42
Surcharges and Discounts Rate Quote .......................................... 43
FedEx Discount Programs ............................................................... 46
Service Availability Request Elements .......................................... 49
Service Availability Reply Elements ............................................... 50
Postal Coding Inquiry Request Elements ....................................... 51
Postal Coding Inquiry Reply Elements ........................................... 51
TrackRequest Elements .................................................................. 55
TrackReply Elements ....................................................................... 57
TrackReply/CompletedTrackDetails/TrackDetails Elements .......... 57
Tracking Status Scan Codes ........................................................... 64
SPOD Letter Request Elements ...................................................... 65
SPOD Letter Reply Elements .......................................................... 66
SPOD Fax Request Elements .......................................................... 66
SPOD Fax Reply Elements .............................................................. 67
Valid Language Codes for Notification Service ............................ 69
Send Notifications Request Elements ........................................... 70
SendNotificationsReply Elements .................................................. 72
FedEx InSight Elements .................................................................. 73
SearchLocationsRequest Coding Elements .................................... 77
SearchLocationsReply Elements ..................................................... 79
Pickup Service Request Elements .................................................. 83

Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

27.
28.
29.
30.
31.
32.
33.
34.
35.
36.
37.
38.
39.
40.
41.
42.
43.
44.
45.
46.
47.
48.
49.
50.
51.
52.

Pickup Service Reply Elements ...................................................... 85
Pickup Service Country Codes ........................................................ 85
Cancel Pickup Service Request Elements ...................................... 86
Cancel a Pickup Request Elements ................................................ 87
Cancel a Pickup Reply Elements .................................................... 87
PickupAvailability Elements ............................................................ 88
Pickup Availability Request Elements ............................................ 89
Pickup Availability Reply Elements ................................................ 90
Ground Close Service Request Elements ...................................... 93
GroundCloseWithDocumentsRequest Elements ............................ 93
Ground Close Service with Document Reply Elements ................ 94
Printing Ground Reports Elements ................................................. 95
FedEx SmartPost Close Service Elements ..................................... 95
Address Validation Request Elements ......................................... 100
Address Validation Reply Elements ............................................. 102
Enterprise Address Service Indicator Changes Elements ........... 103
Enterprise Address Service Residential Status Elements ........... 104
Enterprise Address Service DeliveryPointValidation Elements ... 104
Enterprise Address Service Indicator Changes Elements ........... 104
Open Ship Creation ....................................................................... 110
CreateOpenShipmentRequest ....................................................... 112
CreateOpenShipmentReply ........................................................... 114
AddPackagesToOpenShipmentRequest ........................................ 118
AddPackagesToOpenShipmentReply ............................................ 119
ModifyPackageInOpenShipmentRequest ...................................... 119
ModifyPackageInOpenShipmentReply .......................................... 121

FedEx Web Services, Developer Guide

10

Tables
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

53.
54.
55.
56.
57.
58.
59.
60.
61.
62.
63.
64.
65.
66.
67.
68.
69.
70.
71.
72.
73.
74.
75.
76.
77.

DeletePackagesFromOpenShipmentRequest ................................ 124
DeleteOpenShipmentRequest ....................................................... 124
ConfirmOpenShipmentRequest ..................................................... 125
ConfirmOpenShipmentReply ......................................................... 126
RetrieveJobResultsRequest .......................................................... 127
RetrieveJobResultsReply .............................................................. 128
Shipping Services by Region ........................................................ 132
Requested Shipment Elements .................................................... 132
DeleteShipmentRequest Elements ............................................... 136
Delete Shipment Coding Details Elements ................................. 137
ProcessShipmentReply Elements ................................................. 138
Validate Shipment Request Elements .......................................... 142
Return (Inbound) Email Label Elements ....................................... 144
Non-Return (Outbound) Email Label Elements ............................ 145
CancelPendingShipmentRequest Element ................................... 145
Return Types ................................................................................. 147
ProcessTagRequest Elements ....................................................... 149
DeleteTagRequest Elements ........................................................ 151
ExpressTagAvailabilityRequest Element ...................................... 151
ExpressTagAvailabilityReply Elements ......................................... 152
Print Return Label Elements ......................................................... 154
Alternate Return Request Elements ............................................. 155
Thermal Label Elements ............................................................... 157
Number of Thermal Labels Printed Per U.S. Service .................. 159
Number of Thermal Labels Printed Per U.S. Export Intn'l
Service ........................................................................................... 159

Table
Table
Table
Table
Table
Table

78.
79.
80.
81.
82.
83.

Table 84.
Table 85.
Table 86.
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

87.
88.
89.
90.
91.
92.
93.
94.
95.
96.
97.
98.
99.
100.
101.

Doc-Tab Configuration Elements .................................................. 160
Doc-Tab Prefix (Non-Rate Data) ................................................... 161
Doc-Tab Prefix (Rate Data) ........................................................... 161
Web Services Elements ................................................................ 166
Number of Thermal Labels Printed Per U.S. Service .................. 168
Number of Thermal Labels Printed Per U.S. Export
International Service ..................................................................... 168
Number of Thermal Labels Printed Per Intra-Mexico Service .... 168
Number of Thermal Labels Printed Per Intra-Canada Service .... 168
Number of Thermal Labels Printed Per Canada Export Int'l
Service ........................................................................................... 168
Custom Label Elements for Text .................................................. 170
Custom Label Elements for Graphics ........................................... 173
Recipient Information Elements ................................................... 184
Shipment/Package Information Elements .................................... 184
Label Requirements Elements ...................................................... 185
CustomerReferences/CustomerReferenceType Elements ........... 186
Multiple Piece Shipment Request Elements ............................... 186
Multiple Piece Shipment Reply Elements ................................... 187
U.S. ExpressFreightDetail Elements ............................................. 192
Delivery Signature Services ......................................................... 194
Delivery Signature Elements ........................................................ 195
Priority Alert Basic Complex Elements ........................................ 198
Priority Alert Additional Reply Elements ..................................... 198
Saturday Ship and Delivery Request Elements ........................... 200
Single C.O.D. Shipment Elements ................................................ 202

FedEx Web Services, Developer Guide

11

Tables
Table 102. Multiple Piece Shipment C.O.D. Request Elements .................... 205
Table 103. Multiple Piece Shipment C.O.D. Reply Elements ........................ 205
Table 104. Multiple Piece Shipment C.O.D. Additional Shipping
Options Reply Elements ................................................................ 205
Table 105. Single and C.O.D. Multiple Piece Shipment Elements ............... 208
Table 106. Multiple-Piece Shipment C.O.D. Elements .................................. 212
Table 107. Multiple-Piece Shipment C.O.D. Reply Elements ........................ 212
Table 108. Additional Multiple-Piece Package/Shipment C.O.D. Options .... 213
Table 109. Dangerous Goods Coding Details Elements ................................ 216
Table 110. Hazardous Materials Elements .................................................... 220
Table 111. Hazardous Materials Reply Elements .......................................... 222
Table 112. Alcohol Shipping Elements ........................................................... 225
Table 113. Hold at FedEx Location Elements ................................................ 227
Table 114. Dry Ice ShipService WSDL Elements ........................................... 230
Table 115. Shipment Notification Elements .................................................. 233
Table 116. Variable Handling Elements ......................................................... 236
Table 117. Masked Data Coding Elements .................................................... 239
Table 118. Future Day Shipping Elements ..................................................... 241
Table 119. Recipient Information Elements ................................................... 245
Table 120. Billing Elements ............................................................................ 245
Table 121. Multiple-Package Shipment Elements ......................................... 246
Table 122. Package and Shipment Details Elements .................................... 247
Table 123. LabelSpecification Element .......................................................... 248
Table 124. Package vs. Shipment Level Shipping Options .......................... 248
Table 125. Home Delivery Convenient Delivery Options Elements .............. 249
Table 126. Customer Reference/CustomerReferenceType Elements ............ 249

Table
Table
Table
Table
Table

127.
128.
129.
130.
131.

Table 132.
Table
Table
Table
Table
Table
Table
Table
Table

133.
134.
135.
136.
137.
138.
139.
140.

Table
Table
Table
Table
Table
Table
Table
Table
Table

141.
142.
143.
144.
145.
146.
147.
148.
149.

FedEx SmartPost Request Elements ............................................ 253
FedEx SmartPost Reply Elements ................................................. 254
FedEx SmartPost APO/FPO/DPO Elements .................................. 255
FedEx SmartPost Returns Request Elements .............................. 258
CreatePendingShipment Basic Returns Email Label
Request Elements ......................................................................... 260
CreatePendingShipment Request Returns Email Label
Through FedEx Elements .............................................................. 261
FedEx SmartPost Email Return Label Request Elements ............ 262
FedEx SmartPost Reply Elements ................................................. 263
Cancel Email Label Elements ....................................................... 265
Freight Request Elements ............................................................. 271
Optional Pickup Request Elements .............................................. 275
Freight Reply Elements ................................................................. 275
Canadian Services ........................................................................ 279
Europe, the Middle East and Africa Services and Service
Areas ............................................................................................. 279
Latin America and the Caribbean Services and Service Areas . 281
Latin America and the Caribbean Special Service Options ........ 283
Europe, the Middle East and Africa Special Service Options .... 283
India Special Service Options ...................................................... 285
Freight to Collect with Intra-Country Shipping ............................ 287
Colombia Package Limitations ..................................................... 287
Intra-Country Shipping Weights and Dimension Limits .............. 289
CreatePendingShipmentRequest ................................................. 289
Intra-India Shipping Surcharge Reply Element ............................ 290

FedEx Web Services, Developer Guide

12

Tables
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

150.
151.
152.
153.
154.
155.
156.
157.
158.
159.
160.
161.
162.
163.
164.
165.
166.
167.
168.
169.
170.
171.
172.
173.
174.
175.

Mexico Package Limitations ......................................................... 291
Intra-Mexico Request Elements ................................................... 291
Intra-UK Request Elements .......................................................... 292
Intra-UK Reply Elements ............................................................... 294
Recipient Information Elements ................................................... 299
Billing Elements ............................................................................ 300
Multiple Piece Shipment Elements .............................................. 300
Shipment/Package Information Elements .................................... 301
Label Requirements Element ........................................................ 302
Document Shipment Options ........................................................ 303
Recipient Information Elements ................................................... 303
Billing Detail Elements ................................................................. 304
Multiple-Piece Shipment Elements .............................................. 305
Shipment/Package Information Elements .................................... 305
Label Requirements Element ........................................................ 307
Commodity Shipment Elements ................................................... 307
Commodity Elements .................................................................... 308
International Traffic in Arms Regulations Coding Elements ...... 311
Express International Elements .................................................... 311
CustomerReference/CustomerReferenceType Elements ............. 311
Saturday Service Request Elements ............................................ 314
International ExpressFreightDetail Elements ............................... 317
Recipient Information Elements ................................................... 321
Billing Elements ............................................................................ 321
Multiple Piece Shipment Elements .............................................. 322
Package and Shipment Details Elements .................................... 322

Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table
Table

176.
177.
178.
179.
180.
181.
182.
183.
184.
185.
186.
187.
188.
189.
190.
191.
192.
193.
194.
195.
196.
197.
198.
199.
200.
201.

International Ground Label Requirements ................................... 324
Broker Selection Elements ........................................................... 324
Commodity Information Elements ................................................ 324
FedEx International Ground U.S. to Canada NAFTA Elements ... 326
International Ground Reply Elements .......................................... 326
International/NAFTA Reply Information ....................................... 327
CustomerReference/CustomerReferenceType Elements ............. 327
International Broker Select Elements .......................................... 330
ITN or EEI Exemption Number Elements ..................................... 334
Commerce Destination Control Statement Elements .................. 337
B13A Elements .............................................................................. 339
Certificate of Origin Elements ...................................................... 342
Commerical Invoice Elements ...................................................... 343
NAFTA Certificate of Origin Elements ......................................... 345
OP-900 Elements ........................................................................... 348
Dangerous Goods Shippers Declaration Elements ...................... 349
Pro Forma Invoice Elements ......................................................... 350
Freight Address Label Elements ................................................... 351
UploadImage Request Elements .................................................. 354
UploadImage Reply Elements ....................................................... 354
Electronic Trade Documents Request Elements .......................... 356
Electronic Trade Documents Reply Elements .............................. 357
Electronic Trade Documents Request Elements .......................... 357
Electronic Trade Documents Reply Elements .............................. 358
Canada Province Codes ................................................................ 374
Mexico State Codes ..................................................................... 376

FedEx Web Services, Developer Guide

13

Tables
Table
Table
Table
Table
Table
Table

202.
203.
204.
205.
206.
207.

UAE State Codes .......................................................................... 378
Currency Codes ............................................................................. 380
Harmonized Tariff Unit of Measure Codes .................................. 383
Vague Commodity Descriptions ................................................... 387
Postal Aware Countries and Formats .......................................... 405
Physical Packaging Type Codes ................................................... 407

Table
Table
Table
Table
Table

208.
209.
210.
211.
212.

Customs-Approved Document Descriptions ................................. 409
Maximum Field Lengths ............................................................... 590
FedEx Express Special Handling Codes ....................................... 598
Shipping Documents ..................................................................... 625
Glossary ......................................................................................... 631

FedEx Web Services, Developer Guide

14

About This Guide

Document Organization

Resources
Support

About This Guide
This guide describes how to integrate with FedEx Web Services.

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

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.

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

Document Organization

Support

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

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

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

• Secure Socket Layer Certificates: fedex.com/us/developer/downloads/
dev_cert.zip
• Web Services organization home page: www.web-services.org

• 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

16

1 Introduction

Document Overview

Implementing FedEx Web Services

Printing All or Part of This Guide

Understanding the XML Schema

Web Services, WSDL, and SOAP Overview

Implementation Process

Chapter 1

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 just a few of the ways a
company can use web services to streamline operations, improve visibility,
and provide more choices to clients:
• Verify Addresses 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 Chapter 8: 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 Chapter 2: Rate Services and Chapter 10: Ship Service for more
information.
• More Convenience: Use the GlobalShipAddress 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 Chapter 5: Global Ship Address 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 Chapter 10: 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 Chapter 25: Shipment Notification in the Ship Request, Signature
Proof of Delivery (SPOD) and Chapter 4: 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 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 transfer and service
discovery. By following the standards, applications can seamlessly
communicate with platform services.

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.
FedEx Web Services, Developer Guide

18

Chapter 1

Introduction
• Introduction (this chapter):
– Documentation overview and guidelines, including how to use the Help
application and how to print this guide.
– Overview information about web services, including a high-level
description of FedEx Web Services methods.
– Coding basics.
– Overview information about testing and certifying your application.
• Chapter 2: Rate Services on page 33 describes services to rate packages.
• Chapter 3: Package Movement Information Service on page 48 describes
how to check service availability, postal codes, and route information.
• Chapter 4: Tracking and Visibility Services on page 52 covers Track
Services and includes:
– Elements for requesting tracking information, coding notification
requests, and requesting Signature Proof of Delivery (SPOD) on page
65.
– The Notification on page 69 service, which can be used to notify
shippers and recipients of significant shipment events.
– Elements for configuring FedEx InSight on page 73.

• Chapter 11: Returns Shipping on page 146 describes how to verify that a
FedEx ExpressTag® Dispatch can be scheduled for a given place and time.
• Chapter 30: FedEx SmartPost Shipping on page 251 describes how to
configure FedEx SmartPost® shipping options.
• Chapter 12: Creating a Label on page 156 describes how to configure,
customize, and print shipping labels using a variety of options.
• Chapter 8: Address Validation Service explains how to check your shipping
addresses for accuracy before shipping.
• Appendixes:
– Appendix A: Country Code Tables on page 360
– Appendix B: U.S. State Codes on page 370
– Appendix C: Canada Province Codes on page 373
– Appendix D: Mexico State Codes on page 375
– Appendix F: Currency Codes on page 379
– Appendix G: Harmonized Tariff Unit of Measure Codes on page 382
– Appendix H: Vague Commodity Descriptions on page 386
– Appendix I: Waybill Legal Terms and Conditions on page 402

• Chapter 5: Global Ship Address Service on page 75 describes how to
receive the addresses of the nearest FedEx package drop-off locations,
including FedEx Office® Print and Ship Center locations.

– Appendix J: Postal-Aware Countries and Formats on page 404

• Chapter 10: Ship Service on page 131 provides:

– Appendix M: Time Zones on page 411

®

– Appendix K: Physical Packaging Type Codes on page 406
– Appendix L: Customs-Approved Document Descriptions on page 408

– Service details for shipping with FedEx services.

– Appendix N: Minimum Customs Value on page 413

– Service details and coding details for all shipping services, including
Chapter 13: FedEx Express U.S. Shipping on page 180, Chapter 29:
FedEx Ground U.S. Shipping on page 243, Chapter 33: FedEx Express
International Shipping on page 295, and Chapter 36: FedEx
International Ground Shipping on page 318.

– Appendix O: Error Code Messages on page 415
– Appendix P: Countries Accepting Electronic Trade Documents on page
537
– Appendix Q: Track Service Scan Codes on page 540
FedEx Web Services, Developer Guide

19

Chapter 1

Introduction
– Appendix R: Maximum Field Lengths on page 589
– Appendix S: FedEx Express Plain Paper Label Samples on page 591
– Appendix U: FedEx Ground Plain Paper Labels on page 605
– Appendix V: FedEx Ground Thermal Label Samples on page 612
– Appendix T: FedEx Express Thermal Label Samples on page 603
– Appendix Y: Glossary on page 630
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 each CSP WSDL service. This layout
provides coding requirements for all elements in the schema. The Web
Services CSP Reference Guide includes a detailed description of all
available data elements and types in addition to all of the information
required to build a request and understand the reply.

Printing All or Part of This Guide
You can print all or part of this guide from the PDF version.

Printing from the PDF Version
From the PDF version you can print the complete document or a page range
of the document.
1. Open the PDF file and click the printer icon

or click File > Print.

2. From the Print dialog box, print the complete document, specify a page
range, or choose from any of the available print options.

Web Services, WSDL, and SOAP Overview
This section describes the standard coding technologies used in FedEx Web
Services.

Web Services
Web services are a collection of programming technologies, including XML,
Web Services Description Language (WSDL), and 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 could be declared
at any element in the XML document. The scope of a declared namespace
begins at the element where it is declared and applies 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 declared as
follows:

FedEx Web Services, Developer Guide

20

Chapter 1

Introduction
or even (hypothetically) same as

Element

the form of XML schema). For maximum platform neutrality, WSDL uses XML
schema syntax to define data types.



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 what communications
protocol is used to talk to the service. It defines everything required to write
a program to work with an XML web service. A WSDL document describes a
web service using seven major elements. Elements can be abstract or
concrete.
Abstract XML elements describe the web service: , ,
, . Concrete XML elements provide connection details:
, , .

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

Definition



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 specifies how the client and the web service should send messages to
one another.

Note: For more information about the WSDL standard, refer to the World Wide Web
Consortium (W3C) Website at w3.org/TR/wsdl.

SOAP
• Is a simple XML-based protocol that allows applications to exchange
information over HTTP.
• Is built on open standards supported by numerous development tools on
various platforms.
• 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.
FedEx Web Services, Developer Guide

21

Chapter 1

Introduction
• Enables the data to pass through layers of intermediaries and arrive at the
ultimate receiver the way it was intended.
Note: You may not need to actually construct the SOAP messages yourself — many
development tools available today construct SOAP behind the scenes.

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: Delete Tag Request (SOAP Message)






User Key



User Password




xxxxxxxxx
xxxxxx


ship
12
0
0

MQYA
2012-06-01

shipper

xxxxxxxxx
US


997037200019454




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.

FedEx Web Services, Developer Guide

22

Chapter 1

Introduction
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 Track Request



xxxxxxxxxxxxxxxx




xxxxxxxxx
xxxxxxxx


EN
us



Basic_TrackRequest_q0_Internal


EN
us



trck
7
0
0


FDXE

TRACKING_NUMBER_OR_DOORTAG
797843158299


INCLUDE_DETAILED_SCANS


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
FedEx Web Services, Developer Guide

23

Chapter 1

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

soapenv:Server
5: Schema validation failed for request.


5
Schema validation failed for request.


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 should be checked for the Fault element to indicate failure in processing the message.

FedEx Web Services, Developer Guide

24

Chapter 1

Introduction
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 Chapter 12: Creating a Label.

Non-SOAP HTTP POST Example
The following HTTPS POST example is a valid working example, but is not guaranteed to work for all programming languages, applications, and host systems:
POST /xml HTTP/1.0
Referrer: YourCompanyNameGoesHere
Host: wsbeta.fedex.com
Port: 443
Accept: image/gif, image/jpeg, image/pjpeg, text/plain, text/html, */*
Content-Type: image/gif
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.

Visual Basic Project Error

Implementing FedEx Web Services

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.

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,

FedEx Web Services, Developer Guide

25

Chapter 1

Introduction
.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 128-bit encryption to complete the request.

Understanding the XML Schema
The XML schema defines the messages that you can use to access the FedEx
services. You create a request that contains business data and other
instructions and you send 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.

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.

Guide to the XML Schema

• Elements and attributes that can appear in a document

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.

• Elements that are child elements

The top of each service schema includes:

• Order and number of child elements

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

• Whether an element is empty or can include text

• Alphabetical listing of complex types for the documented service.

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

• Alphabetical listing of schema simple types for the documented service.

Some important facts about the XML schema:

• Input or request data type for the documented service.

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

• Output or reply data type for the documented service.

An XML schema defines:

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

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.

• Complex types in the instance document, and some of the simple types,
are defined in the schema associated with a FedEx Web Service. Other

FedEx Web Services, Developer Guide

26

Chapter 1

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

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.

FedEx Web Services, Developer Guide

27

Chapter 1

Introduction
Schema Diagram

Description

Schema Diagram

A box with a single solid
border represents a single
element that is required.

Description
A layered box represents a
multiple occurrence
element. A solid line
represents a required
multiple occurrence
element.

The type can be simple or
complex.

The number of possible
occurrences appears below
the box, as depicted by the
ProcessShipmentReply.

A box with a dotted border
indicates a single element
that is optional.

An unbounded number of
occurrences is represented
by the infinity ¥ symbol
(maxOccurs="unbounded"),
as depicted by
Notifications.

The type can be simple or
complex.

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.

Required Elements
Most requests to FedEx require the following complex elements:
FedEx Web Services, Developer Guide

28

Chapter 1

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

WebAuthenticationDetail: The WebAuthenticationDetail element includes
user credentials issued by FedEx so that your transactions are recognized by
the FedEx back-end systems. The following elements are required:
Element

Description

WebAuthenticationDetail

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

WebAuthenticationDetail/
CspCredential

Credential key and password used to authenticate a CSP product/
software version. This information is provided by FedEx.

WebAuthenticationDetail/
UserCredential

Credential key and password used to authenticate a specific end
user/customer of the CSP. This information is obtained by processing
the Register Web CSP User Request.

UserCredential

Credential used to authenticate a specific software application. This
value is provided by FedEx after registration.

WebAuthenticationCredential

Two-part authentication string used to verify shipper identity.

WebAuthenticationCredential/ Unique identifier assigned to each customer as part of their
Key
authentication credentials.
WebAuthenticationCredential/ Second part of the authentication credential which has a direct
Password
relationship with the credential key.

Note: FedEx Web Services now use two-factor authentication. If you do not have new
credentials, the latest WSDLs will use your old authentication credentials. If you do not have
a new user authentication credential, do not populate the password element.

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

Element

Description

ClientDetail/AccountNumber

Your FedEx account number.

ClientDetail/MeterNumber

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

ClientDetail/ClientProductId

Identifies the CSP software product. This identifier is provided by
FedEx.

ClientDetail/
ClientProductVersion

Identifies the CSP software version. This identifier is provided by
FedEx.

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.

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

Description

TransactionDetail/
CustomerTransactionId

Maximum of 40 characters. 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.
Element

Description

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

ServiceId

Identifies a system or sub-system which performs an operation.

Major

Identifies the service business level.

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

Intermediate

Identifies the service interface level.

Minor

Identifies the service code level.

FedEx Web Services, Developer Guide

29

Chapter 1

Introduction
Sender Information: Your shipper information is required for all shipping
transactions:

WSDL and XML Schema
You can download the WSDL or XML schema for each service by following
these steps:

Element

Description

AccountNumber

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

1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/
developer.

TIN

Tax Identification Number — this information is required for international
shipments only.

2. Enter your username and password to login to the DRC.

Contact

The
•
•
•
•
•
•
•
•
•
•

Contact element includes:
ContactId
PersonName
Title
CompanyName
PhoneNumber
PhoneExtension
TollFreePhoneNumber
PagerNumber
FaxNumber
EmailAddress

Address

This element includes:
• StreetLines: two StreetLines elements are allowed.
• City
• StateOrProvinceCode: required if your shipper address is in the U.S. or
Canada.
• PostalCode: required.
• UrbanizationCode: may be required if your shipper address is in Puerto Rico.
• CountryCode: required.
• CountryName: required

Residential

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

3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. Under the "Download" section in either the "Standard Services" or the
"Advanced Services" tabs, click on the "Download WSDL or XML" link 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.

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.1-2004-0824.
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 Technical
Resources. Also, obtain a test meter number to engage in real-time online
testing in the FedEx hosted test environment.
FedEx Web Services, Developer Guide

30

Chapter 1

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

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.
Production credentials can be obtained prior to the certification process.
Advanced services are not enabled, but standard services are enabled. Refer
to Preproduction Assistance for more information on support from FedEx.

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 part of the FedEx®
Compatible Solutions Program. 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 CSP providers, go to the Available CSP Solutions
page at http://www.fedex.com/us/compatible-solutions/customer/.

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.

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.

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.

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.
Requirements and Resources for Corporate Developers
Must be accepted into the FedEx® Compatible Solutions Program (CSP)

No

Self-certification of implementations using standard services

Yes

FedEx Web Services, Developer Guide

31

Chapter 1

Introduction
Requirements and Resources for Corporate Developers

Requirements and Resources for Commercial Developers

Self-certification of implementations using advanced services

No

Certification assistance

Yes (WISC team)

FedEx supports the customer directly

Yes

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.

Requirements and Resources for Commercial Developers
Commercial developers create solutions with the intent of distributing and/or
reselling them to their customers. Because they are deployed in a variety of
situations, commercial integrations generally require a higher order of “fit and
finish.” 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.
Requirements and Resources for Commercial Developers
Must be accepted into the FedEx Compatible Solutions Program (CSP)

Yes (Required)

Self-certification of implementation using standard services

No

Self-certification of implementations using advanced services

No

Certification assistance

Yes (via CSP)

FedEx supports the customer directly

No

FedEx supports the commercial developer’s customer

Indirectly

If you are a commercial developer interested in becoming a FedEx Compatible
Solutions Program provider, go to http://www.fedex.com/us/compatiblesolutions/customer/ for more information about the FedEx Compatible
Solutions Program (CSP).

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. Old test key values will now return an error
message.

FedEx Web Services, Developer Guide

32

2 Rate Services

Rate

Samples

Rate Available Services/Rate Shopping

Error Messages

Surcharges and Discounts

Chapter 2

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.

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

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.

• 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.
• Rating is available for Chapter 30: FedEx SmartPost Shipping. See FedEx
SmartPost Request Elements for more details.
• This quote is an estimate and may differ from the actual invoiced amount.

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.

• Rate shopping, service-specific commitment and rate information may also
be specified.

Rate Service Details

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

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

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 discount rates. If you choose LIST as the element value, you receive
both discount and list rates, in addition to automation rate quotes.

FedEx Web Services, Developer Guide

34

Chapter 2

Rate Services
• 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.

Table 1. RateRequest Elements, continued
Element

Required

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

Required

The shipment for which a rate quote (or rateshopping comparison) is desired.

RequestedShipment/
ShipTimestamp

Optional

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

Allows the caller to specify that the transit time
and commit data are to be returned in the reply.
Valid values include:
• TRUE
• FALSE

RequestedShipment/ServiceType

Optional

Identifies the FedEx service to use in shipping the
package for a rate request.

RequestedShipment/
PackagingType

Required

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.

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

RateRequest Elements
Table 1. RateRequest Elements
Element
RateRequest/
ReturnTransitAndCommit

Required
Optional

Description

Description

RateRequest/
CarrierCodesCarrierCodeType

Optional

Candidate carriers for rate-shopping. This field is
only considered if RequestedShipment/ServiceType
is omitted.

RateRequest/
VariableOptionsServiceOption
Type

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.

FedEx Web Services, Developer Guide

35

Chapter 2

Rate Services
Table 1. RateRequest Elements, continued
Element

Required

Description

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

The descriptive data for the physical location from
which the shipment originates.

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). Valid values are:
• BROKER_SELECT_OPTION
• CALL_BEFORE_DELIVERY
• COD
• CUSTOM_DELIVERY_WINDOW
• DANGEROUS_GOODS

Table 1. RateRequest Elements, continued
Element

Required

Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

RequestedShipment/
ExpressFreightDetail

Optional

DO_NOT_BREAK_DOWN_PALLETS
DO_NOT_STACK_PALLETS
DRY_ICE
EAST_COAST_SPECIAL
ELECTRONIC_TRADE_DOCUMENTS
EMAIL_NOTIFICATION
EXTREME_LENGTH
FOOD
FREIGHT_GUARANTEE
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
POISON
PROTECTION_FROM_FREEZING
RETURN_SHIPMENT
SATURDAY_DELIVERY
SATURDAY_PICKUP
TOP_LOAD

Details specific to an Express freight shipment.

FedEx Web Services, Developer Guide

36

Chapter 2

Rate Services
Table 1. RateRequest Elements, continued
Element

Required

Description

Table 1. RateRequest Elements, continued
Element

Required

Description
• PREFERRED

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.

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

Optional

Specifies the type of rate the customer wants to
have used as the actual rate type.

CustomClearanceDetail/
DutiesPayment

Optional

Descriptive data indicating the method and means
of payment to FedEx for providing shipping services.

RequestedShipment/
EditRequestType

Optional

CustomsClearanceDetail/
Commodities/CustomsValue

Optional

Used to calculate Argentina and Dominican
Republic export taxes.

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

Optional

For use in “process tag” transaction.

RequestedShipment/
PackageCount

Optional

PickupDetail/ReadyDateTime

Optional

Specify the time and date the package will be
ready for pickup.

The total number of packages in the entire
shipment. The maximum number of packages in one
rate request is 100.

Optional

Specify the last possible pickup time and date.

RequestedShipment/
RequestedPackageLineItems

Optional

PickupDetail/
LatestPickupDateTime
PickupDetail/CourierInstructions

Optional

Specify any courier instructions.

One or more package-attribute descriptions, each of
which describes an individual package, a group of
identical packages, or (for the total-piece-totalweight case) common characteristics of packages in
the shipment.

PickupDetail/RequestType

Optional

Specify the request type.

PickupDetail/RequestSource

Optional

Specify the request source.

Rating for Multiple-Package Shipment

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

Optional

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

This option is available for FedEx Express U.S. and international multiplepackage shipments (MPS), FedEx Ground® U.S. and international multiplepackage 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.

Note: Request PREFERRED currency using the
LIST and ACCOUNT rate types. The PREFERRED
currency is only returned if the requested
currency is not already in the service response.
Note: RateRequest automatically returns discount
rates. If you include the LIST option, the
RateRequest returns both list and discount rates.

The maximum number of packages in one rate request is 100.

FedEx Web Services, Developer Guide

37

Chapter 2

Rate Services
For more information about MPS, see FedEx Express U.S. Multiple-Package
Shipments .
Note: Package level rates are not returned for Express International shipments. This applies
to single and multi-package shipments.

RateReply Elements

RateRequest Elements
The following request elements are specific to FedEx Freight shipments
Table 3. FedEx Freight RateRequest Shipment Elements
Element

Required

Description

ReturnTransitAndCommit

Optional

Allows the caller to specify that the transit
time and commit data are to be returned in the
reply.

Table 2. RateReply Elements
Element

Required

Description

HighestSeverity

Required

This indicates the highest level of severity of all the
notifications returned in the reply.

Notifications

Required

The descriptive data regarding the results of the
submitted transaction.

TransactionDetail

Optional

Contains the CustomerTransactionID that was sent to
the request.

TransactionDetail/
CustomerTransactionId

Optional

Free form text to be echoed back in the reply. Used to
match requests and replies.

TransactionDetail/Localization

Optional

Governs data payload language/translations
(contrasted with ClientDetail.localization, which
governs Notification.localizedMessage language
selection).

Version

Required

The version of this reply.

RateReplyDetails

Optional

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.

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

Valid values are:
• TRUE
• FALSE
CarrierCodes

Optional

Candidate carriers for rate-shopping use case.
This field is only considered if
RequestedShipment/ServiceType is omitted.

RequestedShipment

Required

The shipment for which a rate quote (or rateshopping comparison) is desired.

RequestedShipment/ShipTimestamp

Optional

The ship 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 type of service the rate quote is
for. Choose either:
• FEDEX_FREIGHT_ECONOMY
• FEDEX_FREIGHT_PRIORITY

RequestedShipment/PackagingType

Optional

Identifies the packaging used by the requestor
for the package. Valid values are:
• YOUR_PACKAGING

RequestedShipment/TotalWeight

Optional

—

RequestedShipment/TotalInsuredValue Optional

—

FedEx Web Services, Developer Guide

38

Chapter 2

Rate Services
Table 3. FedEx Freight RateRequest Shipment Elements, continued
Element

Required

Table 3. FedEx Freight RateRequest Shipment Elements, continued

Description

Element

Required

Description

RequestedShipment/PreferredCurrency Optional

Indicates the currency the caller requests to
have used in all returned monetary values,
when a choice is possible.

Recipient/Address

Required

RequestedShipment/Shipper

Descriptive data identifying the party
responsible for shipping the package. Shipper
and Origin should have the same address.

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.

Required

Shipper/AccountNumber

Optional

The FedEx account number associated with this
transaction.

RequestedShipment/Origin

Optional

Physical starting address for the shipment, if
different from shipper's address.

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

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.

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.

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.

Address/StreetLines

Required

Address/City

Required

Name of city, town, and so on.

ResponsibleParty/AccountNumber

Optional

Address/StateOrProvinceCode

Required

Identifying abbreviation for U.S. state,
Canadian province, etc. Format and presence of
this field will vary, depending on country.

The FedEx account number associated with this
transaction.

RequestedShipment/
SpecialServicesRequested

Optional

Identifies the special services the caller is
requesting with this shipment.

Address/PostalCode

Optional

Identification of a region (usually small) for
mail/package delivery. Format and presence of
this field will vary, depending on country.

RequestedShipment/
FreightShipmentDetail

Required

Includes required shipment data to obtain rates
for FedEx Freight shipments.

Required

The two-letter code used to identify a country.

FreightShipmentDetail/
FedExFreightAccountNumber

Optional

Address/CountryCode

Account number used with FedEx Freight
services.

Address/CountryName

Optional

The fully spelled out name of a country.

RequestedShipment/Recipient

Required

Descriptive data identifying the party receiving
the package.

FreightShipmentDetail/
Optional
FedExFreightBillingContactAndAddress

Billing address used to validate FedEx Freight
account on the bill of lading. Required valid
values for address are:
• StreetLines
• City

FedEx Web Services, Developer Guide

39

Chapter 2

Rate Services
Table 3. FedEx Freight RateRequest Shipment Elements, continued
Element

Required

Description

Table 3. FedEx Freight RateRequest Shipment Elements, continued
Element

Required

• StateOrProvinceCode
• PostalCode
FreightShipmentDetail/Role

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
• CLASS_400
• CLASS_500

LineItem/Packaging

Optional

Physical packaging type for this commodity or
freight class. Valid values are:
• BAG

Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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

Optional

The dimensions of this package and the unit
type used for the measurements. Valid values
are:
• Length
• Width

FedEx Web Services, Developer Guide

40

Chapter 2

Rate Services
Table 3. FedEx Freight RateRequest Shipment Elements, continued
Element

Required

Description

Table 4. FedEx Freight Reply Shipment Elements, continued
Element

• Height
• Units
FreightShipmentLineItem/Volume

Optional

Volume (cubic measure) for this commodity or
freight class.

RequestedShipment/
RateRequestTypes

Optional

Specifies 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.
Rates that can be returned are:
• ACCOUNT
• LIST
• PREFERRED

RequestedShipment/PackageCount

RequestedShipment/
RequestedPackageLineItems

Optional

Optional

• GUARANTEED_MORNING
• GUARANTEED_TIME
ReplyDetails/FLATBED_TRAILER

Surcharge for a flatbed trailer.

SurchargeType/INSIDE_PICKUP

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.

The total number of packages in the entire
shipment (even when the shipment spans
multiple transactions).

SurchargeType/FREIGHT_GUARANTEE

Surcharge for option.

SurchargeType/LIFTGATE_DELIVERY

Surcharge for option.

One or more package-attribute descriptions,
each of which describes an individual package,
a group of identical packages, or (for the totalpiece-total-weight case) common
characteristics all packages in the shipment.

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.

The following reply elements are specific to FedEx Freight shipments:
Table 4. FedEx Freight Reply Shipment Elements
Element

Description

ServiceType

Identifies the type of service used to ship the
package. Valid FedEx Freight options are:
• FEDEX_FREIGHT

ReplyDetails/FREIGHT_GUARANTEE

Description

Specifies how the freight has been guaranteed
for delivery. Valid FedEx Freight values are:
• GUARANTEED_DATE

FedEx Web Services, Developer Guide

41

Chapter 2

Rate Services
Table 4. FedEx Freight Reply Shipment Elements, continued

Table 5. Rate Reply Possible Surcharges for FedEx Service Options, continued

Element

Description

Possible Surcharges

SurchargeType/ISLAND_PICKUP

Surcharge for option.

GST (Goods and Services tax for Canadian origin)

RateDiscountType

The
•
•
•
•
•

HST (Harmonized sales tax for Canadian origin)

type of rate discount. Valid values are:
BONUS
COUPON
EARNED
OTHER
VOLUME

Possible Surcharges

Hazardous_Materials
Home_Delivery_Appointment
Home_Delivery_Evening
Home_Delivery_Date_Certain
Inside_Delivery
Inside_Pickup

This table lists possible surcharges returned in the Rate reply for applicable
FedEx service options:

Insured_Value — FedEx declared-value charges are returned in this element. FedEx does not provide
insurance of any kind.

Table 5. Rate Reply Possible Surcharges for FedEx Service Options

Island_Delivery

Possible Surcharges

Island_Pickup

Clearance Entry Fee Surcharge (Discount) for international shipping

Liftgate_Delivery

COD

Liftgate_Pickup

Dangerous_Goods

Limited_Access_Delivery

Email_Label

Limited_Access_Pickup

Exhibition

List Clearance Entry Fee Surcharge for international shipping

Export

Metro_Delivery

Extreme_Length

Metro_Pickup

FICE (FedEx International Controlled Export)
Fedex_Tag
Flatbed
Freight_Guarantee

Non_Standard_Container
Offshore
Out_Of_Delivery_Area
Out_Of_Pickup_Area

Fuel

FedEx Web Services, Developer Guide

42

Chapter 2

Rate Services
Table 5. Rate Reply Possible Surcharges for FedEx Service Options, continued

• Total surcharge

Possible Surcharges

• Total taxes (for Canadian origin shipments)

Other

• Total discounts

Overdimension

• Itemized surcharge

Oversize
Pre_Delivery_Notification
Protection_From_Freezing
PST (Provincial sales tax for Canadian origin)
Regional_Mall_Delivery
Regional_Mall_Pickup

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 6. Surcharges and Discounts Rate Quote

Residential

Surcharge

Description

Applicable Services

Return_Label

Additional Handling
Dimension Surcharge

For FedEx Express, shipment measures greater
than 60" in length but equal to or less than 108"
in length.

FedEx Priority Overnight®,
FedEx Standard
Overnight®, FedEx 2Day®,
FedEx Express Saver®,
FedEx Ground®, FedEx
International Ground®

Saturday_Delivery
Saturday_Pickup

For FedEx Ground, shipment measures greater
than 60" in length but equal to or less than 108"

Signature_Option
Tarp
TotalCustomerCharge — Contains the discounted net freight charge plus the variable handling charge
amount.

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

Transmit_Service_Fee
VariableHandlingCharges — If you specify additional handling charges in the rate quote, charges are
returned in the Rate reply.
VAT

Note: See Surcharges and Discounts for more information about surcharges and rate
calculations.

Rate Surcharge Return

For FedEx Ground, shipment is not fully encased
in an outer shipping container and/or is encased
in packing material other than corrugated
cardboard.

Surcharges are returned in the Rate reply and in the Ship reply as follows:
FedEx Web Services, Developer Guide

43

Chapter 2

Rate Services
Table 6. Surcharges and Discounts Rate Quote, continued
Surcharge

Description

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.

Table 6. Surcharges and Discounts Rate Quote, continued
Applicable Services

FedEx International
Priority®, FedEx
International Priority®
Freight, FedEx
International Economy®,
See Chapter 40: B13A for Canada Export Shipping FedEx International
Economy® Freight
for more information.

Surcharge

Description

Applicable Services

Dimensional Weight

For FedEx Express shipments: FedEx may assess
shipping charges based on the International Air
Transport Association (IATA) volume standard.
Dimensional weight is calculated by multiplying
the length by width by height of each package in
inches and dividing the total by 166 (for
shipments within the U.S. and shipments
between the U.S. and Puerto Rico) or 186 (for
international shipments). If the dimensional
weight exceeds the actual weight, charges may
be assessed based on the dimensional weight.
Shipments in FedEx packaging may also be
subject to dimensional-weight pricing.

FedEx Express and FedEx
Ground shipments

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

Declared Value

Delivery Area
Surcharge

FedEx assesses a surcharge on each package
containing dangerous-goods materials. For intraCanada 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

FedEx liability for each package is limited to
FedEx Express and FedEx
$100USD unless a higher value is declared and
Ground shipments
paid for. For each package exceeding $100USD in
declared value, an additional amount is charged.
FedEx does not provide insurance of any kind.
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®

For FedEx Ground shipments: Dimensional weight
may apply to FedEx Ground packages that are 3
cubic feet (5,184 cubic inches) or larger. Multiply
the length by width by height of each package in
inches. If the total is 5,184 inches or greater,
calculate dimensional weight by dividing by 166
(for shipments within the U.S. and Puerto Rico
and for shipments to Canada).
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 Express
International package and
freight service

FedEx® Collect on
Delivery (C.O.D.)

If you request FedEx to obtain payment from the
recipient at the time the shipment is delivered,
an additional surcharge is applied.

FedEx Express and FedEx
Ground shipments

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

A charge applies when you direct FedEx to collect FedEx Ground shipments
payment from your recipient and deposit it
directly into your bank account.

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

FedEx Express shipments
to U.S. addresses and
FedEx Ground shipments
to U.S. and Canadian

FedEx Web Services, Developer Guide

44

Chapter 2

Rate Services
Table 6. Surcharges and Discounts Rate Quote, continued
Surcharge

Description

Table 6. Surcharges and Discounts Rate Quote, continued
Applicable Services

Signature Required. Indirect Signature Required is addresses
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. 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

FedEx ExpressTag®

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

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
Convenient Delivery
Options

You can choose FedEx Home Delivery convenient
delivery options: 1) FedEx Date Certain Home
Delivery®, 2) FedEx Evening Home Delivery®, 3)
FedEx Appointment Home Delivery®.

FedEx Home Delivery

Surcharge

Description

Applicable Services

FedEx International
Controlled Export
(FICE)

A charge applies when you select FICE for
shipments moving under a U.S. State Department
(DSP) license or under U.S. 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 International
Priority, FedEx
International Priority
Freight

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 intra-U.S. and
international shipments.

FedEx First Overnight,
FedEx Priority Overnight,
FedEx Standard
Overnight, FedEx 2Day,
FedEx 2Day A.M., FedEx
Ground, FedEx 2Day
Freight, FedEx 3Day
Freight

Inside Delivery/Inside
Pickup Charge

When requested, FedEx may move shipments to
positions beyond the adjacent loading area.

FedEx Freight

FedEx Freight Special
Services

When requested, a surcharge will be applied to
the FedEx Freight special services. For a list of
these surcharges, see Intra-Canada Express
Service.

FedEx Freight

Oversize Charge

FedEx Express: 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).
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 and FedEx
Home Delivery

FedEx Ground: A package weighing 150 lbs. or
less and measuring greater than 130" in length
and girth is classified as an oversize package.

FedEx Web Services, Developer Guide

45

Chapter 2

Rate Services
Table 6. Surcharges and Discounts Rate Quote, continued
Surcharge

Description

Table 6. Surcharges and Discounts Rate Quote, continued
Applicable Services

Surcharge

The shipping charges for an oversize package are
based on the greater of the package’s actual
rounded weight or its dimensional weight.

Note: For more information about FedEx terms and conditions, including surcharges, go to
fedex.com/us/services/terms/.
FedEx Express, FedEx
Ground, FedEx
International Ground
(Canada only), FedEx
Freight, FedEx
International Premium®

Rural Delivery (Alaska A surcharge applies for delivery to select rural
and Hawaii)
postal codes in Alaska and Hawaii.

FedEx Ground U.S.

Saturday Delivery/
Saturday Pickup

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

Fuel Surcharge

Saturday Service is available for an additional
charge depending on the package service type
and origin/destination pair.

A surcharge will be applied for dry-ice packaging. FedEx International
Priority, FedEx
International Economy,
and FedEx International
Economy Freight services
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.

Applicable Services

The fuel surcharge percentage for FedEx Ground
services is subject to monthly adjustment based
on a rounded average of the national U.S. onhighway average price for a gallon of diesel fuel.

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.

Description

FedEx Express, FedEx
Freight, FedEx Ground,
and FedEx Home Delivery

FedEx Discount Programs
The following discount programs are offered by FedEx and are calculated in
your rate quote:
Table 7. 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 shipping criteria. You earn additional
discounts as you increase shipping activity or due to specific shipment
characteristics. Earned discounts are also available for FedEx SmartPost
shipping.

Note: For more information on pricing programs, contact your FedEx account executive.

Samples
Sample code, sample transactions and the specific individual WSDL/XML
guide(s) can be downloaded following these steps:

FedEx Web Services, Developer Guide

46

Chapter 2

Rate Services
1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.

6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

FedEx Web Services, Developer Guide

47

3 Package Movement Information
Service

Service Availability

Samples

Postal Code Inquiry

Error Messages

Chapter 3

Package Movement Information Service
Use the PackageMovementInformationService WSDL to check service
availability, route and postal codes.

Service Availability
You can use the ServiceAvailabilityRequest to determine which FedEx
Express® services are available between an origin and destination.

Example Service Availability Request



XXXXXXXXXX
XXXXXXXXXX



XXXXXXXXX
XXXXXXXXX


pmis
5
0
0


90091
US


95630
US

2011-07-29
FDXE
PRIORITY_OVERNIGHT

YOUR_PACKAGING


Service Availability Service Details
The ServiceAvailabilityRequest returns a list of all available FedEx Express
services for the given origin and destination information, including intraMexico. For more detailed information about the services offered by FedEx,
see the electronic FedEx Service Guide.

Service Availability Coding Details
To check the availability of one particular FedEx Express service and
packaging type, include the Service and Packaging elements in the request
message. Only information regarding that single service and packaging type
will be returned from the request. To obtain a list of all available services for
a given origin and destination, omit the Service and Packaging elements from
the request. In this case the reply will contain every available service.

Service Availability Request Elements
Table 8. Service Availability Request Elements
Element

Required

Description

Origin

Required

The descriptive data for the postal code and country code the
shipment originates from.

Destination

Required

The descriptive data for the postal code and country code to
which the shipment is destined.

ShipDate

Required

The date on which the package will be shipped. The date
should not be a past date or a date more than 10 days in the
future. The date format must be YYYY-MM-DD.

CarrierCode

Required

Identification of a FedEx service. For this transaction the value
can be FDXG or FDXE.

FedEx Web Services, Developer Guide

49

Chapter 3

Package Movement Information Service
Table 8. Service Availability Request Elements, continued
Element

Required

Description

Service

Optional

Identifies the FedEx transportation service to check for
availability. See ServiceType for valid values. Omit this element
and the Packaging element to get a list of every available
service.

Packaging

Optional

Identifies the FedEx packaging type used by the requestor for
the package. See PackagingType for valid values. Omit this
element and the Service element to get a list of every
available service.

Table 9. Service Availability Reply Elements, continued
Element

•
•
•
•
•
•
•
•
•
•
•
•
•

Service Availability Reply Elements
Table 9. Service Availability Reply Elements
Element

Description

Options

The descriptive data for the collection of available FedEx services returned for
the request. The reply includes the day of the week that service is available.

Description
FEDEX_3_DAY_FREIGHT
FEDEX_EXPRESS_SAVER
FEDEX_FIRST_FREIGHT
FEDEX_GROUND
FEDEX_HOME_DELIVERY
FIRST_OVERNIGHT
INTERNATIONAL_ECONOMY
INTERNATIONAL_ECONOMY_FREIGHT
INTERNATIONAL_FIRST
INTERNATIONAL_PRIORITY
INTERNATIONAL_PRIORITY_FREIGHT
PRIORITY_OVERNIGHT
STANDARD_OVERNIGHT

DestinationAirportID

Describes the airport destination.

Service

Describes the service.

DeliveryDate

Expected/estimated date of delivery (YYYY-MM-DD). U.S. destinations only.

DeliveryDay

Expected/estimated day of week of delivery. U.S. destinations only.

DestinationStationId

Station identification.

PackageType options:
•
•
•
•
•
•
•
•

FEDEX_10KG_BOX
FEDEX_25KG_BOX
FEDEX_BOX
FEDEX_ENVELOPE
FEDEX_PAK
FEDEX_TUBE
INDIVIDUAL_PACKAGES
YOUR_PACKAGING

Service type options:
•
•
•
•
•

EUROPE_FIRST_INTERNATIONAL_PRIORITY
FEDEX_1_DAY_FREIGHT
FEDEX_2_DAY
FEDEX_2_DAY_AM
FEDEX_2_DAY_FREIGHT

Postal Code Inquiry
Postal Code Inquiry enables customers to validate postal codes and service
commitments.

Example Postal Code Inquiry



XXXXXXXX

FedEx Web Services, Developer Guide

50

Chapter 3

Package Movement Information Service
XXXXXXXX



XXXXXXXX
XXXXXXXX


pmis
6
0
0

38017
US


Table 11. Postal Coding Inquiry Reply Elements, continued
Element

Description

ExpressFreightDescription

Only the service area field is currently provided for Express Freight.

ExpressDescription

Postal code service area description for FedEx Freight delivery.

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.

Postal Code Inquiry Coding Details

3. Expand "Technical Resources" on the left pane.

In addition to the basic request elements required for all operations, the
following elements are available when coding a PostalCodeInquiryRequest:

4. Expand "FedEx Web Services for Shipping" and choose "Get Started."

Table 10. Postal Coding Inquiry Request Elements
Element

Required

Description

PostalCode

Yes

Postal code is required for postal-aware countries.

CountryCode

Yes

Required 2-letter FedEx country code.

PostalCodeInquiryReply data (based on your search criteria) are returned in a
PostalCodeInquiryReply.
Table 11. Postal Coding Inquiry Reply Elements
Element

Description

ExpressFreightContractor

Identifies whether the area is an Express Freight Contractor
Delivery Area.

ExpressDescription

Postal code service area description for FedEx Express delivery.

5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

FedEx Web Services, Developer Guide

51

4 Tracking and Visibility Services

Tracking Shipments

FedEx InSight

Signature Proof of Delivery (SPOD)

Samples

Notification

Error Messages

Chapter 4

Tracking and Visibility Services
The TrackService WSDL provides the following services to actively track your
shipments:
• Tracking Service
Use the TrackService WSDL to obtain timely and accurate tracking
information for FedEx Express®, FedEx Ground®, FedEx SmartPost®, FedEx
Home Delivery®, FedEx Express® Freight, and FedEx Custom Critical®
shipments.
• Signature Proof of Delivery (SPOD)
Use FedEx SPOD to request a proof of delivery letter that includes a
graphic image of your recipient’s signature after your shipment has been
delivered.
• Notification
Use Notification to have FedEx automatically notify you and/or your
customer and/or another third party by email, fax, or wireless of
significant shipment events, such as clearance delays, delivery attempts,
releases, consolidated proofs of delivery, and pre-alerts.
FedEx now offers a new email notification of Tendered, which may be
specified with the shipment request, in addition to the existing Delivery,
Exception, and Shipment email notifications. Use the Tendered email
notification if you want an email notification sent to the specified
recipients once the shipment has been tendered to FedEx. This notification
is supported for FedEx Express, FedEx Ground, FedEx Freight® Economy,
and FedEx SmartPost®.
• FedEx InSight®
FedEx InSight is a web-based application that enables you to view the
status of your inbound, outbound, and third-party shipments without a
tracking number. All you need is your account number and/or company
name and address. You can see information about the status of your
shipments so you can more effectively manage your supply-chain
processes. FedEx InSight also notifies you by email, fax, or wireless of

significant shipment events, such as clearance delays, delivery attempts,
releases, consolidated proof of delivery, and delivery pre-alerts. For more
information regarding FedEx InSight, go to fedex.com/insight.
As part of the ShipService WSDL, you may add additional elements to your
ProcessShipmentRequest to customize your FedEx InSight information. For
coding elements, see Chapter 10: Ship Service.

Tracking Shipments
Use the TrackService WSDL to use FedEx® Tracking options to obtain timely
and accurate tracking information for FedEx Express, FedEx Ground, FedEx
Home Delivery, FedEx Freight®, FedEx Custom Critical, and FedEx SmartPost
shipments. This WSDL handles tracking numbers individually.
You can also track the status of shipments by using a reference number, such
as a purchase order (PO) number, customer reference, invoice, Bill of Lading
(BOL), part number, or Transportation Control Number (TCN).

Batch Tracking
Batch tracking is not available. Only one tracking number is allowed per
request.

Tracking Service Details
You can use FedEx track service to obtain timely and accurate tracking
information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx
Cargo, FedEx Freight, FedEx SmartPost, and FedEx Custom Critical shipments.
Basic tracking service details are:
• FedEx Express and FedEx Ground Signature Proof of Delivery (SPOD) are
available for 18 months after the ship date.
• FedEx Express shipments support intra-Mexico shipping for Signature Proof
of Delivery (SPOD).
FedEx Web Services, Developer Guide

53

Chapter 4

Tracking and Visibility Services
• FedEx Custom Critical Signature Proof of Delivery (SPOD) is available for
90 days.
• The TrackService WSDL handles tracking numbers individually. Batch
tracking is not supported in this service.
• You can track the status of shipments using a reference number, such as
a PO number, customer reference, invoice number, BOL, part number, or
TCN.
Refer to TrackRequest Elements, TrackReply Elements and the Track Schema
for syntax details.

Note: With a FedEx Express and FedEx Ground shipment, the customer's reference
number is coded as a Shipper Reference and Customer Reference. Use the
Free_Form_Reference value to perform a wildcard search on the values associated with
the shipment.

• Invoice Number
• PO
• Department (not available for FedEx SmartPost)
• Part Number (not available for FedEx SmartPost)
• Returns Material Authorization (RMA)

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

• TCN (not available for FedEx SmartPost)

For a listing of scan codes, see Appendix Q: Track Service Scan Codes.

Note: If you enter a tracking number as part of this Request, the tracking number always
takes precedence over the Reference element. Therefore, if you enter a tracking number for a
shipment that does not include the Reference data you requested, the tracking number is
returned with no error message. To limit the number of tracking replies for a specific
reference, you can enter a date range for this search.

Tracking Service Options
The following options are available with this service:

Track by Tracking Number
This option applies to FedEx Express, FedEx Ground, FedEx Freight, and FedEx
Custom Critical shipments. You can track any package shipped by FedEx using
this tracking method. No extra qualifiers, such as date range are required for
this method, but are recommended. Provide the Carrier Code to ensure the
desired results for your request.

• BOL (not available for FedEx SmartPost)

Tracking requests cannot be batch processed at this time.

Track by Multiple-Package Shipment (MPS) Tracking Number

This option applies to FedEx Express, FedEx Ground, FedEx Freight, FedEx
Cargo, FedEx SmartPost, and FedEx Custom Critical shipments. You can track
packages by a reference number entered during the shipping operation. Track
by Reference Number can use any of the following sources:

This option is available for FedEx Express U.S. and International multiplepackage shipments, FedEx Ground U.S. and international multiple-package
shipments, FedEx Express U.S. C.O.D. and International C.O.D. multiplepackage shipments and FedEx Ground U.S. C.O.D. and FedEx International
C.O.D. multiple-package shipments. MPS tracking allows you to track by the
master tracking number or by one of the associated sequential tracking
numbers for child packages. Tracking by the master tracking number returns
tracking data for all child tracking numbers associated with the master.
Tracking by the child tracking number returns tracking data on the specific
shipment associated with that tracking number.

• Shipper/Customer Reference

For more information about MPS, see Multiple-Package Shipment Elements.

Track by Reference Number

FedEx Web Services, Developer Guide

54

Chapter 4

Tracking and Visibility Services
Track by Door Tag Number

Table 12. TrackRequest Elements, continued

This option is available for FedEx Express and FedEx Ground U.S. and
Canadian shipments. This option allows you to track the status of shipments
by a FedEx Door Tag number. A Door Tag is left at the recipient’s shipping
address if the recipient is not there to receive the package. A Door Tag
number is linked at FedEx with the package’s original tracking number. This
tracking functionality allows you to track using only the Door Tag number
without requiring the associated tracking number. No additional search
elements are required to track by Door Tag. You may request tracking scan
information for any packages shipped by FedEx by entering a valid Door Tag
number.

TrackRequest Elements
In addition to basic elements required for all transactions, the following
elements make up the TrackRequest.
See Chapter 1: Introduction for more information.
Table 12. TrackRequest Elements
Element

Required

Description

TrackRequest/
SelectionDetails

No

Specifies the details needed to select the shipment
being requested to be tracked.

TrackRequest/
SelectionDetails/CarrierCode

No

The FedEx operating company (transportation) used for
this package's delivery.

TrackRequest/
SelectionDetails/
OperatingCompany

No

Identifies operating transportation company that is the
specific to the carrier code.

TrackRequest/
SelectionDetails/
PackageIdentifier

No

The type and value of the package identifier that is to
be used to retrieve the tracking information for a
package or group of packages.
Valid values are:

Element

Required

Description
• Type: The type of the Value to be used to retrieve
tracking information for a package, such as
SHIPPER_REFERENCE, PURCHASE_ORDER,
TRACKING_NUMBER_OR_DOORTAG, and so on.
• Value: The value to be used to retrieve tracking
information for a package.

TrackRequest/
SelectionDetails/
PackageIdentifier/Type

No

The type of track to be performed.
Valid values are:
• BILL_OF_LADING
• COD_RETURN_TRACKING_NUMBER
• CUSTOMER_AUTHORIZATION_NUMBER
• CUSTOMER_REFERENCE
• DEPARTMENT
• DOCUMENT_AIRWAY_BILL
• FREE_FORM_REFERENCE
• GROUND_INTERNATIONAL
• GROUND_SHIPMENT_ID
• GROUP_MPS
• INVOICE
• JOB_GLOBAL_TRACKING_NUMBER
• ORDER_GLOBAL_TRACKING_NUMBER
• ORDER_TO_PAY_NUMBER
• OUTBOUND_LINK_TO_RETURN
• PARTNER_CARRIER_NUMBER
• PART_NUMBER
• PURCHASE_ORDER
• RETURN_MATERIALS_AUTHORIZATION
• RETURNED_TO_SHIPPER_TRACKING_NUMBER
• TRACKING_CONTROL_NUMBER
• TRACKING_NUMBER_OR_DOORTAG
• TRANSPORTATION_CONTROL_NUMBER

FedEx Web Services, Developer Guide

55

Chapter 4

Tracking and Visibility Services
Table 12. TrackRequest Elements, continued
Element

Required

Description
• SHIPPER_REFERENCE
• STANDARD_MPS

TrackRequest/
No
SelectionDetails/
TrackingNumberUniqueIdentifi
er

Used to distinguish duplicate FedEx tracking numbers.

TrackRequest/
SelectionDetails/
ShipDateRangeBegin

No

To narrow the search to a period in time, use the
ShipDateRangeBegin and ShipDateRangeEnd to help
eliminate duplicates.

TrackRequest/
SelectionDetails/
ShipDateRangeEnd

No

TrackRequest/
SelectionDetails/
ShipmentAccountNumber

No

TrackRequest/
SelectionDetails/
SecureSpodAccount

No

Specifies the SPOD account number for the shipment
being tracked.

TrackRequest/
SelectionDetails/Destination

No

For tracking by references information, either the
account number, or destination postal code and country
must be provided.

TrackRequest/
SelectionDetails/PagingDetail

No

Specifies the details about how to retrieve the
subsequent pages when there is more than one page
in the TrackReply.

Table 12. TrackRequest Elements, continued
Element

Required

TrackRequest/
No
SelectionDetails/
CustomerSpecifiedTimeOutVal
ueInMilliseconds

The customer can specify a desired time out value for
this particular tracking number.

TrackRequest/
No
TransactionTimeOutValueInMi
lliseconds

The customer can specify a desired time out value for
this particular transaction.

TrackRequest/
ProcessingOptions

Valid value is INCLUDE_DETAILED_SCANS.

No

To narrow the search to a period in time, use the
ShipDateRangeBegin and ShipDateRangeEnd to help
eliminate duplicates.
For tracking by references information, either the
account number, or destination postal code and country
must be provided.

Valid values are:
• PagingToken: When the MoreData field = true in a
TrackReply, the PagingToken must be sent in the
subsequent TrackRequest to retrieve the next page
of data.
• NumberOfResultsPerPage: Specifies the number of
results to display per page when there is more
than one page in the subsequent TrackReply.

Description

If FALSE (the default), the reply will contain summary/
profile data including current status.
If TRUE, the reply will contain profile and detailed scan
activity (multiple TrackDetail objects) for each package.

Example Track Request



xxxxxxxxxxxxxxxx




xxxxxxxxx
xxxxxxxx


EN
us




FedEx Web Services, Developer Guide

56

Chapter 4

Tracking and Visibility Services
Table 13. TrackReply Elements, continued
Basic_TrackRequest_q0_Internal

EN
us



trck
7
0
0


FDXE

TRACKING_NUMBER_OR_DOORTAG
797843158299


INCLUDE_DETAILED_SCANS


TrackReply Elements
In addition to standard reply elements, the following elements are returned in
a successful TrackReply.

Element

Description

TrackReply/Notifications

Information about the request/reply such was the transaction
successful or not and any additional information relevant to
the request or reply. There may be multiple Notifications in a
reply.

TrackReply/CompletedTrackDetails

Contains detailed tracking entry information.

TrackReply/CompletedTrackDetails/
HighestSeverity

Contains the severity type of the most severe Notification in
the Notifications array.

TrackReply/CompletedTrackDetails/
Notifications

Information about the request/reply, such was the transaction
successful or not and any additional information relevant to
the request or reply. There may be multiple Notifications in a
reply.

TrackReply/CompletedTrackDetails/
DuplicateWaybill

This element is returned if duplicate packages exist with the
same tracking number. Only limited data will be provided for
each one.

TrackReply/CompletedTrackDetails/
MoreData

Returned if additional packages remain to be retrieved.

TrackReply/CompletedTrackDetails/
PagingToken

Value that must be passed in a SendNotification Request to
retrieve the next set of packages (when MoreDataAvailable =
true).

TrackReply/CompletedTrackDetails/
TrackDetails

Contains detailed tracking information for the requested
packages(s). See Table 14.

See Chapter 1: Introduction for more information.

The following optional TrackDetails elements provide further identification of
the package in the TrackService reply.

Table 13. TrackReply Elements

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements

Element

Description

Element

Description

TrackReply/HighestSeverity

Contains the severity type of the most severe Notification in
the Notifications array.

Notification

To report soft error on an individual track detail.

TrackingNumber

The FedEx package identifier.

FedEx Web Services, Developer Guide

57

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Element

Description

Element

Description

Barcode

Each instance of this data type represents a barcode
whose content must be represented as ASCII text, such as
not binary data.

StatusDetail/AncillaryDetails

Barcode/Type

The
•
•
•
•
•
•

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 city-state-ZIP combination
within the U.S.

CustomerExceptionRequests

Unique identifier for the customer exception request.

CustomerExceptionRequests/Id

Unique identifier for the customer exception request.

CustomerExceptionRequests/StatusCode

A code that identifies this type of status.

CustomerExceptionRequests/
StatusDescription

A human-readable description of this status.

CustomerExceptionRequests/CreateTime

An ISO8601DateTime.

Reconciliation

Used to report the status of a piece of a multiple piece
shipment which is no longer traveling with the rest of the
packages in the shipment or has not been accounted for.

ServiceCommitMessage

Used to convey information such as:

kind of barcode data in this instance. Valid values are:
ADDRESS
ASTRA
FEDEX_1D
GROUND
POSTAL
USPS

Barcode/Value

The data content of this instance.

TrackingNumberUniqueIdentifier

When duplicate tracking numbers exist, this data is
returned with summary information for each of the
duplicates. The summary information is used to determine
which of the duplicates the intended tracking number is.
This identifier is used on a subsequent track request to
retrieve the tracking data for the desired tracking number.

StatusDetail

Specifies details about the status of the shipment being
tracked.

StatusDetail/CreationTime

An ISO8601DateTime.

StatusDetail/Code

A code that identifies this type of status.

StatusDetail/Description

A human-readable description of this status.

StatusDetail/Location

Address information related to the associated Status Detail
Code and Description.
Valid values are:
• City
• State
• Country

1.

FedEx has received information about a package but
has not yet taken possession of it.

2.

FedEx has handed the package off to a third party for
final delivery.

3.

The package delivery has been cancelled.

DestinationServiceArea

A FedEx-specific code that indicates the level of service
that FedEx is committed to provide for package delivery.

DestinationServiceAreaDescription

Descriptive text to provide additional explanation about the
Destination Service Area.

CarrierCode

Identifies a FedEx operating company (transportation).

OperatingCompany

Identifies operating transportation company that is specific
to the carrier code.

FedEx Web Services, Developer Guide

58

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Element

Description

Element

Description

OperatingCompanyOrCarrierDescription

Specifies a detailed description about the carrier or the
operating company.

Service/ShortDescription

Specifies a shorter description for the service that is
calculated per the service code.

ProductionLocationContactAndAddress

Specifies the FedEx office production center contact and
address.

PackageWeight

The weight of this package.

PackageDimensions

Physical dimensions of the package.

OtherIdentifiers

Other related identifiers for this package such as reference
numbers.

PackageDimensionalWeight

The dimensional weight of the package.

OtherIdentifiers/PackageIdentifier

Required. The type and value of the package identifier that
is to be used to retrieve the tracking information for a
package.

ShipmentWeight

The weight of the entire shipment.

Packaging

Retained for legacy compatibility only.

PackagingType

Strict representation of the Packaging type, such as
FEDEX_BOX, YOUR_PACKAGING, and so on.

PackagingType

Strict representation of the Packaging type, such as
FEDEX_BOX, YOUR_PACKAGING, and so on.

OtherIdentifiers/PackageIdentifier/Type

Required. The type of value to be used to retrieve tracking
information for a package, such as SHIPPER_REFERENCE,
PURCHASE_ORDER, TRACKING_NUMBER_OR_DOORTAG,
and so on.

OtherIdentifiers/PackageIdentifier/Value

Required. The value to be used to retrieve tracking
information for a package.

PackageSequenceNumber

The sequence number of this package in a shipment. This
would be 2 if it was package number 2 of 4.

OtherIdentifiers/
TrackingNumberUniqueIdentifier

Used to distinguish duplicate FedEx tracking numbers.
When duplicate tracking numbers exist this data is
returned with summary information for each of the
duplicates. The summary information is used to determine
which of the duplicates the intended tracking number is.
This identifier is used on a subsequent track request to
retrieve the tracking data for the desired tracking number.

PackageCount

The number of packages in this shipment.

Charges

Specifies the details about the Single Point of Clearance
(SPOC) details.

Charges/Type

The descriptive information about the type of charges.
Valid value is ORIGINAL_CHARGES.

Charges/ChargeAmount

The currency amount billed for services rendered.

ShipmentContents

This is a hierarchical field; it does not contain data but
identifies that the lower-level fields will be related to the
shipment contents.

ShipmentContents/PartNumber

The part number.

ShipmentContents/ItemNumber

The item number.

ShipmentContents/ReceivedQuantity

The quantity of the item received, in the form of a nonnegative integer.

OtherIdentifiers/CarrierCode

The FedEx operating company (transportation) used for this
package's delivery.

Service

Specifies details about service such as service description
and type.

Service/Type

The service type of the package/shipment, such as
FEDEX_CARGO_AIRPORT_TO_AIRPORT.

Service/Description

Complete and accurate description of this service.
Descriptive text for the associated Service/Type.

FedEx Web Services, Developer Guide

59

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Element

Description

Element

Description

ShipmentContents/Description

The descriptive data identifying the contents of the
shipment.

Commodities/ExciseCondition

Defines additional characteristics of commodity used to
calculate duties and taxes.

PackageContents

Specifies the contents of the package.

Commodities

Describes the kinds and quantities of all commodities in
the shipment.

Commodities/
ExportLicenseExpirationDate

Commodities/CommodityId

Value used to identify a commodity description; must be
unique within the containing shipment.

Date of expiration. Must be at least 1 day into future. The
date that the Commerce Export License expires. Export
License commodities may not be exported from the U.S. on
an expired license. Applicable to U.S. shipping only.
Required only if commodity is shipped on commerce export
license, and Export License Number is supplied.

Commodities/Name

Specify name of the commodity.

Commodities/CIMarksAndNumbers

An identifying mark or number used on the packaging of a
shipment to help customers identify a particular shipment.

Commodities/NumberOfPieces

Specify number of pieces for the commodity.
Commodities/PartNumber

The part number.

Commodities/Description

Complete and accurate description of the commodity.
Commodities/NaftaDetail

Commodities/CountryOfManufacture

Country code where commodity contents were produced or
manufactured in their final form.

All data required for this commodity in NAFTA Certificate
of Origin.

Commodities/HarmonizedCode

The unique alpha/numeric code representing the
commodity item.

Commodities/NaftaDetail/
PreferenceCriterion/

Defined by NAFTA regulations. See instructions for NAFTA
Certificate of Origin for code definitions.

Commodities/Weight

Specify weight of commodity.

Commodities/Quantity

Specify quantity of commodity. This field is used for
enterprise transactions.

Commodities/QuantityWithFraction

This field is only for use in upload file construction and
processing.

Commodities/QuantityUnits

Unit of measure used to express the quantity of this
commodity line item.

Commodities/AdditionalMeasures

Contains only additional quantitative information other than
weight and quantity to calculate duties and taxes.

Commodities/UnitPrice

Value of each unit in Quantity. Six explicit decimal places
positions.

Commodities/CustomsValue

Specify customs value for commodity.

Valid values are:
•A
•B
•C
•D
•E
•F
Commodities/NaftaDetail/
ProducerDetermination

Defined by NAFTA regulations. See instructions for NAFTA
Certificate of Origin for code definitions.
Valid values are:
• NO_1
• NO_2
• NO_3
• YES

FedEx Web Services, Developer Guide

60

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued
Element

Description

Commodities/NaftaDetail/ProducerId

Identification of which producer is associated with this
commodity (if multiple producers are used in a single
shipment).

Commodities/NaftaDetail/
NetCostMethod

Valid values are:
• NC: Net cost method used for RCV calculation.
• NO: Net cost method not used.

Commodities/NaftaDetail/
NetCostDateRange

Date range over which RVC net cost was calculated.

ReturnDetail

This is a hierarchical field; it does not contain data but
identifies that the lower-level fields will be related to a
return shipment.

ReturnDetail/MovementStatus

Identifies whether the return shipment has actually been
returned.

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued
Element

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

Valid values are:
• MOVEMENT_OCCURRED
• NO_MOVEMENT
ReturnDetail/LabelType

Specifies the label that is to be put on a return package.
Valid values are:
• EMAIL
• PRINT

ReturnDetail/Description

Descriptive text about the return shipment, entered by the
customer.

ReturnDetail/AuthorizationName

Name of person authorizing the return, entered by the
customer.

CustomsOptionDetails

Specifies the reason for return.

CustomsOptionDetails/Type

Specifies the reason for an international return, as
recognized by Customs.
Valid values are:

Description

CustomsOptionDetails/Description

Specifies additional description about customs options.
This is a required field when the CustomsOptionType is
"OTHER."

AdvanceNotificationDetail

The details of the advance notification, such as estimated
time of arrival, reason and status.

ShipperAddress

The address information for the shipper.

OriginLocationAddress

The address of the FedEx pickup location/facility.

EstimatedPickupTimestamp

Estimated package pickup time for shipments that haven't
been picked up.

ShipTimestamp

Time package was shipped/tendered over to FedEx. Time
portion will be populated if available, otherwise will be set
to midnight.

FedEx Web Services, Developer Guide

61

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued

Element

Description

Element

Description

TotalTransitDistance

The distance from the origin to the destination. Returned
for Custom Critical shipments.

DeliverySignatureName

DistanceToDestination

Total distance package still has to travel. Returned for
Custom Critical shipments.

This is either the name of the person that signed for the
package or "Signature not requested" or "Signature on
file."

PieceCountVerificationDetails

Specifies the details about the count of the packages
delivered at the delivery location and the count of the
packages at the origin.

PieceCountVerificationDetails/
CountLocationType

The type of location.

DestinationAddress

The address this package is to be (or has been) delivered.

HoldAtLocationContact

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

HoldAtLocationAddress

The address this package is requested to be placed on
hold at.

DestinationLocationAddress

The address of the FedEx delivery location/facility.

AppointmentDeliveryTimestamp

Date and time the package would be delivered if the
package has appointment delivery as a special service.

PieceCountVerificationDetails/Count

The count of the pieces in the form of a non-negative
integer.

EstimatedDeliveryTimestamp

Projected package delivery time based on ship time stamp,
service and destination. Not populated if delivery has
already occurred.

PieceCountVerificationDetails/
Description

Describes the piece count verification.

AvailableImages

The type of image available.

ActualDeliveryTimestamp

The time the package was actually delivered.

Signature

The signature image if available.

ActualDeliveryAddress

Actual address where package was delivered. Differs from
destination address, which indicates where the package
was to be delivered; This field tells where delivery actually
occurred, such as next door, at station and so on.

NotificationEventsAvailable

The types of email notifications that are available for the
package.

SplitShipmentParts

Returned for cargo shipments only when they are currently
split across vehicles. Applies to FedEx Freight shipments.

Valid values are:
• DESTINATION
• ORIGIN

OfficeOrderDeliveryMethod

Identifies the method of office order delivery.

DeliveryLocationType

Strict text indicating the delivery location at the delivered
to address.

SplitShipmentParts/PieceCount

The number of pieces in this part.

SplitShipmentParts/Timestamp

The date and time this status began.

User/screen friendly representation of the
DeliveryLocationType (delivery location at the delivered to
address). Can be returned in localized text.

SplitShipmentParts/StatusCode

A code that identifies this type of status.

SplitShipmentParts/StatusDescription

A human-readable description of this status.

Specifies the number of delivery attempts made to deliver
the shipment.

RedirectToHoldEligibility

Indicates redirection eligibility as determined by tracking
service, subject to refinement/override by redirect-to-hold
service.

DeliveryLocationDescription

DeliveryAttempts

Valid values are:

FedEx Web Services, Developer Guide

62

Chapter 4

Tracking and Visibility Services
Table 14. TrackReply/CompletedTrackDetails/TrackDetails Elements, continued
Element

Description

Events

Event information for a tracking number.

Events/Timestamp

The time this event occurred.

Events/EventType

Carrier's scan code. Pairs with EventDescription.

Events/EventDescription

Literal description that pairs with the EventType.

Events/StatusExceptionCode

Further defines the Scan Type code's specific type, such as
DEX08 business closed. Pairs with
StatusExceptionDescription.

Events/StatusExceptionDescription

Literal description that pairs with the StatusExceptionCode.

Events/Address

Address information of the station that is responsible for
the scan.

Events/StationId

Station identification.

Example TrackReply

SUCCESS

SUCCESS
trck
0
Request was successfully
processed.
Request was successfully
processed.


Basic_TrackRequest_q0_Internal

EN
us




trck
7
0
0


SUCCESS

SUCCESS
trck
0
Request was successfully
processed.
Request was successfully
processed.

false
false


SUCCESS
trck
0
Request was successfully
processed.
Request was successfully
processed.

797843158299
2455910000

DL
Delivered

false

FedEx Web Services, Developer Guide

63

Chapter 4

Tracking and Visibility Services


FDXE
FedEx
Express


SHIPPER_REFERENCE
0356649



FEDEX_2_DAY
FedEx 2Day
Service

0
0
2011-12-14T00:00:00

STAFFORD
VA
US
false

2011-12-16T16:11:00

STAFFORD
VA
US
false

0
Signature not
required


INELIGIBLE

2011-12-16T16:11:00
DL
Delivered
02
Package
delivered to recipient address - release
authorized

STAFFORD
VA
22556
US
false






Tracking Scans
This table defines the tracking scan codes:
Table 15. Tracking Status Scan Codes
Code

Definition

Code

Definition

AA

At Airport

EO

Enroute to Origin Airport

AD

At Delivery

EP

Enroute to Pickup

AF

At FedEx Facility

FD

At FedEx Destination

FedEx Web Services, Developer Guide

64

Chapter 4

Tracking and Visibility Services
Table 15. Tracking Status Scan Codes, continued
Code

Definition

Code

Definition

AP

At Pickup

HL

Hold at Location

CA

Shipment Canceled

IT

In Transit

CH

Location Changed

LO

Left Origin

DE

Delivery Exception

OC

Order Created

DL

Delivered

OD

Out for Delivery

DP

Departed FedEx Location

PF

Plane in Flight

DR

Vehicle Furnished, Not Used

PL

Plane Landed

DS

Vehicle dispatched

PU

Picked Up

DY

Delay

RS

Return to Shipper

EA

Enroute to Airport delay

SE

Shipment Exception

ED

Enroute to Delivery

SF

At Sort Facility

EO

Enroute to Origin airport

SP

Split status - multiple statuses

EP

Enroute to Pickup

TR

Transfer

Signature Proof of Delivery (SPOD)
To confirm a shipment has been received and signed for, you can use the
SPOD request Fax or Letter function of the TrackService WSDL. With this
feature, you can request a letter that includes a graphic of the recipient’s
signature for FedEx Express and FedEx Ground shipments.

Service Details
• To view detailed SPOD information, include the 9-digit FedEx account
number in the SPOD Fax or Letter request.

• If an account number is not provided, or if it does not match the shipper
or payer, then only summary SPOD information will be provided.
• If an SPOD Letter is requested, it will be returned in PDF format that can
be printed, browsed, or emailed.
• An SPOD Fax request will request a Fax format of the SPOD to be sent to
a specific Fax number.
• There is no charge for SPOD.
For more detailed information about the services offered by FedEx, see the
electronic FedEx Service Guide.

SPODLetterRequest Elements
Use this request if the SPOD should be sent as a letter.
In addition to basic elements required for all transactions, the following
elements make up the SPODLetterRequest.
See Chapter 1: Introduction for more information.
Table 16. SPOD Letter Request Elements
Element

Required

Description

TrackingNumber

Yes

Shipment tracking number.

ShipDate

No

Date on which package was shipped.

AccountNumber

No

Account number associated with the shipment.

Carrier

No

FedEx service that delivered the package.

Destination

No

Only country is used for elimination of duplicate tracking
numbers.

AdditionalComments

No

Any additional information.

LetterFormat

Yes

Specify the letter format. Must be included when type is
set to Letter.

Consignee

No

Information to be substituted for recipient information in
the letter.

FedEx Web Services, Developer Guide

65

Chapter 4

Tracking and Visibility Services
Example SPODLetterRequest



XXXXXXXX
XXXXXXXX



XXXXXXXX
XXXXXXXX


**SPOD
REQUEST**


trck
6
0
0


XXXXXXXX
YYYY-MM-DD
XXXXXXXX

PDF


Table 17. SPOD Letter Reply Elements
Element

Description

Letter

Base64-encoded SPOD letter.

SPODFaxRequest Elements
Use this request if the SPOD should be sent as a Fax.
In addition to basic elements required for all transactions, the following
elements make up the SPODFaxRequest.
See Chapter 1: Introduction for more information.
Table 18. SPOD Fax Request Elements
Element

Required

Description

TrackingNumber

Yes

Shipment tracking number.

ShipDate

No

Date on which the package was shipped.

AccountNumber

No

Account number associated with the shipment.

Carrier

FedEx service that delivered the package.

Destination

Only country is used for elimination of duplicate tracking
numbers.

AdditionalComments

No

Any additional information.

FaxSender

No

Contract and address information about the person
requesting the fax to be sent.

SPODLetterReply Elements

FaxRecipient

In addition to standard reply elements, the following element is returned in a
successful SPODLetterReply.

Consignee

Contract and address information, including the fax number,
about the person to receive the fax.
No

Information to be substituted for recipient information in
the letter.

See Chapter 1: Introduction for more information.

FedEx Web Services, Developer Guide

66

Chapter 4

Tracking and Visibility Services
SPODFaxReply Elements
In addition to standard reply elements, the following element is returned in a
successful SPODFaxReply.
See Chapter 1: Introduction for more information.

applicable. For a sample see the following SPOD Sample Letter – Partial
example.

Detailed SPOD

• Use Tracking to check the status of your shipment at any time during and
within 18 months after delivery.

You can obtain a SPOD letter with detailed information by providing the 9digit FedEx account number. If the account number matches the shipper or
payer of the shipment, you will be able to view detailed SPOD information,
which includes complete contact name, company name, street address, city,
state/province, postal code, and country information for both the shipper and
recipient (if available). The signature image and additional recipient
information may not be available for display in all countries and will be
indicated on the SPOD where applicable. For a sample see the following
SPOD Sample Letter – Full example.

• Use SPOD to obtain an image of the recipient's signature (if the signature
is available) once the shipment has been delivered.

Service Availability

SPOD Data Availability

You can get proof-of-delivery for FedEx Express and FedEx Ground shipments
that were delivered to destinations worldwide (where available). For more
information, contact FedEx Customer Service.

Table 19. SPOD Fax Reply Elements
Element

Description

FaxConfirmationNumber

Number of the FAX where confirmation is to be sent.

Tracking and SPOD Differences

Signature Proof of Delivery is available for FedEx Express and FedEx Ground
shipments up to 18 months from the ship date. This includes the signature
image and associated shipment data. The signature image and additional
recipient information may not be available for display in all countries and is
indicated on the SPOD where applicable.

Summary SPOD
You can obtain a SPOD letter with summary information without providing the
9-digit FedEx account number. This letter contains all the same information as
Detailed SPOD, but only contains the city, state/province, and country
information for the shipper and recipient. The signature image may not be
available for display in all countries and is indicated on the SPOD where

No Signature Found
Signatures can take up to five days to process. Even if no signature is
available, you can receive the available proof of delivery information. You can
also check again later for the signature. If no signature is available after
seven business days, call 1.800.GoFedEx 1.800.463.3339.
Note: The signature may be unavailable if it was released (the shipper or recipient signed a
signature release agreement).
SPOD requests cannot be batch-processed. If you need multiple SPOD documents, you must
create multiple requests. The returned SPOD PDF buffer is encoded in Base64 and then must
be Base64 decoded.

FedEx Web Services, Developer Guide

67

Chapter 4

Tracking and Visibility Services
SPOD Sample Letter – Partial

SPOD Sample Letter – Full

FedEx Web Services, Developer Guide

68

Chapter 4

Tracking and Visibility Services
Notification
Notification may be included using the TrackService WSDL
SendNotificationsRequest or in the ShipService. Notification allows you to
request that email exception and delivery notifications be sent to you, your
recipient, and up to 2 other email addresses. A personal message can also be
included.
Note: If you include notification elements in a Ship request, you do not need to use the
TrackService WSDL SendNotificationsRequest for that shipment. The TrackService WSDL
SendNotificationsRequest is provided if no notification request has been made for an
undeliverable shipment.

• A personal message (up to 120 characters) is allowed for email
notifications only. This element is not allowed for wireless notifications.
• You may select a valid language code for your communication. If no
language code is indicated in the service request, the default is EN. The
following table lists the valid language codes:
Table 20. Valid Language Codes for Notification Service
Value

Language

DA

Danish

DE

German

Notification Service Details

EN

English (default value)

The following service details apply:

ES

Spanish (Latin American)

ES

ES

Spanish (North America)

US

FR

French (Canada)

CA

FR

French (Europe)

IT

Italian

JA

Kanji (Japan)

• Shipment, delivery and tendered notifications are available for FedEx
SmartPost® Returns. Email exception is not available.

KO

Korean

NL

Dutch

• There are two notification options:

PT

Portuguese (Latin America)

1. Exception notification, such as if an exception occurs during scanning
and the package may be delayed, or if an address correction is
required

SV

Swedish

ZH

Chinese (simplified)

CN

ZH

Chinese (Taiwan)

TW

2. Delivery notification

ZH

Chinese (Hong Kong)

HK

• Send notification of package state to up to four email addresses.
Note: If the notification request is for an international package, you may identify one of
the notification recipients as a broker.

• FedEx services offering this feature are FedEx Express (including intraMexico), FedEx Ground, FedEx Home Delivery (FHD), FedEx Custom Critical
(FXCC), FedEx SmartPost (FXSP), and FXFR (FedEx Freight).

• You must choose between these delivery types: wireless (to a cell phone),
text only email, and HTML email.

Locale Code (required if
indicated below)

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

69

Chapter 4

Tracking and Visibility Services
Notification Coding Details
In addition to the standard elements required for all transactions, the
following elements are provided as part of the TrackService WSDL
SendNotificationsRequest.
See Chapter 1: Introduction for more information.

Table 21. Send Notifications Request Elements, continued
Element

Required

EMAIL_NOTIFICATION is present in the
SpecialServiceTypes collection.
NotificationDetail/
PersonalMessage

Optional

A message that will be included in the email
notifications. Personal messages are not applicable
with wireless formatted notifications such as UTF-8
encoded message.

NotificationDetail/Recipients

Required

Information describing the destination of the email
format of the email and events to be notified on.
Specify up to six email addresses to receive the
specified notification.

NotificationDetail/Recipients/
EMailNotificationRecipientType

Optional

Identifies the relationship this email recipient has to
the shipment.

SendNotificationsRequest Elements
Table 21. Send Notifications Request Elements
Element

Required

Description

TrackingNumber

Required

Tracking number.

MultiPiece

Optional

Indicates whether to return tracking information for
all associated packages.

PagingToken

Optional

To obtain additional data on second and subsequent
SendNotifications requests. Client must submit this
value in subsequent track requests in order to obtain
next page of data. Must contain at least four
characters.

TrackingNumberUniqueId

Optional

Populate only if the TrackingNumberUniqueId is
known from a previous Tracking request or an email
notifications request that resulted in a duplicate reply.

ShipDateRangeBegin

Optional

Recommend providing date range to find desired track
number by limiting the results to this range. If not
provided FedEx will default to a range that may not
be useful for the search.

ShipDateRangeEnd

Optional

If provided, ShipDateRangeBegin is required.

SenderEMailAddress

Required

Valid email address of notification requestor.

SenderContactName

Required

Valid contact name of notification requestor.

NotificationDetailEMail

Optional

Descriptive data required for FedEx to provide email
notification to the customer regarding the shipment.
This element is required when SpecialServiceType

Description

Valid values are:
•
•
•
•

BROKER
OTHER
RECIPIENT
SHIPPER

EMailNotificationDetail/
Recipients/EmailAddress

Required

The email address of the notification recipient.

EMailNotificationDetail/
Recipients/
NotificationEventsRequested

Optional

Identifies if an email notification should be sent to
the recipient:
• ON_DELIVERY
• ON_EXCEPTION
• ON_SHIPMENT
• ON_TENDER

EMailNotificationDetail/
Recipients/Format

Required

This element is required to specify the type of
notification you want to receive. Valid values are:
• HTML
• TEXT
• WIRELESS

FedEx Web Services, Developer Guide

70

Chapter 4

Tracking and Visibility Services
Table 21. Send Notifications Request Elements, continued
Element

Required

Description

EMailNotificationDetail/
Recipients/Localization

Required

The language/locale to be used in this email
notification

Recipients/Localization/
LanguageCode

Required

You may include a language code to have the email
message returned in that language. See Notification
Service Details on page 69 for a table of valid
language codes. If no value is included with this
element, the default is en (English).

Recipients/Localization/
LocaleCode

Optional

Some languages require a locale code to further
identify the requested language. For example, if you
request the notification emails in Spanish, you must
include a locale code of U.S. for North American
Spanish. See Notification Service Details on page 69
for a table of valid locale codes.

Example Send Notifications Request










0000000000000
00000000

en




TC10_IVR_TRACKBYNOTIFICATION

en



trck
7
0
0

797843158299
2455910000~797843158299
2011-12-14
2011-12-16
shriyash_khisti@syntelinc.com
shriyash

HI!!

SHIPPER
shriyash_khisti@syntelinc.com
ON_DELIVERY
TEXT

de


FedEx Web Services, Developer Guide

71

Chapter 4

Tracking and Visibility Services






SendNotificationsReply Elements
Table 22. SendNotificationsReply Elements
Element

Description

DuplicateWaybill

This element is present in the reply if duplicate tracking numbers are
found as part of the notification request.

MoreDataAvailable

Returned in the reply if additional notification data is available.

PagingToken

If you receive the MoreDataAvailable element in the reply, you will
also receive the PagingToken element with corresponding
PagingToken number. This number must be included in any additional
notification request, to receive additional data for your original
request.

Packages

Information about the notifications that are available for this tracking
number. If there are duplicates, then the ship date and destination
address information is returned for determining which
TrackingNumberUniqueIdentifier to use on a subsequent request.
This complex element includes:
•
•
•
•
•
•

Packages/TrackingNumber
UniqueIdentifiers

TrackingNumber
TrackingNumberUniqueIdentification
CarrierCode
ShipDate
Destination
RecipientDetails

When duplicate tracking numbers exist, this data is returned with
summary information for each of the duplicates. The summary
information is used to determine which of the duplicates the
intended tracking number is. This identifier is used on a subsequent

Table 22. SendNotificationsReply Elements, continued
Element

Description
track request to retrieve the tracking data for the desired tracking
number.

Example Send Notifications Reply

WARNING

WARNING
trck
30035
We are unable to provide notifications
because either the package is too old or there is more than one
package with the provided tracking number.
We are unable to provide
notifications because either the package is too old or there is
more than one package with the provided tracking
number.


TC10_IVR_TRACKBYNOTIFICATION

en



trck
7

FedEx Web Services, Developer Guide

72

Chapter 4

Tracking and Visibility Services
0
0

false
false

797843158299
2455910000
FDXE
2011-12-14

STAFFORD
VA
US
false




Table 23. FedEx InSight Elements, continued
Element

Description
These multiple occurrence elements can be repeated up to 50 times
for a single tracking number.

For more information regarding FedEx InSight, go to fedex.com/insight.
For more information about shipping notification, see Chapter 25: Shipment
Notification in the Ship Request.

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.

FedEx InSight
As part of the ShipService WSDL, you may add additional elements to your
ProcessShipment request to customize your FedEx InSight information:
Table 23. FedEx InSight Elements
Element

Description

RequestedShipment/
BlockInsightVisibility

Optional. If true, only the shipper/payor will have visibility of this
shipment.

RequestedPackageLineItem/
ContentRecords

Includes the following elements:
• PartNumber
• ItemNumber
• ReceivedQuantity
• Description

4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

FedEx Web Services, Developer Guide

73

Chapter 4

Tracking and Visibility Services
Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

FedEx Web Services, Developer Guide

74

5 Global Ship Address Service

Global Ship Address

Chapter 5

Global Ship Address Service
The GlobalShipAddress WSDL searches for, and returns, the addresses of the
nearest FedEx package drop-off locations, including FedEx Office® Print and
Ship Center locations.

Global Ship Address
Use the Global Ship Address service 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 Global Ship Address service to find FedEx locations that provide
Hold at FedEx Location service.

Global Ship Address Service Details
The Global Ship Address Service lets you search for FedEx drop-off locations
by address, geographic coordinates or phone number.

• 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.
• FedEx SmartPost Hub
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, and so on.
The search request will also allow a customer to request 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, accepted
currency and location holidays for the locations that met the criteria specified
in the request.

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:

You may also narrow your search by the following:

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

• Packing Service available (most FedEx Office locations): FedEx will pack
your shipment for you (at an extra charge).

• Express Station
• Freight Service Center
• Ground Terminal
• Home Delivery Station
• Office Location

• Saturday Service available

• 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 dropoff 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 GlobalShipAddress WSDL returns up to 25 locations within a 50-mile radius of
your address.

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

FedEx Web Services, Developer Guide

76

Chapter 5

Global Ship Address Service
Global Ship Address 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:
Table 24. SearchLocationsRequest Coding Elements
Element

Required

Description

EffectiveDate

No

The date.

LocationsSearchCriterion

Yes

Specifies the criterion that may be used to search for
FedEx locations. Valid values are:
• ADDRESS
• GEOGRAPHIC_COORDINATES
• PHONE_NUMBER

Address

Yes

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

No

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

No

Name of city, town, etc.

Address/
StateOrProvinceCode

No

Identifying abbreviations for U.S. state, Canada province,
etc. Format and presence of this field will vary, depending
on country.

Address/PostalCode

No

Identification of a region (usually small) for mail/package
delivery. Format and presence of this field will vary,
depending on country.

Address/
UrbanizationCode

No

Relevant only to addresses in Puerto Rico.

Table 24. SearchLocationsRequest Coding Elements, continued
Element

Required

Description

Address/ CountryCode

Yes

The two-letter code used to identify a country. Required
when searching by any of the LocationsSearchCriterion,
even PhoneNumber and GeographicCoordinates.

Address/ CountryName

No

the fully spelled out name of a country.

Address/Residential

No

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

PhoneNumber

No

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

No

Geographic coordinates if the search criterion is
GEOGRAPHIC_COORDINATES. ISO 6709 format, for
example +40.75-074.00/

MultipleMatchesAction

No

Specifies the criterion to be used to return location results
when there are multiple matches. Valid values are:
• RETURN_ALL
• RETURN_ERROR
• RETURN_FIRST

SortDetail

No

Specifies the details on how the location search results
will be sorted in the reply.

SortDetail/Criterion

No

Specifies the criterion to be used to sort the location
details. Valid values are:
• DISTANCE
• LATEST_EXPRESS_DROPOFF_TIME
• LATEST_GROUND_DROPOFF_TIME
• LOCATION_TYPE

SortDetail/Order

No

Specifies the sort order of the location details. Valid values
are:
• HIGHEST_TO_LOWEST
• LOWEST_TO_HIGHEST

FedEx Web Services, Developer Guide

77

Chapter 5

Global Ship Address Service
Table 24. SearchLocationsRequest Coding Elements, continued
Element

Required

Description

Constraints

No

Constraints to be applied to location attributes.

Constraints/
RadiusDistance

No

Specifies the value and units of the radius around the
address to search for FedEx locations.

Constraints/
RadiusDistance/Value

No

Identifies the maximum distance to return locations for.

Constraints/
RadiusDistance/Units

No

Identifies the unit of measure for the distance value. Valid
values are:
• KM
• MI

Constraints/
ExpressDropOffTimeNeed
ed

No

The latest time at which the customer can drop off a
package for being shipped using an Express service.

Constraints/ResultsFilters

No

Specifies the criteria used to filter the results of locations
searched. The only valid value is
EXCLUDE_LOCATIONS_OUTSIDE_STATE_OR_PROVINCE

Constraints/
SupportedRedirectToHold
Services

No

Specifies the types of services supported by a FedEx
location for redirect to hold. Valid values are:
• FEDEX_EXPRESS
• FEDEX_GROUND
• FEDEX_GROUND_HOME_DELIVERY

Constraints/
No
RequiredLocationAttribute
s

Locations must support the specified requirement to be
listed in the reply. Valid values are:
• ACCEPTS_CASH
• ALREADY_OPEN
• COPY_AND_PRINT_SERVICES
• DANGEROUS_GOODS_SERVICES
• DIRECT_MAIL_SERVICES
• EXPRESS_FREIGHT_DROPOFFS
• EXPRESS_PARCEL_DROPOFFS
• FEDEX_FREIGHT_DROPOFFS

Table 24. SearchLocationsRequest Coding Elements, continued
Element

Required

Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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

Constraints/ResultsToSkip No

A positive number indicating the number of results to skip.

Constraints/
ResultsRequested

No

A positive number indicating the number of results
requested.

Constraints/
LocationContentOptions

No

The
•
•
•

Constraints/
LocationTypesToInclude

No

Identifies a kind of FedEx facility. Valid values are:
• FEDEX_AUTHORIZED_SHIP_CENTER
• FEDEX_EXPRESS_STATION
• FEDEX_FREIGHT_SERVICE_CENTER
• FEDEX_GROUND_TERMINAL
• FEDEX_HOME_DELIVERY_STATION

options provided for the location. Valid values are:
HOLIDAYS
LOCATION_DROPOFF_TIMES
MAP_URL

FedEx Web Services, Developer Guide

78

Chapter 5

Global Ship Address Service
Table 24. SearchLocationsRequest Coding Elements, continued
Element

Required

Description
• FEDEX_OFFICE
• FEDEX_SELF_SERVICE_LOCATION
• FEDEX_SMART_POST_HUB

Successful reply data (based on your search criteria) are returned in a
SearchLocationsReply:
Table 25. SearchLocationsReply Elements
Element

Description

TotalResultsAvailable

Specifies total number of location results that are available.

ResultsReturned

Specifies the number of location results returned in this reply.

FormattedAddress

Specifies the address formatted to have correct postal code per USPS
standards.

AddressToLocationRelationsh The details about the relationship between the address requested and
ip
the locations returned.
AddressToLocationRelationsh Address as provided in the request.
ip/MatchedAddress
AddressToLocationRelationsh Specifies the geographic coordinates for the matched address.
ip/
MatchedAddressGeographicC
oordinates
AddressToLocationRelationsh Specifies the distance between the matched address and the
ip/
addresses of matched FedEx locations. Also specifies the details of
DistanceAndLocationDetails the FedEx locations.

Example SearchLocationsRequest




XXXXXXXXX
XXXXXXXXX



XXXXXXXXX
XXXXXXXXX


gsai
1
0
0

2012-04-30
ADDRESS

9255 MAIN STREET
KANSAS CITY
MO
64114
US

RETURN_ALL

DISTANCE
LOWEST_TO_HIGHEST



100
MI

FEDEX_EXPRESS

FedEx Web Services, Developer Guide

79

Chapter 5

Global Ship Address Service
COPY_AND_PRINT_SERVICES

3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."

LOCATION_DROPOFF_TIMES

5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.

FEDEX_OFFICE



6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.

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 http://fedex.com/
developer.

Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

2. Enter your username and password to login to the DRC.

FedEx Web Services, Developer Guide

80

6 Pickup Service

Pickup

Samples

Cancel Pickup Service

Error Messages

Pickup Availability

Chapter 6

Pickup Service
The FedEx pickup web service allows you to schedule a courier to pick up a
shipment, cancel a pickup request, or check for pickup availability.

Pickup
Use the Pickup Service to schedule courier pickup of a shipment at the
location specified in the transaction.

the current day; however, you can schedule a pickup on Sunday or a
holiday for the next business day.
• 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.

Pickup Service Details

• You cannot change a pickup request. To change a request, you must
delete the original request and enter a new request.

FedEx Express® pickup requests:

General information:

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

• 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.
See Appendix A: Country Code Tables for a complete list.

• 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.
For more information about your cut-off time, call FedEx Customer Service at
1.800.GoFedEx 1.800.463.3339.
FedEx Ground® pickup requests:

• If you need to schedule a pickup for both FedEx Express (including intraMexico 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.
• 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 GlobalShipAddress WSDL to
receive a list of Saturday drop-off locations.

• Pickup can be scheduled for the next business day or any business day up
to 2 weeks in advance. A FedEx Ground pickup cannot be scheduled for
FedEx Web Services, Developer Guide

82

Chapter 6

Pickup Service
• 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.

Table 26. Pickup Service Request Elements, continued
Element

•
•
•
•
•

• If you want a regular FedEx Express or FedEx Ground pickup service,
contact your FedEx account executive.
For more detailed information about the services offered by FedEx, see the
electronic FedEx Service Guide.

Pickup Service Request Elements
In addition to the elements required for all requests, the following elements
are included in the Pickup Service request:

Description

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:
• Y — Use shipper Address
• N — User Alternate Address
If you enter N, the PickupLocation element is required.

OriginDetail/PickupLocation

OriginDetail/PackageLocation

OriginDetail/BuildingPartCode

This element is required for alternate pickup addresses. Valid
elements are:
• Contact
• Address
Provides a location description where the courier/driver will pick up
the package. PickupServiceBuildingLocationType: Valid values are:
• FRONT
• NONE
• SIDE
• 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.

OriginDetail/
CompanyCloseTime

Your company close time is required for a successful dispatch
request. The time between the ReadyTimestamp and the
CustomerCloseTime must be no less than a length of time called the
AccessTime, which can be discovered with a
PickupAvailabilityRequest.

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.

PickupServiceRequest/
OversizePackageCount

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

Required for international APAC customers only. Provides area for any
additional commodity description. Field is limited to 20 characters
since P2D and Cosmos restrict the commodity description to 20
characters.

Table 26. Pickup Service Request Elements
Element

Description

FedEx Web Services, Developer Guide

83

Chapter 6

Pickup Service
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.
Element

Description

FreightDetail/Service

Valid FedEx Freight service type.

FreightDetail/BookingNumber

All freight shipments required an advanced booking number from
FedEx. This booking number is also required for freight dispatch
requests.

FreightDetail/Dimensions

Length, width, and height of freight shipment to be picked up.

FreightDetail/TruckType

Type of truck required for pickup. Valid values are:
• Drop_Trailer_Agreement
• Liftgate
• Tractor_Trailer_Access

FreightDetail/TrailerSize

Trailer size required for dispatch. Valid values are:
• TRAILER_28_FT
• TRAILER_48_FT
• TRAILER_53_FT

Example CreatePickupRequest



XXXXXXXXXX
XXXXXXXXXX



XXXXXXXXXX
XXXXXXXXXX


**TEST
TRANSACTION**



disp
5
0
0


FEDEX_EXPRESS
XXXXXXXXXX


false


Robert Johnson
Sweet Home Chicago
3125551212


7674 WASHINGTON AVE SO
EDEN PRAIRIE
MN
55344
US
false


REAR
2011-08-02T08:00:18.282Z
17:00:00

2

LB
200

FDXG
Courier Pickup Request


FedEx Web Services, Developer Guide

84

Chapter 6

Pickup Service
Pickup Service Reply Elements

Table 28. Pickup Service Country Codes, continued

The following elements are returned in the Pickup Service reply:

Code

Country

Code

Country

Table 27. Pickup Service Reply Elements

BB

Barbados

KN

St. Kitts/Nevis

Element

Description

BE

Belgium

KR

South Korea

DispatchConfirmationNumber

FedEx returns a dispatch confirmation number for a successful
dispatch request. This number must be used if you need to cancel
the dispatch.

BG

Bulgaria

KW

Kuwait

BH

Bahrain

KY

Cayman Islands

BM

Bermuda

LC

St. Lucia

BR

Brazil

LK

Sri Lanka

BS

Bahamas

LU

Luxembourg

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.

CA

Canada

MQ

Martinique

CH

Switzerland

MX

Mexico

CL

Chile

MY

Malaysia

PRP, Package Returns Program, 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.

CO

Colombia

NL

Netherlands

CR

Costa Rica

NZ

New Zealand

CZ

Czech Republic

PA

Panama

DE

Germany

PH

Philippines

Pickup Service Country Codes

DK

Denmark

PL

Poland

Table 28. Pickup Service Country Codes

DO

Dominican Republic

PR

Puerto Rico

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.

PRP Control Number

Code

Country

Code

Country

EC

Ecuador

SE

Sweden

AE

United Arab Emirates

IE

Ireland

EG

Egypt

SG

Singapore

AN

Netherlands Antilles

IL

Israel

ES

Spain

SV

El Salvador

AR

Argentina

IN

India

FI

Finland

TC

Turks & Caicos Islands

AT

Austria

IT

Italy

FR

France

TT

Trinidad/Tobago

AU

Australia

JM

Jamaica

GB

United Kingdom

TW

Taiwan

AW

Aruba

JP

Japan

GD

Grenada

US

United States

FedEx Web Services, Developer Guide

85

Chapter 6

Pickup Service
Table 28. Pickup Service Country Codes, continued

Table 29. Cancel Pickup Service Request Elements, continued

Code

Country

Code

Country

Element

Description

GP

Guadeloupe

UY

Uruguay

ScheduledDate

Indicates the date the dispatch occurs.

GT

Guatemala

VC

St. Vincent

Location

HK

Hong Kong

VE

Venezuela

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.

HN

Honduras

VG

British Virgin Islands

CourierRemarks

HU

Hungary

VI

U.S. Virgin Islands

Any additional information for the FedEx courier regarding the
dispatch cancellation.

ID

Indonesia

Cancel Pickup Service
Use the Cancel Pickup Service to cancel a pickup request.

Cancel Pickup Service Details
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.

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 29. Cancel Pickup Service Request Elements
Element

Description

DispatchConfirmationNumber

This number is received from FedEx in your dispatch reply and is
required for canceling a dispatch request.

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



XXXXXXXX
XXXXXXXX



XXXXXXXX
XXXXXXXX


disp
5
0
0

FDXG

FedEx Web Services, Developer Guide

86

Chapter 6

Pickup Service
Table 30. Cancel a Pickup Request Elements, continued
CPU3821280
2012-05-09
TEST REMARKS
NO LONGER NEEDED


Cancel Pickup Request/Reply Coding Details for
FedEx Freight

Element

Description

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.

Remarks

Identifies comments the customer wants to convey to the FedEx
courier regarding the package pickup.

ShippingChargesPayment

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:

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.

Table 30. Cancel a Pickup Request Elements

PhoneNumber

Identifies the phone number of the person that requested pickup
cancellation.

PhoneExtension

Identifies the phone extension of the person that requested pickup
cancellation.

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.

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 31. Cancel a Pickup 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

87

Chapter 6

Pickup Service
Table 31. Cancel a Pickup Reply Elements, continued
Element

Description

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

Pickup Availability Coding Details
In addition to the basic service elements required for most transactions
(AuthenticationDetail and ClientDetail), the following elements are available
for a PickupAvailability request:
Table 32. PickupAvailability Elements
Element

Description

PackageReadyTime

Optional. Identifies the date and time the package will be ready for
pickup by FedEx. Express pickup can be scheduled for the current or
next business day. Format HHMM where valid time format HH is a
value between 00 and 24 and MM is not a value between 00 and 59.
Note: The Package Ready Time does equate to the time the driver
should arrive for the package

CompanyCloseTime

Optional. Specify your company close time. The ReadyTimeStamp and
the CompanyCloseTime must allow a long enough time period for a
FedEx courier to arrive at your pickup location. Format HHMM where
valid time format HH is a value between 00 and 24 and MM is not a
value between 00 and 59.

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

Optional. Specify the date for package pickup.

Version

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

StreetLines

Optional. Specify if a street address line(s) is required.

Includes a Human readable message from the dispatch system.

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

PostalCode

Required for FedEx Ground shipments if recipient country is a postal
aware country.

Message

Pickup Availability
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 on
page 89.

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.

FedEx Web Services, Developer Guide

88

Chapter 6

Pickup Service
Table 32. PickupAvailability Elements, continued
Element

Description

CountryCode

Required.

Table 33. Pickup Availability Request Elements, continued
Element

Description
container of "address parts" which should be handled as a unit, such
as a city-state-ZIP combination within the U.S.

For a list of valid codes, see Appendix A: Country Code Tables.
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.

Optional. Descriptive information about the package dimensions.

DispatchDate

Identifies the dispatch date (in the local time zone) for the pickup
whose availability is being requested.

Optional. Descriptive information about the package weight.

NumberOfBusinessDays

Identifies the number of business days to consider when checking
availability.

PackageReadyTime

Identifies the time when the package will be ready to be picked up.
The time is local to the pickup postal code, in 24-hour form, such as
13:00:00. It should not contain a TZD. If a TZD is included, it will be
ignored.

CustomerCloseTime

Identifies the latest time at which the courier will be able to gain
access to pick up the package(s). The time is local to the pickup
postal code, in 24-hour form, such as 17:00:00. It should not contain
a TZD. If a TZD is included, it will be ignored.

Carriers

Identifies the FedEx carrier(s) for which availability is requested.

CountryName

Required. The fully spelled out name of a country.

PickupRequestType

Required. Request type valid values are:
• SAME_DAY
• FUTURE_DAY

Carriers

Required. FedEx service (FedEx Express, FedEx Ground) performing the
pickup. Valid values are:
• FDXG
• FDXE

PickupShipmentAttributes/
dimensions
PickupShipmentAttributes/
weight

Pickup Availability Request/Reply Coding Details
for FedEx Freight
Pickup Availability Request Elements
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 33. Pickup Availability Request 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

Valid values are:
•
•
•
•

FDXC
FDXE
FDXG
FXCC

FedEx Web Services, Developer Guide

89

Chapter 6

Pickup Service
Table 33. Pickup Availability Request Elements, continued
Element

Description
• FXFR
• FXSP

ShipmentAttributes

2011-08-22
1
08:00:00
18:00:00
FDXG


Includes descriptive information about the shipment.

Pickup Availability Reply Elements
Example PickupAvailabilityRequest



XXXXXXXX
XXXXXXXX



XXXXXXXX
XXXXXXXX


disp
5
0
0


FEDEX_EXPRESS
XXXXXXXX


1704 Rountree Bridge
Sparks
GA
31647
US
false

FUTURE_DAY

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

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

90

Chapter 6

Pickup Service
Table 34. Pickup Availability Reply Elements, continued
Element

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

Table 34. Pickup Availability Reply Elements, continued
Element

Description

CloseTime

Identifies the close time corresponding to the specified
CloseTimeType.

LocalTime

Identifies the local time of the service center that will service the
pickup.

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.

4. Expand "FedEx Web Services for Shipping" and choose "Get Started."

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 (in the postal code's time
zone) for a postal code. As a local time, it will not include a Time
Zone Designator.

5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.

Options/AccessTime

Identifies the minimum required length of the window of time
between the ReadyTime and CustomerCloseTime.

Options/ResidentialAvailable
Options/CountryRelationship
CloseTimeType

Identifies whether the close time is specified by the customer or is
the default time. Valid values are:
• CUSTOMER_SPECIFIED
• DEFAULT

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.

6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

FedEx Web Services, Developer Guide

91

7 Close Shipment

FedEx Ground Close Ship Day Service Details
FedEx SmartPost Close Shipment Service Details

Chapter 7

Close 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.
Note: The Close transaction (GroundClose Request and/or SmartpostCloseRequest) is required
when processing Ground and/or SmartPost shipments.

FedEx Ground Close Ship Day Service
Details
The Close Service can be performed multiple times during your shipping day.
Use the Close Service to initiate the final stage of processing all shipment
data submitted by the customer for the day (close of business).

Note: Close is a requirement only for FedEx Ground®. FedEx Express® shipments are
automatically closed and do not require you to perform a specific close operation.

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

FedEx Ground Close Ship Day Coding Details
The following elements are required for a Close Service transaction:
Table 35. Ground Close Service Request Elements
Element

Requirements

GroundCloseRequest

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.

SmartPostCloseRequest

Initiates the final stage of processing all shipment data
submitted by the customer for the day (close of business) for
FedEx SmartPost shipments.

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.

ReprintGroundCloseDocumentsReques
t

Prints the user specified reports that were generated when
the Close was processed.

TimeUpToWhichShipmentsAreTo
BeClosed

Identifies the date and time up to which shipments are to be
closed. Both date and time should be included in the Close
request.

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

In addition to the ground manifest, the following reports are returned after a
successful close and need to be printed (if shipments with these services are
included in the Close transaction):
• 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.

The following elements are required for a FedEx Ground Close Service with
Documents request:
Table 36. GroundCloseWithDocumentsRequest Elements
Element

Requirements

CloseDate

Date on which shipments were closed.

FedEx Web Services, Developer Guide

93

Chapter 7

Close Shipment
Table 36. GroundCloseWithDocumentsRequest Elements, continued
Element

Requirements

CloseDocumentSpecification

Specifies characteristics of document(s) to be returned for
this request. You may request the following close documents.
• COD_REPORT
• MANIFEST
• MULTIWEIGHT_REPORT
• OP_950

The following elements may be returned in the Ground Close with Documents
reply:
Table 37. Ground Close Service with Document Reply Elements
Element

Requirements

HighestSeverity

Indicates the highest level of severity of all the notifications
returned in this reply.

Notifications

Descriptive data regarding the results of the submitted
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).

Close Document Type

Actual document contents for all provided reports.

Example GroundCloseWithDocumentsRequest



XXXXXXXX
XXXXXXXX




XXXXXXXX
XXXXXXXX

EN
US



**TEST
SHIPMENT**


clos
2
1
0

2012-08-16

MANIFEST



FedEx Ground Report Printing
When you perform a Close, FedEx Web Services generates four ground
reports:
• Ground Manifest
Note: The address in the header is pulled from the first package shipped that day for
that meter.

• C.O.D./E.C.O.D. Report
• Multiweight Detail
• Hazardous Materials Certification Report (U.S. only)

FedEx Web Services, Developer Guide

94

Chapter 7

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

SmartPost Small Shipper, you 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.

Additional elements for printing ground reports include the following:

If you are a SmartPost Large Shipper, you only need to process the SmartPost
Close.

Table 38. Printing Ground Reports 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
• HAZMAT
• MULTIWEIGHT

• FedEx SmartPost Close is independent of a FedEx Ground® Close. FedEx
Express® shipments are automatically closed and do not require you to
perform a specific close operation.
• No reports are returned in the FedEx SmartPost Close Reply.
• For more detailed information about the services offered by FedEx, see the
electronic FedEx Service Guide.

FedEx SmartPost Close Ship Day Coding Details
The following elements are required for a Close Service transaction:
Table 39. FedEx SmartPost Close Service Elements
Element

Requirements

WebAuthenticationDetail/
UserCredential/Key

The value for the Key was provided by FedEx upon your
request. It is an alphanumeric mixed-case string.

WebAuthenticationDetail/
UserCredential/Password

The value for the Password was provided by FedEx upon your
request. It is an alphanumeric mixed-case string.

ClientDetail/AccountNumber

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

FedEx SmartPost Close Shipment Service
Details

ClientDetail/MeterNumber

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

Version/ServiceId

The value is "clos"

The Close Service can be performed multiple times during your shipping day.
Use the Close Service to initiate the final stage of processing all shipment
data submitted by the customer for the day (close of business). If you are a

Version/Major

The current value is "2".

Version/Intermediate

The current value is "0".

TrackingNumber

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 Web Services, Developer Guide

95

Chapter 7

Close Shipment
Table 39. FedEx SmartPost Close Service Elements, continued
Element

Requirements

Version/Minor

The current value is "0".

HubId

Specify the HubId. Valid values are:
• 5185 ALPA Allentown
• 5303 ATGA Atlanta
• 5281 CHNC Charlotte
• 5602 CIIL Chicago
• 5929 COCA Chino
• 5751 DLTX Dallas
• 5802 DNCO Denver
• 5481 DTMI Detroit
• 5087 EDNJ Edison
• 5431 GCOH Grove City
• 5771 HOTX Houston

HubId

•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

5465 ININ Indianapolis
5648 KCKS Kansas City
5902 LACA Los Angeles
5254 MAWV Martinsburg
5379 METN Memphis
5552 MPMN Minneapolis
5531 NBWI New Berlin
5110 NENY Newburgh
5015 NOMA Northborough
5327 ORFL Orlando
5194 PHPA Philadelphia
5854 PHAZ Phoenix
5150 PTPA Pittsburgh
5958 SACA Sacramento
5843 SCUT Salt Lake City
5983 SEWA Seattle
5631 STMO St. Louis

Table 39. FedEx SmartPost Close Service Elements, continued
Element

Requirements
Note: Include only the numeric HubId value in your request.

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.

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.

FedEx Web Services, Developer Guide

96

Chapter 7

Close Shipment
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

FedEx Web Services, Developer Guide

97

8 Address Validation Service

Address Validation Request

Notification

Address Validation Service Details

Mapping Enterprise Address Service Changes

How FedEx Address Validation Works

Mapping Enterprise Address Service Residential Status

Tips on Getting Accurate Address Matches

Mapping Enterprise Address Service DeliveryPointValidation

Address Results

Mapping Enterprise Address Service Changes

Address Validation Coding Details

Known Service Issue

Chapter 8

Address Validation Service
Use the Address Validation Service to validate or complete recipient
addresses.

• Contains a database of company listing to improve your results (not all
companies are listed).

Validate recipient addresses before you ship packages, provide descriptive
error details and corrected options for invalid addresses, and/or determine
whether an address is business or residential to increase the accuracy of
courtesy rate quotes.

• Receives monthly updates to its address database.

Address Validation Request

• Does not currently verify suite or apartment numbers.

The AddressValidation WSDL AddressValidationRequest allows you to
validate recipient address information before you ship a package. Correct
addresses on the shipping label will 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.

Use the Address Validation request to perform the following:
• Confirm the validity and completeness of U.S., Puerto Rico, and Canadian
addresses.
• Complete incomplete recipient addresses.
• Correct invalid recipient addresses.
• Determine whether an address is business or residential to increase the
accuracy of courtesy rate quotes. Applies to U.S. addresses only.
Note: Use the information returned from an AddressValidationRequest as for suggested use
only, rather than a reference.

• Checks addresses within the United States, Puerto Rico, and Canada.
• Can distinguish between U.S. business and U.S. residential addresses if
an exact match is found.
• Does not match addresses based upon individual/personal names, but may
check an address by matching company names that correspond to street
addresses.
• CASS certified (Coding Accuracy Support System). A service and rating
system for mailers that measures and helps to improve address accuracy.
• 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.
For more detailed information about the services offered by FedEx, see the
electronic FedEx Service Guide.

How FedEx Address Validation Works
• Checks if the street exists in the city, state or province, or postal code
entered.

Address Validation Service Details

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

The followings service details apply to Address Validation:

• Informs you if no possible alternatives can be found based on the street
number, street name, city, state or province, or postal code entered.

• Provides street level matches.

• Up to 100 addresses can be checked in one Web Service request.
FedEx Web Services, Developer Guide

99

Chapter 8

Address Validation Service
Tips on Getting Accurate Address Matches

Address Results

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

You should confirm an address for accuracy before using it to ship a package.
Occasionally EAS will return multiple addresses. A case in point is when the
directional indicator is missing (e.g. North or South). To narrow your results,
you can provide more specific address information and check the address
again. To confirm the address accuracy, you can provide more specific
address data and check the address again.

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

• Street name such as Main, George Washington, 42nd

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.

• Street Suffix such as Road, Avenue, Rd, Ave

For example:

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.

Sr Pedro Rivera Urb Hermosillo 123 Calle 1 Bayamon, PR 00961-1212

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.

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

Provide additional address and street information: Providing additional
address information can increase the accuracy of address results. For
example:
• Building or house number such as 1, 1A, One

Company: Providing a company name may improve your results. Some
addresses have specific company names assigned to them. By including the
company name in your transaction, Address Validation can search for that
company and address.

Address Validation Coding Details
• Address
• City and State or Province or postal code

AddressValidationRequest Elements
Table 40. Address Validation Request Elements
Element

Required

Description

AddressValidationRequest/
RequestTimestamp

Required

Time of request based on shipper’s time zone. Defaults
to CDT.

FedEx Web Services, Developer Guide

100

Chapter 8

Address Validation Service
Table 40. Address Validation Request Elements, continued
Element

AddressValidationRequest/
AddressToValidate

Required

Required

Description

Optional

Element

Required

Description

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

StreetAccuracy: Values are: EXACT, TIGHT, MEDIUM,
and LOOSE.

See Appendix M: Time Zones for more information.

For U.S. addresses only, you can control the algorithm
to use when determining if an input address matches
an address in the postal database. Valid values are:

This element contains basic address information for
validation, including:
• Company
• City
• StateorProvinceCode
• PostalCode
• UrbanizationCode
• CountryCode
• CountryName
• Residential
Note: Up to 100 addresses can be validated in one
request.

AddressValidationRequest/
AddressValidationOptions

Table 40. Address Validation Request Elements, continued

In addition to address information, you can include the
following elements to further identify the type of
address validation information or formatting you want
in the reply:
VerifyAddresses to validate all address elements and
return in the reply.
CheckResidentialStatus check addresses for residential
status only.
MaximumNumberOfMatches allows you to configure
the number of possible matches returned. Maximum is
10.

DirectionalAccuracy: Values are EXACT, TIGHT,
MEDIUM and LOOSE.
CompanyNameAccuracy: Values are EXACT, TIGHT,
MEDIUM and LOOSE.

• EXACT: input must match the database exactly.
• TIGHT: matching of address is allowed for slight
variance
• MEDIUM: matching of address allows for more
variance of address and provides corrections
[default]
• LOOSE: matching of address is minimal
Warning: Selecting EXACT means that every part of
the address must match the postal database exactly,
and no correction will be made to the address for you.
It is recommended to use the MEDIUM setting to get
better results.
ConvertToUpperCase element controls whether
addresses are returned in upper case text.
RecognizeAlternateCityNames recognizes alternate city
names. For example, if you have an address whose city
is Hollywood, if the address can be verified as in Los
Angeles, address verification will be performed instead
of returning an error.
ReturnParsedElements returns the address validation
elements in the reply, as verified by the system before
validation.

FedEx Web Services, Developer Guide

101

Chapter 8

Address Validation Service
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 41. Address Validation Reply Elements, continued
Element

•
•
•
•
•
•

Table 41. Address Validation Reply Elements
Element

Description

AddressID

Every verified address is assigned an ID to help you
match submitted addresses with verified information.

ProposedAddressDetails/Score

The Score element is used to rate the submitted
address. If the Score is too low, the service returns the
“Address Not Validated” message. The Score is an
integer ranging from 0 to 100, with 100 being the
highest and zero indicating failure.

ProposedAddressDetails/Changes

Returned values are:
• APARTMENT_NUMBER_NOT_FOUND
• APARTMENT_NUMBER_REQUIRED
• NORMALIZED
• REMOVED_DATA
• BOX_NUMBER_REQUIRED
• NO_CHANGES
• MODIFIED_TO_ACHIEVE_MATCH
• STREET_RANGE_MATCH
• BOX_NUMBER_MATCH**
• RR_OR_HC_MATCH
• CITY_MATCH
• POSTAL_CODE_MATCH
• RR_OR_HC_BOX_NUMBER_NEEDED
• FORMATTED_FOR_COUNTRY
• APO_OR_FPO_MATCH
• GENERAL_DELIVERY_MATCH
• FIELD_TRUNCATED

Description
UNABLE_TO_APPEND_NON_ADDRESS_DATA
INSUFFICIENT_DATA
HOUSE_OR_BOX_NUMBER_NOT_FOUND
POSTAL_CODE_NOT_FOUND
INVALID_COUNTRY
SERVICE_UNAVAILABLE_FOR_ADDRESS

**If BOX_NUMBER_MATCH is returned in the reply,
remember FedEx does not normally deliver to P.O. box
addresses for U.S. addresses or for U.S. inbound
shipments.
See Address Validation Coding Details for more
information.
ProposedAddressDetails/ResidentialStatus

Returned values are:
• UNDETERMINED
• BUSINESS
• RESIDENTIAL
• INSUFFICIENT_DATA
• UNAVAILABLE
• NOT_APPLICABLE_TO_COUNTRY

ProposedAddressDetails/
DeliveryPointValidation

Returned values are:
• CONFIRMED
• UNCONFIRMED
• UNAVAILABLE

ProposedAddressDetails/CompanyName

The company name as submitted for validation.

ProposedAddressDetails/Address

The address as submitted for validation.

ProposedAddressDetails/
ParsedCompanyName

The verified company name.

ProposedAddressDetails/ParsedAddress

The verified address.

FedEx Web Services, Developer Guide

102

Chapter 8

Address Validation Service
Table 41. Address Validation Reply Elements, continued
Element

Description

ProposedAddressDetails/RemovedNonAddressData

Any information removed from the submitted address
before validation.

Mapping Enterprise Address Service
Changes
Table 42. Enterprise Address Service Indicator Changes Elements
EAS addressIndicator
(indicator attribute)

Changes Element

Sample code, sample transactions and the specific individual WSDL/XML
guide(s) can be downloaded following these steps:

100

APARTMENT_NUMBER_NOT_FOUND

101

APARTMENT_NUMBER_REQUIRED

1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/
developer.

102

NORMALIZED

103

REMOVED_DATA

2. Enter your username and password to login to the DRC.

104

BOX_NUMBER_REQUIRED

3. Expand "Technical Resources" on the left pane.

200

NO_CHANGES

4. Expand "FedEx Web Services for Shipping" and choose "Get Started."

201

MODIFIED_TO_ACHIEVE_MATCH

5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.

202

STREET_RANGE_MATCH

203

BOX_NUMBER_MATCH

204

RR_OR_HC_MATCH

205

CITY_MATCH

206

POSTAL_CODE_MATCH

207

RR_OR_HC_BOX_NUMBER_NEEDED

208

FORMATTED_FOR_COUNTRY

209

APO_OR_FPO_MATCH

210

GENERAL_DELIVERY_MATCH

211

FIELD_TRUNCATED

212

UNABLE_TO_APPEND_NON_ADDRESS_DATA

300

INSUFFICIENT_DATA

301

HOUSE_OR_BOX_NUMBER_NOT_FOUND

Samples

6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Notification
If the Enterprise Address Service (EAS) returns a nonzero systemStatus, then
the AddressValidationReply will contain a severity notification of FAILURE and
a code equal to that systemStatus.

FedEx Web Services, Developer Guide

103

Chapter 8

Address Validation Service
Table 42. Enterprise Address Service Indicator Changes Elements, continued
EAS addressIndicator
(indicator attribute)

Changes Element

303

POSTAL_CODE_NOT_FOUND

305

INVALID_COUNTRY

400

SERVICE_UNAVAILABLE_FOR_ADDRESS

Mapping Enterprise Address Service
Residential Status
Table 43. Enterprise Address Service Residential Status Elements

Table 44. Enterprise Address Service DeliveryPointValidation Elements, continued
EAS dpvIndicator

DeliveryPointValidation Element

3

UNAVAILABLE

Mapping Enterprise Address Service
Changes
Table 45. Enterprise Address Service Indicator Changes Elements
EAS addressIndicator
(indicator attribute)

Changes Element

100

APARTMENT_NUMBER_NOT_FOUND

EAS businessResidentialIndicator

Residential Status Element

101

APARTMENT_NUMBER_REQUIRED

1

UNDETERMINED

102

NORMALIZED

2

BUSINESS

103

REMOVED_DATA

3

RESIDENTIAL

104

BOX_NUMBER_REQUIRED

4

INSUFFICIENT_DATA

200

NO_CHANGES

5

UNAVAILABLE

201

MODIFIED_TO_ACHIEVE_MATCH

6

NOT_APPLICABLE_TO_COUNTRY

202

STREET_RANGE_MATCH

203

BOX_NUMBER_MATCH

204

RR_OR_HC_MATCH

205

CITY_MATCH

206

POSTAL_CODE_MATCH

207

RR_OR_HC_BOX_NUMBER_NEEDED

Mapping Enterprise Address Service
DeliveryPointValidation
Table 44. Enterprise Address Service DeliveryPointValidation Elements
EAS dpvIndicator

DeliveryPointValidation Element

208

FORMATTED_FOR_COUNTRY

1

CONFIRMED

209

APO_OR_FPO_MATCH

2

UNCONFIRMED

210

GENERAL_DELIVERY_MATCH

FedEx Web Services, Developer Guide

104

Chapter 8

Address Validation Service
Table 45. Enterprise Address Service Indicator Changes Elements, continued
EAS addressIndicator
(indicator attribute)

Changes Element

211

FIELD_TRUNCATED

212

UNABLE_TO_APPEND_NON_ADDRESS_DATA

300

INSUFFICIENT_DATA

301

HOUSE_OR_BOX_NUMBER_NOT_FOUND

303

POSTAL_CODE_NOT_FOUND

305

INVALID_COUNTRY

400

SERVICE_UNAVAILABLE_FOR_ADDRESS

Known Service Issue
The Address Validation Web Service schema contains nested nodes that have
the maxOccurs attribute set. The Web Services Description Language Tool
(WSDL.exe), when used to generate the client information, creates
multidimensional arrays in the generated Reference.vb / Reference.cs file.
Therefore, the generated Reference file contains incorrect types for the
nested nodes.

To solve this issue:
• Search for string “()()” in Reference.vb or for string “[][]” in Reference.cs file; you’ll see Class ParsedAddress.
'''
 _
Partial Public Class ParsedAddres
Private parsedUrbanizationCodeField() As ParsedElement
Private parsedStreetLineField()() As ParsedElement
Private parsedCityField() As ParsedElement

_

– Remove extra “()” for VB.NET and “[]” for C# in front of parsedStreetLineField member.
/// 
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.Xml", "2.0.50727.42")]
[System.SerializableAttribute()]

FedEx Web Services, Developer Guide

105

Chapter 8

Address Validation Service
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://fedex.com/ws/
addressvalidation")]
public partial class ParsedAddress {
private ParsedElement[] parsedUrbanizationCodeField;
private ParsedElement[][] parsedStreetLineField;
private ParsedElement[] parsedCityField;

• Search for the next “()()” in Reference.vb or “[][]” in Reference.cs file; you’ll find Property ParsedStreetLine.
'''
 _
Public Property ParsedStreetLine() As ParsedElement()()
Get
Return Me.parsedStreetLineField
End Get
Set

• Remove extra “()” for VB.Net and “[]” for C# in front of the ParsedElement.
/// 
[System.Xml.Serialization.XmlArrayItemAttribute(
"Elements",
typeof(ParsedElement),
IsNullable=false)]
public ParsedElement[][] ParsedStreetLine {
get {
return this.parsedStreetLineField;
}
set

Note: Web reference changes will be lost and need to be made manually.

• Search for ParsedElement[ ][ ] in ParsedAddress.java; you will find first reference. Remove extra “[]” from ParsedElement[][].
FedEx Web Services, Developer Guide

106

Chapter 8

Address Validation Service
public class
private
private
private

ParsedAddress implements java.io.Serializable {
com.fedex.addressvalidation.stub.ParsedElement[] parsedUrbanizationCode;
com.fedex.addressvalidation.stub.ParsedElement[][] parsedStreetLine;
com.fedex.addressvalidation.stub.ParsedElement[] parsedCity;

• Continue the search for ParsedElement[ ][ ] in ParsedAddress.java; you will find another reference to ParsedElement[][]. Remove extra “[]” from
ParsedElement[][].
public ParsedAddress(
com.fedex.addressvalidation.stub.ParsedElement[] parsedUrbanizationCode,
com.fedex.addressvalidation.stub.ParsedElement[][] parsedStreetLine,
com.fedex.addressvalidation.stub.ParsedElement[] parsedCity,

• Continue the search for ParsedElement[ ][ ] in ParsedAddress.java; you will find another reference to ParsedElement[][]. Remove extra “[]” from
ParsedElement[][].
public com.fedex.addressvalidation.stub.ParsedElement[][] getParsedStreetLine() {
return parsedStreetLine;

• Continue the search for ParsedElement[ ][ ] in ParsedAddress.java; you will find another reference to ParsedElement[][]. Remove extra “[]” from
ParsedElement[][].
public void setParsedStreetLine(com.fedex.addressvalidation.stub.ParsedElement[]
[] parsedStreetLine) {this.parsedStreetLine = parsedStreetLine;}

• Comment the code out as mentioned below for the following get/set methods:
/*
public com.fedex.addressvalidation.stub.ParsedElement[] getParsedStreetLine(int i) {
return this.parsedStreetLine[i];
}
public void setParsedStreetLine(
int i, com.fedex.addressvalidation.stub.ParsedElement[] _value) {

FedEx Web Services, Developer Guide

107

Chapter 8

Address Validation Service
this.parsedStreetLine[i] = _value;
}
*/

FedEx Web Services, Developer Guide

108

9 Open Shipping

FedEx Services with Open Ship

Add Piece Transaction

Open Ship Process and Workflow

Modify Piece Transaction

About Web Services Open Ship Transactions

Delete Piece Transaction

Create Open Shipment

Delete Shipment Transaction

Route and Time-in-Transit Transaction

Confirm Shipment Transactions

Rate Open Ship Shipment Transaction

Open Ship Print Options

Chapter 9

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 fivedays,
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 50 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.

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 figure below illustrates the basic
work flow for processing an Open Ship shipment, unless the CONFIRM action
type is used.
Table 46. Open Ship Creation
Workflow Item

Description

1. CREATE
Shipment

To CREATE a shipment requires the CreateOpenShipmentRequest with required
shipment information and at least one package defined (Action type =
CREATE_PACKAGE or RequestedPackageLineItems information) in the request
for a tracking number to be returned.

This chapter describes the procedure for creating, modifying and deleting an
Open Ship shipment using Web Services and the OpenShip WSDL.

A tracking number for the shipment is assigned but no labels are printed for the
Open Ship CREATE shipment transaction.

FedEx Services with Open Ship

2 - 4. ADD Piece*

You can use the Open Ship shipping method for the following FedEx services:

*not to exceed 50
pieces per
shipment

• FedEx Express® intra-U.S. and intra-Canada
• FedEx Ground® intra-U.S. and intra-Canada
• FedEx Home Delivery®
®

• FedEx SmartPost

• FedEx International Priority®

5. CONFIRM
Shipment

Packages are processed individually by sending an
AddPackagesToOpenShipmentRequest. A unique tracking number is returned for
each piece (aka package) processed.

You must ADD a minimum of 1 (one) piece before you can CONFIRM an Open
Ship shipment.
To CONFIRM the shipment, send the ConfirmOpenShipmentRequest, or use the
CONFIRM action type.
Package labels and all other reports are returned in the CONFIRM shipment
response.

• FedEx International Priority® Freight
• FedEx International Economy®

About Web Services Open Ship
Transactions
Open Ship transactions consist of seven steps that perform these functions:

FedEx Web Services, Developer Guide

110

Chapter 9

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

during the CREATE transaction, then you must change the Ship Date to
the current day or later.
• To ship a multiple-piece shipment (MPS) to a single consignee, use Open
Ship to ADD individual packages to the shipment.
• 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.

6. VALIDATE shipment
7. RETRIEVE package and/or RETRIEVE shipment

Create Open Shipment

Rules for Open Ship Transactions

Use the CreateOpenShipment transaction to CREATE Open Ship shipments.

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 (Endof-Day) transaction. After the 5th day, the entire shipment is deleted if you
do not CONFIRM the shipment. If you do not CONFIRM a shipment on the
same day you CREATE it, or if a Future Day ship date is not specified

1. Create the shipment by coding a transaction string that includes
CreateOpenShipmentRequest.
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.

FedEx Web Services, Developer Guide

111

Chapter 9

Open Shipping
5. There are validation actions to be taken as part of processing
CreateOpenShipment, AddPackageToOpenShipment, Modify Open
Shipment and ModifyPackageInOpenShipment transactions, either
STRONG_VALIDATION, WEAK_VALIDATION, or CONFIRM Shipment.
– 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).
– 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.
– 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.

Table 47. CreateOpenShipmentRequest, continued
Element ID

Multiple
Occurrence

• ASYNCHRONOUS_ONLY
• SYNCHRONOUS_ONLY (Default)
Index

No

Optional. Customer-assigned identifier for
this shipment, which must be unique for
stand-alone open shipments.

Actions

Yes

Optional. Specifies the optional actions to
be performed during the creation of this
open shipment.
Valid values are:
CONFIRM
CREATE_PACKAGE
STRONG_VALIDATION
WEAK_VALIDATION

RequestedShipment

No

Required. The descriptive data for the
shipment being tendered to FedEx.

RequestedShipment/ShipTimestamp

No

Optional. Identifies the date and time the
package is tendered to FedEx.

RequestedShipment/DropoffType

No

Optional. Identifies the method by which the
package is to be tendered to FedEx. This
element does not dispatch a courier for
package pickup.

Description

RequestedShipment/ServiceType

No

Required. Identifies the FedEx service to use
in shipping the package.

RequestedShipment/PackagingType

No

Required. Identifies the packaging used by
the requestor for the package.

RequestedShipment/TotalWeight

No

Optional. The total weight of the shipment.

RequestedShipment/TotalInsuredValue

No

Optional. The total amount the shipment is
insured for.

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.
Table 47. CreateOpenShipmentRequest
Element ID

Multiple
Occurrence

Description

AsynchronousProcessingOptions

No

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

AsynchronousProcessingOptions/
Options

Yes

Describes the type of options available.
Valid values are:
• ALLOW_ASYNCHRONOUS

FedEx Web Services, Developer Guide

112

Chapter 9

Open Shipping
Table 47. CreateOpenShipmentRequest, continued
Element ID

Multiple
Occurrence

Table 47. CreateOpenShipmentRequest, continued

Description

Element ID
RequestedShipment/
ExpressFreightDetail

No

Optional. Data applicable to an FedEx
Express Freight shipment.

RequestedShipment/
FreightShipmentDetail

No

Optional. Data applicable to shipments using
FEDEX_FREIGHT_ECONOMY and
FEDEX_FREIGHT_PRIORITY services.

RequestedShipment/TotalDimensions

No

Optional.

RequestedShipment/PreferredCurrency

No

Optional. This attribute indicates the
currency the caller requests to have used in
all returned monetary values (when a choice
is possible).

Multiple
Occurrence

Description

RequestedShipment/Shipper

No

Required. Descriptive data identifying the
party responsible for shipping the package.

RequestedShipment/
DeliveryInstructions

No

Optional. Used with FedEx Ground Home
Delivery and FedEx Freight.

RequestedShipment/Recipient

No

Required. Descriptive data identifying the
party receiving the package.

RequestedShipment/
VariableHandlingChargeDetail

No

RequestedShipment/
RecipientLocationNumber

No

Optional. A unique identifier for a recipient
location.

Optional. Details about how to calculate
variable handling charges at the shipment
level.

No

RequestedShipment/Origin

No

RequestedShipment/
CustomsClearanceDetail

Optional. Customs clearance data, used for
both international and intra-country shipping.

RequestedShipment/PickupDetail

No

Optional. The pickup characteristics of a
shipment (e.g. for use in a tag request).

RequestedShipment/SmartPostDetail

No

Optional. Specifies the characteristics of a
shipment pertaining to FedEx SmartPost
services.

RequestedShipment/
BlockInsightVisibility

No

Optional. If true, only the shipper/payor will
have visibility of this shipment.

RequestedShipment/LabelSpecification

No

Required. Descriptive data identifying the
party responsible for shipping the package.

Required. Descriptive data for the monetary
compensation given to FedEx for services
rendered to the customer.

RequestedShipment/
LabelSpecification/LabelFormatType

Yes

Required. Specifies the type of label to be
returned.

RequestedShipment/SoldTo

No

Optional. Physical starting address for the
shipment, if different from shipper's address.
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

No

RequestedShipment/
SpecialServicesRequested

No

Optional. Special services available at the
shipment level for some or all service types.

RequestedShipment/
LabelSpecification/ImageType

No

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

RequestedShipment/
ProcessingOptionsRequested

No

Optional. Specifies any custom processing to
be applied to this shipment.

RequestedShipment/
LabelSpecification/LabelStockType

No

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

FedEx Web Services, Developer Guide

113

Chapter 9

Open Shipping
Table 47. CreateOpenShipmentRequest, continued
Element ID

Multiple
Occurrence

Table 47. CreateOpenShipmentRequest, continued

Description
•
•
•
•
•
•
•
•
•
•
•
•
•

PAPER_4X6
PAPER_4X8
PAPER_4X9
PAPER_7X4.75
PAPER_8.5X11_BOTTOM_HALF_LABEL
PAPER_8.5X11_TOP_HALF_LABEL
PAPER_LETTER
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/
ShippingDocumentSpecification

No

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

RequestedShipment/RateRequestTypes

Yes

Required. Specifies the 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/EdtRequestType

No

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

RequestedShipment/PackageCount

No

No

Optional. Only used with multipletransaction shipments to identify the master
package in a multi-piece shipment.
Required. The total number of packages in
the entire shipment, even when the

Element ID

Multiple
Occurrence

Description
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

No

Optional. Specifies data structures that may
be re-used multiple times with a single
shipment.

RequestedShipment/
RequestedPackageLineItems

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:
• Weight/Units
• Weight/Value

Table 48. CreateOpenShipmentReply
Element
HighestSeverity

Multiple
Occurrence
No

Description
Identifies the set of severity values for a
Notification.
Valid values are:
ERROR
FAILURE
NOTE

FedEx Web Services, Developer Guide

114

Chapter 9

Open Shipping
Table 48. CreateOpenShipmentReply, continued
Element

Multiple
Occurrence

Table 48. CreateOpenShipmentReply, continued
Description

Element

Multiple
Occurrence

SUCCESS

request) and performed by the callee (in
each reply).

WARNING
JobId

No

—

AynchronousProcessingResults

No

Indicates whether the transaction was
processed synchronously or asynchronously.

Indicates the source of this notification.
Combined with the Code it uniquely
identifies this notification.

ServiceType

No

List the type of FedEx service associated
with the shipment.

CompletedShipmentDetail

No

Provides Completed Shipment Details.

CompletedShipmentDetail/UsDomestic

No

Indicates whether or not this is an intra-U.S.
shipment.

CompletedShipmentDetail/CarrierCode

No

Indicates the carrier that will be used to
deliver this shipment.

CompletedShipmentDetail/
MasterTrackingId

No

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

No

Description of the FedEx service used for
this shipment. Currently not supported.

CompletedShipmentDetail/
PackagingDescription

No

Description of the packaging used for this
shipment. Currently not supported.

CompletedShipmentDetail/
OperationalDetail

No

Specifies shipment level operational
information.

CompletedShipmentDetail/
AccessDetail

No

Only used with pending shipments.

CompletedShipmentDetail/TagDetail

No

Only used in the reply to tag requests.

Notifications

Yes

The descriptive data regarding the result of
the submitted transaction.

Notifications/Severity

No

Same as "NotificationSeverityType" above

Notifications/Source

No

Notifications/Code

No

A code that represents this notification.
Combined with the Source it uniquely
identifies this notification.

Notifications/Message

No

Human-readable text that explains this
notification.

Notifications/LocalizedMessage

No

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

TransactionDetail

Version

Yes

No

No

Description

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.
Descriptive data for the customer
transaction. The Transaction detail from the
request is echoed back to the caller in the
corresponding reply.
Identifies the version/level of a service
operation expected by a caller (in each

The following valid values are returned only
for FedEx Express services:
• ConfirmationNumber

FedEx Web Services, Developer Guide

115

Chapter 9

Open Shipping
Table 48. CreateOpenShipmentReply, continued
Element

Multiple
Occurrence

Table 48. CreateOpenShipmentReply, continued
Description
•
•
•
•

CompletedShipmentDetail/
SmartPostDetail

No

CompletedShipmentDetail/
HazardousShipmentDetail

No

CompletedShipmentDetail/
ShipmentRating

No

CompletedShipmentDetail/
CompletedHoldAtLocationDetail

No

CompletedShipmentDetail/
ExportComplianceStatement

No

AccessTime
CutoffTime
Location
DeliveryCommitment

Valid values are:
• 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.

Element

Multiple
Occurrence

CompletedShipmentDetail/
CompletedEtdDetail

No

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.

AssociatedShipments/Type

No

Describes the type of associated shipment.
Valid values:
COD_RETURN

Computed shipment level information about
hazardous commodities.
All shipment-level rating data for this
shipment, which may include data for
multiple rate.

Description

DELIVERY_ON_INVOICE_ACCEPTANCE_
RETURN
AssociatedShipments/Sender

No

The descriptive data for a person or
company entity doing business with FedEx.

Returns the default holding location
information when HOLD_AT_LOCATION
special service is requested and the client
does not specify the hold location address.

AssociatedShipments/Recipient

No

The descriptive data for a person or
company entity doing business with FedEx.

AssociatedShipments/ServiceType

No

Describes the type of FedEx service.

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.

AssociatedShipments/PackagingType

No

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

Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

FedEx Web Services, Developer Guide

116

Chapter 9

Open Shipping
Table 48. CreateOpenShipmentReply, continued
Element

Multiple
Occurrence

Table 48. CreateOpenShipmentReply, continued
Description

AssociatedShipments/TrackingId

No

Specifies the tracking ID for the payment on
the return.

AssociatedShipments/
CustomerReferences

Yes

Specifies additional customer reference data
about the associated shipment.

AssociatedShipments/
ShipmentOperationalDetail

No

Specifies shipment level operational
information.

AssociatedShipments/
PackageOperationalDetail

No

Specifies package level operational
information on the associated shipment. This
information is not tied to an individual
outbound package.

AssociatedShipments/Label

No

All package-level shipping documents (other
than labels and barcodes).

CompletedShipmentDetail/
CompletedCodDetail

No

Specifies the results of processing for the
COD special service.

CompletedShipmentDetail/
CompletedPackageDetails

Yes

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

Element

Multiple
Occurrence

Description
• 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 error label behavior is
PACKAGE_ERROR_LABEL and one or more
errors occurred during transaction
processing,

Index

No

Either the Customer-assigned identifier from
the CreateOpenShipmentRequest or the
FedEx generated index.

Route and Time-in-Transit Transaction
Web Services returns FedEx Express routing or FedEx Ground time-in-transit
information in the ConfirmOpenShipmentReply transaction.

FedEx Web Services, Developer Guide

117

Chapter 9

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

Table 49. AddPackagesToOpenShipmentRequest, continued
Element

Multiple
Occurrence

Actions

Yes

Optional. Specifies the actions to be performed
during the add piece transaction. Valid values
are:
• STRONG_VALIDATION
• WEAK_VALIDATION

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.

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 49. AddPackagesToOpenShipmentRequest
Element

Multiple
Occurrence

Description

UserDetail

No

Optional.

Index

No

Required. Either the Customer-assigned
identifier or the FedEx generated identifier of
the open shipment where the package(s) are to
be added.

Description

Valid values are:

FedEx Web Services, Developer Guide

118

Chapter 9

Open Shipping
Table 49. AddPackagesToOpenShipmentRequest, continued
Element

Multiple
Occurrence

Description
•
•
•
•

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

RequestedPackageLineItem/
SpecialServicesRequested

Yes

RequestedPackageLineItem/
ContentRecords

Element

Multiple
Occurrence

Description
• ReceivedQuantity
• Description

Returned Add Piece Fields
The AddPackagesToOpenShipmentReply to an Open Ship ADD package
transaction includes the tracking number of the newly added package.
Table 50. AddPackagesToOpenShipmentReply
Element

Multiple
Occurrence

Description

Optional. Specifies additional customer
reference data about the associated shipment.

JobId

No

Optional.

Optional.

ServiceType

No

Optional. Description of the FedEx service type for
the particular shipment.

CompletedShipmentDetail

No

Provides all of the returned information about a
shipment/package(s).

ErrorLabels

Yes

Optional. Empty unless error label behavior is
PACKAGE_ERROR_LABEL.

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

Table 49. AddPackagesToOpenShipmentRequest, continued

Optional. Only used for individual packages and
PACKAGE_GROUPS. Valid values are:
• PartNumber
• ItemNumber

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 51 in a ModifyPackageInOpenShipmentRequest.
Table 51. ModifyPackageInOpenShipmentRequest
Element
UserDetail

Multiple
Occurrence
No

Description
Optional.

FedEx Web Services, Developer Guide

119

Chapter 9

Open Shipping
Table 51. ModifyPackageInOpenShipmentRequest, continued
Element
Index

Actions

Multiple
Occurrence
No

Yes

Table 51. ModifyPackageInOpenShipmentRequest, continued

Description

Element

Required. Customer-assigned identifier for
this shipment - must be unique for standalone open shipments.

RequestedPackageLineItem/
GroupNumber

No

RequestedPackageLineItem/
GroupPackageCount

No

Optional. Specifies the optional actions to
be performed during the modification of
packages in Open Shipment. Valid values
are:

Multiple
Occurrence

No

Required. The Tracking ID of the package
being modified.

TrackingId/TrackingIdType

No

Optional. Describes the type of tracking ID.

TrackingId/FormId

No

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

TrackingId/UspsApplicationId

No

Optional. For use with SmartPost tracking
IDs only.

TrackingId/TrackingNumber

No

Optional.

RequestedPackageLineItem

No

Optional.
This class rationalizes RequestedPackage
and RequestedPackageSummary from
previous interfaces.

RequestedPackageLineItem/
SequenceNumber

No

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.

Optional.
Used only with package groups, as a unique
identifier of each group of identical
packages.
Optional.
Used only with package groups, as a count
of packages within a group of identical
packages.

STRONG_VALIDATION
TrackingId

Description

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

No

Optional.
Only used for individual packages.
Details about how to calculate variable
handling charges at the shipment level.

VariableHandlingChargeDetail/
FixedValue

No

Optional.

VariableHandlingChargeDetail/
PercentValue

No

Optional. Actual percentage (10 means 10%,
which is a multiplier of 0.1)

VariableHandlingChargeDetail/
RateElementBasis

No

Optional. Select the value from a set of rate
data to which the percentage is applied.

VariableHandlingChargeDetail/
RateTypeBasis

No

Optional. Select the type of rate from which
the element is to be selected.

RequestedPackageLineItem/
InsuredValue

No

Optional.
Only used for individual packages and
package groups.

FedEx Web Services, Developer Guide

120

Chapter 9

Open Shipping
Table 51. ModifyPackageInOpenShipmentRequest, continued
Element
RequestedPackageLineItem/Weight

Multiple
Occurrence
No

Description

Table 51. ModifyPackageInOpenShipmentRequest, continued
Element

Multiple
Occurrence

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.

Required.
Only used for individual packages and
package groups.

RequestedPackageLineItem/
Dimensions

No

Optional.
The dimensions of this package and the unit
type used for the measurements.
Valid values are:
• Length
• Width
• Height
• Units

RequestedPackageLineItem/
PhysicalPackaging

No

Optional.
Provides additional detail on how the
customer has physically packaged this item.

For example, to request C.O.D., "COD" must
be included in the SpecialServiceTypes
collection and the CodDetail object must
contain the required data.
SpecialHandlingDetail

No

Optional. Specifies the condition of a
package when it was received at a FedEx
location.

RequestedPackageLineItem/
ContentRecords

Yes

Optional. Only used for individual packages
and package groups. Valid values are:
• PartNumber
• ItemNumber
• ReceivedQuantity
• Description

Required for packages moving under
international and SmartPost services.
RequestedPackageLineItem/
ItemDescription

No

Optional.
Human-readable text describing the
package.

RequestedPackageLineItem/
CustomerReferences

Yes

RequestedPackageLineItem/
SpecialServicesRequested

No

Table 52. ModifyPackageInOpenShipmentReply

Optional.

Element

Specifies additional customer reference data
about the associated shipment.

HighestSeverity

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

Description

Multiple
Occurrence
No

Description
Identifies the set of severity values for a
Notification. Valid values are:
• ERROR
• FAILURE
• NOTE
• SUCCESS
• WARNINGS

FedEx Web Services, Developer Guide

121

Chapter 9

Open Shipping
Table 52. ModifyPackageInOpenShipmentReply, continued
Element

Multiple
Occurrence

Description

Element
CompletedShipmentDetail/
MasterTrackingId

No

Only used with multiple-transaction
shipments to identify the master package in
a multi-piece shipment.

CompletedShipmentDetail/
ServiceTypeDescription

No

Description of the FedEx service used for
this shipment. Currently not supported.

CompletedShipmentDetail/
PackagingDescription

No

Description of the packaging used for this
shipment. Currently not supported.

CompletedShipmentDetail/
OperationalDetail

No

Description of the operational details of the
shipment.

CompletedShipmentDetail/
AccessDetail

No

Only used with pending shipments.

CompletedShipmentDetail/TagDetail

No

Only used in the reply to tag requests.

Notifications

Yes

The descriptive data regarding the result of
the submitted transaction.

Notifications/Severity

No

Same as HighestSeverity types above.

Notifications/Source

No

Indicates the source of this notification.
Combined with the Code it uniquely
identifies this notification.

Notifications/Code

No

A code that represents this notification.
Combined with the Source it uniquely
identifies this notification.

Notifications/Message
Notifications/LocalizedMessage

No
No

Notifications/MessageParameters

Table 52. ModifyPackageInOpenShipmentReply, continued

Human-readable text that explains this
notification.
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.

Multiple
Occurrence

The following valid values are, as of June
2007, returned only for FedEx Express
services:
• ConfirmationNumber
• AccessTime
• CutoffTime
• Location
• DeliveryCommitment

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

No

—

CompletedShipmentDetail

No

Provides Completed Shipment Details.

CompletedShipmentDetail/UsDomestic

No

Indicates whether or not this is an intra-US
shipment.

CompletedShipmentDetail/CarrierCode

No

Indicates the carrier that will be used to
deliver this shipment.

Description

CompletedShipmentDetail/
SmartPostDetail

No

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.

FedEx Web Services, Developer Guide

122

Chapter 9

Open Shipping
Table 52. ModifyPackageInOpenShipmentReply, continued
Element

Multiple
Occurrence

Table 52. ModifyPackageInOpenShipmentReply, continued

Description

Element
AssociatedShipmentDetail/Type

No

Describes the type of associated shipment.
Valid values are:
• COD_RETURN
• DELIVERY_ON_INVOICE_ACCEPTANCE_
RETURN

CompletedShipmentDetail/
CompletedCodDetail

No

Specifies the results of processing for the
COD special service.

CompletedShipmentDetail/
CompletedPackageDetails

Yes

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

CompletedShipmentDetail/
HazardousShipmentDetail

No

Computed shipment level information about
hazardous commodities.

CompletedShipmentDetail/
ShipmentRating

No

All shipment-level rating data for this
shipment, which may include data for
multiple rate.

CompletedShipmentDetail/
CompletedHoldAtLocationDetail

No

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

No

Returns any defaults or updates applied to
RequestedShipment.exportDetail.export
ComplianceStatement.

CompletedShipmentDetail/
CompletedEtdDetail

No

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

Multiple
Occurrence

Description

FedEx Web Services, Developer Guide

123

Chapter 9

Open Shipping
Table 52. ModifyPackageInOpenShipmentReply, continued
Element

Multiple
Occurrence

Description
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 error label behavior is
PACKAGE_ERROR_LABELS and one or more
errors occurred during transaction
processing.

Delete Piece Transaction
To delete one or more packages from an Open Ship shipment:
Delete the piece before you CONFIRM using the
DeletePackagesFromOpenShipmentRequest.
Table 53. DeletePackagesFromOpenShipmentRequest
Element

Multiple
Occurrence

Description

Table 53. DeletePackagesFromOpenShipmentRequest, continued
Element

Multiple
Occurrence

Description

TrackingId/UspsApplicationId

No

Optional. For use with SmartPost tracking IDs only.

TrackingId/TrackingNumber

No

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.

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.

UserDetail

No

Optional.

Index

No

Required. Customer-assigned identifier for this
shipment - must be unique for stand-alone open
shipments.

Element

Table 54. DeleteOpenShipmentRequest
Multiple
Occurrence

Description

TrackingId

Yes

Required. The Tracking ID of the package.

UserDetail

No

Optional.

TrackingId/TrackingIdType

No

Optional.

Index

No

TrackingId/FormId

No

Optional.

Required. Customer-assigned identifier for this
shipment - must be unique for stand-alone open
shipments.

FedEx Web Services, Developer Guide

124

Chapter 9

Open Shipping
Confirm Shipment Transactions
The CONFIRM transaction validates the shipment and package information for
the respective Open Shipment index. The system returns Route, Time-inTransit, Rate Quote and required shipping document information, including
labels for the packages.

Table 55. ConfirmOpenShipmentRequest, continued
Element

Multiple
Occurrence

Description

AsynchronousProcessingOptions/
Options

Yes

Describes the type of options available.
Valid values are:
• ALLOW_ASYNCHRONOUS
• ASYNCHRONOUS_ONLY
• SYNCHRONOUS_ONLY

Index

No

Required. Customer-assigned identifier for
this shipment - must be unique for standalone open shipments.

LabelSpecification

No

Optional. Description of shipping label to be
returned in the reply.

RequestedShipment/
LabelSpecification/LabelFormatType

Yes

6. CONFIRM Shipment

Required. Specifies the type of label to be
returned.

Confirm Open Ship Shipment

RequestedShipment/
LabelSpecification/ImageType

No

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

After you add all packages to an Open Ship shipment, you may CONFIRM the
shipment by passing in the elements in the ConfirmOpenShipmentRequest.

RequestedShipment/
LabelSpecification/LabelStockType

No

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
• PAPER_LETTER
• STOCK_4X6
• STOCK_4X6.75_LEADING_DOC_TAB
• STOCK_4X6.75_TRAILING_DOC_TAB
• STOCK_4X8

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

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 55. ConfirmOpenShipmentRequest
Element
AsynchronousProcessingOptions

Multiple
Occurrence
No

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

FedEx Web Services, Developer Guide

125

Chapter 9

Open Shipping
Table 55. ConfirmOpenShipmentRequest, continued
Element

Multiple
Occurrence

Description
• STOCK_4X9_LEADING_DOC_TAB
• STOCK_4X9_TRAILING_DOC_TAB

Table 55. ConfirmOpenShipmentRequest, continued
Element

Multiple
Occurrence

Description

ShippingDocumentSpecification/
FreightAddressLabelDetail

No

Optional.

ShippingDocumentSpecification

No

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

ShippingDocumentSpecification/
ReturnInstructionsDetail

No

Optional. Specifies the production of the
return instructions document.

ShippingDocumentSpecification/
ShippingDocumentTypes

Yes

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

RateRequestTypes

Yes

ShippingDocumentSpecification/
CertificateOfOrigin

No

Optional.

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

ShippingDocumentSpecification/
CommercialInvoiceDetail

No

Optional.

EdtRequestType

No

ShippingDocumentSpecification/
CustomPackageDocumentDetail

Yes

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

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

ShippingDocumentSpecification/
CustomShipmentDocumentDetail

Yes

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

ShippingDocumentSpecification/
ExportDeclarationDetail

No

Optional.

Element

ShippingDocumentSpecification/
GeneralAgencyAgreementDetail

No

Optional.

HighestSeverity

No

ShippingDocumentSpecification/
NaftaCertificateOfOriginDetail

No

Optional.

ShippingDocumentSpecification/
Op900Detail

No

Optional. Specifies the production of the OP900 document for hazardous materials
packages.

ShippingDocumentSpecification/
DangerousGoodsShippersDeclarationD
etail

No

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

Identifies the highest severity encountered
when performing the request. Valid values
are:
• FAILURE
• ERROR
• WARNING
• NOTE
• SUCCESS

Notifications

Yes

Descriptive data regarding the results of the
submitted transaction.

Table 56. ConfirmOpenShipmentReply
Multiple
Occurrence

Description

FedEx Web Services, Developer Guide

126

Chapter 9

Open Shipping
Table 56. ConfirmOpenShipmentReply, continued
Element
TransactionDetail

Multiple
Occurrence
No

Description

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

JobId

No

—

AsynchronousProcessingResults

No

This indicates whether the transaction was
processed synchronously or asynchronously.

CompletedShipmentDetail

No

Provides Completed Shipment Details.

ErrorLabels

Yes

Empty unless error label behavior is
PACKAGE_ERROR_LABEL 5 and one or more
errors occurred during transaction
processing.

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

Asynchronous Processing
The AsynchronousProcessingOption in the OpenShip WSDL lets you specify
the manner the shipment artifacts, which are the shipping labels and all
associated documents, such as Commercial Invoice, Certification of Origin,
NAFTA Certificate of Origin, Export Declaration and so on, are returned.
Specify that the shipment artifacts 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 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 57. RetrieveJobResultsRequest
Element
JobId

Multiple
Occurrence
No

Description
Optional. Specifies the job under which the
desire artifacts are stored.

FedEx Web Services, Developer Guide

127

Chapter 9

Open Shipping
Table 57. RetrieveJobResultsRequest, continued
Element

Multiple
Occurrence

Table 58. RetrieveJobResultsReply, continued
Description

Filters

Yes

Optional. Specifies the filters to be used for
retrieving artifacts.

Filters/AccessReference

No

Optional.

Filters/Type

No

Optional.

Filters/ReferenceId

No

Optional.

Element

Multiple
Occurrence

• FAILURE - FedEx was unable to process
your transaction at this time due to a
system failure. Please try again later.
Notifications/Source

No

Indicates the source of this notification.
Combined with the Code it uniquely
identifies this notification

Notifications/Code

No

A code that represents this notification.
Combined with the Source it uniquely
identifies this notification.

Description

Notifications/Message

No

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.

/MessageParameters/Id

No

Identifies the type of data contained in
Value (e.g. SERVICE_TYPE,
PACKAGE_SEQUENCE, etc.).

/MessageParameters/Value

No

The value of the parameter (e.g.
PRIORITY_OVERNIGHT, 2, etc.).

TransactionDetail

No

Contains the CustomerTransactionID that
was sent in the request.

TransactionDetail/
CustomerTransactionId

No

Free form text to be echoed back in the
reply. Used to match requests and replies.

Table 58. RetrieveJobResultsReply
Element

Multiple
Occurrence

Description

HighestSeverity

No

Ranks the level of notification severity.

Notifications

Yes

The descriptive data regarding the results of
the submitted transaction.

Notifications/Severity

No

The severity of this notification. This can
indicate 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 or that you may need
to take action on.
• ERROR - Information about an error that
occurred while processing your
transaction.

FedEx Web Services, Developer Guide

128

Chapter 9

Open Shipping
Table 58. RetrieveJobResultsReply, continued
Element

Multiple
Occurrence

Table 58. RetrieveJobResultsReply, continued
Description

TransactionDetail/Localization

No

Governs data payload language/translations
(contrasted with ClientDetail.localization,
which governs Notification.localizedMessage
language selection).

/Locationalization/LanguageCode

No

Two-letter code for language (e.g. EN, FR,
etc.).

/Locationalization/LocaleCode

No

Two-letter code for the region (e.g. us, ca,
etc.).

Version

No

The version of this reply.

Artifacts

Yes

Shipping labels and all associated
documents.

Artifacts/AccessReference

No

Artifacts/HighestSeverity

No

Ranks the level of notification severity.

Artifacts/Notifications

Yes

The descriptive data regarding the results of
the submitted transaction.

/Notifications/Severity

No

The severity of this notification. This can
indicate 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 or that you may need
to take action on.

Element

Multiple
Occurrence

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

No

Indicates the source of this notification.
Combined with the Code it uniquely
identifies this notification.

/Notifications/Code

No

A code that represents this notification.
Combined with the Source it uniquely
identifies this notification.

/Notifications/Message

No

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

No

Identifies the type of artifact.

Format

No

Specifies the format of the artifact.

FormatSpecification

No

Identifies the schema or specific format
definition used for the artifact.

FedEx Web Services, Developer Guide

129

Chapter 9

Open Shipping
Table 58. RetrieveJobResultsReply, continued
Element

Multiple
Occurrence

Open Ship Print Options
Description

ReferenceId

No

Specifies a reference to the artifact that
follows the naming convention defined for
file storage.

Parts

Yes

Parts/SequenceNumber

No

Specifies the sequence of this part of the
artifact.

Parts/Contents

No

Specifies the contents of this retrieved
artifact part.

Open Ship has one print label option:
Print-At-The-End (PATE) — print all labels at the end after the shipment is
confirmed.

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

FedEx Web Services, Developer Guide

130

10 Ship Service

Shipping Services by Region

Process Shipment Reply

Ship Service Coding Basics

Validate Shipment

Delete Shipment

Email Labels

Chapter 10

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:
• Chapter 13: FedEx Express U.S. Shipping

Table 59. Shipping Services by Region, continued
Region

Latin American
countries (LAC)

FedEx
Express
U.S.

FedEx Express FedEx
International
Ground
U.S

FedEx
International

Intra-Country
Service*

Ground

X

Note: Intra-country indicates shipping service within a specific country or region.Refer to
Chapter 32: FedEx Intra-Country Shipping for a list of countries that support intra-country
shipping services.

• Chapter 32: FedEx Intra-Country Shipping
• Chapter 29: FedEx Ground U.S. Shipping

Ship Service Coding Basics

• Chapter 33: FedEx Express International Shipping

This section describes the Web Services elements needed to create, cancel,
and validate shipments.

• Chapter 36: FedEx International Ground Shipping

Create Shipment Using Process Shipment
Request

Shipping Services by Region
This table outlines available FedEx shipping services by region:

The ProcessShipmentRequest requires the RequestedShipment complex
element, which is made up of the following elements.

Table 59. Shipping Services by Region
Region

United States

FedEx
Express
U.S.
X

FedEx Express FedEx
International
Ground
U.S
X

Canada

X

Asian Pacific
countries (APAC)

X

Europe, Middle
East and Africa
(EMEA)

X

X

FedEx
International

Intra-Country
Service*

RequestedShipment Elements
Table 60. Requested Shipment Elements

Ground
X

X

Element

X

X

ShipTimestamp

Required
Required

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

FedEx Web Services, Developer Guide

132

Chapter 10

Ship Service
Table 60. Requested Shipment Elements, continued
Element

Required

Description

Element

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, such as xx:xx, from UTC;
for example, 2009-06-26T17:00:00-04:00 is
defined as June 26, 2009 5:00 p.m.
Eastern Time.

PreferredCurrency

Optional

Indicates the currency the caller requests
to have used in all returned monetary
values (when a choice is possible).

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

Optional

A unique identifier for a recipient location.

Origin

Optional

Identifies the shipment’s physical starting
address if different from the shipper.

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.

ShippingChargesPayment

Required

Descriptive data indicating the method
and means of payment to FedEx for
providing shipping services.

SpecialServicesRequested

Required

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

See Appendix M: Time Zones for more
information about time zones.
DropoffType

Optional

Table 60. Requested Shipment Elements, continued

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.

TotalWeight

Optional

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

Optional

Total declared value amount. FedEx does
not provide insurance of any kind.

Required

Description

FedEx Web Services, Developer Guide

133

Chapter 10

Ship Service
Table 60. Requested Shipment Elements, continued
Element

Required

Description

Table 60. Requested Shipment Elements, continued
Element

Required

request C.O.D., "COD" must be included in
the SpecialServiceTypes collection and the
CodDetail object must contain the required
data.
ExpressFreightDetail

Optional

Details specific to a FedEx Freight®
shipment.

Description
• LIST — Returns published rates in
response
• PREFERRED — Returns rates in
currency specified in the
PreferredCurrency element

EdtRequestType

Optional

Specifies 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

Optional

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.

FreightShipmentDetail

Optional

Data applicable to shipments using
FEDEX_FREIGHT PRIORITY and
FEDEX_FREIGHT ECONOMY services.

DeliveryInstructions

Optional

Used with FedEx Home Delivery® and
FedEx Freight.

VariableHandlingChargeDetail

Optional

Details about how to calculate variable
handling charges at the shipment level.

CustomsClearanceDetail

Optional

Information about this package that only
applies to an international (export)
shipment or return.

PickupDetail

Optional

For use in “process tag” transaction.

SmartPostDetail

Optional

Details specific to FedEx SmartPost
shipments.

PackageCount

Required

For an MPS, this is the total number of
packages in the shipment.

If true, only the shipper/payor will have
visibility of this shipment.

ConfigurationData

Optional

Specifies data structures that may be reused multiple times with a single
shipment.

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-totalweight case) common characteristics of
packages in the shipment.

BlockInsightVisibility

Optional

LabelSpecification

Required

Details about the image format and
printer type for the returned label.

ShippingDocumentSpecification

Optional

Contains all data required for additional
(non-label) shipping documents to be
produced with a specific shipment.

RateRequestTypes

Optional

Indicates the type of rates to be returned.
Valid values are:
• ACCOUNT — Returns discounted
rates in response if applicable

FedEx Web Services, Developer Guide

134

Chapter 10

Ship Service
Example ProcessShipmentRequest



XXXXXXXX
XXXXXXXX



XXXXXXXX
XXXXXXXX


** TEST TRANSACTION
**


ship
12
0
0


2012-05-07T20:04:33.948Z
REGULAR_PICKUP
STANDARD_OVERNIGHT
YOUR_PACKAGING


Mr. Test
Widgets Inc.
9015551212


3318 Pembridge Street
Thousand Oaks
CA
91360

US




Jean Austin
Widgets
9015551212


123 Main Street
Atlanta
GA
30303
US
true



SENDER


XXXXXXXX





COMMON2D
EPL2
STOCK_4X6.75_LEADING_DOC_TAB
TOP_EDGE_OF_TEXT_FIRST

ACCOUNT
1

1

FedEx Web Services, Developer Guide

135

Chapter 10

Ship Service

LB
8.0





Table 61. DeleteShipmentRequest Elements, continued
Element

Required

Description
• FEDEX
• GROUND
• USPS
Note: Canceling a shipment is not
supported for Freight. You must call FedEx
to cancel or update a previously scheduled
Freight pickup.

Cancel Shipment Using Delete Shipment Request
The DeleteShipmentRequest consists of the following elements:
DeletionControl

DeleteShipmentRequest Elements

Required

Determines the type of deletion to be
performed in relation to package level
versus shipment level.

Table 61. DeleteShipmentRequest Elements
Element

Required

Description

Error Messages
For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

WebAuthenticationDetail

Required

Descriptive data to be used in
authentication of the sender’s identify
(and right to use FedEx Web Services).

ClientDetail

Required

Descriptive data identifying the client
submitting the transaction.

TransactionDetail

Optional

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

Version

Required

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

ShipTimestamp

Optional

The timestamp of the shipment request.

TrackingId

Optional

Identifies the FedEx tracking number of
the package being cancelled.

TrackingIDType

Required

Valid values are:
• EXPRESS

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.

Delete Shipment Coding Details
The following elements can be used to delete a package or shipment:

FedEx Web Services, Developer Guide

136

Chapter 10

Ship Service
Table 62. Delete Shipment Coding Details Elements
Element

Required

Description

TrackingNumber

Required

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-package
shipments labels are not associated with sequential
numbers (1 of 2, 2 of 2), you do not need to delete the
entire shipment.
• 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. multiple-package shipments, you
must delete each individual package.

TransactionDetail

Optional

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

ShipTimestamp

Optional

The timestamp of the shipment request.

DeletionControlType

Optional

Determines the type of deletion to be performed in relation to
package level versus shipment level. Valid options are:
• DELETE_ALL_PACKAGES
• 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 DeleteShipmentRequest



XXXXXXXX
XXXXXXXX



XXXXXXXX
XXXXXXXX


ship
12
0
0

2012-05-07T20:08:12.349Z

FEDEX

FedEx Web Services, Developer Guide

137

Chapter 10

Ship Service
Table 63. ProcessShipmentReply Elements
YOURTRACKINGNUMBERHERE

DELETE_ALL_PACKAGES


Element

Required

Description

HighestSeverity

Yes

This indicates the highest level of all the notifications
returned in this reply.

Samples

Notifications

Yes

The descriptive data regarding the results of the
submitted transaction.

Sample code, sample transactions and the specific individual WSDL/XML
guide(s) can be downloaded following these steps:

JobId

No

—

CompletedShipmentDetail

No

The reply payload. All of the returned information
about this shipment/package.

CompletedShipmentDetail/
UsDomestic

No

Indicates whether or not this is an intra-U.S. shipment.

CompletedShipmentDetail/
CarrierCode

No

Indicates the carrier that will be used to deliver this
shipment.

CompletedShipmentDetail/
MasterTrackingId

No

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

No

Description of the FedEx service used for this shipment.
Currently not supported.

CompletedShipmentDetail/
PackagingDescription

No

Description of the packaging used for this shipment.
Currently not supported.

CompletedShipmentDetail/
OperationalDetail

No

Specifies shipment level operational information.

For error messages, see the Appendix O: Error Code Messages section of the
Web Services Developer Guide in the Support area of the Developer Resource
Center at fedex.com/developer.

CompletedShipmentDetail/
AccessDetail

No

Used only with pending shipments.

CompletedShipmentDetail/
TagDetail

No

Only used in the reply to tag requests.

Process Shipment Reply

CompletedShipmentDetail/
HazardousShipmentDetail

No

Computed shipment level information about hazardous
commodities.

The following may be returned in a Process Shipment Reply.

CompletedShipmentDetail/
ShipmentRating

No

All shipment-level rating data for this shipment, which
may include data for multiple rate types.

1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

Error Messages

FedEx Web Services, Developer Guide

138

Chapter 10

Ship Service
Table 63. ProcessShipmentReply Elements, continued

Table 63. ProcessShipmentReply Elements, continued

Element

Required

Description

Element

Required

Description

CompletedShipmentDetail/
CompletedHoldAtLocationDet
ail

No

Returns the default holding location information when
HOLD_AT_LOCATION special service is requested and
the client does not specify the hold location address.

/PackageRating/
ActualRateType

No

This rate type identifies which entry in the following
array is considered as presenting the "actual" rates for
the package.

CompletedShipmentDetail/
ExportComplianceStatement

No

Returns any defaults or updates applied to
RequestedShipment.exportDetail.ExportComplianceState
ment.

/PackageRating/
EffectiveNetDiscount

No

The "list" net change minus "actual" net change.

No

Valid values are:
• FolderId — The identifier for all clearance
documents associated with this shipment.
• UploadDocumentReferenceDetails

/PackageRating/
PackageRateDetails

No

CompletedShipmentDetail/
CompletedEtdDetail

Each element of this field provides package-level rate
data for a specific rate type.

/PackageRating/
PackageRateDetail/RateType

No

Type used for this specific set of rate data.
Indicates which weight was used.

No

All shipment-level shipping documents (other than
labels and barcodes).

/PackageRating/
PackageRateDetail/
RatedWeightMethod

No

CompletedShipmentDetail/
ShipmentDocuments
CompletedShipmentDetail/
AssociatedShipments

No

Provides the customer with the Delivery on Invoice
Acceptance data.

No

INTERNAL FEDEX USE ONLY.

CompletedShipmentDetail/
CompletedCodDetail

No

Specifies the results of processing for the COD special
service.

/PackageRating/
PackageRateDetail/
MinimumChargeType

No

The weight that was used to calculate the rate.

CompletedShipmentDetail/
CompletedPackageDetails

No

Package level details about this package.

/PackageRating/
PackageRateDetail/
BillingWeight

/CompletedPackageDetails/
SequenceNumber

No

The package sequence number of this package in a
multiple piece shipment.

/PackageRating/
PackageRateDetail/
OversideWeight

No

The oversie weight of this package (if the package is
oversize).

/CompletedPackageDetails/
TrackingIds

No

The tracking number and form id for this package.

No

The Transportation charge only (prior to any discounts
applied) for this package.

/CompletedPackageDetails/
GroupNumber

No

Used with request containing PACKAGE_GROUPS, to
identify which group of identical packages was used to
produce a reply item.

/PackageRating/
PackageRateDetail/
BaseCharge

No

The sum of all discounts on this package.

/CompletedPackageDetails/
OversizeClass

No

Oversize class for this package.

/PackageRating/
PackageRateDetail/
TotalFreightDiscounts

/CompletedPackageDetails/
PackageRating

No

All package-level rating data for this package, which
may include data for multiple rate types.

/PackageRating/
No
PackageRateDetail/NetFreight

This package's baseCharge - totalFreightDiscounts.

FedEx Web Services, Developer Guide

139

Chapter 10

Ship Service
Table 63. ProcessShipmentReply Elements, continued
Element

Required

Description

/PackageRating/
PackageRateDetail/
TotalSurcharges

No

The sume of all surcharges on the package.

/PackageRating/
PackageRateDetail/
NetFedExCharge

No

The package's netFreight + totalSurcharges (not
including totalTaxes).

/PackageRating/
No
PackageRateDetail/TotalTaxes

The sum of all taxes on this package.

/PackageRating/
No
PackageRateDetail/NetCharge

The package's netFreight + totalSurcharges +
totalTaxes.

/PackageRating/
PackageRateDetail/
TotalRebates

No

The total sum of all rebates applied to this package.

/PackageRating/
PackageRateDetail/
FreightDiscounts

No

All rate discounts that apply to this package.

/PackageRating/
PackageRateDetail/Rebates

No

All rebates that apply to this package.

/PackageRating/
PackageRateDetail/
Surcharges

No

All surcharges that apply to this package (either
because of characteristics of the package itself, or
because it is carrying per-shipment surcharges for the
shipment of which it is a part).

/Surcharges/SurchargeType

No

The type of surcharge applied to the shipment. Valid
values are:
• ADDITIONAL_HANDLING
• ANCILLARY_FEE
• APPOINTMENT_DELIVERY
• BROKER_SELECT_OPTION
• CANADIAN_DESTINATION
• CLEARANCE_ENTRY_FEE
• COD

Table 63. ProcessShipmentReply Elements, continued
Element

Required

Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

CUT_FLOWERS
DANGEROUS_GOODS
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_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

FedEx Web Services, Developer Guide

140

Chapter 10

Ship Service
Table 63. ProcessShipmentReply Elements, continued
Element

Required

Description
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•

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

Table 63. ProcessShipmentReply Elements, continued
Element

Required

Description

/Surcharges/Level

No

Identifies whether the surcharge is assessed at the
PACKAGE or SHIPMENT level.

/Surcharges/Description

No

The data describing the surcharge.

/Surcharges/Amount

Yes

The amount of the surcharge applied to the shipment.

/PackageRating/
PackageRateDetail/Taxes

No

All taxes applicable (or distributed to) this package.

/PackageRating/
PackageRateDetail/
VariableHandlingCharges

No

The variable handling charges calculated based on the
type variable handling charges requested.

/CompletedPackageDetails/
OperationalDetail

No

Specifies package level operational information.

/CompletedPackageDetails/
Label

No

The label image or printer commands to print the label.

/CompletedPackageDetails/
PackageDocuments

No

All package-level shipping documents (other than labels
and barcodes). For use in loads after January 2008.

/CompletedPackageDetails/
CodReturnDetail

No

Specifies the information associated with this package
that has COD special service in a ground shipment.

/CompletedPackageDetails/
SignatureOption

No

Actual signature option applied, to allow for cases in
which the original value conflicted with other service
features in the shipment.

/CompletedPackageDetails/
DryIceWeight

No

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

No

Documents the kinds and quantities of all hazardous
commodities in the current package, using updated
hazardous commodity description data.

FedEx Web Services, Developer Guide

141

Chapter 10

Ship Service
Table 63. ProcessShipmentReply Elements, continued
Element

Required

Description

ErrorLabels

No

Empty unless error label behavior is
PACKAGE_ERROR_LABELS and one or more errors
occurred during transaction processing.

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.

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.

3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

ValidateShipmentRequestElements
In addition to the basic request elements required for all operations, the
following elements are required for when coding a ValidateShipmentRequest:
Table 64. Validate Shipment Request Elements
Element

Required

Description

RequestedShipment

Y

Describe ship information you wish to validate. For
information on RequestedShipment elements, see Ship
Service Coding Basics.

ValidateShipmentReply Data

Email Labels
Create either an email (non-returns) shipping label or an email returns
shipping label using the ShipService CreatePendingShipment Request. Cancel
either of these requests using the ShipService CancelPendingShipment
Request.
The Email Return 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.

Successful reply data are returned in a ValidateShipmentReply.

FedEx Web Services, Developer Guide

142

Chapter 10

Ship Service

Delivery Area

• The email label is created using elements from the
CreatingPendingShipmentRequest in the ShipService WSDL for FedEx
Ground or FedEx Express shipments. Requirements that apply to ground
and express shipments also apply to email labels.

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.

• The email label request is canceled using elements from the
CancelPendingShipmentRequest in the ShipService WSDL for FedEx
Ground or FedEx Express shipments. Requirements that apply to FedEx
Ground and FedEx Express shipments also apply to email labels.

FedEx Express® and FedEx Ground® return labels are not available for
international destinations.

• You may request up to 25 email labels to one email address using one
request transaction.

Email Label Service Details
The following service details apply to email labels:

Exceptions

• Email label URLs expire according to your expiration time stamp.

FedEx Express Saver® and FedEx 1Day® Freight services are not available.

• After the customer prints the label, the label does not expire but can be
used indefinitely.

Chapter 20: Dangerous Goods and Chapter 21: Hazardous Materials (FedEx
Ground U.S.) on page 219 cannot be shipped.

• A FedEx Ground Manifest is not required for an email label.

Additional Information

• A surcharge is added to a return email label. No surcharge is applied to a
non-return email label.

Additional service options include Saturday Service, Chapter 24: Dry Ice
Shipments on page 229, and Chapter 23: Hold at FedEx Location on page 226.
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.

Email Label Coding Details

• The only label format supported is laser (or plain paper).

• The maximum expiration date for an email label must be greater or equal
to the day of the label request and no greater than 30 days in future.
• A Returns shipment can be associated to an Outbound shipment using the
ReturnAssociation element.

Return (Inbound) Email Label Elements
In addition to the basic FedEx Ground or FedEx Express shipping elements
required to request an email label, the following elements must be included
in the CreatePendingShipmentRequest:

The following coding details apply to email labels:

FedEx Web Services, Developer Guide

143

Chapter 10

Ship Service
Table 65. Return (Inbound) Email Label Elements

Table 65. Return (Inbound) Email Label Elements, continued

Element

Description

Element

Description

RequestedShipment/
SpecialServicesRequested/
SpecialServiceTypes

Required. Specify the type of special service.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail

Required. Specify the Pending Shipment Type. Include the
following value:
• EMAIL

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/ExpirationDate

Required. Specify the email label expiration date: for
example, 2012-12-31.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
EmailLabelDetail/
NotificationEmailAddress

Required. Email address of the end-user to be notified of
the return label. This element has a 200-character
maximum.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
EmailLabelDetail/NotificationMessage

Optional. Notification message included in the email to the
end-user.

RequestedShipment/
RequestedPackageLineItems/
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. For a RMA number, use the
following value:

Valid values for a return email label are:
• PENDING_SHIPMENT
• RETURN_SHIPMENT

RequestedShipment/
SpecialServicesRequested/
DeliveryOnInvoiceAcceptanceDetail

Optional. Allows customers to direct the signed return
receipt to a different address.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail

Required. Specify the Return Type. Include the following
value:

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/Rma/Reason

Optional. Return Materials Authorization Reason. You may
enter a reason for the return authorization associated with
this Email Label. Prints on the label.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnEmailDetail/
MerchantPhoneNumber

Required. Include the phone number for the merchant, such
as a general customer service phone number.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnEmailDetail/
AllowedSpecialServices

Optional. Allow specific special services for the end-user.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnAssociation

Optional. Describes the data for the outbound shipment
associated with the return.

PENDING

Valid values are:
• SATURDAY_DELIVERY
• SATURDAY_PICKUP

The maximum expiration date must be greater or equal to
the day of the label request and not greater than 30 days in
the future.

RMA_ASSOCIATION
If specified, the package can also be tracked by this value.

Non-Return Email Label 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:

FedEx Web Services, Developer Guide

144

Chapter 10

Ship Service
Table 66. Non-Return (Outbound) Email Label Elements

Include the following value for a non-return email label:

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

PENDING_SHIPMENT

Table 67. CancelPendingShipmentRequest Element

Element

Description

RequestedShipment/
SpecialServicesRequested/
SpecialServiceTypes

Required. Specify the type of special service.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail

Cancel Email Label Elements

Required. Specify the pending shipment type.

Element

Description

Include the following value:

TrackingNumber

The tracking number associated with the pending shipment to be
canceled.

EMAIL
RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/ExpirationDate

Required. Specify the email label expiration date: for
example, 2009-01-31.

Samples

The maximum expiration date must be greater than or
equal to the day of the label request and no greater than
30 days in future.

Sample code, sample transactions and the specific individual WSDL/XML
guide(s) can be downloaded following these steps:

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
EmailLabelDetail/
NotificationEmailAddress

Required. Email address of the end-user to be notified of
the label.

1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/
developer.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
EmailLabelDetail/NotificationMessage

Optional. Notification message included in the email to the
end user (200-character maximum).

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
ShipmentDryIceDetail

Optional. PackageCount and TotalWeight elements for Dry
Ice shipments.

RequestedShipment/
SpecialServicesRequested/
PendingShipmentDetail/
HomeDeliveryPremiumDetail

Optional. Special service elements for FedEx Ground Home
Delivery shipments.

2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

FedEx Web Services, Developer Guide

145

11 Returns Shipping

FedEx Return Tags

Alternate Return Address

FedEx Express / FedEx Ground Printed Return Label

Samples

Chapter 11

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 international 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 68. Return Types, continued
OUTBOUND

RETURN

What's the reason for
including a return
label?

What's the reason for
the return?

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.

Table 68. Return Types
OUTBOUND

RETURN

What's the reason for
including a return
label?

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.

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.

Item for Loan

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.

When to use

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

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 Web Services, Developer Guide

147

Chapter 11

Returns Shipping
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 pre-printed labels (Billable Stamps and Ground
Package Returns Program).
– 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 passwordprotected 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.
– 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 onsite. You 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.
You can also find more information on shipping labels in Chapter 12: Creating
a Label.

FedEx Return Tags
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
ExpressTagAvailability from the ReturnTagService WSDL to check valid pickup
times.
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.

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.

Delivery Area
• Available for FedEx deliveries throughout the 50 United States.

FedEx Web Services, Developer Guide

148

Chapter 11

Returns Shipping
• FedEx Express and FedEx Ground return tag labels are not available for
international destinations.
• Both commercial and residential locations are allowed.
• Intra-country returns are also available. Refer to Chapter 32: FedEx IntraCountry Shipping for a list of countries that support intra-country shipping
services.

Exceptions

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

• Chapter 21: Hazardous Materials (FedEx Ground U.S.), Chapter 24: Dry Ice
Shipmentsand Chapter 20: Dangerous Goodscannot be shipped.

Additional Information

RequestedShipment/Recipient

• Additional service options include residential pickup.

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.

• The maximum declared value is $25,000USD.
For more detailed information about the services offered by FedEx, see the
electronic FedEx Service Guide.

Return Tag Coding Details

RequestedShipment/
ShippingChargesPayment

The following coding details apply to Return Tags:
• You may request one Return Tag pickup in a single transaction.

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

Optional. Valid elements for payment type are:
• COLLECT
• RECIPIENT
• SENDER
• THIRD_PARTY
Payor. AccountNumber and CountryCode of the payor are
required in this element.

• You may request up to 99 pieces in a multiple-piece Return Tag
transaction.
• No ground manifest is required.

Required. Package delivery destination information, including
contract name, company, address, etc.

RequestedShipment/
SpecialServicesRequested/
SpecialServicesTypes

Required. Special Services Type:

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/ReturnType

Required. Return Type:

RETURN_SHIPMENT

FEDEX_TAG

FedEx Web Services, Developer Guide

149

Chapter 11

Returns Shipping
Table 69. ProcessTagRequest Elements, continued

Table 69. ProcessTagRequest Elements, continued

Element

Description

Element

Description

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/Rma/Reason

Optional. Customer-provided reason for the return.

RequestedShipment/
ShippingDocumentSpecification/
ReturnInstructionsDetail

Optional. Specifies the production of the return instructions
document.

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.

ShippingDocumentSpecification/
ReturnInstructionsDetail/Format

Optional. Specifies characteristics of a shipping document to
be produced.

RequestedShipment/
SpecialServicesRequested/
ReturnShipmentDetail/
ReturnAssociation/Shipdate

Optional. This is the ship date for the outbound shipment
associated with the return.

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 YYYYMM-DDHH:MM:SS.

RequestedShipment/PickupDetail/
LatestPickupDateTime

RequestedShipment/PackageCount

Required. This element is required if you want to process a
multiple-package shipment. FedEx allows up to 99 pieces in a
single transaction.

RequestedShipment/
RequestedPackageLineItems

Optional. An array of individual package attributes.

Note: Does not apply to FedEx Ground® Call Tags.

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

ReturnInstructionsDetail/CustomText Optional. Specifies additional customer provided text to be
inserted into the return document.

Optional. Additional instructions to the FedEx courier, such as
package location or directions, may be added to your request.

Single piece tag requests will have one
RequestedPackageLineItem.
Multiple piece tag requests will have multiple
RequestedPackageLineItems.
RequestedPackageLineItems cannot exceed 99.

RequestedShipment/
RequestedPackageLineItems/
InsuredValue

Optional. This is the declared value for an individual package.
Use this element if you want to declare a higher value.
Note: InsuredValue refers to declared value of the package.
FedEx does not provide insurance of any kind.
InsuredValue element includes currency and amount.

RequestedShipment/
RequestedShipment/
RequestedPackagesLineItems/
InsuredValue/Amount

Required. 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. 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/
RequestedPackageLineItems/Weight

Optional. Weight element includes units and value.

FedEx Web Services, Developer Guide

150

Chapter 11

Returns Shipping
Table 69. ProcessTagRequest Elements, continued
Element

Description

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.

RequestedShipment/
RequestedPackagesLineItems/
CustomerReferences/Value

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 70. DeleteTagRequest Elements

Use RMA_ASSOCIATION to associate outbound and return
shipments by the RMA Number.
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.

RequestedShipment/
RequestedPackageLineitems/
CustomerReferences/
CustomerReferenceType

DeleteTagRequest

Optional. Specifies where to print the customer reference
value.
Valid values:
• BILL_OF_LADING
• CUSTOMER_REFERENCE
• DEPARTMENT_NUMBER
• ELECTRONIC_PRODUCT_CODE
• INTRACOUNTRY_REGULATORY_REFERENCE
• INVOICE_NUMBER
• P_O_NUMBER
• RMA_ASSOCIATION
• SHIPMENT_INTEGRITY
• STORE_NUMBER

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

ExpressTagAvailability
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 71. ExpressTagAvailabilityRequest Element
Element

Description

ExpressTagAvailabilityRequest

The following elements are required:
• OriginAddress

FedEx Web Services, Developer Guide

151

Chapter 11

Returns Shipping
Table 71. ExpressTagAvailabilityRequest Element, continued
Element

Description
• 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 72. 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.
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 Express / FedEx Ground Printed
Return Label
There are two methods for obtaining printed return labels.

2. Have a return label e-mailed to you
The recipient can then apply this label to the return package as needed and
drop the package off at a FedEx drop-off location. No charges are assessed
until the package is delivered. 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 and FedEx Ground 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.

FedEx Express / FedEx Ground 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

1. Print your own return label after shipment receipt

FedEx Web Services, Developer Guide

152

Chapter 11

Returns Shipping
– $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 Express / FedEx Ground Return Label
Coding Details
The following coding details apply to FedEx Express and FedEx 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.

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. For more
information, see Email Labels on page 142.
• You can override the shipper address information for a returns shipment
by using the Alternate Return Address feature. See Alternate Return
Address on page 154 for more information.
• You can direct the signed return receipt to a different address.

• Customs clearance documents must be generated by country to ensure
shipments are captured and processed correctly.

• Rate quotes are included in the reply for a returns shipment.

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

Print Return Label Elements

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

• Return shipments must be processed as a single piece shipment. Multiple
piece shipments are not supported.

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

153

Chapter 11

Returns Shipping
Table 73. Print Return Label Elements
Element
RequestedShipment/
ShipmentSpecialServicesRequested/
SpecialServiceTypes

Table 73. Print Return Label Elements, continued
Required
Optional

Description

Element

The types of all special services
requested for the enclosing
shipment (or other shipment-level
transaction). Valid values include:

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/ReturnAssociation

Optional

Specifies the data for the
outbound shipment associated
with the return.

RequestedShipment/
ShippingDocumentSpecification/
ReturnInstructionsDetail

Optional

Specifies the production of the
return instructions document.

RequestedShipment/
ShippingDocumentSpecification/
ReturnInstructionsDetail/Format

Optional

Specifies the format of the Return
Instructions shipping document.

RequestedShipment/
ShippingDocumentSpecification/
ReturnInstructionsDetail/CustomText

Optional

Specifies the additional customer
provided text to be inserted into
the return document.

RETURN_SHIPMENT
RequestedShipment/
ShipmentSpecialServicesRequested/
DeliveryOnInvoiceAcceptanceDetail

Optional

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/ReturnType

Required

RequestedShipment/
ShipmentSpecialServicesRequested/
ReturnShipmentDetail/Rma

Optional

Allows customers to direct the
signed return receipt to a
different address.
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.
Return Merchant Authorization
(RMA)
If included, this element has one
optional field:
• Reason: 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.

Required

Description

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.

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:

FedEx Web Services, Developer Guide

154

Chapter 11

Returns Shipping
Table 74. Alternate Return Request Elements
Element

Required

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.

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 http://fedex.com/
developer.
2. Enter your username and password to login to the DRC.
3. Expand "Technical Resources" on the left pane.
4. Expand "FedEx Web Services for Shipping" and choose "Get Started."
5. In the right-hand column of either the "Standard Services" or the
"Advanced Services" tabs, click on the dropdown box for the appropriate
service and choose the format required.
6. Go to the right column in the appropriate tab, select the Download code
dropdown and choose the code in the format needed.
Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the
WSDL guide also.

FedEx Web Services, Developer Guide

155

12 Creating a Label

Thermal Labels

Custom Labels

Doc-Tab Configuration

PNG Label

Laser Labels

Label Review Checklist

Chapter 12

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

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

FedEx offers 2 label formats to support shipping services:

3. FedEx specific barcode:

1. Thermal Labels
2. Laser Labels

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.

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.

– 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.
– 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 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 75. Thermal Label Elements
Web Services Element

Description/Valid Values

LabelSpecification/LabelFormatType

Required to receive the correct label image in the Ship
Reply service:
Valid values are:
• COMMON2D: The label format type to receive a
label.
• FEDEX_FREIGHT_STRAIGHT_BILL_OF_LADING

FedEx Web Services, Developer Guide

157

Chapter 12

Creating a Label
Table 75. Thermal Label Elements, continued
Web Services Element

Description/Valid Values
• LABEL_DATA_ONLY: The value used to receive
the barcode data if you create a custom label.
• VICS_BILL_OF_LADING

LabelSpecification/ImageType

Description/Valid Values
thermal labels) or generic font/size (for plain paper
labels).

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

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.

Valid values are:

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.

Note: These printers are all compatible with the ASCII
Eltron Programming Language (EPL2) page mode.
Required only for thermal labels. Specifies whether
label stock has Doc-Tab on leading or trailing end of
labels or has no Doc-Tab.
Valid values are:
•
•
•
•
•
•

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

CustomerSpecifiedLabelDetail/
CustomContent

Defines any custom content to print on the label.

CustomContent/CoordinateUnits

Valid values for CustomLabelCoordinateUnits:
MILS
PIXELS

CustomContent/TextEntries

Web Services Element

CustomContent/GraphicEntries

• DPL — Unimark
• EPL2 — Eltron
• ZPLII — Zebra

LabelSpecification/LabelStockType

Table 75. Thermal Label Elements, continued

Constructed string, based on format and zero or more
data fields, printed in specified printer font (for

Valid values are:
•
•
•
•

NONE
COMMON_2D
SSCC_18
USPS

Note: USPS is applicable for FedEx SmartPost
shipments.

Sending a Thermal Label to a Local Printer 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
FedEx Web Services, Developer Guide

158

Chapter 12

Creating a Label
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.

Number of Thermal Labels Printed Per Service

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.

U.S.

Supported Thermal Printers
The following thermal printers are recommended with FedEx Web Services:
• Unimark

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

• Eltron
– Orion (EPL2)
– Eclipse (EPL2)

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

• Zebra

2 C.O.D. Return labels

– LP2443 (EPL2)
– LP2844 (EPL2)

U.S. Export International

– LP2348 Plus (EPL2)

Table 77. Number of Thermal Labels Printed Per U.S. Export Intn'l Service

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

Service Type

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

FedEx Express U.S. Export International

1 Shipping label
2 Recipient labels

FedEx Express U.S. Export International
Broker Select Option

1 Shipping label
2 Recipient labels

FedEx Web Services, Developer Guide

159

Chapter 12

Creating a Label
Table 77. Number of Thermal Labels Printed Per U.S. Export Intn'l Service, continued
Service Type

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

FedEx Ground U.S. Export International

1 Shipping label

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

1 Shipping label

Service Type

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

FedEx Express Canada Export International
Broker Select

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

2 C.O.D. Return labels

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

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

Canada Export International

FedEx Express Canada Export International

1 Shipping label

Doc-Tab Configuration

Service Type

Service Type

FedEx Ground Canada (CA) Export
International

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

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

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

Defines the first record of a possible multi-occurence
array

FedEx Web Services, Developer Guide

160

Chapter 12

Creating a Label
Table 78. Doc-Tab Configuration Elements, continued
Desired element

Doc-Tab path (string)

Total Net Charge using List rates

REPLY/SHIPMENT/RATES/PAYOR_LIST_PACKAGE/
TotalNetCharge/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.

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

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

Remainder of path selects data from…

ClientDetail/…

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

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

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

• Rate data, and if so, which rate type

FedEx Web Services, Developer Guide

161

Chapter 12

Creating a Label
Example Doc-Tab Coding

COMMON2D
EPL2
STOCK_4X6.75_LEADING_DOC_TAB
TOP_EDGE_OF_TEXT_FIRST


ZONE001


1
REF
REQUEST/PACKAGE/CustomerReferences[CustomerReferenceType="CUSTOMER_REFERENCE"]/value
LEFT


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


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


4
SHP
REQUEST/SHIPMENT/ShipTimestamp
LEFT


5
WHT
REQUEST/PACKAGE/weight/Value

FedEx Web Services, Developer Guide

162

Chapter 12

Creating a Label
LEFT


6
INS
REQUEST/PACKAGE/InsuredValue/Amount
LEFT


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

FedEx Web Services, Developer Guide

163

Chapter 12

Creating a Label
REPLY/PACKAGE/RATE/ACTUAL/NetCharge/Amount
LEFT



SHIPPER_ACCOUNT_NUMBER



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:

If both a data reference and literal value are passed, literal value takes
precedence over data reference.
The data reference specifies a path to the element desired, based on a
specific starting point:
• Client detail data (ClientDetail)

RequestedShipment
…
LabelSpecification (LabelSpecification)
CustomerSpecifiedLabelDetail (CustomerSpecifiedLabelDetail)
DocTabContent (DocTabContent)
DocTabContentType (DocTabContentType)
Zone001 (DocTabContentZone001)
DocTabZoneSpecifications[] (DocTabZoneSpecification)
ZoneNumber (positiveInteger)
Header (string)
DataReference (string)
LiteralValue (string)
Justification (DocTabZoneJustificationType:string)

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

• An optional header

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:

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

Shipper’s first street address line:
REQUEST/SHIPMENT/Shipper/Address/StreetLines[1]

• An optional justification

Third-party number of shipment uploaded to FedEx InSight® system:

After identifying the zone number, the specification can indicate:

FedEx Web Services, Developer Guide

164

Chapter 12

Creating a Label
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 — 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
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
FedEx Web Services, Developer Guide 165 Chapter 12 Creating a Label
American National Standards Institute (ANSI) MH10.8.3 standard. The 2D barcode is created using the Portable Document Format (PDF) 417 format. 3. FedEx specific barcode: 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. – 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 when applicable. – FedEx 1D (FDX1D) barcode for FedEx Express shipments is created using ANSI/AIM BC4-1995 (Uniform Symbology Specification CODE128). • 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: – Microsoft Internet Explorer 10 or higher Generating a Laser Label The following FedEx Web Services elements are required to generate a laser label: Table 81. Web Services Elements – Firefox 1.0 or higher Web Services Element Description/Valid Values – Mozilla 1.7 or higher LabelSpecification/ LabelFormatType Required to receive the correct label image in the Ship Reply service: 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. • 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. 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. Two dimensional (2D) barcode — The dimensional alphanumeric barcode stores data for both FedEx Express and FedEx Ground shipments using Valid values are: LabelSpecification/ ImageType Required to indicate label formatting. Type of data stream or bitmap to be returned: Valid values are: FedEx Web Services, Developer Guide 166 Chapter 12 Creating a Label Table 81. Web Services Elements, continued Web Services Element Description/Valid Values • PDF — plain paper • PNG — plain paper LabelSpecification/ LabelStockType Required for all label types. Specifies whether label stock has Doc-Tab 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: • PAPER_4X6 • PAPER_4X8 • PAPER_4X9 these values display a plain paper format shipping label: • • • • PAPER_7X4.75 PAPER_8.5X11_BOTTOM_HALF_LABEL PAPER_8.5X11_TOP_HALF_LABEL PAPER_LETTER Note: The PAPER_LETTER value is also valid for international A4 paper format. 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. 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. 3. If you use plain paper instead of label stock, fold the page in half and place it in a waybill pouch. 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. Attach the pouch to your package so that the barcode portion of the label can be read and scanned. Supported Laser Printers 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. 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. Note: For all Mexico to Mexico shipments, if no language is specified, the Legal Terms and Conditions will be provided in Spanish. 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 FedEx Web Services, Developer Guide 167 Chapter 12 Creating a Label the FedEx Common Label Server (CLS), and CLS returns a single buffer with the exception of the C.O.D. Return labels. Intra-Mexico Table 84. Number of Thermal Labels Printed Per Intra-Mexico Service U.S. Service Type Laser Label - PDF Format FedEx Express Intra-Mexico FedEx Express Intra-Mexico Table 82. 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 Non-DG (Dangerous Goods)/Dry ice shipment: 1 Shipping label Intra-Canada Table 85. Number of Thermal Labels Printed Per Intra-Canada Service 2 C.O.D. Return labels Service Type Laser Label - PDF Format FedEx Express Intra-Canada FedEx Express Intra-Canada U.S. Export International Non-DG (Dangerous Goods)/Dry ice shipment: 1 Shipping label Table 83. Number of Thermal Labels Printed Per U.S. Export International Service FedEx Ground Intra-Canada 1 Shipping label FedEx Ground Intra-Canada C.O.D. 1 Shipping label 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 Ground U.S. Export International 1 Shipping label Service Type Laser Label - PDF Format FedEx Ground U.S. Export International C.O.D. 1 Shipping label FedEx Express Canada Export International FedEx Express Canada Export International 2 C.O.D. Return labels 2 C.O.D. Return labels Canada Export International Table 86. Number of Thermal Labels Printed Per Canada Export Int'l Service Non-DG/Dry ice shipment: 1 Shipping label 2 Recipient labels FedEx Web Services, Developer Guide 168 Chapter 12 Creating a Label Table 86. Number of Thermal Labels Printed Per Canada Export Int'l Service, continued Service Type Laser Label - PDF Format 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 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. The rules for using these label formats are: • 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. Custom Labels • The customizable graphic or text must not exceed 2 inches high and 4-1/2 inches wide. 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: • No correction is provided by FedEx. The graphic and/or text prints as it is submitted in the shipping service. 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. • 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. Using a Customizable Section of a Thermal Label • 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. FedEx Web Services provides two thermal label formats that you can customize with either a graphic or text file to prevent the need for creating a • Character insertion point is the top left corner of the first character in the string, at the cap line. 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 169 Chapter 12 Creating a Label • 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. Custom Label TextEntries Elements To Add Text to the 4x8 or4x9 Label, in the Ship Service WSDL, use the following elements. Table 87. 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 Specifies how to create, organize, and return the document. RequestedShipment/LabelSpecification/ LabelFormatType Specifies the type of label to be returned. The label format type should be set to COMMON2D. RequestedShipment/LabelSpecification/ ImageType Specifies 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. Table 87. Custom Label Elements for Text, continued Web Services Element Description/Valid Values 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. 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. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/Position/Y Vertical position, relative to the top edge of the custom area. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/Format Contains the text to be printed on the label. Valid values are: • MILS • PIXELS Only non-negative integers may be used. Only non-negative integers may be used. Note: This is a format string used to format the printed text. It is not the actual text. FedEx Web Services, Developer Guide 170 Chapter 12 Creating a Label Table 87. Custom Label Elements for Text, continued Table 87. Custom Label Elements for Text, continued Web Services Element Description/Valid Values Web Services Element Description/Valid Values RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/DataFields Contains the text to be printed on the label. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Position/Y Vertical position, relative to the top edge of the custom area. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/ThermalFontID Printer-specific font name for use with thermal printer. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Format RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/FontName Generic font name for use with plain paper labels. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/DataFields RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/FontSize Generic font size for use with plain paper labels. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/BarHeight RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ TextEntries/Rotation Relative to normal orientation for the printer. 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 are: • CODEBAR • CODE128 • CODE128B • CODE128C • CODE128_WIDEBAR • CODE39 • CODE93 • 120F5 • PDF417 • POSTNET • QR_CODE • UCC128 Valid values are from 1 to 23. Valid values are: • LEFT • NONE • RIGHT • UPSIDE_DOWN 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/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Position/X Horizontal position, relative to left edge of custom area. Only non-negative integers may be used. FedEx Web Services, Developer Guide 171 Chapter 12 Creating a Label Table 87. Custom Label Elements for Text, continued Table 87. Custom Label Elements for Text, continued Web Services Element Description/Valid Values Web Services Element Description/Valid Values 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/ ShippingDocumentSpecification/ FreightAddressLabelDetail/Copies Indicates the number of copies to be produced for each unique label. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/MaskedData Controls which data/sections will be suppressed. RequestedShipment/ ShippingDocumentSpecification/ FreightAddressLabelDetail/StartingPosition Specifies the quadrant of the page on which the label printing will start. 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/ ShippingDocumentSpecification/ FreightAddressLabelDetail/DocTabContent If omitted, no doc tab will be produced, such as default = former NONE type. Identifies the representation of human-readable text. RequestedShipment/ ShippingDocumentSpecification/ FreightAddressLabelDetail/ CustomContentPosition RelativeVerticalPositionType RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/ TermsAndConditionsLocalization RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/AdditionalLabels Controls the number of additional copies of supplemental labels. Defines any custom content to print on the Freight label. 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. RequestedShipment/ ShippingDocumentSpecification/ FreightAddressLabelDetail/CustomContent 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. RequestedShipment/ ShippingDocumentSpecification/ FreightAddressLabelDetail/Format Specifies characteristics of a shipping document to be produced. 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. Transaction Sample for Custom Text on a Label Note: 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 field 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 ZPLII STOCK_4X8 BOTTOM_EDGE_OF_TEXT_FIRST FedEx Web Services, Developer Guide 172 Chapter 12 Creating a Label PIXELS 50 200 Data for text 14 50 50 %s ShippingDocumentRequest/RequestedShipment/ RequestedPackageLineItems[1]/CustomerReferences[1]/Value 100 8 CODE128C SHIPPER_ACCOUNT_NUMBER Custom Label GraphicEntries Elements To add a graphic to the 4x8 or 4x9 thermal label in the Ship Service WSDL, use the following elements. Only single bit color images should be added since labels will print in black and white. Table 88. Custom Label Elements for Graphics Web Services Element Description/Valid Values RequestedShipment/LabelSpecification/ Description of shipping label to be returned in the reply. RequestedShipment/LabelSpecification/ Dispositions Specifies how to create, organize, and return the document. RequestedShipment/LabelSpecification/ LabelFormatType Specifies the type of label to be returned. The label format type should be set to COMMON2D. RequestedShipment/LabelSpecification/ ImageType Specifies 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. 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). Valid values are: • MILS • PIXELS The following elements are required only for Thermal labels: FedEx Web Services, Developer Guide 173 Chapter 12 Creating a Label Table 88. Custom Label Elements for Graphics, continued Table 88. Custom Label Elements for Graphics, continued Web Services Element Description/Valid Values Web Services Element Description/Valid Values RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries Image to be included from printer's memory, or from a local file for offline clients. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Position/Y Vertical position, relative to the top edge of the custom area. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries/Position Contains the x/y coordinates for placement of the graphic. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries/Position/X Horizontal position, relative to left edge of custom area. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries/Position/Y Vertical position, relative to the top edge of the custom area. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries/PrinterGraphicID Printer-specific index of graphic image to be printed. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/ThinBarWidth Width of thinnest bar/space element in the barcode. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ GraphicEntries/FileGraphicFullName Fully-qualified path and file name for graphic image to be printed. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/BarcodeSymbology 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/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Position/X Horizontal position, relative to left edge of custom area. Identification of the type of barcode (symbology) used on FedEx documents and labels. Specify the BarcodeSymbologyType. Valid values are: • CODEBAR • CODE128 • CODE128B • CODE128C • CODE128_WIDEBAR • CODE39 • CODE93 • 120F5 • PDF417 • POSTNET • QR_CODE • UCC128 x= Only non-negative integers may be used. Only non-negative integers may be used. Only non-negative integers may be used. Only non-negative integers may be used. RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/Format RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/DataFields RequestedShipment/LabelSpecification/ CustomerSpecifiedDetail/CustomContent/ BarcodeEntries/BarHeight FedEx Web Services, Developer Guide 174 Chapter 12 Creating a Label Table 88. Custom Label Elements for Graphics, continued Web Services Element Description/Valid Values 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. Custom Label Barcode Transaction Sample xxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxx XXXXXXXXXXX xxxxxxxxx Ground Shipment Example ship 12 0 0 2013-02-25T12:00:00-05:00 REGULAR_PICKUP FEDEX_GROUND YOUR_PACKAGING John Doe FedEx 9015551234 3610 Hacks Cross Road First Floor Memphis TN 38125 US Joe Customer ABC Widget Co 3305551234 1234 Main Street Suite 200 Akron FedEx Web Services, Developer Guide 175 Chapter 12 Creating a Label OH 44333 US false SENDER xxxxxxxxxxxx COMMON2D ZPLII STOCK_4X8 BOTTOM_EDGE_OF_TEXT_FIRST PIXELS 50 200 Data for text 14 50 50 %s RequestedPackageLineItems[1]/CustomerReferences[1]/Value 100 8 CODE128C SHIPPER_ACCOUNT_NUMBER ACCOUNT 1 1 USD 25.00 LB 10.0 5 5 5 IN CUSTOMER_REFERENCE ref1234 ShippingDocumentRequest/RequestedShipment/ FedEx Web Services, Developer Guide 176 Chapter 12 Creating a 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. 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. The following requirements apply when using the 4" x 6" PNG graphic embedded in your shipping document: To scale the PNG image for a 4" x 6" label in inches: 4" width and 6" length exactly. Label Stock To scale the PNG image for a 4" x 6" label in pixels: PNG Label 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. 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. 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 • If your screen resolution is 96 DPI: – Width = 384 pixels (96 ÷ 200 x 800 = 384) – Height = 576 pixels (95 ÷ 200 x 1200 = 576) • If your screen resolution is 72 DPI: – 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 – Width = Your screen DPI ÷ 200 x 800 – Height = Your screen DPI ÷ 200 x 1200 Label Review Checklist Use these lists to check for problems before you submit each set of labels. All Barcodes Required for validation: • Quiet Zone: Must always have at least 0.1" white space both above and below barcode. FedEx Web Services, Developer Guide 177 Chapter 12 Creating a Label • Quiet Zone: Must always have at least 0.2" white space both left and right of barcode. • Postal code and routing • Validate that all barcodes meet minimum height requirements. • Actual Weight Print Quality • Customer Automation Device information (meter, application/system, version) Common problems that cause labels to be rejected: • Split Bars • Faded Print/White Voids • Repeating White Voids (roller problem) • Smudging (thermal transfer) • Ship date • Dimensions • Miscellaneous reference information • Tracking number and Form ID (Tracking number must be 14 digits) • Airport Ramp ID • Postal code • Flaking (laser) indicates Toner Fusion Problem • Wrinkled in the Print (thermal transfer) Human Readable for Express Labels • Print Contrast for direct thermal labels must be at least 90% The following elements must be printed on the label to pass certification: Human Readable for FedEx Ground Labels Required for validation: Data matches barcode • FedEx Ground logo: Logos are available for download from the FedEx Identity website brand.fedex.com. See Appendix U: FedEx Ground Plain Paper Labels and Appendix V: FedEx Ground Thermal Label Samples. • 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 • FedEx Express logo: Logos are available for download from the FedEx Identity Website brand.fedex.com. See Appendix S: FedEx Express Plain Paper Label Samples and Appendix T: FedEx Express Thermal Label Samples. • 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 FedEx Web Services, Developer Guide 178 Chapter 12 Creating a Label • Postal code and routing • Reference field if an alcohol shipment • URSA routing prefix and suffix • 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 32-character 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. • Handling codes • Service area commitment • Recipient and shipper's phone numbers • Weight • Dims, if applicable (Dims are always required for Express Freight) FedEx Web Services, Developer Guide 179 13 FedEx Express U.S. Shipping FedEx Express U.S. Service Options FedEx Express U.S. Multiple-Package Shipments Express U.S. Service Details Group Multiple Piece Shipments FedEx Express U.S. Coding Details Chapter 13 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. service is available to the 50 United States. Transit times vary depending on the package destination and the service you choose. FedEx Express U.S. Service Options • 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. The following service options are available for use with FedEx Express U.S. shipping: • Chapter 22: Alcohol Shipping • Alternate Return Address • Chapter 20: Dangerous Goods • Chapter 15: Delivery Signature Services • Chapter 24: Dry Ice Shipments • FedEx Express U.S. Multiple-Package Shipments • Chapter 28: Future Day Shipping • Chapter 23: Hold at FedEx Location • Chapter 32: FedEx Intra-Country Shipping • Chapter 27: Masked Data • 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. • Chapter 17: Saturday Service FedEx First Overnight • Chapter 25: Shipment Notification in the Ship Request • Chapter 26: Variable Handling Charges FedEx First Overnight® provides early-morning delivery between 8 and 10 a.m. depending upon the destination postal code. Express U.S. Service Details • Service days are Monday through Friday, with Saturday pickup available in many areas for an additional charge. Before coding a FedEx Express U.S. transaction, you should be familiar with the basic shipping rules for this service: • 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 FedEx Web Services, Developer Guide 181 Chapter 13 FedEx Express U.S. Shipping Hawaii. For more information about Alaska and Hawaii shipments, go to fedex.com/us/service-guide/our-services/us/. • Options include Chapter 17: Saturday Service, Chapter 20: Dangerous Goods support for Chapter 24: Dry Ice Shipments only, and Chapter 15: Delivery Signature Services. 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 Chapter 17: Saturday Service, Chapter 20: Dangerous Goods, support for Inaccessible Dangerous Goods (IDG), Accessible Dangerous Goods (ADG) and Chapter 24: Dry Ice Shipments, Inside Pickup and Delivery, and Chapter 25: Shipment Notification in the Ship Request that includes Chapter 16: FedEx Priority Alert Options (for contracted accounts only), Ship Alert, Exception, and Delivery. 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. • 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 fedex.com/us/service-guide/our-services/us/. • Options include Chapter 17: Saturday Service, Chapter 20: Dangerous Goods, Chapter 19: FedEx Ground U.S. Collect On Delivery (C.O.D.), Chapter 15: Delivery Signature Services and Chapter 23: Hold at FedEx Location. 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. FedEx Web Services, Developer Guide 182 Chapter 13 FedEx Express U.S. Shipping • 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 fedex.com/us/service-guide/our-services/us/. • Options include Chapter 17: Saturday Service, Chapter 20: Dangerous Goods, Chapter 15: Delivery Signature Services, and Chapter 23: Hold at FedEx Location. 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. • 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. Services, Chapter 23: Hold at FedEx Location, Chapter 11: Returns Shipping, and Chapter 25: Shipment Notification in the Ship Request that includes Ship Alert, Exception and Delivery. Note: Shipment notification is not available while tracking a package. 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 Chapter 17: Saturday Service, Chapter 20: Dangerous Goods inaccessible items only, Chapter 15: Delivery Signature Services and Chapter 23: Hold at FedEx Location. 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. • Options include Chapter 17: Saturday Service, Chapter 20: Dangerous Goods support for inaccessible items only, Chapter 15: Delivery Signature FedEx Web Services, Developer Guide 183 Chapter 13 FedEx Express U.S. Shipping • 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 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 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). Express U.S. Basic Ship Request Elements Table 89. Recipient Information Elements, continued Element Description RequestedShipment/Postal Code Required. Recipient postal code. RequestedShipment/ PhoneNumber Required. Recipient phone number. Shipment/Package Information Table 90. Shipment/Package Information Elements Element Description ServiceType Required. Valid values are: • 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 PackagingType Required. Valid values are: • 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 In addition to the basic complex elements required for all web service requests described in the Chapter 1: Introduction, the following elements are available for FedEx Express U.S. ship requests: Recipient Information Table 89. Recipient Information Elements Element Description RequestedShipment/Company 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. Recipient city. RequestedShipment/ StateOrProvinceCode Required. Valid value for FedEx Express – U.S. is U.S. See Appendix B: U.S. State Codes for more information on state codes. FedEx Web Services, Developer Guide 184 Chapter 13 FedEx Express U.S. Shipping Table 90. Shipment/Package Information Elements, continued Element Description U.S. packages are 150 lbs. and 119" in length and 165" in length and girth (L+2W+2H). Label Requirements Table 91. Label Requirements Elements Element Description LabelSpecification 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 Chapter 30: FedEx SmartPost Shipping. 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: • IN • CM 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. • 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. Note: "InsuredValue" refers to declared value of the package. FedEx does not provide insurance of any kind. • Rates and surcharges: For more information on the rating elements that are returned in a Ship Reply, see Chapter 2: 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. MultiplePackage Shipments . 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: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-05:00 is defined as June 26, 2009 5:00 p.m. Eastern Time. See Appendix M: Time Zones for more information about time zones Address/Residential 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 Chapter 8: Address Validation Service. FedEx Express U.S. Ship Reply Elements In the ShipResponse/ProcessShipmentReply, the following elements are returned for a Ship request: • Service commitment. • Routing code. • Origin commitment. • Time-in-transit detail. • Delivery day. • Destination location ID. • Station ID (where applicable). FedEx Web Services, Developer Guide 185 Chapter 13 FedEx Express U.S. Shipping Reference Elements with Output Location The ShipService WSDL uses the CustomerReferences/CustomerReferenceType element to define reference information. Table 92. CustomerReferences/CustomerReferenceType Elements SignatureOptions) is included on the master package. The SequenceID for this package is 1. • In the master package reply, the tracking number assigned to this first package should be in the MasterTrackingID element for all subsequent packages. You must return the master tracking number and increment the package number (SequenceID) for subsequent packages. Value Prints BILL_OF_LADING Shipping label and invoice. Note: The maximum number of packages in an MPS request is 200. CUSTOMER_REFERENCE Shipping label, FedEx Ground shipping reports, and in the Customer Reference element on the invoice. Multiple Piece Shipment Request Elements INVOICE_NUMBER Shipping label and invoice. Table 93. Multiple Piece Shipment Request Elements P_O_NUMBER Shipping label and invoice. RMA_ASSOCIATION Shipping label and invoice. SHIPMENT_INTEGRITY Invoice. STORE_NUMBER Shipping label and invoice. Element Package/ Shipment Level Description SequenceNumber Package Required for multiple-package shipments (MPS). 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. MasterTrackingID Package Required for MPS tracking requests. The reply for the first package (master package) in a shipment includes the MasterTrackingID element. This element the MasterTrackingNumber. FormID is included only for C.O.D. shipments. For each subsequent ship request for an MPS, the MasterTrackingID element is required. MasterTrackingID/ TrackingIDType Package Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX Note: These elements can also be configured to print on the thermal label Doc-Tab. For more information, see the Doc-Tab instructions in Chapter 12: Creating a Label. You may use reference elements to track packages or to tie packages together for a single track request. See Chapter 4: Tracking and Visibility Services for more information. FedEx Express U.S. Multiple-Package Shipments A multiple-package shipment (MPS) consists of two or more packages shipped to the same recipient. To create a multiple-package shipment: • The first package in the shipment request is considered the master package. Any shipment level information (TotalWeight, PackageCount, FedEx Web Services, Developer Guide 186 Chapter 13 FedEx Express U.S. Shipping Table 93. Multiple Piece Shipment Request Elements, continued Element Package/ Shipment Level Description Element Description Note: Use "FEDEX" when using the new standard 34 digit barcode for FedEx Express, FedEx Ground and FedEx SmartPost. Note: Use "FEDEX" when using the standard 34 digit barcode for FedEx Express, FedEx Ground and FedEx SmartPost. PackageCount Shipment 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. TotalShipmentWeight Shipment 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. Multiple Piece Shipment Reply Elements Table 94. 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 Table 94. Multiple Piece Shipment Reply Elements, continued Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX 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 shipment-level detail. 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. Group Multiple-Piece Shipment Details • A shipment must contain two or more packages. FedEx Web Services, Developer Guide 187 Chapter 13 FedEx Express U.S. Shipping • 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 188 14 FedEx Express Freight Services: U.S. FedEx Express Freight Services Details FedEx Express Freight Services Coding Details Chapter 14 FedEx Express Freight Services: U.S. If your package exceeds 150 lbs., you must use FedEx Express® Freight Services. Location, and Chapter 16: FedEx Priority Alert Options (for contracted accounts only). FedEx Express Freight Services Details FedEx 2Day Freight The following service details apply: 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: • Freight must be shrink-wrapped and/or banded to a skid. • Must be palletized, stackable, and forkliftable. • Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. • Available throughout all 50 states; Hawaii service is to and from the island of Oahu only. Not available to Puerto Rico. FedEx 1Day Freight • 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. 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, Chapter 20: Dangerous Goods, Chapter 18: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx • The following special services are allowed (depending on destination location): Saturday Service, Chapter 20: Dangerous Goods, Chapter 18: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx Location, and Chapter 16: FedEx Priority Alert Options (for contracted accounts only). 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. • 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. FedEx Web Services, Developer Guide 190 Chapter 14 FedEx Express Freight Services: U.S. • The following special services are allowed (depending on destination location): Chapter 20: Dangerous Goods, Chapter 18: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx Location, and Chapter 16: FedEx Priority Alert Options (for contracted accounts only). 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. 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 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. • 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. • 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: FedEx Web Services, Developer Guide 191 Chapter 14 FedEx Express Freight Services: U.S. Table 95. U.S. ExpressFreightDetail Elements Table 95. U.S. ExpressFreightDetail Elements, continued Element Description Element Description ExpressFreightDetail/ BookingConfirmationNumber 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, Chapter 20: Dangerous Goods, Chapter 18: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx Location. FedEx Web Services, Developer Guide 192 15 Delivery Signature Services Delivery Signature Service Details Delivery Signature Coding Rules Chapter 15 Delivery Signature Services Shippers can choose from three FedEx® Delivery Signature Options for FedEx Express® and FedEx Ground® shipments: • All packages in a multiple-package shipment must have the same FedEx Delivery Signature Option. Table 96. Delivery Signature Services • All pieces with a declared value of $500USD or $500CAD or greater require a signature. Direct Signature Required is the default service and is provided at no additional cost. If you are shipping a multiple-package shipment and one or more packages has a declared value of $500USD/ CAD or greater, process the package with the lowest value first to avoid multiple delivery charges. Option Service Description Restrictions Special Fees Indirect Signature Required FedEx obtains a signature in one of three ways: • From any person at the delivery address. • From a neighbor, building manager, or other person at a neighboring address. • The recipient can sign a FedEx door tag authorizing release of the package without anyone present. Not available A surcharge for shipments to applies. nonresidential addresses. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Direct Signature Required FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. A surcharge applies. Adult Signature Required FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. A surcharge applies. Delivery Signature Coding Rules • Signature services are supported at the package level for all FedEx Express® and FedEx Ground® services except for FedEx® Collect on Delivery (C.O.D.), where they are supported at the shipment level. • You may choose “No Signature Required” as a valid signature service option in addition to the three signature requirements. Delivery Signature Service Details • An adult signature is required for Chapter 20: Dangerous Goods and alcohol shipments. An adult signature may also be required for shipments containing adult materials or firearms. However, FedEx Web Services cannot edit or monitor the use of an adult signature for these types of shipments. It is your responsibility to choose the Adult Signature Required option. • Once a shipment has been given to FedEx, you may not change the signature option. • Signature service requirements are the same for FedEx Express and FedEx Ground U.S. shipments. • Direct Signature Required is not available for Hold at FedEx Location.. • A signature option is required for international origins shipped to the United States. • Adult Signature Required is available for Chapter 23: Hold at FedEx Location. FedEx Web Services, Developer Guide 194 Chapter 15 Delivery Signature Services Delivery Signature Elements In the ShipService WSDL, the following elements are required to designate a signature option: Table 97. Delivery Signature Elements Element Description SignatureOptionDetail/OptionType Five choices are available: • ADULT • DIRECT • INDIRECT Table 97. Delivery Signature Elements, continued Element Description • NO_SIGNATURE_REQUIRED • SERVICE_DEFAULT Note: If you choose SERVICE_DEFAULT, FedEx Web Services selects the appropriate signature option for your shipping service. For example, if you ship a Chapter 20: Dangerous Goods shipment, the DIRECT signature option is chosen for you. For residential FedEx International Ground® shipments from Canada to the U.S., two valid signature options are allowed: • NO_SIGNATURE_REQUIRED • DIRECT FedEx Web Services, Developer Guide 195 16 FedEx Priority Alert Options FedEx Priority Alert Service Details Chapter 16 FedEx Priority Alert Options Our customer's needs are global. FedEx stays ahead of those needs by expanding its specialized package monitoring service to more than 70 countries spanning the globe — bringing the world closer to you. This expanded service applies to inbound and outbound shipments and provides peace of mind that sensitive shipments will arrive quickly, safety and securely. FedEx Priority Alert™ comes with a promise of proactive monitoring and 24hour connectivity so you know where your shipment is every step of the way. Dedicated support from FedEx means security for you when it matters most. FedEx Priority Alert Plus™ comes with an even higher guarantee — proactive defense. In the unlikely case of a delay, your critical, temperature-sensitive shipment (typically healthcare-related) will get the necessary intervention, such as dry ice replenishment, gel pack reconditioning and access to cold storage. FedEx understands the on-time delivery of critical shipments can save lives. We offer added assurance that your urgent package will be closely watched from the time of departure until it's safely delivered. Pink means priority. Priority Alert packages come equipped with bright pink tape around the package, signaling their priority status when it comes to loading and unloading. FedEx Priority Alert™ and FedEx Priority Alert Plus™ are specialized contractonly, fee-based services that combine 24/7 support, advanced shipment monitoring, proactive notification and customized package recovery for critical and time-sensitive shipments. Shipments receive priority boarding and priority clearance handling. For ease of visibility, all FedEx Priority Alert™ information is printed on the FedEx ASTRA label. A per package surcharge is associated with FedEx Priority Alert™ service. FedEx Priority Alert Plus™ includes all the FedEx Priority Alert™ features of the highest level of advanced monitoring for time and temperature sensitive shipments catering to the financial, aerospace, electronics manufacturing and healthcare industries, plus these options: • Dry Ice Replenishment • Gel Pack Replacement • Cold Storage As with FedEx Priority Alert™, a surcharge is associated with this special service. FedEx Priority Alert Service Details The FedEx Priority Alert and Priority Alert Plus services are supported as an option for the following shipment services: • FedEx First Overnight® • FedEx First Overnight® Freight (for contracted accounts only) • FedEx Priority Overnight® • FedEx 1Day® Freight (Express) • FedEx International Priority® • FedEx International First® • FedEx Europe First® • FedEx International Priority® Freight Shipment Special Services: • Saturday Delivery • Weekday Delivery • Hold Saturday • Hold at FedEx Location Package Special Services: • Dangerous Goods • Dry Ice FedEx Web Services, Developer Guide 197 Chapter 16 FedEx Priority Alert Options Table 98. Priority Alert Basic Complex Elements, continued • Signature Service Option FedEx Priority Alert and Priority Alert Plus require a service contract. If you are interested in signing up for FedEx Priority Alert options, contact your FedEx account executive. Element Description SpecialServicesRequested/ PriorityAlertDetail/ EnhancementTypes Identifies the Priority Alert special service type at Package the package level. Specify PRIORITY_ALERT_PLUS which includes intervention to protect shipment contents. FedEx Priority Alert Coding Details In addition to the basic complex elements required for all ship requests described in the Chapter 1: Introduction, the following elements are required for the FedEx Priority Alert feature: Level Additional Reply Elements Table 99. Priority Alert Additional Reply Elements Basic Complex Elements Element Description Table 98. Priority Alert Basic Complex Elements Surcharges/SurchargeType Identifies the surcharge type returned. For Priority Shipment/ Alert surcharges, this value is returned as Package PRIORITY_ALERT. Surcharges/Description Description of surcharge type returned. Shipment/ Package Surcharges/Amount/Currency Currency Code of surcharge amount returned. Shipment/ Package Surcharges/Amount/Amount Amount of surcharge returned. Shipment/ Package Element Description Level SpecialServicesRequested/ SpecialServiceTypes Identifies the special service type at the package level. Specify PRIORITY_ALERT to notify customers in the event that a critical shipment is delayed. Package Optional. Package SpecialServicesRequested/ PriorityAlertDetail/Content Specify any associated details to include with FedEx Priority Alert Notification. Level FedEx Web Services, Developer Guide 198 17 Saturday Service Saturday Ship and Delivery Service Details Saturday Ship and Delivery Coding Details Chapter 17 Saturday Service In the ShipService WSDL, you may choose Saturday pickup or Saturday delivery services for your FedEx Express® shipments for an additional surcharge. Saturday Ship and Delivery Service Details The following service details apply: • Saturday delivery is available for the following FedEx Express U.S. service types: ® – FedEx Priority Overnight – FedEx 2Day® – FedEx 2Day® A.M. – FedEx 1Day® Freight – FedEx 2Day® Freight – FedEx First Overnight® Freight • Saturday pickup is available for the following FedEx Express U.S. service types: – FedEx Priority Overnight – FedEx Standard Overnight® – FedEx 2Day – FedEx Express Saver® – FedEx First Overnight Freight • Saturday Hold at Location service is available for the following FedEx Express U.S. service types: – FedEx Priority Overnight – FedEx 2Day • To determine if Chapter 17: Saturday Service is available for your shipment origin/destination pair, use the Chapter 3: Package Movement Information Service WSDL ServiceAvailabilityRequest. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Saturday Ship and Delivery Coding Details Saturday service is included in the ShipService WSDL. The following elements are required: Table 100. Saturday Ship and Delivery Request Elements Element Description RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes 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 example, if you choose FedEx Priority Overnight and your ship date is Thursday, Saturday delivery is not allowed. • SATURDAY_PICKUP: Ship date must equal a Saturday date for this option. Note: A Hold At FedEx Location Saturday Delivery indication can be implemented by setting the SpecialServicesRequested to be both HOLD_AT_LOCATION and SATURDAY_DELIVERY. FedEx Web Services, Developer Guide 200 18 FedEx Express Collect on Delivery (C.O.D.) Express C.O.D. Service Details Multiple Piece Shipment C.O.D. Request Elements FedEx Express C.O.D. Coding Details Multiple Piece Shipment C.O.D. Reply Elements Single C.O.D. Shipments Chapter 18 FedEx Express Collect on Delivery (C.O.D.) The FedEx® Collect on Delivery (C.O.D.) option allows you to designate the amount of money that the FedEx Express courier collects from your recipient when the package is delivered. Enrollment is not required. Your recipient can pay by personal check, money order, cashier’s check, company check, official check, or certified check. FedEx returns payment to you the next business day by FedEx Standard Overnight® (where available: otherwise, FedEx 2Day®). An additional surcharge applies to C.O.D. shipments. Express C.O.D. Service Details The following service details apply to FedEx C.O.D.: • C.O.D. service is not available with FedEx SameDay® or FedEx First Overnight®. C.O.D. services is not available to and from extended services areas for FedEx Express® Freight Services shipments. Also, C.O.D. service is not available to and from Puerto Rico or other international locations. ® • These services allow C.O.D.: FedEx Priority Overnight , FedEx Standard Overnight, FedEx 2Day, FedEx 2Day® A.M., FedEx Express Saver® and FedEx Freight. • C.O.D. is not available for FedEx First Overnight. • C.O.D. is not available for international shipments. • C.O.D. is not available for intra-Canada or intra-Mexico FedEx Express shipments. • Two labels are returned in the Ship reply: one outbound label to ship the package and one inbound label to return payment to you. • Valid payment types are: – Secured: cashier’s check, official check, or money order. – Unsecured: personal check, certified check, cashier’s check, official check, money order, or company check. • To code C.O.D. shipments as multiple-piece shipments (MPS), you must submit multiple ship requests. You must submit a ship request for the master package and one ship request for each child package in the MPS. See Single C.O.D. Shipments for more information about the multiple occurrence elements. For C.O.D. multiple-package shipments, a shipping label prints for each package, and one C.O.D. return label prints to return payment to you. • You may override your shipper address to return the payment to a different location. • FedEx Express C.O.D. is requested using the ShipService WSDL. In addition to the basic shipping elements required for a FedEx Express shipment, the following elements are available: For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. • Chapter 20: Dangerous Goods may be shipped using the C.O.D. service. Single C.O.D. Shipments • Chapter 23: Hold at FedEx Location is allowed with the C.O.D. service. Table 101. Single C.O.D. Shipment Elements For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Element Package/ Shipment Level Description FedEx Express C.O.D. Coding Details RequestedShipment/ ShipmentSpecialServicesRequested/ SpecialServiceTypes Shipment This element should be set to COD for a single COD package. For an multiple-piece shipment (MPS) C.O.D., the master package Before you begin coding C.O.D., you should know: FedEx Web Services, Developer Guide 202 Chapter 18 FedEx Express Collect on Delivery (C.O.D.) Table 101. Single C.O.D. Shipment Elements, continued Element Package/ Shipment Level Description Table 101. Single C.O.D. Shipment Elements, continued Element Package/ Shipment Level Note: The collection amount must be added to each package in an MPS C.O.D. shipment. (first package in the sequence) must include this element. Weight Package Individual package weight is required for all shipments. The Weight element includes Weight/Units and Weight/Value. Values for Weight/Units are: • LB • KG CodDetail/ CodAddTransportationChargesDetail Shipment Package Optional for customer packages. Not allowed for FedEx package types. The Dimensions element include: • Width • Height • Length • Units Dimensions/Units values are: • • • • • • • • • Package Valid values are: • Currency: Currency type for C.O.D. For U.S. Express shipments, the currency type is USD. • Amount: The total amount to be collected. For multiple-package shipments, the element must be included on each package and include the total collection amount minus transportation charges. ADD_ACCOUNT_COD_SURCHARGE ADD_ACCOUNT_NET_CHARGE ADD_ACCOUNT_NET_FREIGHT ADD_ACCOUNT_TOTAL_C USTOMER_CHARGE ADD_LIST_COD_SURCHARGE ADD_LIST_NET_CHARGE ADD_LIST_NET_FREIGHT ADD_LIST_TOTAL_CUSTOMER_CHARGE CodDetail/ CodAddTransportationChargesDetail/ RateTypeBasis Shipment The rate type. Valid values are: • ACCOUNT: Uses the customer’s account rate as the basis for the additional charge calculation. • LIST: Uses the FedEx List rate as the basis for the additional charge calculation. CodDetail/ CodAddTransportationChargesDetail/ ChargeBasis Shipment Valid values are: • COD_SURCHARGE: Adds the COD surcharge amount to the collect amount. • NET_CHARGE: Adds the net freight plus surcharges and taxes to the collect amount. • CM • IN SpecialServicesRequested/ CodCollectionAmount Optional. This element allows you to add transportation charges to the C.O.D. collection amount. Valid values are: Weight/Value is entered with one explicit decimal position. Dimensions Description FedEx Web Services, Developer Guide 203 Chapter 18 FedEx Express Collect on Delivery (C.O.D.) Table 101. Single C.O.D. Shipment Elements, continued Element Package/ Shipment Level Description Table 101. Single C.O.D. Shipment Elements, continued Element Package/ Shipment Level • NET_FREIGHT: Adds the base freight charge minus discounts to the collect amount. • TOTAL_CUSTOMER_CHARGE: Adds the net freight charge plus variable handling to the collect amount. CodDetail/ AddTransportationChargesDetail/ ChargeBasisLevel CodDetail/CollectionType CodDetail/CodRecipient Shipment Shipment Shipment Description • • • • • Country State PostalCode Phone Residential (for residential addresses) Valid values are: • CURRENT_PACKAGE: Adds the current package charge basis to the COD amount. • SUM_OF_PACKAGES: Adds the charge basis for all packages in the shipment to the COD amount. CodDetail/ FinancialInstitutionContactAnd Address Shipment When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD. CodDetail/RemitToName Shipment Specifies the name of the person or company receiving the secured/unsecured funds payment. Note: For Express shipments, the COD amount is calculated only at the shipment level; therefore, both of these values use the shipment totals. CodDetail/ReferenceIndicator Shipment Optional. If you want reference information added to the return C.O.D. label, use this element. Values are: • INVOICE • PO • REFERENCE • TRACKING CodDetail/ReturnTrackingId Shipment Only used with multi-piece COD shipments sent in multiple transactions. Required on last transaction only. Required. Valid values are: • ANY • CASH • COMPANY_CHECK • GUARANTEED_FUNDS • PERSONAL_CHECK The C.O.D. return label uses your shipper information as the recipient for the C.O.D. payment. To override this address, the following elements are required: • Contact • Company (if contact is not supplied) • City Multiple Piece Shipment C.O.D. Request Elements Note: The maximum number of packages in an multiple-piece shipment (MPS) request is 200. FedEx Web Services, Developer Guide 204 Chapter 18 FedEx Express Collect on Delivery (C.O.D.) Table 102. Multiple Piece Shipment C.O.D. Request Elements Element Package/ Shipment Level Description RequestedPackageLineItems/ SequenceNumber Package Required for multiple-package shipments. Each C.O.D. 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. MasterTrackingId PackageCount Package Shipment Multiple Piece Shipment C.O.D. Reply Elements Table 103. Multiple Piece Shipment C.O.D. Reply Elements Required for multiple-package shipments. The reply for the first package (master package) in a C.O.D. shipment includes the MasterTrackingId element. This element includes both the MasterTrackingNumber and FormID. For each subsequent ship request for an multiple piece shipment C.O.D., the MasterTrackingId (with MasterTrackingNumber and FormID) element is required. Total number of packages in the multiple-piece C.O.D. shipment. Include this element in the master package request. The maximum number of packages in one rate request is 100. Element Description CreatePendingShipmentReply/ CompletedShipmentDetail/MasterTrackingId/ TrackingNumber Returned in the master package reply for an MPS C.O.D. Includes tracking number and form ID. CreatePendingShipmentReply/ CompletedShipmentDetail/CompletedPackageDetail/ CodReturnPackageDetail/CollectionAmount Total amount printed on the C.O.D. return label. Includes both C.O.D. collection amount and transportation charges (if included in the Ship request). CreatePendingShipmentReply/ CompletedShipmentDetail/CompletedCodDetail/ CollectionAmount The amount to be collected for the shipment. CreatePendingShipmentReply/ CompletedShipmentDetail/CompletedCodDetail/ AdjustmentType Specifies the type of adjustment that was performed to the COD collection amount during rating. CompletedShipmentDetail/AssociatedShipments Provides the customer with the Delivery on Invoice Acceptance data. TotalWeight Shipment 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. Note: Additional shipping options like Chapter 20: Dangerous Goods and Chapter 23: Hold at FedEx Location are available for C.O.D. shipments. Information for each of these options is provided in the applicable topic. For C.O.D. multiple-piece shipments, you may request additional options either on the package level or the shipment level: CodReturnTrackingId Shipment The CodReturnTrackingId (including TrackingNumber and FormID) is returned in the master package reply. This ID is required on the final package in an multiple-piece C.O.D. shipment. Table 104. Multiple Piece Shipment C.O.D. Additional Shipping Options Reply Elements Shipping Option Package vs. Shipment Level Delivery Signature Options Shipment Hazardous Materials Shipment Dry Ice Shipment FedEx Web Services, Developer Guide 205 Chapter 18 FedEx Express Collect on Delivery (C.O.D.) Table 104. Multiple Piece Shipment C.O.D. Additional Shipping Options Reply Elements, continued Table 104. Multiple Piece Shipment C.O.D. Additional Shipping Options Reply Elements, continued Shipping Option Package vs. Shipment Level Shipping Option Package vs. Shipment Level Reference Elements Package Inside Delivery Shipment Shipment Notification Shipment Inside Pickup Shipment Future Day Shipment Saturday Services Shipment Hold at Location Shipment Variable Handling Charge Package FedEx Web Services, Developer Guide 206 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) FedEx Ground C.O.D. Coding Details Ground E.C.O.D. Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) FedEx Ground® C.O.D. allows the shipper to designate the amount of money that the FedEx Ground driver collects from the recipient when a package is delivered. If the FedEx Ground driver collects guaranteed funds, or a company and/or personal check, the payment is sent directly to the shipper via U.S. mail. If cash is collected, by the next business day, FedEx Ground issues a check to the shipper in the amount of the cash collected. The FedEx issued check is sent to the shipper using the U.S. Postal Service. The shipper must designate the type of payment to be collected by FedEx Ground. FedEx Ground C.O.D. is not available with the FedEx Home Delivery® service. Available options with FedEx Ground C.O.D.: • Chapter 15: Delivery Signature Services • Chapter 21: Hazardous Materials (FedEx Ground U.S.) • Additional handling options are available in Chapter 29: FedEx Ground U.S. Shipping. ® Note: FedEx offers a FedEx Ground Electronic C.O.D. (E.C.O.D.) option. When you contract to use this option, FedEx electronically deposits your C.O.D. payment into your bank account within 24 to 48 hours of collection. Because E.C.O.D. is a contract service, you must contact your FedEx account executive to register for this option. No additional entries are required to create an E.C.O.D. shipment in the Ship request. – Unsecured — personal check, certified check, cashier’s check, official check, money order, or company check • C.O.D. shipments can be coded as multiple-package shipments (MPS). This means that you must create multiple C.O.D. packages using multiple Ship requests. These packages must be going to the same destination with the same service type. See Single and Multiple Piece C.O.D. Shipments for more information about multiple occurrence elements. For C.O.D. MPS, a shipping label prints for each package, and one C.O.D. return label prints to return payment to you. • You may override your shipper address if you want the payment returned to a different location. Single and Multiple Piece C.O.D. Shipments FedEx Ground C.O.D. is requested using the ShipService WSDL. In addition to the basic shipping elements required for a FedEx Ground shipment, the following elements are available: Table 105. Single and C.O.D. Multiple Piece Shipment Elements Element Package/ Shipment Level Description RequestedShipment/ ShipmentSpecialServicesRequested/ SpecialServiceTypes Shipment This element should be set to COD for a single C.O.D. package. For a C.O.D multiple-piece shipment (MPS), the master package (first package in the sequence) must include this element. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. FedEx Ground C.O.D. Coding Details Before you begin coding FedEx Ground C.O.D., you should know: • Two labels print at ship time: one inbound label to ship the package and one outbound label to return payment to you. Note: The COD special service type and associated information are added at the package level under RequestedPackageLineItems. • Valid payment amounts are: – Secured — cashier’s check, official check, or money order Weight Package Individual package weight is required for all shipments. The Weight element FedEx Web Services, Developer Guide 208 Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) Table 105. Single and C.O.D. Multiple Piece Shipment Elements, continued Element Package/ Shipment Level Description includes Weight/Units and Weight/ Value. Values for Weight/Units are: • LB • KG Table 105. Single and C.O.D. Multiple Piece Shipment Elements, continued Element Package Optional for customer packages. Not allowed for FedEx package types. The Dimensions element includes: • Width • Height • Length • Units CodAddTransportationChargesDetail/ RateTypeBasis Valid values are: • Currency: Currency type for C.O.D. For U.S. Express shipments, the currency type is U.S. • Amount: The total amount to be collected. For MPS, the element must be included on each package and include the total collection amount minus transportation charges. Note: The collection amount must be added to each package in an MPS C.O.D. shipment. Since FedEx Ground packages do not travel together and may be delivered at different times, you Optional. Select the type of rate from which the element is to be selected. • ACCOUNT: Uses the customer’s account rate as the basis for the additional charge calculation. • LIST: Uses the FedEx List rate as the basis for the additional charge calculation. CodAddTransportationChargesDetail/ ChargeBasis Valid values are: • COD_SURCHARGE: Adds the COD surcharge amount to the collect amount. • NET_CHARGE: Adds the net freight plus surcharges and taxes to the collect amount. • NET_FREIGHT: Adds the base freight charge minus discounts to the collect amount. • TOTAL_CUSTOMER_CHARGE: Adds the net freight charge plus variable handling to the collect amount. CodAddTransportationChargesDetail/ ChargeBasisLevel Valid values are: • CURRENT_PACKAGE: Adds the current package charge basis to the COD amount. • SUM_OF_PACKAGES: Adds the charge basis for all packages in the shipment to the COD amount. • CM • IN Package Shipment Valid values are: Dimensions/Units values are: CodDetail/CollectionAmount Description should add the value for the individual packages to be collected. Weight/Value is entered with one explicit decimal position. Dimensions Package/ Shipment Level FedEx Web Services, Developer Guide 209 Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) Table 105. Single and C.O.D. Multiple Piece Shipment Elements, continued Element Package/ Shipment Level Description Note: For Express shipments, the COD amount is calculated only at the shipment level; therefore, both of these values use the shipment totals. CodRecipient CodDetail/CollectionType CodDetail/CodRecipient Shipment Shipment Shipment The C.O.D. return label uses your shipper information as the recipient for the C.O.D. payment. To override this address, the following elements are required: • Contact • Company (if contact is not supplied) • City • Country • State • PostalCode • Telephone • Residential (for residential addresses) Required. Valid values are: • ANY • CASH • COMPANY_CHECK • GUARANTEED_FUNDS • PERSONAL_CHECK For Express, this is the descriptive data that is used for the recipient of the FedEx Letter containing the COD payment. For Ground, this is the descriptive data for the party to receive Table 105. Single and C.O.D. Multiple Piece Shipment Elements, continued Element Package/ Shipment Level Description the payment that prints the COD receipt. CodDetail/FinancialInstitutionContact AndAddress Shipment When the FedEx COD payment type is not CASH, indicates the contact and address of the financial institution used to service the payment of the COD. RemitToName Shipment Specifies the name of the person or company receiving the secured/ unsecured funds payment. CodDetail/ReferenceIndicator Shipment Optional. If you want reference information added to the return C.O.D. label, use this element. Values are: • INVOICE • PO • REFERENCE • TRACKING ReturnTrackingId Shipment Only used with multiple-piece C.O.D. shipments sent in multiple transactions. Required on last transaction only. Example C.O.D. Transaction XXXXXXXXXX XXXXXXXXXX XXXXXXXXXX FedEx Web Services, Developer Guide 210 Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) XXXXXXXXXX ** TEST TRANSACTION ** ship 12 0 0 2012-05-07T20:53:40.250Z REGULAR_PICKUP STANDARD_OVERNIGHT YOUR_PACKAGING Mr. Test Widgets Inc. 9015551212 3318 Pembridge Street Thousand Oaks CA 91360 US Jean Austin Widgets 9015551212 123 Main Street Atlanta GA 30303 US true SENDER XXXXXXXXXX COD USD 100.00 GUARANTEED_FUNDS COMMON2D EPL2 STOCK_4X6.75_LEADING_DOC_TAB TOP_EDGE_OF_TEXT_FIRST ACCOUNT 1 1 LB FedEx Web Services, Developer Guide 211 Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) 8.0 Multiple-Piece Shipment C.O.D. Elements Table 106. Multiple-Piece Shipment C.O.D. Elements, continued Element Package/ Shipment Level Description TotalShipmentWeight Shipment Total shipment weight is added to the master package in the MPS and contains the total weight of all packages in the shipment. Table 106. Multiple-Piece Shipment C.O.D. Elements Element Package/ Shipment Level Description SequenceNumber Package Required for multiple-piece shipments (MPS). Each C.O.D. 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. MasterTrackingId MasterTrackingID/ TrackingIDType PackageCount Package Package Shipment Required for MPS. The reply for the first package (master package) in a C.O.D. shipment includes the MasterTrackingID element. This element includes both the MasterTrackingNumber and FormID. For each subsequent ship request for an MPS C.O.D., the MasterTrackingID (with MasterTrackingNumber and FormID) element is required. Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX Total number of packages in the C.O.D. multiple-piece shipment. Include this element in the master package request. Reply Elements Table 107. Multiple-Piece Shipment C.O.D. Reply Elements Element Description CompletedShipmentDetail/ MasterTrackingId/ TrackingNumber Returned in the reply for a single piece C.O.D. for Express shipping. Includes tracking number and form ID. MasterTrackingId Returned in the master package reply for an MPS C.O.D. Includes tracking number and form ID. MasterTrackingID/ TrackingIDType Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX Surcharge/SurchargeType COD for C.O.D. surcharge amount for shipment. SpecialServicesRequested/ CodDetail/ReturnTrackingId Optional. Returned in the reply only when used with multipiece COD shipments sent in multiple transactions. Required on last transaction only. CompletedShipmentDetail/ CompletedCodDetail/ CollectionAmount The amount to be collected for the shipment. FedEx Web Services, Developer Guide 212 Chapter 19 FedEx Ground U.S. Collect On Delivery (C.O.D.) Table 107. Multiple-Piece Shipment C.O.D. Reply Elements, continued Element Description CompletedShipmentDetail/ CompletedCodDetail/ AdjustmentType Specifies the type of adjustment that was performed to the COD collection amount during rating. Note: Additional shipping options like Hazardous Materials and Shipment Notification are available for C.O.D. shipments. Information for each of these options is provided in the applicable topic. For MPS C.O.D. shipments, you may request additional options either on the package level or the shipment level: Table 108. Additional Multiple-Piece Package/Shipment C.O.D. Options Ground E.C.O.D. Use the FedEx Ground E.C.O.D. service option to receive funds within 24 to 48 hours after shipment delivery. Shippers receive monies via electronic funds transfer. Contact your FedEx account executive for more information about E.C.O.D. E.C.O.D. is not available with FedEx Home Delivery service. You can ship either C.O.D. and/or E.C.O.D., but you cannot use both services simultaneously under the same meter number. Available options with FedEx Ground E.C.O.D.: • Chapter 15: Delivery Signature Services Shipping Option Package vs. Shipment Level Delivery Signature Options Shipment Hazardous Materials Shipment Dry Ice Shipment Reference Elements Package • FedEx Home Delivery Convenient Delivery Options Shipment Notification Shipment • Chapter 26: Variable Handling Charges Future Day Shipment Variable Handling Charge Package • Prepaid or third-party billing only • Declared Value • Chapter 21: Hazardous Materials (FedEx Ground U.S.) Shipping a FedEx Ground E.C.O.D. package requires three thermal labels. Label 1 must be affixed to the outside shipping container. Labels 2 and 3 must be placed in a FedEx Ground C.O.D. pouch (OP013 POUCH) and affixed to the outside shipping container. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. FedEx Web Services, Developer Guide 213 20 Dangerous Goods Dangerous Goods Service Details Dangerous Goods Coding Details Chapter 20 Dangerous Goods 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. Accessible dangerous goods may be shipped using: • FedEx Priority Overnight® • FedEx 1Day® Freight • FedEx International Priority® • FedEx International Priority® Freight • FedEx International Economy® • FedEx International Economy® Freight Inaccessible dangerous goods may be shipped using: 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. Note: For FedEx Ground® services, these types of shipments are referred to as hazardous materials (HazMat) shipments. • FedEx Priority Overnight • FedEx Standard Overnight® ® • FedEx 2Day Dangerous Goods Service Details The following shipping rules apply to dangerous-goods shipments: ® • 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. • 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 GlobalShipAddress 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 Web Services, Developer Guide 215 Chapter 20 Dangerous Goods • 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. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Table 109. Dangerous Goods Coding Details Elements, continued Element Requirements /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. Lithium batteries with 5 grams or more of lithium should also be labeled HAZMAT. See Chapter 21: Hazardous Materials (FedEx Ground U.S.) for more information. • LIMITED_QUANTITIES_COMMODITES: • LITHIUM_BATTERY_EXCEPTION: Package contains lithium batteries with nonhazardous quantities of lithium. Nonhazardous lithium batteries contain less than 5 grams of lithium. HazMat lithium batteries contain 5 grams or more of lithium and will be treated as hazardous materials. • ORM_D: 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. Dangerous Goods Coding Details The following ShipService WSDL elements are available for dangerous goods: Table 109. 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 are: • ADR • DOT • IATA • ORMD /DangerousGoodsDetail/Accessibility Identifies whether or not the products being shipped accessible or inaccessible during delivery. /DangerousGoodsDetail/PackingOption Valid values are: • ACCESSIBLE • INACCESSIBLE /DangerousGoodsDetail/CargoAircraftOnly Optional. Shipment is packaged and documented for movement on cargo aircraft only. 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. FedEx Web Services, Developer Guide 216 Chapter 20 Dangerous Goods Table 109. Dangerous Goods Coding Details Elements, continued Table 109. Dangerous Goods Coding Details Elements, continued Element Requirements Element Requirements /DangerousGoodsDetail/Containers Indicates one or more containers used to pack dangerous goods commodities. /Description/SequenceNumber Containers/PackingType Indicates whether there are additional inner receptacles within this container. In conjunction with the regulatory identifier, this field uniquely identifies a specific hazardous materials commodity. /Description/PackingGroup Identifies DOT packing group for a hazardous commodity. /Description/PackingDetails Specifies 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. These description elements are formatted on the OP-950 form in 25-character columns (up to 6 printed lines). /Description/TechnicalName Hazardous material technical name. /Description/Percentage Specifies the percentage for the hazardous commodity. /Description/HazardClass DOT hazardous material class or division. /Description/SubsidiaryClasses Hazardous material subsidiary classes. /Description/LabelText Indicates the number of occurrences of this container with identical dangerous goods configuration. DOT diamond hazard label type. Can also include limited quantity or exemption number. /Description/ProcessingOptions Documents the kinds and quantities of all hazardous commodities in the current container. 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 Specifies the amount of the commodity in alternate units. Valid value is: ALL_PACKED_IN_ONE Containers/ContainerType Containers/RadioactiveContainerClass 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. 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 Containers/HazardousCommodities Containers/HazardousCommodities HazardousCommodityContent/Description Identifies and describes an individual hazardous commodity. /Description/Id Regulatory identifier for a commodity (e.g. "UN ID" value). FedEx Web Services, Developer Guide 217 Chapter 20 Dangerous Goods Table 109. Dangerous Goods Coding Details Elements, continued Element Requirements 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 Specifies 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 Chapter 21: Hazardous Materials (FedEx Ground U.S.) for more information. /DangerousGoodsDetail/Signatory Specifies 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 Specifies the contact of the party responsible for handling the infectious substances, if any, in the dangerous goods shipment. /DangerousGoodsDetail/AdditionalHandling Specifies additional handling information for the current package. /DangerousGoodsDetail/RadioactivityDetail Specifies the radioactivity detail for the current package, if the package contains radioactive materials. Table 109. Dangerous Goods Coding Details Elements, continued Element Requirements Valid values are: • TransportIndex • SurfaceReading • CriticalitySafetyIndex • Dimensions Note: For details about creating a Shipper's Declaration for Dangerous Goods form, see the Shipping Document Service section. 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 218 21 Hazardous Materials (FedEx Ground U.S.) Hazardous Materials Service Details Hazardous Materials Coding Details Chapter 21 Hazardous Materials (FedEx Ground U.S.) FedEx Web Services supports FedEx Ground® hazardous materials (hazmat) shipping under 49CFR — FedEx Ground regulations. Hazardous Materials Coding Details Note: For FedEx Express® services, these types of shipments are referred to as Chapter 20: Dangerous Goods. 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: Hazardous Materials Service Details Table 110. Hazardous Materials Elements The following service details apply to hazardous materials shipments: • Ship, rate, and track services are available for Dangerous Goods shipments for HazMat, ORM-D, Dry Ice, Small Quantity Exception and HazMat/NonHazMat Lithium Battery. Element Description SpecialServicesRequested/DangerousGoodsDetail/ Set to HAZARDOUS_MATERIALS. Options • FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. SpecialServicesRequested/DangerousGoodsDetail/ Describes the kinds and quantities of all Containers/HazardousCommodities hazardous commodities in the package, including customer-specified options for handling and regulatory identifiers. • FedEx Ground HazMat weight is limited to 70 lbs. 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. • 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 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. Valid values are: • 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 single package. If you create a multiplepackage 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. DEFAULT I II III Description/PackingDetails Specifies documentation and limits for validation of an individual packing group/category. FedEx Web Services, Developer Guide 220 Chapter 21 Hazardous Materials (FedEx Ground U.S.) Table 110. Hazardous Materials Elements, continued Table 110. Hazardous Materials Elements, continued Element Description Element Description Description/PackingDetails/PackingInstructions Coded specification for how commodity is to be packed. Quantity/Units Description/ReportableQuantity Specifies the reportable quantity for the hazardous commodity Units by which the hazardous commodity is measured. For IATA commodity, the units values are restricted based on regulation type. Quantity/QuantityType Specifies 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 Specifies the quantity contained in the inner receptacle. 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 25character columns (up to 6 printed lines). Description/TechnicalName Hazardous material technical name. Description/Percentage Specifies the percentage for the hazardous commodity HazardousCommodities/Options Customer-provided specifications for handling individual commodities. Description/HazardClass DOT hazardous material class or division. Options/LabelTextOption Description/SubsidiaryClasses Hazardous material subsidiary classes. Specifies how the customer wishes the label text to be handled for this commodity in this package. Description/LabelText DOT diamond hazard label type. Can also include limited quantity or exemption number. Options/CustomerSuppliedLabelText Text used in labeling the commodity under control of the LabelTextOption field. Description/ProcessingOptions Specifies any special processing to be applied to the dangerous goods commodity description validation. HazardousCommodities/RadionuclideDetail Specifies the details of any radio active materials within the commodity. RadionuclideDetail/Radionuclide An atom with an unstable nucleus. Valid value is: RadionuclideDetail/Activity The number of radioactive decays per second. INCLUDE_SPECIAL_PROVISIONS Activity/Value The data content of this instance. Information related to quantity limitations and operator or state variations as may be applicable to the dangerous goods commodity. Activity/UnitOfMeasure Valid values are: • BQ • GBQ • KBQ • MBQ • PBQ • TBQ Description/Authorization HazardousCommodities/Quantity Specifies the amount of the commodity in alternate units. Quantity/Amount Number of units of the type specified in "Units." FedEx Web Services, Developer Guide 221 Chapter 21 Hazardous Materials (FedEx Ground U.S.) Table 110. Hazardous Materials Elements, continued Element Description RadionuclideDetail/ ExceptedPackagingIsReportableQuantity Indicates whether packaging type EXCEPTED or EXCEPTED_PACKAGE is for radioactive material in reportable quantity. RadionuclideDetail/PhysicalForm Valid values are: • GAS • LIQUID • SOLID • SPECIAL RadionuclideDetail/ChemicalForm Table 111. Hazardous Materials Reply Elements, continued Element the client provided a package configuration for several packages that have the exact same dangerous goods content. HazardousPackageDetail/Accessibility HazardousPackageDetail/CargoAircraftOnly When true indicates that the package can be transported only on a cargo aircraft. HazardousPackageDetail/ RadioactiveTransportIndex Specifies the maximum radiation level from the package (measured in microSieverts per hour at a distance of one meter from the external surface of the package, divided by 10). HazardousPackageDetail/LabelType Specifies the label that is to be put on a package containing radioactive material. The label type is determined in accordance with the Transportation of Dangerous Goods Act and indicates the type of radioactive material being handled as well as the relative risk. — SpecialServicesRequested/DangerousGoodsDetail/ Telephone number to use for contact in the event EmergencyContactNumber of an emergency. SpecialServicesRequested/DangerousGoodsDetail/ Shipper name (offeror) or contact number. Offeror Required on all shipping papers, including OP900LL, OP-900LG forms, and Hazardous Materials Certification per DOT regulation. Valid values are: • III_YELLOW • II_YELLOW • I_WHITE 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 fedex.com/us/services/options/hazmat. 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. Hazardous Materials Reply Elements Table 111. Hazardous Materials Reply Elements Element Description CompletedPackageDetail/HazardousPackageDetail Documents the kinds and quantities of all hazardous commodities in the current package, using updated hazardous commodity description data. HazardousPackageDetail/ReferenceID Description A unique reference id that matches the package to a package configuration. This is populated if FedEx Web Services, Developer Guide 222 Chapter 21 Hazardous Materials (FedEx Ground U.S.) 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. FedEx Web Services, Developer Guide 223 22 Alcohol Shipping Alcohol Shipping Coding Details Chapter 22 Alcohol Shipping Before you process shipments containing alcohol, review the following information: • You must sign a FedEx Alcohol Shipping Agreement prior to shipping. Contact your FedEx account executive to start the enrollment process. • You must identify alcohol shipments in the description. This applies to all pieces in a multiple piece shipment and must be done for the first pieces in the shipment. Note: If Alcohol special service is not specified for the first package in the shipment, but is specified for a subsequent package in the shipment, then the transaction will fail for all pieces. • Common carriers, such as FedEx Express® and FedEx Ground® must report alcohol shipping activity to state authorities on a regular basis. For this reason, shippers must notify FedEx of each shipment containing alcohol via their electronic FedEx shipping solution and by applying FedEx alcohol shipping labels and by attaching an extra Alcohol sticker (SEL 169) to each package. You can get these stickers from your FedEx Sales Account Executive. • FedEx will assign the Adult Signature Required signature option to the package (ship, rate, and email return transactions). • FedEx will apply the associated Adult Signature Required surcharge to the package (ship, rate, and email return transactions). • FedEx will add $AW to the beginning of the customer’s reference field (ship and email return transactions only). • State law, as well as FedEx policy, requires an adult signature at the time of delivery for every package containing alcohol. It is the shipper’s responsibility to ensure an adult is available to sign for the shipment at delivery. If a shipper fails to follow the procedures outlined herein, the shipment will be deemed undeliverable. Violations may result in suspension or termination of your FedEx account. For more information about alcohol shipping, go to fedex.com/us/wine/ gettingstarted.html. FedEx accepts shipments of alcohol (beer, wine, and spirits) within the U.S. and for both U.S. import and export when the shipper and the recipient are licensed to import and/or export alcohol. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Alcohol Shipping Coding Details The following ShipService WSDL and RateService WSDL elements are available for alcohol shipping: Table 112. Alcohol Shipping Elements Element Requirements RequestedPackageLineItems/ SpecialServicesRequested/ SpecialServiceTypes Specify ALCOHOL Reply/CompletedShipmentDetail/ CompletedPackageDetails/ SignatureOption FedEx assigns ADULT. Reply/CompletedShipmentDetail/ CompletedPackageDetails/ PackageRating/PackageRateDetails/ Surcharges/SurchargeTypes FedEx assigns SIGNATURE_OPTION. FedEx Web Services, Developer Guide 225 23 Hold at FedEx Location Hold at FedEx Location Service Details Samples Chapter 23 Hold at FedEx Location Hold at FedEx Location (HAL) is available to customers who want to pick up a package rather than have it delivered. The shipper must select the FedEx pickup location from designated FedEx Office® Print and Ship Center or FedEx World Service Center® locations. You must first use the GlobalShipAddress Service WSDL to locate FedEx locations to use with the Hold at FedEx Location option. Hold at FedEx Location Service Details The following shipping services allow the HOLD_AT_LOCATION option: • FedEx Priority Overnight® (Saturday service available) • FedEx Standard Overnight® • FedEx 2Day® (Saturday service available) • FedEx 2Day® A.M. • FedEx Express Saver® • FedEx 1Day® Freight • FedEx 2Day® Freight • FedEx 3Day® Freight available for FedEx Freight. Use GlobalShipAddress Service to determine if Hold at FedEx Location is available between your origin ZIP code and destination ZIP code. For FedEx Express® and FedEx Ground® shipments, you also have the option of requesting Adult Signature Required for pickup at the FedEx location. The standard Adult Signature Surcharge applies. Note: Hold at FedEx Location service is not available for intra-United Kingdom shipments. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Hold at FedEx Location Coding Details The following ShipService WSDL elements are required for Hold at FedEx Location: Table 113. Hold at FedEx Location Elements Element Description RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes For the Hold At FedEx Location service, you must include a SpecialServiceTypes element with the value HOLD_AT_LOCATION. Note: A Hold At FedEx Location Saturday Delivery indication can be implemented by setting the SpecialServicesRequested/ SpecialServiceTypes to be both HOLD_AT_LOCATION and SATURDAY_DELIVERY. • FedEx Ground® • FedEx Home Delivery® Hold at FedEx Location service is also available for certain international shipments. Services include FedEx International Priority®, FedEx International Economy®, FedEx International Priority® Freight and FedEx International Economy® Freight. Call 1.800.GoFedEx 1.800.463.3339 and say “International Services” to confirm pickup date and time. The service is not available for FedEx SameDay® or FedEx First Overnight®. Saturday Hold at FedEx Location Services is available for FedEx Priority Overnight and FedEx 2Day. Saturday Hold at FedEx Location service is not RequestedShipment/ SpecialServicesRequested/ HoldAtLocationDetail/ PhoneNumber When your Hold at FedEx Location shipment is received at the designated FedEx location, you will be notified that your shipment is ready to be picked up. RequestedShipment/ SpecialServicesRequested/ HoldAtLocationDetail/ LocationContactAndAddress/ Contact The contact information. FedEx Web Services, Developer Guide 227 Chapter 23 Hold at FedEx Location Table 113. Hold at FedEx Location Elements, continued Element Description RequestedShipment/ SpecialServicesRequested/ HoldAtLocationDetail/ LocationContactAndAddress/ Address The FedEx location address where you want to have your shipment held for pickup is required in the ship transaction. For a list of available FedEx locations, use the FedEx GlobalShipAddress Service to search for FedEx locations where Hold at FedEx Location service is available. You must obtain the eligible Location Address from the GlobalShipAddress Service WSDL and populate this element with the data found in the SearchLocationsReply element. 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 228 24 Dry Ice Shipments Dry Ice Service Details Dry Ice Coding Details Chapter 24 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. While dry ice is not considered a Chapter 20: Dangerous Goods material, you must clearly mark all packages that contain dry ice. 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. 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 a packing material and does not require any Chapter 20: Dangerous Goods elements for shipping. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Dry Ice Coding Details The following ShipService WSDL elements are required for dry ice: Table 114. 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. RequestedShipment/ SpecialServicesRequested/ ShipmentDryIceDetail/ PackageCount Number of packages in this shipment which contain dry ice. This element is required when SpecialServiceType DRY_ICE is present in the SpecialServiceTypes collection at the package level. RequestedShipment/ Descriptive data or total weight of the dry ice for this shipment. SpecialServicesRequested/ Descriptive data includes Units, in KGs, and Value. ShipmentDryIceDetail/TotalWeight Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. 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 http://fedex.com/ developer. FedEx Web Services, Developer Guide 230 Chapter 24 Dry Ice Shipments 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. FedEx Web Services, Developer Guide 231 25 Shipment Notification in the Ship Request Shipment Notification Coding Details Chapter 25 Shipment Notification in the Ship Request Notification may be included in the ShipService or requested after shipping through TrackService SendNotificationsRequest. The ShipService ShipmentSpecialServicesRequested/EmailNotificationDetail element allows you to request that FedEx email exception and delivery notifications be sent to you, your recipient, and up to six (6) other email addresses. A personal message can also be included. Note: Shipment Notification emails are not sent for ship transactions in a Test environment, even if the request is configured correctly. In addition to the current email notifications of “On Delivery,” “On Exception,” and “On Shipment,” FedEx now offers a new email notification of “On Tender,” which may be specified with the shipment request, in addition to the existing “Delivery,” “Exception,” and “Shipment” email notifications. Use the “On Tender” email notification if you want an email notification sent to the specified recipients once the shipment has been tendered to FedEx. This notification is supported for FedEx Express®, FedEx Ground®, FedEx Freight® Economy, and FedEx SmartPost®. Note: If you include notification elements in your Ship request, you do not need to use the TrackService Notification option for that shipment. The TrackService Notification option is provided if no notification request has been made for an undelivered shipment. Shipment Notification Coding Details In addition to the standard elements required for all transactions described in the Chapter 1: Introduction, the following elements are provided as part of the ShipService WSDL: Shipment Notification Elements Table 115. Shipment Notification Elements Element Required Description RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes Required Set type as EMAIL_NOTIFICATION. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail Required Descriptive data required for FedEx to provide email notification to the customer regarding the shipment. This element is required when SpecialServiceType. EMAIL_NOTIFICATION is present in the SpecialServiceTypes collection. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ PersonalMessage Optional Identifies the message text to be sent in the email notification. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients Required Up to six (6) email addresses to receive the specified shipment notification. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ EmailNotificationRecipient Optional Identifies the set of valid email notification recipient types. For SHIPPER, RECIPIENT, and BROKER, any email address sent with the email notification for these three email notification recipient types will overwrite the email addresses associated with the SHIPPER, RECIPIENT, and BROKER definitions. Valid values are: • BROKER • OTHER • RECIPIENT • SHIPPER • THIRD_PARTY RequestedShipment/ SpecialServicesRequested/ Required The email address of the notification recipient. FedEx Web Services, Developer Guide 233 Chapter 25 Shipment Notification in the Ship Request Table 115. Shipment Notification Elements, continued Element Required Description EmailNotificationDetail/ Recipients/ EmailAddress RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ EMailNotificationAggregation Type Optional Specifies whether/how email notifications are grouped. Valid values are: • PER_PACKAGE • PER_SHIPMENT RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ NotificationEventsRequested/ EmailNotificationEventType Required RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ NotificationEventsRequested/ EmailNotificationEventType/ ON_DELIVERY Optional RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ NotificationEventsRequested/ EmailNotificationEventType/ ON_EXCEPTION Optional Identifies if an email notification should be sent to the recipient when an exception occurs during package movement from origin to destination. RequestedShipment/ SpecialServicesRequested/ Optional Identifies if an email notification should be sent to the recipient when the package is shipped. Identifies if an email notification should be sent to the recipient: • ON_DELIVERY • ON_EXCEPTION • ON_SHIPMENT • ON_TENDER Identifies if an email notification should be sent to the recipient when the package is delivered. Table 115. Shipment Notification Elements, continued Element Required EmailNotificationDetail/ Recipients/ NotificationEventsRequested/ EmailNotificationEventType/ ON_SHIPMENT Description Note: Shipment Notification emails are not sent for ship transactions in a Test environment, even if the request is configured correctly. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ON_TENDER Optional Identifies if an email notification should be sent to the recipient when the shipment is tendered to FedEx. RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Format Required This element is required to specify the type of notification you want to receive. Valid values are: • HTML • Text • Wireless RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Localization/ Language Required You may include a language code to have the email message returned in that language. See "Tracking and Visibility Services" for a table of valid language codes. If no value is included with this element, the default is EN (English). RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Localization/ LocaleCode Optional Some languages require a locale code to further identify the requested language. For example, if you request the notification emails in Spanish, you must include a locale code of "US" for North American Spanish. See Notification Service Details for a table of valid locale codes. FedEx Web Services, Developer Guide 234 26 Variable Handling Charges Variable Handling Coding Details Chapter 26 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 Ship reply and can be configured to print on the 4" x 6" thermal label Doc-Tab. See Canada Export International for more information. Table 116. Variable Handling Elements, continued Element Required Requirements VariableHandlingChargeDetail Required Valid values are: • 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 Canadaorigin 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 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 display as an individual itemized amount and follow shipments across FedEx systems. 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 116. Variable Handling Elements Element Required VariableHandlingChargeDetail/ RateTypeBasisType/ RateTypeBasis VariableHandlingChargeDetail/ RateElementBasisType/ RateElementBasis Requirements The rate type. Valid values are: • 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 are: • 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. FedEx Web Services, Developer Guide 236 Chapter 26 Variable Handling Charges 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. 3. Expand "Technical Resources" on the left pane. Samples Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. 2. Enter your username and password to login to the DRC. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 237 27 Masked Data Masked Data Coding Details Samples Error Messages Chapter 27 Masked Data In the ShipService WSDL, you can choose to have some data masked on the shipping label for security purposes. The shipper's account number is automatically masked. Masked Data Coding Details If the following element is included in the Ship request, your specified options will be masked on the shipping label: Table 117. Masked Data Coding Elements Element Required Description MaskedData No MaskedData allows customers to prevent the following types of information from being printed on the label. Valid values are: • CUSTOMS_VALUE • DUTIES_AND_TAXES_PAYOR_ACCOUNT_NUMBER • TERMS_AND_CONDITIONS • TRANSPORTATION_CHARGES_PAYOR_ACCOUNT_NUMBER Samples 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: FedEx Web Services, Developer Guide 239 28 Future Day Shipping Future Day Service Details Future Day Coding Details Chapter 28 Future Day Shipping FedEx Web Services allows you to perform future day shipping for all supported FedEx shipping types. Table 118. Future Day Shipping Elements, continued Element Requirements • For Express shipping, entry must be less than or equal to 10 days in the future. • For Express freight, entry must be less than or equal to 5 days in the future. Future Day Service Details The following service details apply to future day shipping: • Future day shipping is available for FedEx Express® U.S., FedEx Express® international, FedEx Ground® U.S., and FedEx International Ground® shipping between all origin and destination pairs supported by FedEx Web Services. 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-06-26T17:00:00. The UTC offset indicates the number of hours/minutes, such as xx:xx, from UTC, such as 2009-0626T17:00:00-04:00 is defined as June 26, 2009 5:00 p.m. Eastern Time. • FedEx Express packages may be created with a future ship date up to 10 days in advance. FedEx Freight® shipments can be created up to 5 days in advance. See Appendix M: Time Zones for more information. • FedEx Ground future day shipments may be created up to 10 days in advance. Samples • You may delete future day shipments up until the ship date. Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Future Day Coding Details The following ShipService WSDL elements are required to code a future day shipment: Table 118. Future Day Shipping Elements Element Requirements ShipmentSpecialServicesRequested/ SpecialServiceTypes Future day shipping is considered a special service. For future day shipping, FUTURE_DAY_SHIPMENT must be included in the ship request. ProcessShipmentRequest/ RequestedShipment/ShipTimestamp The ShipTimestamp must be included in the Ship request. For future day shipping, the following parameters apply: 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 241 Chapter 28 Future Day Shipping Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. FedEx Web Services, Developer Guide 242 29 FedEx Ground U.S. Shipping FedEx Ground U.S. Service Details FedEx Ground U.S. Coding Details FedEx Ground U.S. Service Options FedEx Home Delivery Service Details Chapter 29 FedEx Ground U.S. Shipping Use the Shipping service to access the FedEx Ground® U.S. shipping features. • Chapter 15: Delivery Signature Services See Shipping Services by Region for a list of FedEx Ground U.S. services available by region. • Chapter 28: Future Day Shipping FedEx Ground U.S. Service Details • Chapter 19: FedEx Ground U.S. Collect On Delivery (C.O.D.) • Chapter 21: Hazardous Materials (FedEx Ground U.S.) • Chapter 23: Hold at FedEx Location The following rules apply to FedEx Ground U.S. shipping: • FedEx Home Delivery Service Details • 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. • Chapter 27: Masked Data • 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. • Chapter 26: Variable Handling Charges • 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 Chapter 21: 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. • Chapter 25: Shipment Notification in the Ship Request 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. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. • 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 thirdparty billing. If the account number is missing or incorrect, you will be billed for the shipping costs. FedEx Ground U.S. Service Options • 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. The following service options are available for use with FedEx Ground U.S. shipping: • Alternate Return Address • 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 FedEx Web Services, Developer Guide 244 Chapter 29 FedEx Ground U.S. Shipping 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. Table 119. Recipient Information Elements, continued Element Multiple Occurrence • Nonstandard containers also incur an additional surcharge. The nonstandard container definition is: a valid physical address; empty lines should not be included. Multiple occurrence field. – 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. Description City No Required. Name of the city or town of the recipient. StateOrProvinceCode No 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. PostalCode No 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 No Identifies the recipient country. CountryName No Required. The fully spelled out name of a country. Recipient Information PhoneNumber No Required. The recipient’s phone number. Table 119. Recipient Information Elements Residential No Optional. However, if you ship to a residential address and do not include the Residential element, your rate quote will be incorrect. Required Elements The following elements are available to ship a FedEx Ground U.S. package: Element Multiple Occurrence Description CompanyName No Required. The name of the company associated with the recipient. Contact No Required. The name of the person receiving the shipment. StreetLines No 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 Billing Table 120. Billing Elements Element ShippingChargesPayment/ PaymentType Multiple Occurrence No Description Required. Values are: • ACCOUNT • COLLECT • SENDER FedEx Web Services, Developer Guide 245 Chapter 29 FedEx Ground U.S. Shipping Table 120. Billing Elements, continued Element Multiple Occurrence Table 120. Billing Elements, continued Description Element Multiple Occurrence • RECIPIENT • THIRD_PARTY AccountNumber Currency No No • STORE_NUMBER SHIPMENT_INTEGRITY prints only on the invoice. 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. Required. The currency code of the monetary exchange for FedEx Services. 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 No See Appendix F: Currency Codes 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 No The country code associated with the currency type. CountryName No Optional. The fully spelled out name of a country. CustomerReferenceType No 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_REFERENCE • INVOICE_NUMBER • P_O_NUMBER • RMA_ASSOCIATION • SHIPMENT_INTEGRITY Description 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. Multiple-Package Shipment Elements This option is available for FedEx Express U.S. and international multiplepackage 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 121. Multiple-Package Shipment Elements Element PackageCount Multiple Occurrence No Description Required for MPS. Total number of packages in the shipment. FedEx Web Services, Developer Guide 246 Chapter 29 FedEx Ground U.S. Shipping Table 121. Multiple-Package Shipment Elements, continued Element SequenceNumber MasterTrackingID MasterTrackingID/ TrackingIDType Multiple Occurrence No No No Description 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. Table 122. Package and Shipment Details Elements, continued Element Multiple Occurrence • SAME_DAY_CITY Note: If you ship to a residential address, your service type must be GROUND_HOME_DELIVERY. PackagingType Yes Required. Valid value is YOUR_PACKAGING. Weight Yes Required. Units and Value are included in this element. Values for the Units element are: • LB • KG 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. Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX The Value element must contain the actual package weight. For MPS, each ship request must contain the package weight. TotalWeight No • LB • KG Table 122. Package and Shipment Details Elements ServiceType Multiple Occurrence No The Value element must contain actual package weight. Description Required. Valid values are: • FEDEX_GROUND • GROUND_HOME_DELIVERY • FEDEX_FREIGHT_PRIORITY • FEDEX_FREIGHT_ECONOMY • SAME_DAY 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 are: Package and Shipment Details Element Description 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. FedEx Web Services, Developer Guide 247 Chapter 29 FedEx Ground U.S. Shipping Table 122. Package and Shipment Details Elements, continued Element Multiple Occurrence Description Label Requirements Table 123. LabelSpecification Element Element Dimensions/Units TotalInsuredValue/Amount PreferredCurrency ShipTimestamp Yes No No No Required if dimensions (Height, Width, Length) are submitted. Values are: • IN • CM 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. Indicates the currency the shipper requests to have used in all returned monetary values (when a choice is possible). 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-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-06-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 M: Time Zones for more information about time zones. LabelSpecification Multiple Occurrence No Description 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 Chapter 12: Creating 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 124. Package vs. Shipment Level Shipping Options Shipping Option Package vs. Shipment Level Delivery Signature Options Shipment HazMat Shipment Reference Elements Package Shipment Notification Package FedEx Home Delivery Convenient Delivery Options 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 Web Services, Developer Guide 248 Chapter 29 FedEx Ground U.S. Shipping • 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. • 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. • 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. • Rates and surcharges: For more information, see Registration Service. Note: FedEx Home Delivery convenient delivery options are requested on the package level and incur surcharges. • Service commitment • Routing code • Origin commitment • Time in transit detail Elements for FedEx Home Delivery Convenient Delivery Options • Station ID (where applicable) Table 125. Home Delivery Convenient Delivery Options Elements Reference Elements with Output Location Element Description HomeDeliveryPremiumDetail/ HomeDeliveryPremiumType Valid values are: • APPOINTMENT • DATE_CERTAIN • EVENING The ShipService WSDL includes these CustomerReference/ CustomerReferenceType 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. HomeDeliveryPremiumDetail/Date Required for FedEx Date Certain Home Delivery. Valid dates are Monday through Saturday. You may use reference elements to track packages or to tie packages together for a single track request. HomeDeliveryPremiumDetail/ DeliveryInstructions Optional. Allows additional delivery instructions are for any FedEx Home Delivery convenient delivery option. Table 126. Customer Reference/CustomerReferenceType Elements HomeDeliveryPremiumDelivery/ PhoneNumber Required for FedEx Date Certain Home Delivery and FedEx Appointment Home Delivery. FedEx contacts the recipient at this number to schedule delivery. Reply Elements In the ShipResponse/ProcessShipmentReply, the following elements are returned: • Error messages with severity Value Prints BILL_OF_LADING Shipping label and invoice. CUSTOMER_REFERENCE Shipping label, FedEx Ground shipping reports, and in the Customer Reference element on the invoice. INVOICE_NUMBER Shipping label and invoice. P_O_NUMBER Shipping label and invoice. RMA_ASSOCIATION Shipping label and invoice. SHIPMENT_INTEGRITY Invoice. FedEx Web Services, Developer Guide 249 Chapter 29 FedEx Ground U.S. Shipping Table 126. Customer Reference/CustomerReferenceType Elements, continued Value Prints STORE_NUMBER Shipping label and invoice. • 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. FedEx Home Delivery Service Details FedEx Home Delivery Convenient Delivery Options The following rules apply to FedEx Home Delivery (residential flag checked): 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: • Shipment can originate from and be delivered to the 50 United States, 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 packages: see Chapter 21: Hazardous Materials (FedEx Ground U.S.) for details. 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. FedEx Evening Home Delivery • Options include Delivery Signature Services, Signature Proof of Delivery (SPOD), and Chapter 30: FedEx SmartPost Shipping. Use this convenient delivery option to specify delivery between 5 p.m. and 8 p.m., based on the recipient’s local time zone. • 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. 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 250 30 FedEx SmartPost Shipping FedEx SmartPost Service Details FedEx SmartPost Returns Service Details Chapter 30 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 lowweight, 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. • 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. 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. FedEx SmartPost Service Details For Standard Mail, Bound Printed Matter, and Media the following dimensions restriction applies: FedEx SmartPost Service includes the following features: • Dimensions: No more than 84" in combined length and girth (L+2W+2H). • 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. • No one dimension greater than 60". • The FedEx SmartPost service allows delivery to all 50 United States and the U.S. territories, including PO boxes and military locations (Army Post office - APO, Fleet Post Office - FPO, Diplomatic Post Office - DPO), and Puerto Rico. • Minimum dimensions are 6" L x 4" W x 1". 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". • FedEx SmartPost supports customer packaging only. Because FedEx SmartPost employs the USPS for final delivery to residences, packages are subject to USPS restrictions. For more detailed information about FedEx SmartPost outbound shipping and returns, go to fedex.com/us/smartpost. • Future Day shipping is available for FedEx SmartPost shipments. FedEx SmartPost Request Elements • Saturday delivery is possible by USPS. No FedEx surcharge applies in this case. In addition to the elements required for all requests, the following elements are included in the FedEx SmartPost request: • Packages can only be tracked using the Delivery Confirmation Number (DCN) assigned to each FedEx SmartPost package. FedEx Web Services, Developer Guide 252 Chapter 30 FedEx SmartPost Shipping Table 127. FedEx SmartPost Request Elements Element Description 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 options include: • MEDIA_MAIL • PARCEL_SELECT (1 LB through 70 LBS) • PRESORTED_BOUND_PRINTED_MATTER • PRESORTED_STANDARD (less than 1 LB) • 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 Table 127. FedEx SmartPost Request Elements, continued Element • • • • • • • • • • • • • • • • • • • • Note: For 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. Valid values are: • 5185 ALPA Allentown • 5303 ATGA Atlanta • 5281 CHNC Charlotte • 5602 CIIL Chicago • 5929 COCA Chino • 5751 DLTX Dallas • 5802 DNCO Denver • 5481 DTMI Detroit Description 5087 EDNJ Edison 5431 GCOH Grove City 5771 HOTX Houston 5465 ININ Indianapolis 5648 KCKS Kansas City 5902 LACA Los Angeles 5254 MAWV Martinsburg 5379 METN Memphis 5552 MPMN Minneapolis 5531 NBWI New Berlin 5110 NENY Newburgh 5015 NOMA Northborough 5327 ORFL Orlando 5194 PHPA Philadelphia 5854 PHAZ Phoenix 5150 PTPA Pittsburgh 5958 SACA Sacramento 5843 SCUT Salt Lake City 5983 SEWA Seattle 5631 STMO St. Louis Note: Include only the numeric HubID value in your request. 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 FedEx Web Services, Developer Guide 253 Chapter 30 FedEx SmartPost Shipping Table 127. FedEx SmartPost Request Elements, continued Element Table 128. FedEx SmartPost Reply Elements, continued Description Element Description 041001, 041002, 041003 (this example includes leading zeros on the trailer numbers). MasterTrackingId/ TrackingIdType Lists the type of tracking ID. Valid values are: • FEDEX • GROUND • USPS The maximum length is 8 characters. RequestedShipment/ RequestedPackageLineItems/ PhysicalPackaging Optional 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. Provides additional detail on how the customer has physically packaged this item. FedEx SmartPost Reply Elements MasterTrackingId/FormId Describes in detail the type of airbill and shipment moving through the FedEx system. 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. MasterTrackingId/ UspsApplicationId For use with Smartpost tracking IDs only. MasterTrackingId/ TrackingNumber Specifies 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. Specifies the shipment level operational information. 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 128. FedEx SmartPost Reply Elements Element Description ProcessShipmentReply/ CompletedShipmentDetail/ UsDomestic Indicates whether or not this is an intra-U.S. shipment. ProcessShipmentReply/ CompletedShipmentDetail/ OperationalDetail Used only with pending shipments. ProcessShipmentReply/ CompletedShipmentDetail/ CarrierCode Indicates the carrier that will be used to deliver this shipment. ProcessShipmentReply/ CompletedShipmentDetail/ AccessDetail 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. ProcessShipmentReply/ CompletedShipmentDetail/ SmartPostDetail/ Returns FedEx SmartPost shipment account details including: • Machineable (indicates whether the shipment is deemed to be machineable, based on dimensions, weight, and packaging) • AllowedHubs • MailerId FedEx Web Services, Developer Guide 254 Chapter 30 FedEx SmartPost Shipping Table 128. FedEx SmartPost Reply Elements, continued Element Description • • • • • • • DistributionCenter SmartPostId PickUpCarrier (CarrierCodeType) AllowedIndicia AllowedSpecialServices SmartPostHubId MaximumTransitTime 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. Table 129. FedEx SmartPost APO/FPO/DPO Elements, continued Element Value • FPO • DPO StateOrProvinceCode Valid values are: • 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. The following is an example of a FedEx SmartPost APO address: StreetLines: PSC 2 box 7629 City: APO StateOrProvinceCode: AE PostalCode: 09012 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 129. FedEx SmartPost APO/FPO/DPO Elements Element Value City Valid values are: • APO CountryCode: US The following reply elements would be returned for the FedEx SmartPost APO Address Validation: 100 MODIFIED_TO_ACHIEVE_MATCH APO_OR_FPO_MATCH CONFIRMED FedEx Web Services, Developer Guide 255 Chapter 30 FedEx SmartPost Shipping Psc 2 Box 7629 APO Ae 09012-0026 US 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 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. 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. • FedEx integrated label - FedEx Ground® is the pickup carrier • Direct your customers back to your Website to process and print online labels using a ProcessShipment web service. 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. • Send your customers an email that includes a FedEx URL link to the return shipping label for them to print using a CreatePendingShipment web service. 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. 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. FedEx SmartPost Returns Service Details 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. 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 SmartPost Returns is a contract-only service for customers with highvolume 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 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. Features • To use the FedEx SmartPost Returns service, shippers must have an account flagged as eligible for FedEx SmartPost Returns and be U.S. FedEx Web Services, Developer Guide 256 Chapter 30 FedEx SmartPost Shipping 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 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-of-pocket expenses. • 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. 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-the-minute 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. 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. • No residential or Saturday pickup surcharges. • 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 Returns does not provide estimated shipping rates when using the Rating or Shipping Web services. • FedEx SmartPost return labels are not available for international destinations. • Inbound shipment visibility via FedEx InSight®. FedEx InSight email notifications provide timely and automatic status information about your • Dangerous Goods and Hazardous Materials cannot be shipped. • Maximum package weight of 70 lbs. FedEx Web Services, Developer Guide 257 Chapter 30 FedEx SmartPost Shipping • 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. • 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. FedEx SmartPost Returns Request Elements Begin your ship request with the basic Ship Request elements as detailed in Chapter 13: FedEx Express U.S. Shipping 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 130. FedEx SmartPost Returns Request Elements Element Required Description or Optional SpecialServicesRequested/ SpecialServiceTypes Required Include the value: RETURN_SHIPMENT. ReturnShipmentDetail/ ReturnType Required The type of return shipment being requested. Valid value is 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. Table 130. FedEx SmartPost Returns Request Elements, continued Element Required Description or Optional RequestedShipment/ RequestedPackageLineItems/ CustomerReferences/ CustomerReferenceType Optional Include the value: RMA_ASSOCIATION RequestedShipment/ RequestedPackageLineItems/ CustomerReferences/Value Optional Include the value: Number ProcessShipmentRequest/ RequestedShipment/ServiceType Required Specify SMART_POST for FedEx SmartPost shipping services. SmartPostDetail Required Required. Specify the appropriate details for a FedEx SmartPost shipment. SmartPostDetail/Indicia Required Required. Specify the indicia type. Available option includes: PARCEL_RETURN. SmartPostDetail/HubID Required Required. Specify the HubID. Valid values are: • 5185 ALPA Allentown • 5303 ATGA Atlanta • 5281 CHNC Charlotte • 5602 CIIL Chicago • 5929 COCA Chino • 5751 DLTX Dallas • 5802 DNCO Denver • 5481 DTMI Detroit • 5087 EDNJ Edison • 5431 GCOH Grove City • 5771 HOTX Houston • 5465 ININ Indianapolis • 5648 KCKS Kansas City • 5902 LACA Los Angeles The RMA number associated with the return shipment. Including this number in your request allows you to track by RMA number up to 20 alphanumeric characters. FedEx Web Services, Developer Guide 258 Chapter 30 FedEx SmartPost Shipping Table 130. FedEx SmartPost Returns Request Elements, continued Element Required Description or Optional • • • • • • • • • • • • • • 5254 MAWV Martinsburg 5379 METN Memphis 5552 MPMN Minneapolis 5531 NBWI New Berlin 5110 NENY Newburgh 5015 NOMA Northborough 5327 ORFL Orlando 5194 PHPA Philadelphia 5854 PHAZ Phoenix 5150 PTPA Pittsburgh 5958 SACA Sacramento 5843 SCUT Salt Lake City 5983 SEWA Seattle 5631 STMO St. Louis Note: Include only the numeric HubID value in your request. 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 ShipService 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 CreatePendingShipment web services in the ShipService 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. 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. Email Return Labels Coding Details The following coding details apply to email labels: • The email label is created using elements from the CreatingPendingShipmentRequest in the ShipService WSDL for FedEx SmartPost Returns. • The email label request is canceled using elements from the CancelPendingShipmentRequest in the ShipService 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 label must be greater or equal to the day of the label request and no greater than 30 days in future. FedEx Web Services, Developer Guide 259 Chapter 30 FedEx SmartPost Shipping Returns (Inbound) Email 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 131. CreatePendingShipment Basic Returns Email Label Request Elements Element Required Description CreatePendingShipment Required The web service inside the Ship Service WSDL file used to create all Email Return Labels WebAuthenticationDetail/ UserCredential/Key Required The value for the Key was provided by FedEx upon your request through the FedEx Developer Resource Center. It is an alphanumeric mixed-case string. WebAuthenticationDetail/ UserCredential/Password Required The value for the Password was provided by FedEx upon your request through the FedEx Developer Resource Center. 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 through the FedEx Developer Resource Center. ClientDetail/MeterNumber Required The FedEx Express meter number that was provided by FedEx upon your request through the FedEx Developer Resource Center. Version/ServiceId Required The value is “ship” Version/Major Required The current value is "13". Version/Intermediate Required The current value is "0". Version/Minor Required The current value is "0". RequestedShipment/ ServiceType Required For this transaction the valid value is SMART_POST. RequestedShipment/Shipper/ Contact/PersonName Optional and/or Required Table 131. CreatePendingShipment Basic Returns Email Label Request Elements, continued Element Required Description RequestedShipment/Shipper/ Contact/CompanyName Optional and/or Required Required if Company name is blank. RequestedShipment/Shipper/ Contact/PhoneNumber Required Shipper phone number. Numeric only. RequestedShipment/Shipper/ Contact Optional and/or Required There are additional fields available. They are optional. RequestedShipment/Shipper/ Address/StreetLines Optional and/or Required At least one street address line is required. This is a multiple occurrence field. RequestedShipment/Shipper/ Address/City Required Shipper city. RequestedShipment/Shipper/ Address/StateOrProvinceCode Required Please refer to Appendix B for a list of State Codes. RequestedShipment/Shipper/ Address/PostalCode Required Shipper postal code. RequestedShipment/Shipper/ Address/CountryCode Required Valid value - US RequestedShipment/Shipper/ Address/CountryName Optional The fully spelled out name of a country RequestedShipment/Shipper/ Address Optional and/or Required There are additional fields available. They are optional. RequestedShipment/ Recipient/Contact Optional The descriptive data for a point-of-contact person. RequestedShipment/ Recipient/Contact/ContactId Optional Client provided identifier corresponding to this contact information. Required if Contact name is blank. FedEx Web Services, Developer Guide 260 Chapter 30 FedEx SmartPost Shipping Table 131. CreatePendingShipment Basic Returns Email Label Request Elements, continued Element Required Table 131. CreatePendingShipment Basic Returns Email Label Request Elements, continued Description Element Required Description RequestedShipment/ Recipient/Address/PostalCode Required Recipient postal code. RequestedShipment/ Recipient/Address/ CountryCode Required Valid value - US RequestedShipment/ Recipient/Contact/ PersonName Optional and/or Required Required if Contact name is blank. RequestedShipment/ Recipient/Contact/Title Optional Identifies the contact person's title. RequestedShipment/ Recipient/Contact/ CompanyName Optional and/or Required Required if Company name is blank. RequestedShipment/ Recipient/Address/ CountryName Optional The fully spelled out name of a country. RequestedShipment/ Recipient/Contact/ PhoneNumber Required Required. Recipient phone number. Numeric only. RequestedShipment/ Recipient/Address Optional and/or Required There are additional fields available. They are optional. RequestedShipment/ Recipient/Contact/ PhoneExtension Optional Identifies the phone extension associated with this contact. RequestedShipment/ Recipient/Contact/ TollFreePhoneNumber Optional RequestedShipment/ Recipient/Contact/FaxNumber Optional RequestedShipment/ Recipient/Contact/ EmailAddress Optional Identifies the email address associated with this contact. RequestedShipment/ Recipient/Address/StreetLines Optional and/or Required At least one street address line is required. This is a multiple occurrence field. RequestedShipment/ Recipient/Address/City Required Recipient city. RequestedShipment/ Recipient/Address/ StateOrProvinceCode Required Refer to Appendix B for a list of State Codes. Identifies a toll free number, if any, associated with this contact. Identifies the fax number associated with this contact In addition to the basic shipping elements, the following elements must be included in the CreatePendingShipmentRequest to trigger an Email Return Label through fedex.com: Table 132. CreatePendingShipment Request Returns Email Label Through FedEx Elements Element Required Description RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes Required Required. Specify the type of special service. Both of these Service Types must be included for a returns email label: • PENDING_SHIPMENT • RETURN_SHIPMENT RequestedShipment/ SpecialServicesRequested/ ReturnShipmentDetail/ ReturnType Required Specify the Return Type. Use the following value: RequestedShipment/ SpecialServicesRequested/ Required PENDING Include the phone number for the merchant, such as a general customer service phone number. FedEx Web Services, Developer Guide 261 Chapter 30 FedEx SmartPost Shipping Table 132. CreatePendingShipment Request Returns Email Label Through FedEx Elements, continued Element Required ReturnShipmentDetail/ ReturnEmailDetail/ MerchantPhoneNumber Description Table 133. FedEx SmartPost Email Return Label Request Elements, continued Element Required Description SmartPostDetail/Indicia Required Required. Specify the indicia type. The value for this transaction is PARCEL_RETURN. SmartPostDetail/ AncillaryEndorsement Optional and/or Required Max 10 characters, numeric-only string. RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/Type Required Required. Specify the Pending Shipment Type. Include the following value: • EMAIL RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ ExpirationDate Required Required. Specify the email label expiration date: for example, 2009-01-31. Optional. Specify an endorsement type from the following valid values: • ADDRESS_CORRECTION • CARRIER_LEAVE_IF_NO_RESPONSE • CHANGE_SERVICE • FORWARDING_SERVICE • RETURN_SERVICE The maximum expiration date must be greater or equal to the day of the label request and not greater than 30 days in the future. Note: These services are of little practical use for a return package, but they will not cause the transaction to fail. RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ EmailLabelDetail/ NotificationEmailAddress Required Required. Email address of the end-user to be notified of the return label. This element has a 200-character maximum. RequestedShipment/ SpecialServicesRequested/ PendingShipmentDetail/ EmailLabelDetail/ NotificationMessage Optional Notification message included in the email to the enduser. Finally, the following elements are included in a request for the email return label to be a FedEx SmartPost® Email Return Label: Table 133. FedEx SmartPost Email Return Label Request Elements Element SmartPostDetail Required Required Description Required. Specify the appropriate details for a FedEx SmartPost shipment. SmartPostDetail/HubId Required Required. Specify the HubID. Valid values are: • 5185 ALPA Allentown • 5303 ATGA Atlanta • 5281 CHNC Charlotte • 5602 CIIL Chicago • 5929 COCA Chino • 5751 DLTX Dallas • 5802 DNCO Denver • 5481 DTMI Detroit • 5087 EDNJ Edison • 5431 GCOH Grove City • 5771 HOTX Houston • 5465 ININ Indianapolis • 5648 KCKS Kansas City • 5902 LACA Los Angeles • 5254 MAWV Martinsburg • 5379 METN Memphis • 5552 MPMN Minneapolis • 5531 NBWI New Berlin FedEx Web Services, Developer Guide 262 Chapter 30 FedEx SmartPost Shipping Table 133. FedEx SmartPost Email Return Label Request Elements, continued Element Required Description • • • • • • • • • • 5110 NENY Newburgh 5015 NOMA Northborough 5327 ORFL Orlando 5194 PHPA Philadelphia 5854 PHAZ Phoenix 5150 PTPA Pittsburgh 5958 SACA Sacramento 5843 SCUT Salt Lake City 5983 SEWA Seattle 5631 STMO St. Louis Optional and/or Required Element RequestedShipment/ RequestedPackageLineItems/ PhysicalPackaging Required Optional and/or Required Description Optional. Provides additional detail on how the customer has physically packaged this item. FedEx SmartPost Reply Elements The following elements are returned in the FedEx SmartPost reply: Table 134. FedEx SmartPost Reply Elements Element Description CompletedShipmentDetail/ OperationalDetail/TransitTime String. Standard transit time per origin, destination, and service. Optional. This field is of little practical use for a returns package. CompletedShipmentDetail/ OperationalDetail/ MaximumTransitTime String. The maximum expected transit time. The CustomerManifestId is used to group FedEx SmartPost packages onto a manifest for each trailer that is being prepared. 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. Note: Include only the numeric HubID value in your request. SmartPostDetail/ CustomerManifestId Table 133. FedEx SmartPost Email Return Label Request Elements, continued 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). 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. The maximum length is 8 characters. The customer will receive an email from FedEx that uses the data as provided in your request. The email will look like this: FedEx Web Services, Developer Guide 263 Chapter 30 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: Cancel Email Label Elements The following information is required to cancel an Email Return Label using a CancelPendingShipment Web Service Request: FedEx Web Services, Developer Guide 264 Chapter 30 FedEx SmartPost Shipping Table 135. Cancel Email Label Elements Element Required Description CancelPendingShipment Required The web service inside the Ship Service WSDL file used to cancel all Email Return Labels WebAuthenticationDetail/ UserCredential/Key Required The value for the Key was provided by FedEx upon your request through the FedEx Developer Resource Center. It is an alphanumeric mixed-case string. WebAuthenticationDetail/ UserCredential/Password Required The value for the Password was provided by FedEx upon your request through the FedEx Developer Resource Center. 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 through the FedEx Developer Resource Center. ClientDetail/MeterNumber Required The FedEx Express meter number that was provided by FedEx upon your request through the FedEx Developer Resource Center. 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. Version/ServiceId Required The value is “ship” Version/Major Required The current value is "13". Customizable Labels Version/Intermediate Required The current value is "0". Version/Minor Required The current value is "0". Shippers will be offered a customizable area on thermal labels for FedEx SmartPost and FedEx SmartPost Returns. TrackingId/TrackingIdType Required Required. You will use a Tracking number to cancel a specific package. This field specifies which tracking number will be specified. Valid values are: • GROUND • USPS • FEDEX 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. Required. The Tracking number for the active package you wish to cancel. 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 TrackingId/TrackingNumber Optional and/or Required Future Day Shipping FedEx Web Services, Developer Guide 265 Chapter 30 FedEx SmartPost Shipping Tracking Numbers Samples Customers can track FedEx SmartPost shipments using: Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: • Customer reference number • Invoice number 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. • P.O. number 2. Enter your username and password to login to the DRC. • Return Merchant Authorization (RMA) number 3. Expand "Technical Resources" on the left pane. • Tracking number 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." Error Messages 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 266 31 FedEx Freight Services FedEx Freight Service Features Custom Delivery Date Options FedEx Freight Service Details Inside Pickup Service Option FedEx Freight Priority FedEx Freight Rates and Surcharges FedEx Freight Economy FedEx Freight Coding Details Chapter 31 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 timesensitive shipments. 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 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. See the Freight Elements for information on how to specify the freight elements. • 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. 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. • 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. 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. 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. Use either the Shipper Freight Account or the Bill To Freight Account depending on your role. Freight services and special services (accessorials) are supported via Web Services for rate quote, shipment, and pickup requests. Tracking offreight shipments is also supported. There is no specific element for freight that must be specified in a track request. 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: FedEx Freight address labels are optional and contain very little information, compared to FedEx Express and FedEx Ground labels. The PRO number is the FedEx Web Services, Developer Guide 268 Chapter 31 FedEx Freight Services • 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 • You must call FedEx to 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) 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. Shipping Rules • Both commercial and residential shipments may be shipped using FedEx Freight Priority and FedEx Freight Economy. 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. – 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. Packaging FedEx provides standard packaging options for FedEx Freight Priority and FedEx Freight Economy shipments. • Residential packages must be identified in your shipping transaction. Creating and Printing a Bill of Lading • The FreightShipmentDetail/FedExFreightAccountNumber and the corresponding FreightShipmentDetail/ 1. You can indicate within the transaction one of the following formats for a thermal label. FedEx Web Services, Developer Guide 269 Chapter 31 FedEx Freight Services a. 4" x 6" without the Doc-Tab b. 4" x 6" with the Doc-Tab c. 4" x 8" d. 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 6" PNG or PDF b. 4" x 8" PNG or PDF c. 4" x 9" PNG or PDF 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. • Consistent, on-time reliability. • Direct delivery to virtually every ZIP code in the continental U.S. • End-to-end shipment visibility. *All services are subject to the terms and conditions of the FXF 100 Series Rules Tariff. 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. 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. • Knowledgeable and dependable employees. • No-fee money-back guarantee.* Inside Pickup Service Option • State-of-the art information technology with end-to-end shipment visibility. Review the following before shipping using the inside pickup service option. For more information, contact your account executive, or call our customer service team at 1.866.393.4585. • Inside pickup service does not require a special service contract with FedEx. FedEx Web Services, Developer Guide 270 Chapter 31 FedEx Freight Services • If a shipment breakdown is needed to fit a shipment through a doorway, additional charges may be assessed. 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 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. 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: Freight Elements Table 136. 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: • FEDEX_FREIGHT_PRIORITY • FEDEX_FREIGHT_ECONOMY RequestedShipment/ShippingChargesPayment 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. 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. 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/2011rates/surcharges.html. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Valid values are: FedEx Web Services, Developer Guide 271 Chapter 31 FedEx Freight Services Table 136. Freight Request Elements, continued Element Table 136. Freight Request Elements, continued Description • GUARANTEED_DATE • GUARANTEED_MORNING Element RequestedShipment/FreightShipmentDetail/ AlternateBilling Description Optional 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 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/ FedExFreightBillingContactAndAddress Required Date for all Freight guarantee types. Enter the Billing Address information in FedExFreightBillingContactAndAddress fields for the above FedExFreightAccountNumber. Entries in FedExFreightAccountNumber and FedExFreightBillingContactAndAddress are required for security purposes. 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 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 (9digit 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 pointof-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 FedEx Web Services, Developer Guide 272 Chapter 31 FedEx Freight Services Table 136. Freight Request Elements, continued Element Table 136. Freight Request Elements, continued Description Element Billing Address information associated with the specified AlternateBilling/ AccountNumber: • Street Line • City • State or Province • Country Code RequestedShipment/FreightShipmentDetail/ LiabilityCoverageDetail Optional Identifies the Liability Coverage Amount. For January 2011, this value represents coverage amount per pound RequestedShipment/FreightShipmentDetail/ Coupons Optional Identifiers for promotional discounts offered to customers. RequestedShipment/FreightShipmentDetail/ TotalHandlingUnits Required Total number of individual handling units in the entire shipment (for unit pricing). RequestedShipment/FreightShipmentDetail/ ClientDiscountPercent Optional Estimated discount rate provided by client for unsecured rate quote. RequestedShipment/FreightShipmentDetail/ PalletWeight Optional Total weight of pallets used in shipment. RequestedShipment/FreightShipmentDetail/ ShipmentDimensions Optional Overall shipment dimensions. Valid values are: • CONSIGNEE • SHIPPER RequestedShipment/FreightShipmentDetail/ Comment Optional Description for the shipment. FreightShipmentDetail/SpecialServicePayments Optional Specifies which party will pay surcharges for any special services which support split billing. RequestedShipment/FreightShipmentDetail/ SpecialServicePayments/SpecialService Optional Identifies the special service. RequestedShipment/FreightShipmentDetail/ SpecialServicePayments/PaymentType Optional Indicates who will pay for the special services. 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. RequestedShipment/FreightShipmentDetail/ CollectTermsType Optional Designates the terms of the “collect” payment for a Freight Shipment. Description Valid values are: • SECTION_7_SIGNED • NONRECOURSE_SHIPPER_SIGNED • STANDARD RequestedShipment/FreightShipmentDetail/ DeclaredValuePerUnit Optional Identifies the declared value for the shipment. RequestedShipment/FreightShipmentDetail/ HazardousMaterialsEmergencyContactNumber Optional Must be populated if any line items contain hazardous materials. RequestedShipment/FreightShipmentDetail/ DeclaredValueUnits Optional Identifies the declared value units corresponding to the above defined declared value. RequestedShipment/FreightShipmentDetail/ HazardousMaterialsOfferor Optional Must be populated with a contact name if any line items contain hazardous materials. FedEx Web Services, Developer Guide 273 Chapter 31 FedEx Freight Services Table 136. Freight Request Elements, continued Element Table 136. Freight Request Elements, continued Description RequestedShipment/FreightShipmentDetail/ LineItems Optional RequestedShipment/FreightShipmentDetail/ LineItems/FreightClass Required Freight class for this line item. RequestedShipment/FreightShipmentDetail/ LineItems/HandlingUnits Optional Number of individual handling units to which this line applies. Description Valid values are: Details of the commodities in the shipment. Note: Total of line-item-level handling units may not balance to shipmentlevel total handling units.) RequestedShipment/FreightShipmentDetail/ LineItems/Packaging Required RequestedShipment/FreightShipmentDetail/ LineItems/Pieces Required Number of pieces for this commodity or class line. RequestedShipment/FreightShipmentDetail/ LineItems/NmfcCode Optional NMFC Code for commodity. RequestedShipment/FreightShipmentDetail/ LineItems/HazardousMaterials Optional Indicates the kind of hazardous material content in this line item. RequestedShipment/FreightShipmentDetail/ LineItems/BillOfLadingNumber Optional For printed reference per line item. RequestedShipment/FreightShipmentDetail/ LineItems/PurchaseOrderNumber Optional For printed reference per line item. RequestedShipment/FreightShipmentDetail/ LineItems/Description Required Customer-provided description for this commodity or class line. RequestedShipment/FreightShipmentDetail/ LineItems/Weight Required Weight for this commodity or class line. RequestedShipment/FreightShipmentDetail/ LineItems/Weight/Units Element Specification of handling-unit packaging for this commodity or class line. Identifies the unit of measure associated with a weight value. See the list of enumerated types for valid values. • KG • LB RequestedShipment/FreightShipmentDetail/ LineItems/Weight/ValueDecimal Required Identifies the weight value of a package/shipment. RequestedShipment/FreightShipmentDetail/ LineItems/Volume Optional Volume (cubic measure) for this commodity or class line. RequestedShipment/ ShippingDocumentSpecification Required Indicates the types of shipping documents produced for the shipper by FedEx RequestedShipment/ ShippingDocumentSpecification/ DangerousGoodsShippersDeclarationDetail Optional Indicates the instructions on how to print the 1421c form for dangerous goods shipment. DangerousGoodsShippersDeclarationDetail/Format Optional Specifies characteristics of a shipping document to be produced. DangerousGoodsShippersDeclarationDetail/ CustomerImageUsages Optional Specifies 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/StartingPosition Optional Specifies 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 are: • • • • BOTTOM_LEFT BOTTOM_RIGHT TOP_LEFT TOP_RIGHT FedEx Web Services, Developer Guide 274 Chapter 31 FedEx Freight Services Table 136. Freight Request Elements, continued Table 137. Optional Pickup Request Elements, continued Element Description Element CreatePickupRequest/Remarks RequestedShipment/ ShippingDocumentSpecification/ FreightAddressLabelDetail/DocTabContent Optional If omitted, no doc-tab will be produced (i.e. default - former NONE type). ShippingDocumentSpecification/ ReturnInstructionsDetail Optional Specifies 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/CustomText Optional Specifies additional customer provided text to be inserted into the return document. Table 137. Optional Pickup Request Elements Element Description CreatePickupRequest/ AssociatedAccountNumber Optional 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 freight service pickup and should not be used for other types of pickups including FedEx Freight pickups CreatePickupRequest/CarrierCode Optional The number associated with the FedEx Account. Identifies the FedEx service that is being sent the package pickup request. Description Optional Identifies any remarks or comments to be passed to the FedEx courier picking up the shipment. Table 138. 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 Specifies 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. FedEx Web Services, Developer Guide 275 Chapter 31 FedEx Freight Services Table 138. Freight Reply Elements, continued Table 138. Freight Reply Elements, continued Element Description Element Description CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FuelSurchargePercent Specifies a fuel surcharge percentage. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalBillingWeight The weight used to calculate these rates. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail Rate data specific to FedEx Freight services. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalDimWeight Sum of dimensional weights for all packages. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail/ QuoteNumber A unique identifier for a specific rate quotation. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalBaseCharge The total freight charge that was calculated for this package before surcharges, discounts and taxes. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail/QuoteType CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalFreightDiscounts The total discounts used in the rate calculation. Specifies the type of rate quote. Valid values are: • AUTOMATED • MANUAL CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalNetFreight The freight charge minus discounts. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail/ BaseChargeCalculation Specifies how total base charge is determined. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalSurcharges The total amount of all surcharges applied to this shipment. Individual charge which contributes to the total base charge for the shipment. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalNetFedExCharge This shipment's totalNetFreight + totalSurchages (not including totalTaxes). CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail/ BaseCharges CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalTaxes Total of the transportation-based taxes. CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/FreightRateDetail/ BaseCharges/FreightClass CompletedShipmentDetail/ShipmentRating/ ShipmentRateDetails/TotalNetCharge The net charge after applying all discounts and surcharges. Freight class type. These values represent the industry-standard freight classes used for FedEx Freight Priority and FedEx Freight Economy shipment description. 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. Note: The alphabetic prefixes are required to distinguish these values from decimal numbers on some client platforms. Valid values are: • CLASS_050 • CLASS_055 • CLASS_060 • CLASS_065 • CLASS_070 • CLASS_077_5 FedEx Web Services, Developer Guide 276 Chapter 31 FedEx Freight Services Table 138. Freight Reply Elements, continued Element Table 138. Freight Reply Elements, continued Description • • • • • • • • • • • • CLASS_085 CLASS_092_5 CLASS_100 CLASS_110 CLASS_125 CLASS_150 CLASS_175 CLASS_200 CLASS_250 CLASS_300 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. Element Description 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. 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 277 32 FedEx Intra-Country Shipping Services and Service Areas India Intra-Country Services Overview Mexico Special Service Options United Kingdom Colombia Chapter 32 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. Services and Service Areas The service areas for intra-country shipping are detailed below. Canada Table 139. Canadian Services FedEx Ground® FedEx Priority Overnight® FedEx First Overnight® FedEx Economy FedEx 2Day® Freight X X X X X Europe, the Middle East and Africa Table 140. Europe, the Middle East and Africa Services and Service Areas Country FedEx Priority Overnight Austria X Belgium X Czech Republic X Denmark X Finland X France X FedEx Economy FedEx Standard Overnight® FedEx 1Day Freight™ FedEx® Next Day by 9 a.m. FedEx® Next Day by 10 a.m. FedEx® Next Day by 12 noon FedEx® Next Day X FedEx Web Services, Developer Guide 279 Chapter 32 FedEx Intra-Country Shipping Table 140. Europe, the Middle East and Africa Services and Service Areas, continued FedEx Priority Overnight FedEx Economy Germany X X Hungary X India X X Italy X X Luxembourg X Norway X Poland X Russia X X Spain X X Sweden X Switzerland X The Netherlands X Country United Arab Emirates United Kingdom FedEx Standard Overnight® FedEx® Next Day by 9 a.m. FedEx® Next Day by 10 a.m. FedEx® Next Day by 12 noon FedEx® Next Day X X X X X X X FedEx 1Day Freight™ X X 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. FedEx Web Services, Developer Guide 280 Chapter 32 FedEx Intra-Country Shipping Latin America and the Caribbean Table 141. Latin America and the Caribbean Services and Service Areas FedEx Priority Overnight® FedEx First Overnight® FedEx Economy Colombia X X X Mexico X X X Country FedEx Standard Overnight® FedEx 1Day® Freight FedEx 2Day® Freight X X X X X Intra-Country Services Overview FedEx First Overnight 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 where. FedEx First Overnight® provides early-morning delivery between 8 and 10 a.m. depending upon the destination postal code. FedEx Economy • Options include Chapter 17: Saturday Service, Chapter 20: Dangerous Goods support for Chapter 24: Dry Ice Shipments only, and Chapter 15: Delivery Signature Services. FedEx Economy® provides delivery in 3 business days to businesses by 4:30 p.m. and to residences by 7 p.m. 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 Chapter 20: Dangerous Goods inaccessible items only, Chapter 15: Delivery Signature Services, Chapter 23: Hold at FedEx Location and Chapter 17: Saturday Service. • Service days are Monday through Friday, with Saturday pickup available in many areas for an additional charge. 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. 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. FedEx Web Services, Developer Guide 281 Chapter 32 FedEx Intra-Country Shipping Service days are Monday through Friday with Saturday pickup and delivery available for an extra charge. 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: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx Location, and Chapter 16: FedEx Priority Alert Options (for contracted accounts only). FedEx Ground The following rules apply to FedEx Ground shipping transactions: • Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets. • Do not include fields for Saturday delivery or pickup. This service option is not available for FedEx Ground. • A booking number is required for this service. Call 1.800.332.0807 to book your freight shipment. • When estimating time-in-transit or ship dates, consider FedEx Ground delivery days: Mon. through Fri. (8 a.m. to close of business day). • 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. • Do not include packages over 150 lbs. in a FedEx Ground shipment. • The following special services are allowed (depending on the destination location): Saturday Service, Chapter 20: Dangerous Goods, Chapter 18: FedEx Express Collect on Delivery (C.O.D.), Chapter 23: Hold at FedEx Location, and Chapter 16: FedEx Priority Alert Options (for contracted accounts only). • Do not include HazMat packages over 70 lbs. in a FedEx Ground shipment. • Do not include ORM-D packages over 66 lbs. in a FedEx Ground shipment. • Do not include special accessorial Hold at Location with a HazMat or ORM-D shipment. • Do not include packages which exceed 108" in length or 165" in length plus girth (L + 2W + 2H). FedEx 2Day Freight • Before you ship hazardous materials, you must be certified to do so. See fedex.com for certification and training information. 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: FedEx SameDay • Service days are Monday through Friday, with Saturday pickup and delivery available to many major markets. • 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, Chapter 20: Dangerous Goods, Chapter 18: FedEx SameDay® service provides door-to-door delivery within hours between select cities and postal codes in an area between Mexico City and the southern Mexican states. Pickups and deliveries can be made Monday through Friday. Use the SAME_DAY element to identify this service type when shipping a package. FedEx Web Services, Developer Guide 282 Chapter 32 FedEx Intra-Country Shipping A contract is required to use FedEx SameDay City service. See your FedEx Account Executive for more information about SameDay City. FedEx SameDay City FedEx SameDay® City service provides cross-city delivery within hours in select cities and postal codes in Mexico. Pickups and deliveries can be made Monday through Friday. Note: Manual air waybills are not available with SameDay City service. Special Service Options Use the SAME_DAY_CITY element to identify this service type when shipping a package. The following special handling service options are available. Service Options for Canada These special service options are available in Canada: • Future Day Shipping • Hold at Location • Residential Delivery Service Options for Latin America and the Caribbean Table 142. Latin America and the Caribbean Special Service Options Country Delivery on Invoice Acceptance Colombia Freight to Collect Future Day Shipping Hold at Location Residential Delivery X X X X X X X Mexico X Service Options for Europe, the Middle East and Africa Table 143. Europe, the Middle East and Africa Special Service Options Country Austria Dangerous Goods Dry Ice X X Freight to Collect Future Day Hold at Location X Holiday Delivery On Call Pickup Priority Alert Priority Alert Plus X X X Residential Delivery Returns X Saturday Delivery Ship Alerts Special Delivery Sunday Delivery X FedEx Web Services, Developer Guide 283 Chapter 32 FedEx Intra-Country Shipping Table 143. Europe, the Middle East and Africa Special Service Options, continued Dangerous Goods Dry Ice On Call Pickup Priority Alert Priority Alert Plus Residential Delivery Returns Belgium X X X X X X X X X Czech Republic X X X X X X X X Denmark X X X X X X X X Finland X X X X X X X X France X X X X X X X X X Germany X X X X X X X X X Hungary X X X X X X X X India X X X X X Italy X X X X X X X X X Luxembourg X X X X X X X X X X The Netherlands X X X X X X X X X Norway X X X X X X X X Poland X X X X X X X X Russia X X X X X X X X Spain X X X X X X X X Sweden X X X X X X X X Country United Kingdom X Freight to Collect Future Day Hold at Location X X X X X X X X Holiday Delivery X X X Saturday Delivery Ship Alerts X X X Special Delivery Sunday Delivery X X X FedEx Web Services, Developer Guide 284 Chapter 32 FedEx Intra-Country Shipping India Details Not all special service options are available for each service. This table lists the options that are supported with each service. Table 144. India Special Service Options Special Service Option FedEx Priority Overnight FedEx Standard Overnight FedEx Economy Collect on Delivery (C.O.D.) X X Dangerous Goods X X Delivery Invoice Acceptance (D.I.A.) X X Dry Ice X X Freight on Value Carrier Risk X X X Freight on Value Own Risk X X X Freight to Collect X X X Hold at Location X X X Holiday, Special and Sunday Delivery X X X Outside Delivery Area (ODA) X X X Outside Pickup Area (OPA) X X X Priority Alert X Priority Alert Plus X 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. FedEx Web Services, Developer Guide 285 Chapter 32 FedEx Intra-Country Shipping 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. • 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: – 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. 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. 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. 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 FedEx Web Services, Developer Guide 286 Chapter 32 FedEx Intra-Country Shipping 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. 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. Colombia The following information pertains to intra-country shipping within Colombia. Rules for Colombia • Packaging Types Only the FedEx Envelope and customer packaging are supported. • Weight and Dimension Limits Table 146. Colombia Package Limitations Table 145. Freight to Collect with Intra-Country Shipping Country Mexico India FedEx First Overnight FedEx Priority Overnight FedEx Standard Overnight FedEx 1Day Freight FedEx 2Day Freight FedEx Express Saver X X X X X X X X X Packaging Customer Packaging X Service Dimension Error Message 1Day Freight (Express) Weight > 1,000 kgs / 2,206 lbs 0270 "The weight limit for this service type has been exceeded." 2Day Freight (Express) Length > 302 cm / 119 in 0422 "Length cannot be greater than the maximum allowed." 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." Rules • FTC option takes precedence over the selection of FedEx SameDay services and the Return Receipt on a paper Airway Bill (AWB). • FTC surcharge takes precedence over any other surcharges that would otherwise be applied, such as Commercial Delivery. Length + Girth > 1,064 cm 0421 "Length & girth combined cannot / 419 in be greater than the maximum allowed." • 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. Restrictions India The following information pertains to intra-country shipping within India. Rules for India • Collect on Delivery (C.O.D.) and Delivery Invoice Acceptance (D.I.A.) FTC cannot be combined with the COD/DIA service option. FedEx Web Services, Developer Guide 287 Chapter 32 FedEx Intra-Country Shipping 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. • Collection Types The following collection types are supported: – Cash • Multiple Piece Shipments – 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. • Package Type Only customer packaging is supported. • Payment Types The following payment types are supported: – Company Check – Bill Sender – Personal Check – Bill Recipient or Consignee – Demand Draft – Bill Third Party – 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. • Purpose of Shipment 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 The state/province code is required with intra-India shipping. • Sunday Delivery See Hold at Location above. Intra-India Shipping Weight and Dimension Limits Intra-India shipping is only available in the Ship WSDL v12 and higher. FedEx Web Services, Developer Guide 288 Chapter 32 FedEx Intra-Country Shipping Table 147. Intra-Country Shipping Weights and Dimension Limits FedEx Priority Overnight Size and Weight Restrictions FedEx Standard Overnight Table 148. CreatePendingShipmentRequest , continued FedEx Express Saver Maximum allowable Maximum allowable Maximum allowable weight for single piece: weight for single piece: weight for single piece: 31 kg/ 68.2 lbs 68 kg/ 149.6 lbs 68 kg/ 149.6 lbs Element Required RequestedShipment/ ServiceType Yes Identifies the FedEx services to use in shipping the package. Valid values are: • PRIORITY_OVERNIGHT • FEDEX_EXPRESS_SAVER • FEDEX_1_DAY_FREIGHT • STANDARD_OVERNIGHT RequestedShipment/ PackagingType Yes Identifies the packaging used by the requestor for the package. Valid value is: • YOUR_PACKAGING RequestedShipment/Shipper Yes Descriptive data identifying the party responsible for shipping the package. Shipper and Origin should have the same address. RequestedShipment/Recipient Yes Descriptive data identifying the party receiving the package. RequestedShipment/ ShippingChargesPayment/ Payment/PaymentType No Descriptive data indicating the method and means of payment to FedEx for providing shipping services. Valid values are: • ACCOUNT • COLLECT • RECIPIENT • SENDER • THIRD_PARTY RequestedShipment/ SpecialServicesRequested No Descriptive data regarding special services requested by the shipper for this shipment. RequestedShipment/ SpecialServicesRequested/ CodDetail No Descriptive data required for a FedEx COD (Collect-onDelivery) shipment. RequestedShipment/ SpecialServicesRequested/ DeliveryOnInvoiceAcceptance Detail No The Recipient and Tracking ID data for the Delivery On Invoice Acceptance service. Dimensional Limitations Length: 274 cm/ 108 inches Width: 157 cm/ 62 inches Height: 157 cm/ 62 inches Combined length + girth = 330 cm/ 130 inches • 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. The available Service Types for intra-India shipments are Priority Overnight, Standard Overnight, and FedEx Express Saver. See Table 144 on page 285for guidelines when choosing an intra-India shipping option. Intra-India Coding Details Table 148. CreatePendingShipmentRequest Element RequestedShipment RequestedShipment/ ShipTimestamp RequestedShipment/ DropofType Required Yes Yes Yes Description Descriptive data about the shipment being sent by the requestor. 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. Identifies the method by which the package is to be tendered to FedEx. Description FedEx Web Services, Developer Guide 289 Chapter 32 FedEx Intra-Country Shipping Table 148. CreatePendingShipmentRequest , continued Element Required Table 148. CreatePendingShipmentRequest , continued Description Element Required Description RequestedShipment/ RequestedPackageLineItem/ SpecialServicesRequested/ PackageSpecialServicesReque sted/DangerousGoodsDetail No Descriptive data required for a FedEx shipment containing dangerous materials. CreatePickupRequest/ FreightPickupDetail/ FreightPickupLineItem/ ShipmentSpecialServicesRequ ested/ExtraLaborDetail No Specification for labor to be performed with the shipment. List the total labor time in ExtraLaborDetail/ Duration. RequestedShipment/ SpecialServicesRequested/ HoldAtLocationDetail No 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 No Number of packages in this shipment which contain dry ice and the total weight of the dry ice for this shipment. RequestedShipment/ CustomsClearanceDetail/ FreightOnValue No Identifies responsibilities with respect to loss, damage, etc. Valid values are: • CARRIER_RISK • OWN_RISK RequestedShipment/ LabelSpecification Yes Details about the image format and printer type for the label. An EXTRA_SURFACE_HANDLING_CHARGE will be assessed for all FedEx Express Saver Intra-India shipments. RequestedShipment/ RateRequestTypes Yes Specifies 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. Note: For more information about C.O.D. coding details, see FedEx Express C.O.D. Coding Details. RequestedShipment/ PackageCount Yes The total number of package in the entire shipment (even when the shipment spans multiple transactions). RequestedShipment/ RequestedPackageLineItems No 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/ RequestedPackageLineItem/ SpecialServicesRequested/ PackageSpecialServicesReque sted/SpecialServiceTypes No The types of all special services requested for the enclosing shipment or package. Valid values are: COD DANGEROUS_GOODS DRY_ICE FREIGHT_TO_COLLECT Table 149. 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. Mexico The following information pertains to intra-country shipping within Mexico. Rules for Mexico • Contract Required FedEx Web Services, Developer Guide 290 Chapter 32 FedEx Intra-Country Shipping A contract is required for FedEx Same Day City service. Contact your FedEx sales representative for details. Table 151. Intra-Mexico Request Elements, continued Element • Packaging Types Only the FedEx Envelope and customer packaging are supported. • • • • • • • • • Weight and Dimension Limits Table 150. Mexico Package Limitations Service Option Packaging Service Customer Packaging First Overnight Priority Alert Priority Overnight Priority Alert Plus Standard Overnight Dimension Error Message Weight > 68 kgs 0270 "The weight limit for this / 150 lbs service type has been exceeded." RequestedShipment/SpecialServicesRequested/ SpecialServiceTypes Return list rates by specifying the FREIGHT_TO_COLLECT element with the RECIPIENT payment type without including the account number. 2025 "Width cannot be greater than the maximum allowed." 0421 "Length & girth combined cannot be greater than the maximum allowed." Intra-Mexico Coding Details Table 151. Intra-Mexico Request Elements Element Description RequestedShipment/ServiceType Identifies the FedEx services to use in shipping the package. Valid values are: The types of all special services requested for the enclosing shipment or package. FREIGHT_TO_COLLECT Return account specific rates by specifying the FREIGHT_TO_COLLECT element with the SENDER payment type and include the account number. Height > 274 cm 2083 "Height cannot be greater / 108 in than the maximum allowed." Length + Girth > 330 cm / 130 in FEDEX_1_DAY_FREIGHT FEDEX_2_DAY_FREIGHT FIRST_OVERNIGHT FEDEX_EXPRESS_SAVER SAME_DAY SAME_DAY_CITY PRIORITY_OVERNIGHT STANDARD_OVERNIGHT Valid values are: Length > 274 cm 0422 "Length cannot be greater / 108 in than the maximum allowed." Width > 274 cm / 108 in Description United Kingdom The following information pertains to intra-country shipping within the United Kingdom. Rules for The United Kingdom • Contract Required Intra-UK shipping must be enabled for your account. • Dangerous Goods FedEx Web Services, Developer Guide 291 Chapter 32 FedEx Intra-Country Shipping 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 intraUnited 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. 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 152. Intra-UK Request Elements Element Description RequestedShipment/ServiceType Identifies the FedEx service to use in shipping the package. Valid values are: • 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/ PackageSpecialServicesRequested/ SpecialServiceTypes The types of all special services requested for the enclosing shipment or package. 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. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Regulation Identifies the source of regulation for hazardous commodity data. Valid values are: • ADR (Required) • DOT FedEx Web Services, Developer Guide 292 Chapter 32 FedEx Intra-Country Shipping Table 152. Intra-UK Request Elements, continued Element Description • IATA • ORMD RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Options Indicates which kind of hazardous content (as defined by DOT) is being reported. Valid values are: • HAZARDOUS_MATERIALS • LITHIUM_BATTERY_EXCEPTION • ORM_D • REPORTABLE_QUANTITIES • SMALL_QUANTITY_EXCEPTION • LIMITED_QUANTITIES_COMMODITIES Table 152. Intra-UK Request Elements, continued Element Description DangerousGoodsDetail/Containers/ HazardousCommodities RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/Description Identifies and describes an individual hazardous commodity. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/Quantity Specifies the amount of the commodity in alternate units. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/InnerReceptacles This describes the inner receptacle details for a hazardous commodity within the dangerous goods container. Customer-provided specifications for handling individual commodities. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers Indicates one or more containers used to pack dangerous goods commodities. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/PackingType Indicates whether there are additional inner receptacles within this container. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/Options RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/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. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/RadionuclideDetail Specifies the details of any radio active materials within the commodity. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ RadioactiveContainerClass Indicates the packaging type of the container used to package the radioactive materials. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities Documents the kinds and quantities of all hazardous commodities in the current container. RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ NumberOfContainers Indicates the number of occurrences of this container with identical dangerous goods configuration. 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/ Documents the kind and quantity of all hazardous commodities in the current container. RequestedShipment/ PackageSpecialServicesRequested/ Specifies the amount of the commodity in alternate units. FedEx Web Services, Developer Guide 293 Chapter 32 FedEx Intra-Country Shipping Table 152. Intra-UK Request Elements, continued Element Description DangerousGoodsDetail/Containers/ HazardousCommodities/InnerReceptacles/Quantity RequestedShipment/ PackageSpecialServicesRequested/ DangerousGoodsDetail/Containers/ HazardousCommodities/Description Table 153. Intra-UK Reply Elements, continued Element Description CompletedPackageDetails/ HazardousPackageDetail/Containers Documents the kinds and quantities of all hazardous commodities in the current package. Table 153. Intra-UK Reply Elements Element Description CreatePendingShipmentReply/ CompletedShipmentDetail/ The reply payload. All of the returned information about this shipment/package. CreatePendingShipmentReply/ CompletedShipmentDetail/ HazardousShipmentDetail Computed shipment level hazardous commodity information. CreatePendingShipmentReply/ CompletedShipmentDetail/ HazardousShipmentDetail/ADRLicense Contains the ADR License information, which identifies the license number and ADR category under which the customer is allowed to ship. CreatePendingShipmentReply/ 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. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails Package level details about this package. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails/ HazardousPackageDetail Documents the kinds and quantities of all hazardous commodities in the current package using updated hazardous commodity description data. CreatePendingShipmentReply/ CompletedShipmentDetail/ Describes the kinds and quantities of all hazardous commodities in the current package. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails/ HazardousPackageDetail/Containers/ HazardousCommodities Documents the kinds and quantities of all hazardous commodities in the current package. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails/ HazardousPackageDetail/Containers/ HazardousCommodities/MassPoints The mass points are a calculation used by ADR regulations for measuring the risk of a particular hazardous commodity. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails/ HazardousPackageDetail/Containers/ HazardousCommodities/Description Identifies and describes an individual hazardous commodity. CreatePendingShipmentReply/ CompletedShipmentDetail/ CompletedPackageDetails/ HazardousPackageDetail/Containers/ HazardousCommodities/Description/ TunnelRestrictionCode 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: M Explosions M Release of toxic gas or volatile toxic liquid M Fires FedEx Web Services, Developer Guide 294 33 FedEx Express International Shipping FedEx Express International Service Details International Packaging Options FedEx Express International Service Options FedEx Express International Coding Details Chapter 33 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 Chapter 36: FedEx International Ground Shipping for more information about that service. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. FedEx International Priority See Ship Service for a list of FedEx Express international services available by region. 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. FedEx Express International Service Details • Service days are Monday through Friday, with Express International Saturday available in many areas. 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. • Available in more than 220 countries and territories. FedEx International First • 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. 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. • Options include Express International Saturday and Chapter 20: Dangerous Goods support for Chapter 24: Dry Ice Shipments only. • Package size and weight up to 150 lbs. each; 108" in length; 130" in length plus girth (L+2W+2H). • Options include Express International Saturday, International Broker Select, Chapter 39: Commercial Destination Control, Chapter 20: Dangerous Goods, and Chapter 23: Hold at FedEx Location. 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). FedEx Web Services, Developer Guide 296 Chapter 33 FedEx Express International Shipping • Door-to-door, customs-cleared delivery to major world markets. • Options include Express International Saturday, International Broker Select, Chapter 24: Dry Ice Shipments, and Chapter 20: Dangerous Goods to U.S., Canada and Puerto Rico only. FedEx Europe First FedEx Europe First® provides intra-European next day, door-to-door, customscleared (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: – 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. • 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. FedEx Express International Service Options The following service options are available for use with FedEx Express international shipping: • Alternate Return Address • Chapter 39: Commercial Destination Control • Chapter 20: Dangerous Goods • Chapter 34: FedEx Express International (Saturday) • Chapter 24: Dry Ice Shipments • Chapter 15: Delivery Signature Services • FedEx InSight • FedEx International Broker Select® FedEx Web Services, Developer Guide 297 Chapter 33 FedEx Express International Shipping • Chapter 32: FedEx Intra-Country Shipping • International Freight shipping is available to Puerto Rico. • Mask Account Number (FedEx International Ground) • 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. • Chapter 27: Masked Data • Chapter 25: Shipment Notification in the Ship Request • Chapter 26: Variable Handling Charges International Packaging Options In addition to standard FedEx Express packaging, you may also choose a FedEx 10kg Box or a FedEx 25kg Box. The weight limit is 22 lbs. for a FedEx 10kg Box and 55 lbs. for a FedEx 25kg Box. These packaging options are allowed for FedEx International Priority® to more than 220 countries and territories. 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 allows multiple-package shipping (MPS). MPS Express International shipments are associated with one another using a package sequence indicator. 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. • 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 https:// www.fedex.com/GTM?cntry_code=us Global Trade Manager website that provides the information you need to reduce the time it takes to clear packages through customs. 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. • You may ship both documents and commodity shipments. FedEx Web Services, Developer Guide 298 Chapter 33 FedEx Express International Shipping • 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. Table 154. Recipient Information Elements, continued Element Multiple Occurrence Description Note: The maximum number of packages in an MPS request is 200. RequestedShipment/City No Required. This option is available for international C.O.D. multiple-package shipments. RequestedShipment/ StateOrProvinceCode No Required only if recipient country is U.S. or Canada, or if EEI applies and country is Mexico (MX). RequestedShipment/ PostalCode No Required only if recipient country is a postal aware country. For more information about MPS, see FedEx Express U.S. Multiple-Package Shipments. Document Shipments See Appendix J: Postal-Aware Countries and Formats for a list of postal aware countries. 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. Recipient Information 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 No Required. Identifies the recipient country. RequestedShipment/ CountryName No The fully spelled out name of a country. RequestedShipment/ PhoneNumber No Required. TinType/TinNumber No Tax Identification Number. Specify the Employer Identification Number (EIN). Table 154. Recipient Information Elements Element Multiple Occurrence Required if duties, taxes, and fees are billed to recipient. Description RequestedShipment/Company No Required if Contact name is blank. RequestedShipment/Contact No Required if Company name is blank. RequestedShipment/ StreetLines Yes At least one street address line is required. Address/Residential No 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. FedEx Web Services, Developer Guide 299 Chapter 33 FedEx Express International Shipping Billing Table 155. Billing Elements, continued Element Table 155. Billing Elements Element ShippingChargesPayment/ PaymentType Multiple Occurrence No Multiple Occurrence Description Required. Values are: • ACCOUNT • COLLECT (Ground) • SENDER • RECIPIENT • THIRD_PARTY ShippingChargesPayment/ Payor/AccountNumber No Required if PaymentType element is SENDER, RECIPIENT or THIRD_PARTY. Currency No 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 No Required. The country code associated with the shipper’s FedEx account billing currency type. CountryName No Optional. The fully spelled out name of a country. CustomerReferenceType No 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 • INTRA_REGULATORY_REFERENCE • INVOICE_NUMBER • P_O_NUMBER Description • RMA_ASSOCIATION • SHIPMENT_INTEGRITY • STORE_NUMBER Note: You can add up to three references per shipment. SHIPMENT_INTEGRITY prints only on the invoice. CustomerReference/Value No 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. Multiple Piece Shipment Elements This option is available for FedEx Express U.S. and international multiplepackage shipments (MPS), FedEx Ground U.S. and international MPS, 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. For more information about MPS, see FedEx Express U.S. MultiplePackage Shipments. Note: Up to 200 MPS packages can be created for one master shipment. Table 156. 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. FedEx Web Services, Developer Guide 300 Chapter 33 FedEx Express International Shipping Table 156. Multiple Piece Shipment Elements, continued Element MasterTrackingID Multiple Occurrence Yes Description 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. Table 157. Shipment/Package Information Elements, continued Element Multiple Occurrence • FEDEX_TUBE • YOUR_PACKAGING PhysicalPackaging Yes 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. Shipment/Package Information Weight ServiceType PackagingType Multiple Occurrence No Yes Yes Description Required. Values are: • EUROPE_FIRST_INTERNATIONAL_PRIORITY (for intra-Europe shipment only). • INTERNATIONAL_ECONOMY • INTERNATIONAL_FIRST • INTERNATIONAL_PRIORITY • INTERNATIONAL_ECONOMY_ FREIGHT • INTERNATIONAL_PRIORITY_ FREIGHT Required. Values are: • FEDEX_10KG_BOX • FEDEX_25KG_BOX • FEDEX_BOX • FEDEX_ENVELOPE • FEDEX_PAK 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 for valid package descriptions. Table 157. Shipment/Package Information Elements Element Description Required. Units and Value are included in this element. Values for the Units element are: • LB • KG The Value element must contain the actual package weight. For multiple-piece shipments (MPS), each ProcessShipment request must contain the package Weight. TotalWeight No 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: • LB • KG The Value element must contain the actual package weight. FedEx Web Services, Developer Guide 301 Chapter 33 FedEx Express International Shipping Table 157. Shipment/Package Information Elements, continued Element Multiple Occurrence Description Height Yes Optional but recommended if your package type is CUSTOMER_PACKAGING. Width Yes Optional but recommended if your package type is CUSTOMER_PACKAGING. Length Yes Optional but recommended if your package type is CUSTOMER_PACKAGING. Units InternationalDocument Commodity/Description Table 157. Shipment/Package Information Elements, continued Element Multiple Occurrence Note: "InsuredValue" refers to declared value of the package. FedEx does not provide insurance of any kind. RequestedShipment/ ShipTimeStamp No 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 M: Time Zones for more information. RequestedShipment/Date No See Appendix L: Customs-Approved Document Descriptions for more information. Commodity/ CountryOfManufacture Yes InsuredValue/Amount No Optional. Country code where document contents were produced in their final form. Note: Some countries require a minimum document declared value of $1USD. For a list of these countries, see Minimum Customs Value. 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. 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. 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-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. Required if dimensions are specified. Values are: • IN • CM No Description Required. Date of shipment. For FedEx Express international shipments, this value can be current date or up to 10 days in future. Label Requirements Table 158. Label Requirements Element Element LabelSpecification Multiple Occurrence No Description 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 Chapter 12: Creating a Label. FedEx Web Services, Developer Guide 302 Chapter 33 FedEx Express International Shipping In addition to these elements, you may choose these shipping options for a document shipment: • Alternate Return Address • Chapter 34: FedEx Express International (Saturday)(depending on origin/ destination pair and service) • FedEx Insight • Chapter 23: Hold at FedEx Location (depending on origin/destination pair and service) • International Broker Select • Chapter 25: Shipment Notification in the Ship Request Table 159. Document Shipment Options Commodity 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. Shipping Option Package vs. Shipment Level Recipient Information Dangerous Goods Shipment Table 160. Recipient Information Elements Delivery Signature Options Shipment Dry Ice Shipment Future Day Shipment RequestedShipment/Company No Required if Contact name is blank. Hold at Location Shipment RequestedShipment/Contact No Required if Company name is blank. Inside Delivery Shipment RequestedShipment/ StreetLines Yes At least one street address line is required. Inside Pickup Shipment RequestedShipment/City No Required. Notification Shipment Package RequestedShipment/ StateOrProvinceCode No Reference Elements Required only if recipient country is U.S. or Canada, or if EEI applies and country is Mexico (MX). Saturday Services Shipment No Variable Handling Charge Package RequestedShipment/ PostalCode Required only if recipient country is a postal aware country. Element Multiple Occurrence Description See Appendix J: Postal-Aware Countries and Formats 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 FedEx Web Services, Developer Guide 303 Chapter 33 FedEx Express International Shipping Table 160. Recipient Information Elements, continued Element Multiple Occurrence Description Table 160. Recipient Information Elements, continued Element Multiple Occurrence have the same house number and street name. When this is the case, the urbanization code is needed to distinguish them. RequestedShipment/ CountryCode No RequestedShipment/ CountryName No RequestedShipment/ PhoneNumber No Required. TaxpayerIdentification/ TinType/ No Identifies the category of the taxpayer identification. The UTC offset indicates the number of hours/ minutes (e.g. xx:xx) from UTC (e.g., 2009-0626T17:00:00-04:00 is defined as June 26, 2009 5:00 p.m. Eastern Time). Identifies the recipient country code. See Appendix M: Time Zones or more information about time zones. The fully spelled out name of a country. RequestedShipment/Date No Required. Date of shipment. For FedEx Express International shipments, this value can be the current date or up to 10 days in the future. Billing Details Valid values are: • • • • • BUSINESS_NATIONAL BUISNESS_STATE BUSINESS_UNION PERSONAL_NATIONAL PERSONAL_STATE TinType/TinNumber No 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 No 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/ ShipTimeStamp Description No 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 (e.g., 2009-06-26T17:00:00). Table 161. Billing Detail Elements Element TaxpayerIdentification/TinType Multiple Occurrence No Description Required for non document shipments to Brazil. Valid values are: • 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 No 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. FedEx Web Services, Developer Guide 304 Chapter 33 FedEx Express International Shipping Table 161. Billing Detail Elements, continued Element ShippingChargesPayment/ PaymentType Multiple Occurrence No Table 162. Multiple-Piece Shipment Elements Description Element Required. Values are: • COLLECT (Ground) • SENDER • RECIPIENT • THIRD_PARTY 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. AccountNumber No Required if PaymentType element is SENDER, RECIPIENT or THIRD_PARTY. Currency No 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 No Optional. Country code associated with the currency. CountryName No Optional. The fully spelled out name of a country. Shipment/Package Information Table 163. Shipment/Package Information Elements Multiple Occurrence Note: The maximum number of packages in an MPS request is 200. Description ServiceType No Required. Values are: • EUROPE_FIRST_INTERNATIONAL_PRIORITY (for intra-Europe shipment only) • INTERNATIONAL_ECONOMY • INTERNATIONAL_FIRST • INTERNATIONAL_PRIORITY • INTERNATIONAL_ECONOMY_FREIGHT • INTERNATIONAL_PRIORITY_FREIGHT PackagingType Yes Required. Values are: • FEDEX_10KG_BOX • FEDEX_25KG_BOX • FEDEX_BOX • FEDEX_ENVELOPE This option is available for FedEx Express U.S. and international multiplepackage shipments, FedEx Ground U.S. and international multiple-package shipments, 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 (MPS). Description Note: The MasterTrackingID element includes the MasterTrackingNumber and FormID. Both simple elements are required. Element Multiple-Piece Shipment Elements Multiple Occurrence FedEx Web Services, Developer Guide 305 Chapter 33 FedEx Express International Shipping Table 163. Shipment/Package Information Elements, continued Element Multiple Occurrence Description • FEDEX_PAK • FEDEX_TUBE • YOUR_PACKAGING PhysicalPackaging Yes Table 163. Shipment/Package Information Elements, continued Element CustomerReferenceType Multiple Occurrence No • • • • • • • • • • See Appendix K: Physical Packaging Type Codes for valid package descriptions. Yes Required. Units and Value are included in this Element. Values for the Units element are: • LB • KG No 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: • LB • KG The Value element must contain the actual package weight. 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. The Value element must contain the actual package weight. For MPS shipments, each ship request must contain the package Weight. TotalWeight 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: 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. Weight Description CustomerReference/Value No 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. FedEx Web Services, Developer Guide 306 Chapter 33 FedEx Express International Shipping Table 163. Shipment/Package Information Elements, continued Element Multiple Occurrence Units InsuredValue/Amount Description Required if dimensions are specified. Values are: • IN • CM No RequestedShipment/ ShipTimeStamp No No Required. Values are: • DOCUMENTS_ONLY • NON_DOCUMENTS 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-0626T17: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 for valid package descriptions. RequestedShipment/Date No Table 164. Label Requirements Element Element LabelSpecification Multiple Occurrence No 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 Label Requirements Required. Date of shipment. For FedEx Express international shipments, this value can be current date or up to 10 days in future. Description 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 Chapter 12: Creating a Label. International Clearance Requirements Table 165. Commodity Shipment Elements Element TermsOfSale Multiple Occurrence No Description Required for commodity shipments. 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. FedEx Web Services, Developer Guide 307 Chapter 33 FedEx Express International Shipping Table 165. Commodity Shipment Elements, continued Element Multiple Occurrence Description • 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 No 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 No Required if the Terms of Sale element is CIF. This charge must be added to the total customs value amount. RegulatoryControlType No Identities the type of regulatory control. Valid values are: • • • • EU_CIRCULATION FOOD_OR_PERISHABLE NAFTA NOT_APPLICABLE_FOR_LOW_CUSTOMS_VALUE _EXCEPTION Table 165. Commodity Shipment Elements, continued Element Multiple Occurrence U.S. and Puerto Rico (except for shipments from PR to the U.S. or U.S. to PR) containing food items. CustomsValue No 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 No 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 Commodity 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 166. Commodity Elements Element Multiple Occurrence Description Commodity/Name No 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 A minimum of three characters is required for this element. Maximum number of characters is 450. 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 Description FedEx Web Services, Developer Guide 308 Chapter 33 FedEx Express International Shipping Table 166. Commodity Elements, continued Element Multiple Occurrence Table 166. Commodity Elements, continued Description Element Multiple Occurrence Description See Appendix H: Vague Commodity Descriptions for a list of appropriate commodity names. Commodity/ExiseConditions Yes Optional. Defines additional characteristics of the commodity used to calculate duties and taxes. Commodity/ CountryOfManufacture Yes Required. Code of country in which commodity contents were produced or manufactured in their final form. Commodity/ ExportLicenseNumber No 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. 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/ ExportLicenseExpirationDate No 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. Commodity/Weight Commodity/Quantity No Yes Required. Total weight of this commodity. One explicit decimal position. Maximum length is 11 including the decimal. 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. Required only for the FedEx CI. Commodity/PartNumber No The part number of the commodity. Commodity/NaftaDetail No All data required for this commodity in NAFTA Certificate of Origin. Must be included for each commodity. Commodity/QuantityUnits No 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 No Required. Customs value for each commodity in the shipment. Commodity/CustomsValue No 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. If the recipient and the importer are not the same, the following importer elements are required: Element customsClearanceDetail/ ImporterofRecord Multiple Occurrence No Description Required if the recipient and importer are not the same. The following elements are included: • AccountNumber • TIN (Tax Payer Identification) • Contact • Address FedEx Web Services, Developer Guide 309 Chapter 33 FedEx Express International Shipping In addition to the preceding elements, you may also choose from the following shipping options for a commodity shipment: • Alternate Return Address • Chapter 34: FedEx Express International (Saturday) (depending on origin/ destination pair and service) • FedEx International Broker Select • FedEx InSight • Chapter 23: Hold at FedEx Location (depending on origin/destination pair and service) International 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. • Chapter 25: Shipment Notification in the Ship Request FedEx Express can accept and properly transport two types of ITAR-controlled items: Shipping Option Package vs. Shipment Level 1. ITAR Exempt goods Dangerous Goods 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 Refer to http://www.fedex.com/us/international/regulatory-alerts/ index.html for specific details on the various State Department licenses and ITAR exemptions. Shipment Notification Shipment International Traffic in Arms Regulations Coding Details Signature Options Shipment Variable Handling Charge Package International Traffic in Arms Regulations (ITAR) services are included in the ShipService, OpenShip, and RateService WSDLs. The following elements are required: 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. FedEx Web Services, Developer Guide 310 Chapter 33 FedEx Express International Shipping Table 167. International Traffic in Arms Regulations Coding Elements Table 168. Express International Elements, continued Element Description Element Description RequestedShipment/ SpecialServicesRequested/ InternationalTrafficInArmsRegulationsDetail 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. CustomsOptionsDetail/Type RequestedShipment/ SpecialServicesRequested/ InternationalTrafficInArmsRegulationsDetail/ LicenseOrExemptionNumber The export or license number for the ITAR shipment. Valid values are: • COURTESY_RETURN_LABEL • EXHIBITION_TRADE_SHOW • FAULTY_ITEM • FOLLOWING_REPAIR • FOR_REPAIR • ITEM_FOR_LOAN • OTHER • REJECTED • REPLACEMENT • TRIAL RequestedShipment/ CustomsClearanceDetail/ CustomsOptions/ CustomsOptionsDetail/Description Specifies additional description about customs options. Required when the customs options type is "other." Reply Elements In addition to the standard reply elements for all ship requests, the following Express International elements are returned: Table 168. Express International Elements Reference Elements with Output Location 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. Value Prints Taxes/TaxType/PST Returned for Canadian origin shipments. BILL_OF_LADING Shipping label and invoice. SurchargeType/Offshore Returned for international shipments. CUSTOMER_REFERENCE SurchargeType/EuropeFirst Returned for intra-Europe shipments using Europe First service. Shipping label, ground shipping reports, and in the Customer Reference element on the invoice. INVOICE_NUMBER Shipping label and invoice. P_O_NUMBER Shipping label and invoice. RMA_ASSOCIATION Shipping label and invoice. RequestedShipment/ CustomsClearanceDetail/ CustomsOptions/ Details the return reason used for clearance processing of international dutiable outbound and international dutiable return shipments. The ShipService WSDL includes these CustomerReference/ CustomerReferenceType elements: Table 169. CustomerReference/CustomerReferenceType Elements FedEx Web Services, Developer Guide 311 Chapter 33 FedEx Express International Shipping Table 169. CustomerReference/CustomerReferenceType Elements, continued Table 169. CustomerReference/CustomerReferenceType Elements, continued Value Prints Value Prints SHIPMENT_INTEGRITY Invoice. STORE_NUMBER Shipping label and invoice. FedEx Web Services, Developer Guide 312 34 FedEx Express International (Saturday) Saturday Service Details Saturday Coding Details Chapter 34 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. Saturday Service Details The following service details apply: • Saturday delivery is available for shipments from the U.S. to select points in Canada for the following services: – 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. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. Saturday Coding Details Saturday services are included in the ShipService WSDL. The following elements are required: Table 170. Saturday Service Request Elements Element Description ShipmentSpecialServicesRequested/ SpecialServiceTypes 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. 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. FedEx Web Services, Developer Guide 314 35 FedEx Express Freight Services: International FedEx International Priority Freight Alcohol Shipping (International Express) FedEx International Economy Freight Future Day Shipping (International Express) Additional Service Details Hold at FedEx Location (International Express) FedEx Express Freight Services Coding Details: International Dry Ice Shipments (International Express) Dangerous Goods (International Express) Chapter 35 FedEx Express Freight Services: International If your FedEx Express® international package exceeds 150 lbs, you must choose one of the FedEx Express® Freight Services. 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. • The following special services are allowed (depending on destination location): Chapter 34: FedEx Express International (Saturday), Chapter 37: FedEx International Broker Select, Chapter 20: Dangerous Goods, and Chapter 23: Hold at FedEx Location. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. 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): Chapter 37: FedEx International Broker Select,® Chapter 23: Hold at FedEx Location, Chapter 20: Dangerous Goods, and Chapter 24: Dry Ice Shipments. 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. 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 Web Services, Developer Guide 316 Chapter 35 FedEx Express Freight Services: International 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 171. International ExpressFreightDetail Elements Element Description ExpressFreightDetail/ BookingConfirmationNumber An advance booking number is required for FedEx International Priority Freight. When you call 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. Reply Elements See the Chapter 10: Ship Service section for ProcessShipment reply information. Dangerous Goods (International Express) See FedEx Express U.S. Chapter 20: Dangerous Goods for more information. Alcohol Shipping (International Express) See FedEx Express U.S. Chapter 22: Alcohol Shipping for more information. Future Day Shipping (International Express) See FedEx Express U.S. Chapter 28: Future Day Shipping for more information. Hold at FedEx Location (International Express) See FedEx Express U.S. Chapter 23: Hold at FedEx Location for more information. Dry Ice Shipments (International Express) See FedEx Express U.S. Chapter 24: Dry Ice Shipments for more information. FedEx Web Services, Developer Guide 317 36 FedEx International Ground Shipping FedEx International Ground Service Options Future Day Shipping (FedEx International Ground) FedEx International Ground Service Details FedEx Ground Collect On Delivery (C.O.D.) (International) FedEx International Ground Coding Details Alternate Return Address (FedEx International Ground) Delivery Signature Services (FedEx International Ground) Mask Account Number (FedEx International Ground) Chapter 36 FedEx International Ground Shipping Use the Shipping service to access the FedEx International Ground® shipping features. • Delivery Times: 2-7 business days. See Shipping Services by Region for a list of FedEx International Ground services available by region. • Delivery Area: Canada. FedEx International Ground Service Options The following service options are available for use with FedEx International Ground shipping: • Alternate Return Address • Chapter 39: Commercial Destination Control • Chapter 15: Delivery Signature Services • Service Days: Monday through Friday by the end of the business day. • 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 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]). • Chapter 19: FedEx Ground U.S. Collect On Delivery (C.O.D.) • 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. • Mask Account Number (FedEx International Ground) • A CI is needed for all shipments. • Chapter 25: Shipment Notification in the Ship Request Note: To determine actual shipping services and options allowed for your origin/destination pair, use the Service Availability service. • Chapter 28: Future Day Shipping • Chapter 26: Variable Handling Charges 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: For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. 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. FedEx Web Services, Developer Guide 319 Chapter 36 FedEx International Ground Shipping • 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. Brokerage and Billing Options for Shipments Between the 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. • 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. Samples • Brokerage Inclusive Services: Through the new default brokerageinclusive service option, FedEx International Ground shipping gives you one point of contact, and initiates regulatory clearance while your packages are still en route. Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: • Broker Selection Option: If you prefer to use your own broker, you have the option to do so. 2. Enter your username and password to login to the DRC. • Flexible Billing Solutions: You now have the option to bill duties, taxes, and ancillary fees to the shipper, the recipient, or a third party. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 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. 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. 3. Expand "Technical Resources" on the left pane. 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. • The ground collect billing option is also available for the Broker Select Option services. FedEx Web Services, Developer Guide 320 Chapter 36 FedEx International Ground Shipping Table 172. Recipient Information Elements, continued Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. 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. Element RecipientEIN Element Multiple Occurrence No Description Required if duties, taxes, and fees are billed to recipient. Billing Table 173. Billing Elements Element Recipient Information Table 172. Recipient Information Elements Multiple Occurrence Multiple Occurrence Description ShippingChargesPayment/ PaymentType No Required. Values are: • ACCOUNT • COLLECT (Ground) • SENDER • RECIPIENT • THIRD_PARTY AccountNumber No 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 No 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. Description Company No Required Contact No Required StreetLines No At least one street address line is required. StreetLines No Optional City No Required StateOrProvinceCode No Required for Canada and U.S. PostalCode No Required CountryCode No Identifies the recipient country. Country No Country code associated with the currency. CountryName No The fully spelled out name of a country. CustomerReferenceType No Telephone No Required Residential No Optional. If you ship to a residential address and do not include the Residential element, your rate quote will be incorrect. 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 FedEx Web Services, Developer Guide 321 Chapter 36 FedEx International Ground Shipping Table 173. Billing Elements, continued Element Multiple Occurrence Table 174. Multiple Piece Shipment Elements, continued Description • • • • • • • ELECTRONIC_PRODUCT_CODE INTRACOUNTRY_REGULATORY_REFERENCE INVOICE_NUMBER P_O_NUMBER RMA_ASSOCIATION SHIPMENT_INTEGRITY STORE_NUMBER Element Multiple Occurrence for that package. The shipment level information added to a master package applies to all packages in the shipment. MasterTrackingID No MasterTrackingID/ TrackingIDType Package 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 No 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. Multiple Piece Shipment Elements Table 174. Multiple Piece Shipment Elements ServiceType Multiple Occurrence No No Required for MPS. Total number of packages in the shipment. SequenceNumber No Required if PackageCount is greater than 1. The sequence number determines the master package and is important when shipment level information is added Description Required. Note: Both residential and commercial shipments use the FEDEX_GROUND ServiceType. Description PackageCount Valid values are: • EXPRESS • FREIGHT • GROUND • USPS • FEDEX Table 175. Package and Shipment Details Elements Element Multiple Occurrence 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. Package and Shipment Details Note: Up to 200 multiple piece shipment (MPS) packages may be created for one master shipment. Element Description 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. FedEx Web Services, Developer Guide 322 Chapter 36 FedEx International Ground Shipping Table 175. Package and Shipment Details Elements, continued Element PhysicalPackaging Multiple Occurrence Yes Description Element 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. 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: • IN • CM InsuredValue/Amount No 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. See Appendix K: Physical Packaging Type Codes for valid packaging types. Weight Yes No Multiple Occurrence Required. Units and Value are included in this element. Values for the Units element are: • LB • KG The Value element must contain the actual package weight. For multiple-piece shipments (MPS), each ship request must contain the package weight. TotalWeight Table 175. Package and Shipment Details Elements, continued 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: • LB • KG 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. Description Note: "InsuredValue" refers to declared value of the package. FedEx does not provide insurance of any kind. RequestedShipment/Date No Date of shipment. For FedEx International Ground, this date can be the current date or up to 10 days in advance. RequestedShipment/ TimeStamp No 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-06-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 M: Time Zones for more information. FedEx Web Services, Developer Guide 323 Chapter 36 FedEx International Ground Shipping Label Requirements Table 177. Broker Selection Elements, continued Table 176. International Ground Label Requirements Element Multiple Occurrence LabelSpecification Description No 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. More information about label printing is provided in Chapter 12: Creating a Label. Broker Selection Table 177. Broker Selection Elements Element Multiple Occurrence Element Multiple Occurrence Description CustomsClearanceDetail/Contact/ PagerNumber No Optional CustomsClearanceDetail/Contact/ FaxNumber No Optional CustomsClearanceDetail/Contact/ EmailAddress No Optional CustomsClearanceDetail/Address/ StreetLines No Optional CustomsClearanceDetail/Address/City No Optional CustomsClearanceDetail/Address/ StateOrProvinceCode No Optional CustomsClearanceDetail/Address/ PostalCode No Optional CustomsClearanceDetail/Address/ CountryCode No Optional CustomsClearanceDetail/Address/ CountryName No Optional. The fully spelled out name of a country. Description CustomsClearanceDetailBrokers// AccountNumber No Optional. Broker’s valid FedEx account number. CustomsClearanceDetail/Brokers/Party/ Tins No CustomsClearanceDetail/Contact/ PersonName No Required. CustomsClearanceDetail/Contact/ CompanyName No Required if PersonName is not supplied. CustomsClearanceDetail/Contact/ PhoneNumber No Required. CustomsClearanceDetail/Contact/ PhoneExtension No Optional. Identifies the phone extension associated with this contact. CustomsClearanceDetail/Contact/ TollFreePhoneNumber No Optional. Identifies a toll free number, if any, associated with this contact. Optional. Tax ID number (EIN). 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 178. Commodity Information Elements Element Commodity/NumberOfPieces Multiple Occurrence Yes Description Required. The total number of packages within the shipment that contain this commodity (can be less than or equal to PackageCount). FedEx Web Services, Developer Guide 324 Chapter 36 FedEx International Ground Shipping Table 178. Commodity Information Elements, continued Element Commodity/Description Multiple Occurrence Yes Description Table 178. Commodity Information Elements, continued Element Multiple Occurrence Description Amount must equal the commodity UnitPrice times Units. 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/ ExportLicenseNumber No Required only if a commodity is shipped on a commercial export license. Commodity/ CountryOfManufacture Yes Code of the country in which the commodity contents were produced or manufactured in their final form. Commodity/ ExportLicenseExpirationDate No Required only if a commodity is shipped on a commercial export license and the ExportLicenseNumber element is supplied. 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 CommercialInvoice/Comments Yes A maximum of four occurrences per commodity may be included. customsClearanceDetail/ NAFTA No For shipments to NAFTA countries (U.S., Canada, and Mexico), you are required to enter the appropriate NAFTA information for your shipment. For more information regarding these requirements, go to fedex.com/us/customersupport/ftn/faq/ nafta.html. NAFTACommodityDetail No Optional. Specifies the NAFTA commodity detail for the shipment. NAFTACommodityDetail/ PreferenceCriterion No Optional. Preference for each commodity in the shipment: 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/ CIMarksandNumbers Yes Optional. An identifying mark or number used on the packaging of a shipment to help customs identify a particular shipment. A - The good was obtained or produced entirely in a NAFTA country. Commodity/QuantityUnits Yes Required. Unit of measure (for example: EA = each; DZ = dozen) of each commodity in the shipment. B - The good was produced entirely in a NAFTA country and satisfies the specific origin that applies to its tariff classification. 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/ NAFTACommodityDetail/ ProducerDetermination No 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 FedEx Web Services, Developer Guide 325 Chapter 36 FedEx International Ground Shipping Table 178. Commodity Information Elements, continued Element Multiple Occurrence Table 179. FedEx International Ground U.S. to Canada NAFTA Elements Description Element No (2) - Written statement from producer Print General Agency Authority (GAA) Form No Optional. Print the GAA. No (3) - Signed certificate from producer Multiple Occurrence Description NAFTACommodityDetail/ ProducerId No Identifies the commodity producer when multiple producers are used in a single shipment. GAA Media Type No Optional. Specify the form for the GAA as PNG or PDF. NAFTACommodityDetail/ NetCostMethod No Optional. The Net cost (NC) method calculates regional value content (RVC) as a percentage of the net cost to produce the good. Provide GAA Instructions No Optional. Specify whether to include GAA instructions. List Clearance Entry Fee Surcharge No Optional. Specify the list clearance entry fee surcharge. Clearance Entry Fee Surcharge (Discount) No Optional. Specify the list clearance entry fee surcharge discount. GAA Form No Optional. Specify the location of the GAA form. GAA Form Copies To Print No Optional. Specify the number of GAA form copies to print. GAA Instructions No Optional. Specify the GAA instructions. GAA Instruction Copies to Print No Optional. Specify the number of GAA instruction copies to print. 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/ NetCostDateRange No 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. 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. Reply Elements In addition to the standard reply elements for all Ship requests, the following FedEx International Ground elements are returned: Table 180. 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. FedEx Web Services, Developer Guide 326 Chapter 36 FedEx International Ground Shipping Table 180. International Ground Reply Elements, continued Reference Elements with Output Location Element Description Taxes/TaxType/GST Returned for Canadian origin shipments. The ShipService WSDL includes these CustomerReference/ CustomerReferenceType elements: Taxes/TaxType/PST Returned for Canadian origin shipments. Table 182. CustomerReference/CustomerReferenceType Elements International/NAFTA Reply Information Table 181. International/NAFTA Reply Information Value Prints BILL_OF_LADING Shipping label and invoice. CUSTOMER_REFERENCE Shipping label, ground shipping reports, and in the Customer Reference element on the invoice. Element Description List Clearance Entry Fee Surcharge Returned list clearance entry fee surcharge. INVOICE_NUMBER Shipping label and invoice. Clearance Entry Fee Surcharge (Discount) Returned list clearance entry fee surcharge discount. P_O_NUMBER Shipping label and invoice. RMA_ASSOCIATION Shipping label and invoice. GAA (General Agency Authority) form Returned location of the GAA form. SHIPMENT_INTEGRITY Invoice. STORE_NUMBER Shipping label and invoice. 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 See Chapter 15: Delivery Signature Services for more information. 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 Delivery Signature Services (FedEx International Ground) 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. Future Day Shipping (FedEx International Ground) See FedEx Express U.S. Chapter 28: Future Day Shipping for more information. FedEx Ground Collect On Delivery (C.O.D.) (International) See Chapter 36: FedEx International Ground Shipping for more information. FedEx Web Services, Developer Guide 327 Chapter 36 FedEx International Ground Shipping Alternate Return Address (FedEx International Ground) Mask Account Number (FedEx International Ground) See FedEx Express U.S. Alternate Return Address for more information. See FedEx Express U.S. Chapter 27: Masked Data for more information. FedEx Web Services, Developer Guide 328 37 FedEx International Broker Select FedEx International Broker Select Service Details FedEx International Broker Select Coding Details Chapter 37 FedEx International Broker Select FedEx International Broker Select® allows you to designate a specific customs broker other than FedEx (or our designated broker). 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 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 Elements 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 183. International Broker Select Elements • FedEx International Economy® Freight Element Description • FedEx International Ground® to Canada CustomsClearanceDetail/Party/AccountNumber Optional. Broker’s valid FedEx account number. Note: FedEx International Broker Select is a contract service. Contact your FedEx account executive for more information. CustomsClearanceDetail/Party/Tins Optional. Tax ID Number. EIN (Employer Identification Number). For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. CustomsClearanceDetail/Party/Contact Required. The descriptive data for a point-ofcontact person. CustomsClearanceDetail/Contact/ContactId Optional. Client provided identifier corresponding to this contact information. CustomsClearanceDetail/Contact/PersonName Required CustomsClearanceDetail/Contact/CompanyName Required 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. CustomsClearanceDetail/Contact/PagerNumber Optional CustomsClearanceDetail/Contact/FaxNumber Optional 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 FedEx Web Services, Developer Guide 330 Chapter 37 FedEx International Broker Select Table 183. International Broker Select Elements, continued Table 183. International Broker Select Elements, continued Element Description Element Description CustomsClearanceDetail/Contact/EmailAddress Optional CustomsClearanceDetail/Address/City Required CustomsClearanceDetail/PartyAddress/StreetLines Required. 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/ StateOrProvinceCode Required for U.S. or CA CustomsClearanceDetail/Address/PostalCode Optional CustomsClearanceDetail/Address/StreetLines CustomsClearanceDetail/Address/CountryCode Required CustomsClearanceDetail/Address/CountryName Optional. The fully spelled out name of a country. Optional. Additional street lines can be included as needed. FedEx Web Services, Developer Guide 331 38 Electronic Export Information Where to File Information for the EEI When to File Electronic Export Information Coding Details U.S. to Canada Chapter 38 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. • FedEx International Shipping page: fedex.com/us/international 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). When to File 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. Where to File Because of U.S. Government changes in the EEI process, you must file your EEI information with AESDirect at www.aesdirect.gov. This Governmentsupported 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. • FedEx Global Trade Manager: fedex.com/GTM • AESDirect: www.aesdirect.gov • U.S. Census Bureau: www.census.gov/foreign-trade/ You must 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. For more information regarding EEI filing, the following locations are available: FedEx Web Services, Developer Guide 333 Chapter 38 Electronic Export Information 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. 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. • 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/. 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 184. 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 are: • BUSINESS_NATIONAL FedEx Web Services, Developer Guide 334 Chapter 38 Electronic Export Information Table 184. ITN or EEI Exemption Number Elements, continued Element Description • • • • Sender/Tins/Number CustomsClearanceDetail/ExportDetail/ ExportComplianceStatement BUSINESS_STATE BUSINESS_UNION PERSONAL_NATIONAL PERSONAL_STATE Specify the Taxpayer Identification/Number with the corresponding ID number for TinType. 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. Table 184. ITN or EEI Exemption Number Elements, continued Element Description 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. FedEx Web Services, Developer Guide 335 39 Commercial Destination Control Commercial Destination Control Service Details Commercial Destination Control Coding Details Chapter 39 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. 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. 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 185. Commerce Destination Control Statement Elements Element Required Description CustomsClearanceDetail/ ExportDetail/ DestinationControlDetail/ StatementTypes Optional Values are: • DEPARTMENT_OF_COMMERCE • DEPARTMENT_OF_STATE CustomsClearanceDetail/ ExportDetail/ DestinationControlDetail/ DestinationCountries Optional DCS shipment destination country. Up to 11 alphanumeric characters are allowed. If the StatementType is DEPARTMENT_OF_STATE, this element is required. You may enter up to four country codes in this element. See Appendix A: Country Code Tables for a list of countries. CustomsClearanceDetail/ ExportDetail/ DestinationControlDetail/ EndUser Optional End-user name. If the StatementType is DEPARTMENT_OF_STATE, this element is required. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. FedEx Web Services, Developer Guide 337 40 B13A for Canada Export Shipping B13A Service Details B13A Coding Details Chapter 40 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,000CAD 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. B13A Service Details The following service details apply: • 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 fedex.com/ ca_english/international/regulatorynews/b13afaqs.html for more information. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. 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: • $999.99USD • $0.00 for any other currency type Note: The B13A Authorization Code, if submitted, prints on the international shipping label. B13A Elements Required elements for the B13A export declaration are provided in the ShipService WSDL: Table 186. 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 are: • • • • • FEDEX_TO_STAMP FILED_ELECTRONICALLY MANUALLY_ATTACHED 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 21-character 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. • $1,999.99CAD FedEx Web Services, Developer Guide 339 Chapter 40 B13A for Canada Export Shipping Table 186. B13A Elements, continued Table 186. B13A Elements, continued Element Description Element Description ExportDetail/ ExportComplianceStatement General field for exporting country-specific data (such as B13A for CA, FTSR Exemption or AES Citation for US). ExportDetail/ DestinationControlDetail Department of Commerce/Department of State information about this shipment. ExportDetail/PermitNumber If you enter NOT_REQUIRED as the B13AFilingOption, you may enter a Canada export permit number as well (optional). FedEx Web Services, Developer Guide 340 41 Shipping Document Service Shipping Document Service Details Chapter 41 Shipping Document Service FedEx Web Services can save you time and help optimize your shipping by creating many shipping documents for you. You will need to submit the required data elements in your Ship requests, including signature and/or letterhead images if desired. Before you can attach images, you must upload them (see the Electronic Trade Documents WSDL Guide). FedEx Web Services will then create the shipping documents and return them in your Ship replies as Base64-encoded strings. You can also request that most shipping documents be sent electronically (see the Electronic Trade Documents WSDL Guide) instead of printing and attaching them to your shipments. For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. ShippingDocuments Elements The following request elements are available from the ShipService WSDL. Include the following elements to produce a Certificate of Origin: Certificate of Origin Table 187. Certificate of Origin Elements Shipping Document Service Details FedEx Web Services can create the following types of shipping documents: • Certificate of Origin • Commercial Invoice • Customer Specified Labels • Custom Package Document Element Required Description or Optional CreatePendingShipmentRequest/ RequestedShipment/ ShippingDocumentSpecification/ ShippingDocumentType Required Specify CERTIFICATE_OF_ORIGIN. ShippingDocumentSpecification/ CertificateOfOrigin Optional The instructions indicating how to print the Certificate of Origin, such as whether or not to include the instructions, image types, and so on. ShippingDocumentSpecification/ CertificateOfOrigin/DocumentFormat Optional Specifies characteristics of a shipping document to be produced. ImageType and StockType are required. Other elements are optional. ShippingDocumentSpecification/ CertificateOfOrigin/ CustomerImageUsages Optional Specifies the usage and identification of customer supplied images to be used on this document. Specify image of type SIGNATURE to include on your document. RequestedShipment/ SpecialServicesRequested ShipmentSpecialServicesRequested/ ShipmentSpecialServiceType Optional The types of all special services requested for the enclosing shipment (or other shipmentlevel transaction). Specify ELECTRONIC_TRADE_DOCUMENTS to send this document electronically. • Custom Shipment Document • Shipper's Declaration for Dangerous Goods Form 1421C • Export Declaration • FedEx Freight Address Label • General Agency Agreement (GAA) • Labels • NAFTA Certificate of Origin • OP-900 (Required for shipping hazardous materials with FedEx Ground®) • Pro Forma Invoice • Return Instructions FedEx Web Services, Developer Guide 342 Chapter 41 Shipping Document Service Table 187. Certificate of Origin Elements, continued Table 188. Commerical Invoice Elements, continued Element Required Description or Optional Element SpecialServicesRequested/EtdDetail/ RequestedDocumentCopies Optional Specify CERTIFICATE_OF_ORIGIN if you want to send this document electronically and also receive a copy of this document in reply. CustomsClearanceDetail/ ImporterOfRecord Optional Specify Importer of Record information if different from Recipient. CustomsClearanceDetail/CustomsValue Optional SpecialServicesRequested/Detail/ DocumentReferences Optional Customer reference to the uploaded document(s). Specify customs value for your entire shipment. CustomsClearanceDetail/ InsuranceCharges Optional Specify insurance charges if applicable. CustomsClearanceDetail/ PartiesToTransactionAreRelated Optional RequestedShipment/ CustomsClearanceDetail/Commodities/ Description Complete and accurate description of this commodity. Commercial Invoice Required Description or Optional Note: FedEx does not provide insurance of any kind. Valid values are: TRUE Include the following elements to produce a Commercial Invoice: Table 188. Commerical Invoice Elements Element Required Description or Optional Specify Shipper tax identification number and type. Specify if parties to transactions are related. FALSE CustomsClearanceDetail/ CommercialInvoice/Comments Optional Any comments that need to be communicated about this shipment. CustomsClearanceDetail/ CommercialInvoice/ FreightCharge Optional Specify freight charges. Optional Specify total taxes and/or any miscellaneous charges. CreatePendingShipmentRequest/ RequestedShipment/Shipper/Tins Optional RequestedShipment/Recipient/Tins Optional Specify Recipient tax identification number and type if known. CustomsClearanceDetail/ CommercialInvoice/ TaxesOrMiscellaneousCharge RequestedShipment/ SpecialServicesRequested ShipmentSpecialServicesRequested/ SpecialServicesTypes Optional Specify ELECTRONIC_TRADE_DOCUMENTS to send this document electronically. CustomsClearanceDetail / CommercialInvoice/PackingCosts Optional Specify packing costs. CustomsClearanceDetail/ CommercialInvoice/HandlingCosts Optional Specify handling costs. RequestedShipment/ SpecialServicesRequested ShipmentSpecialServicesRequested/ EtdDetail/ RequestedDocumentCopies Optional CustomsClearanceDetail/ CommercialInvoice/SpecialInstructions Optional Specify special instructions. RequestedShipment/ CustomsClearanceDetail/Brokers Optional Specify COMMERCIAL_INVOICE if you want to send this document electronically and also receive a copy of this document in reply. Note: Values specified for the CUSTOMER_REFERENCE element may also appear as special instructions. Specify Broker information only if you are using Broker Select Option for your shipment. FedEx Web Services, Developer Guide 343 Chapter 41 Shipping Document Service Table 188. Commerical Invoice Elements, continued Element Required Description or Optional CustomsClearanceDetail/ CommercialInvoice/ DeclarationStatement Optional Free-form text. CustomsClearanceDetail/ CommercialInvoice/PaymentTerms Optional Specify payment terms. CustomsClearanceDetail/ CommercialInvoice/Purpose Optional Specify purpose of shipment. Valid values are: • GIFT • NOT_SOLD • PERSONAL_EFFECTS • REPAIR_AND_RETURN • SAMPLE • SOLD CustomsClearanceDetail/ CommercialInvoice/ CustomsInvoiceNumber Optional Customer assigned Invoice number. CustomsClearanceDetail/ CommercialInvoice/OriginatorName Optional Name of the International Expert that completed the Commercial Invoice if different from Sender. CustomsClearanceDetail/ CommercialInvoice/TermsOfSale Optional Specify terms of sale. Valid values are: • CFR_OR_CPT • CIF_OR_CIP • DDP • DDU • DAP • DAT • EXW • FOB_OR_FCA Table 188. Commerical Invoice Elements, continued Element Required Description or Optional CustomsClearanceDetail/Commodities/ Name Optional Specify name of the commodity. CustomsClearanceDetail/Commodities/ NumberOfPieces Required Specify number of pieces for the commodity. CustomsClearanceDetail/Commodities/ Description Optional Specify description of the commodity. CustomsClearanceDetail/Commodities/ CountryOfManufacture Required Specify country where commodity was manufactured. CustomsClearanceDetail/Commodities/ HarmonizedCode Optional Specify Harmonized Code for commodity. Refer to the FedEx® Global Trade Manager for Harmonized Codes. CustomsClearanceDetail/Commodities/ Weight Required Specify weight of commodity. CustomsClearanceDetail/Commodities/ Quantity Optional Specify quantity of commodity. CustomsClearanceDetail/Commodities/ QuantityUnits Optional Unit of measure used to express the quantity of this commodity line item. CustomsClearanceDetail/Commodities/ AdditionalMeasures Optional Contains only additional quantitative information other than weight and quantity to calculate duties and taxes. CustomsClearanceDetail/Commodities/ UnitPrice Optional Value of each unit in Quantity. Six explicit decimal positions, Max length 18 including decimal. CustomsClearanceDetail/Commodities/ CustomsValue Optional Specify customs value for commodity. CustomsClearanceDetail/Commodities/ ExciseConditions Optional Defines additional characteristic of commodity used to calculate duties and taxes. FedEx Web Services, Developer Guide 344 Chapter 41 Shipping Document Service Table 188. Commerical Invoice Elements, continued Element Required Description or Optional CustomsClearanceDetail/Commodities/ ExportLicenseNumber Optional Applicable to U.S. export shipping only. CustomsClearanceDetail/Commodities/ ExportLicenseExpirationDate Optional Date of expiration. Must be at least 1 day into future. The date that the Commerce Export License expires. Export License commodities may not be exported from the U.S. on an expired license. Applicable to U.S. shipping only. Required only if commodity is shipped on commerce export license, and Export License Number is supplied. CustomsClearanceDetail/Commodities/ CIMarksAndNumbers Optional An identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment. CustomsClearanceDetail/ExportDetail/ ExportComplianceStatement Optional Enter Automated Export System (AES) or Foreign Trade Regulations (FTR) exemption. CustomsClearanceDetail/ExportDetail/ PermitNumber Optional This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed. CustomsClearanceDetail/ExportDetail/ DestinationControlDetail Optional RequestedShipment/ ShippingDocumentSpecification/ ShippingDocumentType Required ShippingDocumentSpecification/ CommercialInvoiceDetail/ DocumentFormat Optional VERY IMPORTANT: Specify appropriate destination control statement type(s). Valid values are DEPARTMENT_OF_COMMERCE and DEPARTMENT_OF_STATE. Be sure to also specify destination country and end user. Specify COMMERCIAL_INVOICE. ImageType and StockType are required. Other elements are optional. Table 188. Commerical Invoice Elements, continued Element Required Description or Optional ShippingDocumentSpecification/ CommercialInvoiceDetail/ CustomerImageUsages Optional Specify image type of LETTER_HEAD and/or SIGNATURE to include on the document. RequestedShipment/ RequestedPackageLineItems/ CustomerReferences Optional Specify P_O_NUMBER and/or INVOICE_NUMBER. NAFTA Certificate of Origin Include the following elements to produce a NAFTA Certificate of Origin: Table 189. NAFTA Certificate of Origin Elements Element Required Description or Optional CreatePendingShipmentRequest/ RequestedShipment/Shipper/Tins Optional Specify Shipper tax identification number and type. RequestedShipment/Recipient/Tins Optional Specify Recipient tax identification number and type if known. RequestedShipment/ SpecialServicesRequested/ SpecialServicesTypes Optional Specify ELECTRONIC_TRADE_DOCUMENTS to send this document electronically. RequestedShipment/ SpecialServicesRequested/EtdDetail/ RequestedDocumentCopies Optional Specify NAFTA_CERTIFICATE_OF_ORIGIN if you want to send this document electronically and also receive a copy of this document in reply. RequestedShipment/ CustomsClearanceDetail/Brokers Optional Specify Broker information only if you are using Broker Select Option for your shipment. CustomsClearanceDetail/ ImporterofRecord Optional Specify Importer of Record information if different from Recipient. FedEx Web Services, Developer Guide 345 Chapter 41 Shipping Document Service Table 189. NAFTA Certificate of Origin Elements, continued Element Required Description or Optional CustomsClearanceDetail/CustomsValue Optional Specify customs value for your entire shipment. CustomsClearanceDetail/ InsuranceCharges Optional Specify insurance charges if applicable. CustomsClearanceDetail/ PartiesToTransactionAreRelated Optional Table 189. NAFTA Certificate of Origin Elements, continued Element Required Description or Optional CustomsClearanceDetail/Commodities/ UnitPrice Optional Value of each unit in Quantity. Six explicit decimal positions, Max length 18 including decimal. Note: FedEx does not provide insurance of any kind. CustomsClearanceDetail/Commodities/ CustomsValue Optional Specify customs value for commodity. Specify if parties to transactions are related. CustomsClearanceDetail/Commodities/ ExciseConditions Optional Defines additional characteristic of commodity used to calculate duties and taxes. CustomsClearanceDetail/Commodities/ ExportLicenseNumber Optional Applicable to U.S. export shipping only. CustomsClearanceDetail/Commodities/ ExportLicenseExpirationDate Optional Date of expiration. Must be at least 1 day into future. The date that the Commerce Export License expires. Export License commodities may not be exported from the U.S. on an expired license. Applicable to U.S. shipping only. Required only if commodity is shipped on commerce export license, and Export License Number is supplied. CustomsClearanceDetail/Commodities/ CIMarksAndNumbers Optional An identifying mark or number used on the packaging of a shipment to help customers identify a particular shipment. Valid values are: TRUE FALSE CustomsClearanceDetail/Commodities Optional Specify name of the commodity. CustomsClearanceDetail/Commodities/ NumberOfPieces Required Specify number of pieces for the commodity. CustomsClearanceDetail/Commodities/ Description Optional Specify description of the commodity. CustomsClearanceDetail/Commodities/ CountryOfManufacture Required Specify country where commodity was manufactured. CustomsClearanceDetail/Commodities/ HarmonizedCode Optional Specify Harmonized Code for commodity. Refer to the FedEx® Global Trade Manager for Harmonized Codes. CustomsClearanceDetail/Commodities/ Weight Required Specify weight of commodity. CustomsClearanceDetail/Commodities/ NaftaDetail Optional All data required for this commodity in NAFTA Certificate of Origin. CustomsClearanceDetail/Commodities/ Quantity Optional Specify quantity of commodity. CustomsClearanceDetail/Commodities/ NaftaDetail/PreferenceCriterion Optional CustomsClearanceDetail/Commodities/ QuantityUnits Optional Unit of measure used to express the quantity of this commodity line item. CustomsClearanceDetail/Commodities/ AdditionalMeasures Optional Contains only additional quantitative information other than weight and quantity to calculate duties and taxes. Specify preference criterion. Valid values are: •A •B •C •D •E •F FedEx Web Services, Developer Guide 346 Chapter 41 Shipping Document Service Table 189. NAFTA Certificate of Origin Elements, continued Element CustomsClearanceDetail/Commodities/ NaftaDetail/ProducerDetermination Required Description or Optional Optional Specify producer determination. Valid values are: • NO_1 • NO_2 • NO_3 • YES CustomsClearanceDetail/Commodities/ NaftaDetail/ProducerId Optional CustomsClearanceDetail/Commodities/ NaftaDetail/NetCostMethod Optional CustomsClearanceDetail/Commodities/ NaftaDetail/NetCostDateRange Optional Specify begin and end dates for net cost. CustomsClearanceDetail/ExportDetail/ B13AFilingOption Optional Specifies which filing option is being exercised by the customer. Required for nondocument shipments originating in Canada destined for any country other than Canada, the United States, Puerto Rico, or the U.S. Virgin Islands. Table 189. NAFTA Certificate of Origin Elements, continued Element Required Description or Optional RequestedShipment/ ShippingDocumentSpecification/ ShippingDocumentTypes Required Specify NAFTA_CERTIFICATE_OF_ORIGIN. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail Optional Data required to produce a Certificate of Origin document. Remaining content (business data) to be defined once requirements have been completed. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/Format Optional ImageType and StockType are required. Other elements are optional. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ BlanketPeriod Optional Specify begin and end dates for blanket period. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ ImporterSpecification Optional Specify importer specification.Valid values are: • IMPORTER_OF_RECORD • RECIPIENT • UNKNOWN • VARIOUS ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ SignatureContact Optional Contact information for “Authorized Signature” area of form. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ ProducerSpecification Optional Specify producer specification. Valid values are: • AVAILABLE_UPON_REQUEST • MULTIPLE_SPECIFIED • SAME • SINGLE_SPECIFIED • UNKNOWN Specify producer ID. Specify net cost method. Valid values are: • NC • NO CustomsClearanceDetail/ExportDetail/ ExportComplianceStatement Optional Enter Automated Export System (AES) or Foreign Trade Regulations (FTR) exemption. CustomsClearanceDetail/ExportDetail/ PermitNumber Optional This field is applicable only to Canada export non-document shipments of any value to any destination. No special characters are allowed. CustomsClearanceDetail/ExportDetail/ DestinationControlDetail Optional VERY IMPORTANT: Specify appropriate destination control statement type(s). Valid values are DEPARTMENT_OF_COMMERCE and DEPARTMENT_OF_STATE. Be sure to also specify destination country and end user. FedEx Web Services, Developer Guide 347 Chapter 41 Shipping Document Service Table 189. NAFTA Certificate of Origin Elements, continued Element Required Description or Optional Table 190. OP-900 Elements, continued Element Required Description or Optional ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ Producers Optional Specify producer(s), including contact company, and tax identification information. Op900Detail/CustomerImageUsages Optional Specifies the usage and identification of customer supplied images to be used on this document. ShippingDocumentSpecification/ NaftaCertificateOfOriginDetail/ CustomerImageUsages Optional Specify image of type SIGNATURE to include on the document. Op900Detail/SignatureName Optional Data field to be used when a name is to be printed in the document instead of (or in addition to) a signature image. RequestedShipment/ConfigurationData Optional Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities. RequestedPackageLineItems/ SpecialServicesRequested/ SpecialServicesTypes Optional Specify DANGEROUS_GOODS. RequestedPackageLineItems/ SpecialServicesRequested/ DangerousGoodsDetail Optional The descriptive data required for a FedEx shipment containing dangerous goods (hazardous materials). DangerousGoodsDetail/Options Optional Indicates which kinds of hazardous content are in the current package. Specify HAZARDOUS_MATERIALS. DangerousGoodsDetail/Containers Optional Describes an approved container used to package dangerous goods commodities. Thsi does not describe any individual inner receptacles that may be within this container. Containers DangerousGoodsContainers/ PackingType Optional Indicates whether there are additional inner receptacles within this container. Containers DangerousGoodsContainers/ HazardousCommodities Optional Documents the kinds and quantities of all hazardous commodities in the current container. OP-900 Include the following elements to produce an OP-900 form: Table 190. OP-900 Elements Element Required Description or Optional RequestedShipment/ ShippingDocumentSpecification Optional Content data used to create additional (nonlabel) shipping documents. ShippingDocumentSpecification/ ShippingDocumentTypes Required Specify OP_900. ShippingDocumentSpecification/ Op900Detail Optional Specifies the production of the OP-900 document for hazardous materials packages. Op900Detail/Format Optional Specify ImageType of PDF and StockType of OP_900_LLB, or ImageType of Text and StockType of OP_900_LGB. Other elements are optional. Op900Detail/Reference Optional Identifies which reference type (from the package’s customer reference) is to be used as the source for the references on this OP900. FedEx Web Services, Developer Guide 348 Chapter 41 Shipping Document Service Shipper's Declaration for Dangerous Goods Elements Table 190. OP-900 Elements, continued Element Required Description or Optional HazardousCommodities/Description Optional Identifies and describes an individual hazardous commodity. Description/Id Optional Specify UN ID for commodity. Description/PackingGroup Optional Specify packing group. Valid values are: Include the following elements to produce a Shipper's Declaration for Dangerous Goods form: Table 191. Dangerous Goods Shippers Declaration Elements Element Required Description or Optional RequestedShipment/ ShippingDocumentSpecification Optional Content data used to create additional (non-label) shipping documents. ShippingDocumentSpecification/ ShippingDocumentTypes Required III Specify DANGEROUS_GOODS_ SHIPPERS_ DECLARATION. DEFAULT I II Description/ProperShippingName Optional Specify DOT proper shipping name for commodity. ShippingDocumentSpecification/ DangerousGoodsShippersDeclarationDetail Optional The instructions indicting how to print the 1421C form for dangerous goods shipment. Description/TechnicalName Optional Specify the technical name for the hazardous commodity. DangerousGoodsShippersDeclarationDetail/Format Optional Description/HazardClass Optional Specify hazard class for commodity. Specifies characteristics of a shipping document to be produced. Description/SubsidiaryClasses Optional Specify the subsidiary class of the hazardous material. DangerousGoodsShippersDeclarationDetail/ CustomerImageUsages Optional Description/LabelText Optional Specify the text for the label. Specifies the usage and identification of customer supplied images to be used on this document. DangerousGoodsDetail/Packaging Optional Specify packaging. RequestedShipment/ConfigurationData Optional DangerousGoodsDetail/ EmergencyContactNumber Optional Specify emergency contact telephone number. DangerousGoodsDetail/Offeror Optional Specify shipper name (offeror) or contact number. Required on all shipping papers, including OP900LL, OP900LG forms, and Hazardous Materials Certification per DOT regulation. Specifies the data that is common to dangerous goods packages in the shipment. This is populated when the shipment contains packages with identical dangerous goods commodities. RequestedPackageLineItems/ SpecialServicesRequested/SpecialServicesTypes Optional Specify DANGEROUS_GOODS. RequestedPackageLineItems/ SpecialServicesRequested/DangerousGoodsDetail Optional The descriptive data required for a FedEx shipment containing dangerous goods (hazardous materials). FedEx Web Services, Developer Guide 349 Chapter 41 Shipping Document Service Table 191. Dangerous Goods Shippers Declaration Elements, continued Element DangerousGoodsDetail/Options DangerousGoodsDetail/Containers Required Description or Optional Optional Optional Indicates which kinds of hazardous content are in the current package. Specify HAZARDOUS_MATERIALS. Describes an approved container used to package dangerous goods commodities. This does not describe any individual inner receptacles that may be within this container. Containers/PackingType Optional Indicates whether there are additional inner receptacles within this container. Containers/HazardousCommodites Optional Documents the kinds and quantities of all hazardous commodities in the current container. HazardousCommodites/Description Optional Identifies and describes an individual hazardous commodity. Description/Id Optional Specify UN ID for commodity. Description/PackingGroup Optional Specify packing group. Valid values are: DEFAULT I II III Description/ProperShippingName Optional Specify DOT proper shipping name for commodity. Table 191. Dangerous Goods Shippers Declaration Elements, continued Element Required Description or Optional Description/TechnicalName Optional Specify the technical name for the hazardous commodity. Description/HazardClass Optional Specify hazard class for commodity. Description/SubsidiaryClasses Optional Specify the subsidiary class of the hazardous material. Description/LabelText Optional Specify the text for the label. DangerousGoodsDetail/Packaging Optional Specify packaging. DangerousGoodsDetail/EmergencyContactNumber Optional Specify emergency contact telephone number. DangerousGoodsDetail/Offeror Optional Specify shipper name (offeror) or contact number. Required on all shipping papers, including OP900LL, OP900LG forms, and Hazardous Materials Certification per DOT regulation. Pro Forma Invoice Include the following elements to produce a Pro Forma Invoice: Table 192. Pro Forma Invoice Elements Element Description ShippingDocumentSpecification/ ShippingDocumentType Specify PRO_FORMA_INVOICE. SpecialServicesRequested/ SpecialServicesTypes Specify ELECTRONIC_TRADE_DOCUMENTS to send this document electronically. SpecialServicesRequested/EtdDetail/ RequestedDocumentCopies Specify PRO_FORMA_INVOICE to send this document electronically. FedEx Web Services, Developer Guide 350 Chapter 41 Shipping Document Service Table 192. Pro Forma Invoice Elements, continued Table 192. Pro Forma Invoice Elements, continued Element Description Element Description CustomsClearanceDetail/ImporterOfRecord Specify Importer of Record information if different from Recipient. CustomsClearanceDetail/Commodities/ Quantity Specify quantity of commodity. CustomsClearanceDetail/CustomsValue Specify customs value for your entire shipment. Specify customs value for commodity. CustomsClearanceDetail/CommercialInvoice/ Purpose Specify purpose of shipment. Valid values are: • GIFT • NOT_SOLD • PERSONAL_EFFECTS • REPAIR_AND_RETURN • SAMPLE • SOLD CustomsClearanceDetail/Commodities/ CustomsValue ShippingDocumentSpecification/ CommercialInvoiceDetail/ DocumentFormat ImageType and StockType are required. Other elements are optional. ShippingDocumentSpecification/ CommercialInvoiceDetail/ CustomerImageUsages Specify image of type LETTER_HEAD and/or SIGNATURE to include on the document. RequestedPackageLineItems/ CustomerReferences Specify P_O_NUMBER to include a purchase order number. Specify CUSTOMER_REFERENCE to include special instructions. CustomsClearanceDetail/CommercialInvoice/ TermsOfSale Specify terms of sale. Valid values are: • CFR_OR_CPT • CIF_OR_CIP • DDP • DDU • DAP • DAT • EXW • FOB_OR_FCA CustomsClearanceDetail/Commodities/Name Specify name of commodity. CustomsClearanceDetail/Commodities/ NumberOfPieces Specify number of pieces for commodity. CustomsClearanceDetail/Commodities/ Description Specify description of commodity. CustomsClearanceDetail/Commodities/ CountryOfManufacture Specify country where commodity was manufactured. CustomsClearanceDetail/Commodities/ HarmonizedCode Specify Harmonized Code for commodity. Refer to the FedEx Global Trade Manager for Harmonized Codes. Freight Address Label Include the following elements to produce a Freight Address Label: Table 193. Freight Address Label Elements Element Description ShippingDocumentSpecification/ ShippingDocumentType Specify FREIGHT_ADDRESS_LABEL. ShippingDocumentSpecification/ ShippingDocumentType/ FreightAddressLabelDetail/ Specifies the details on the Freight Address Label. FreightAddressLabelDetail/Format/ ShippingDocumentFormat/StockType Lists the correct type of paper for the Freight address label option. Note: Type OUTBOUND_LABEL is the enumerator used to indicate the Bill of Lading, for both Uniform and VICS formats. Specify valid value: • PAPER_4_PER_PAGE_PORTRAIT CustomsClearanceDetail/Commodities/Weight Specify weight of commodity. FedEx Web Services, Developer Guide 351 Chapter 41 Shipping Document Service Samples Sample code, sample transactions and the specific individual WSDL/XML guide(s) can be downloaded following these steps: 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 1. Go to the FedEx Developer Resource Center (DRC) at http://fedex.com/ developer. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. FedEx Web Services, Developer Guide 352 42 Upload Images Upload Image Service Details Chapter 42 Upload Images FedEx Web Services enables you to upload signature and letterhead images to be inserted on FedEx generated shipping documents. See the Shipping Document Service section for more information. Upload Image Service Details You can upload up to five different images for future use. If you upload an image to a slot where you previously uploaded an image, the new image overwrites the old image. The maximum size of an image can only be 700 pixels wide by 50 pixels tall. Table 195. UploadImage Reply Elements Element Description ImageStatuses/Id Returns value for the slot where you uploaded the image. UploadImageStatusType Returns status as SUCCESS or ERROR. ImageStatuses/StatusInfo Returns applicable error messages: • IMAGE_EXCEEDS_MAX_RESOLUTION • IMAGE_EXCEEDS_MAX_SIZE • IMAGE_FAILED_VIRUS_CHECK • IMAGE_ID_INVALID • IMAGE_ID_MISSING • IMAGE_MISSING • IMAGE_TYPE_INVALID • IMAGE_TYPE_MISSING For more detailed information about the services offered by FedEx, see the electronic FedEx Service Guide. UploadImage Request Elements The following elements are available from the UploadDocuments WSDL: Table 194. UploadImage Request Elements Element Description Images/Id Specify slot to store uploaded image. Valid values are: • IMAGE_1 • IMAGE_2 • IMAGE_3 • IMAGE_4 • IMAGE_5 Images/Image Provide GIF, PNG, JPG, or PDF image encoded as Base64 string. UploadImage Reply Elements The following elements are available from the UploadDocuments WSDL: 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. FedEx Web Services, Developer Guide 354 43 FedEx Electronic Trade Documents FedEx ETD Details Chapter 43 FedEx 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. First, you upload your trade documents (Commercial Invoice, Certificate of Origin, etc.) using the UploadDocuments WSDL. When you upload a document successfully, you receive a Document ID in the reply. Second, you create the FedEx shipment using the ShipService WSDL. You indicate Electronic Trade Documents as a special service and reference the Document ID for each uploaded document associated with your shipment. • 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. UploadDocuments Request Elements The following Electronic Trade Documents request elements are available from the UploadDocuments WSDL: Table 196. Electronic Trade Documents Request Elements Element Description Documents/LineNumber 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 Base64encoded string. FedEx ETD Details • For the most current list of Electronic Trade Document-enabled countries, check FedEx website fedex.com/international/etd. Note: The server does not limit ETD requests to only the countries that are supported. It's up to the programmer to limit the countries that use this service to only the countries that allow it. • 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 Web Services, Developer Guide 356 Chapter 43 FedEx Electronic Trade Documents UploadDocuments Reply Elements The following Electronic Trade Documents reply elements are available from the UploadDocuments WSDL: Table 197. Electronic Trade Documents Reply Elements, continued Element • ELECTRONIC_CLEARANCE_NOT_ALLOWED_AT _DESTINATION • ELECTRONIC_CLEARANCE_NOT_ALLOWED_AT _ORIGIN • UNABLE_TO_PROCESS_DOCUMENT • UPLOAD_NOT_ATTEMPTED Table 197. 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 Description 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. Returns the string (if any) specified in the UploadDocuments request. DocumentStatuses/DocumentProducer Returns CUSTOMER. ShipRequest Elements DocumentStatuses/DocumentType Returns the type specified in the UploadDocuments request. DocumentStatuses/FileName Returns the file name specified in the UploadDocuments request. The following Electronic Trade Documents request elements are available from the ShipService WSDL: DocumentStatuses/Status Returns the high-level results for the document upload. Valid values are: • SUCCESS • FAILURE • ERROR DocumentStatuses/StatusInfo Returns one or more of the following specific reasons for high-level results: • DOCUMENT_CONTENT_FAILED_VIRUS_CHECK • DOCUMENT_CONTENT_MISSING • 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 Table 198. Electronic Trade Documents Request Elements Element Description ShipmentSpecialServicesRequested/ EtdDetail/ RequestedDocumentCopies Optional Specify FedEx generated documents for which you want copies returned. Valid values are: • • • • • CustomsClearanceDetail COMMERCIAL_INVOICE CERTIFICATE_OF_ORIGIN NAFTA_CERTIFICATE_OF_ORIGIN PRO_FORMA_INVOICE GENERAL_AGENCY_AGREEMENT Customs clearance data, used for both international and intra-country shipping. FedEx Web Services, Developer Guide 357 Chapter 43 FedEx Electronic Trade Documents Table 198. Electronic Trade Documents Request Elements, continued Table 199. Electronic Trade Documents Reply Elements Element Description Element Description DocumentReferences/LineNumber Optional. Specify a positive integer value to sequence your uploaded documents. This value is not stored with your document. CompletedEtdDetail/ UploadDocumentReferenceDetails/ LineNumber Returns the number (if any) specified in the ProcessShipment request or returns a value of zero if none is specified. 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. CompletedEtdDetail/ UploadDocumentReferenceDetails/ CustomerReference Returns the string (if any) specified in the ProcessShipment request. CompletedEtdDetail/ UploadDocumentReferenceDetails/ DocumentProducer Returns the value (if any) specified in the ProcessShipment 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/ UploadDocumentReferenceDetails/ DocumentType Returns the type of document (if any) specified in the ProcessShipment request. CompletedEtdDetail/ UploadDocumentReferenceDetails/ DocumentId Returns the value specified in the ProcessShipment request for your uploaded documents in addition to other values for FedEx generated documents such as shipping labels. Use this element to change the DocumentType specified during document upload. CompletedEtdDetail/ UploadDocumentReferenceDetails/ DocumentIdProducer Reserved. This element is reserved for future use and should not be specified. Returns the value (if any) specified in the ProcessShipment 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, used for both international and intra-country shipping. DocumentReferences/DocumentProducer Reserved. This element is reserved for future use and should not be specified. DocumentReferences/DocumentType Optional. Specify the type of uploaded document. Valid values are: • • • • • DocumentReferences/DocumentIDProducer COMMERCIAL_INVOICE CERTIFICATE_OF_ORIGIN NAFTA_CERTIFICATE_OF_ORIGIN PRO_FORMA_INVOICE OTHER ShipReply Elements The following Electronic Trade Documents reply elements are returned from the ShipService WSDL: 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 http://fedex.com/ developer. 2. Enter your username and password to login to the DRC. FedEx Web Services, Developer Guide 358 Chapter 43 FedEx Electronic Trade Documents 3. Expand "Technical Resources" on the left pane. 4. Expand "FedEx Web Services for Shipping" and choose "Get Started." 5. In the right-hand column of either the "Standard Services" or the "Advanced Services" tabs, click on the dropdown box for the appropriate service and choose the format required. 6. Go to the right column in the appropriate tab, select the Download code dropdown and choose the code in the format needed. Note: Select the checkmark box next to "Include Documentation (PDF)" box to get the WSDL guide also. Error Messages For error messages, see the Appendix O: Error Code Messages section of the Web Services Developer Guide in the Support area of the Developer Resource Center at fedex.com/developer. FedEx Web Services, Developer Guide 359 A Country Code Tables A I B J C K D L E M F N G O H P A Country Code Tables, continued Q V R W S Y T Z U Appendix A Country Code Tables The following country codes are listed in alphabetic order. Country A Code Ship To Ship From Barbados BB Y Y Barbuda AG Y Y Code Ship To Ship From Belarus BY Y N Afghanistan AF Y Y Belgium BE Y Y Albania AL Y Y Belize BZ Y Y Algeria DZ Y Y Benin BJ Y N American Samoa AS Y N Bermuda BM Y Y Andorra AD Y N Bhutan BT Y Y Angola AO Y Y Bolivia BO Y Y Anguilla AI Y Y Bonaire BQ Y Y Antarctica AQ N N Bosnia-Herzegovina BA Y Y Antigua AG Y Y Botswana BW Y Y Argentina AR Y Y Bouvet Island BV N N Armenia AM Y N Brazil BR Y Y Aruba AW Y Y British Indian Ocean Territory IO N N Australia AU Y Y British Virgin Islands VG Y Y Austria AT Y Y Brunei BN Y Y Azerbaijan AZ Y N Bulgaria BG Y Y Burkina Faso BF Y N Burundi BI Y Y Code Ship To Ship From KH Y Y Country B Country Code Ship To Ship From Bahamas BS Y Y Bahrain BH Y Y Bangladesh BD Y Y C Country Cambodia FedEx Web Services, Developer Guide 362 Appendix A Country Code Tables Country Code Ship To Ship From Cameroon CM Y N Canada CA Y Y Canary Islands ES Y Y Cape Verde CV Y N Caribbean Netherlands BQ Y Y Cayman Islands KY Y Y Central African Republic CF N N Chad TD Y N Channel Islands GB Y Y Chile CL Y Y China CN Y Y Christmas Island CX N N Cocos (Keeling) Islands CC N N Colombia CO Y Y Comoros KM N N Congo CG Y N Congo, Democratic Republic Of CD Y N Cook Islands CK Y N Costa Rica CR Y Y Croatia HR Y Y Cuba CU N N Curacao CW Y Y Cyprus CY Y Czech Republic CZ Y D Country Code Ship To Ship From Denmark DK Y Y Djibouti DJ Y Y Dominica DM Y Y Dominican Republic DO Y Y Code Ship To Ship From East Timor TL Y Y Ecuador EC Y Y Egypt EG Y Y El Salvador SV Y Y England GB Y Y Equatorial Guinea GQ Y N Eritrea ER Y Y Estonia EE Y Y Ethiopia ET Y Y Code Ship To Ship From Faeroe Islands FO Y N Y Falkland Islands FK N N Y Fiji FJ Y N E Country F Country FedEx Web Services, Developer Guide 363 Appendix A Country Code Tables Country Code Ship To Ship From Finland FI Y Y France FR Y French Guiana GF French Polynesia French Southern Territories Country Code Ship To Ship From Guinea GN Y N Y Guinea Bissau GW N N Y Y Guyana GY Y Y PF Y N TF N N Code Ship To Ship From Haiti HT Y Y Heard and McDonald Islands HM N N H Country G Country Code Ship To Ship From Gabon GA Y N Holland NL Y Y Gambia GM Y N Honduras HN Y Y Georgia GE Y N Hong Kong HK Y Y Germany DE Y Y Hungary HU Y Y Ghana GH Y Y Gibraltar GI Y Y Grand Cayman KY Y Y Code Ship To Ship From Great Britain GB Y Y Iceland IS Y Y Great Thatch Island VG Y Y India IN Y Y Great Tobago Islands VG Y Y Indonesia ID Y Y Greece GR Y Y Iran IR N N Greenland GL Y N Iraq IQ Y Y Grenada GD Y Y Ireland IE Y Y Guadeloupe GP Y Y Israel IL Y Y Guam GU Y Y Italy IT Y Y Guatemala GT Y Y Ivory Coast CI Y Y I Country FedEx Web Services, Developer Guide 364 Appendix A Country Code Tables J Country Country Code Ship To Ship From Jamaica JM Y Y Japan JP Y Y Jordan JO Y Y Jost Van Dyke Islands VG Y Y K Country Code Ship To Ship From Kazakhstan KZ Y Y Kenya KE Y Y Kiribati KI N N Kuwait KW Y Y Kyrgyzstan KG Y Y L Country Code Ship To Ship From Laos LA Y Y Latvia LV Y Y Lebanon LB Y Y Lesotho LS Y Y Liberia LR Y Y Libya LY Y N Liechtenstein LI Y Y Code Ship To Ship From Lithuania LT Y Y Luxembourg LU Y Y Code Ship To Ship From Macau MO Y Y Macedonia MK Y Y Madagascar MG Y Y Malawi MW Y Y Malaysia MY Y Y Maldives MV Y Y Mali ML Y N Malta MT Y Y Marshall Islands MH Y N Martinique MQ Y Y Mauritania MR Y N Mauritius MU Y Y Mayotte YT N N Mexico MX Y Y Micronesia FM Y N Moldova MD Y N Monaco MC Y Y Mongolia MN Y N Montenegro ME Y Y M Country FedEx Web Services, Developer Guide 365 Appendix A Country Code Tables Country Code Ship To Ship From Montserrat MS Y Y Morocco MA Y Y Mozambique MZ Y Y Myanmar / Burma MM N N O Country Code Ship To Ship From OM Y Y Code Ship To Ship From Pakistan PK Y Y Palau PW Y N Palestine PS Y Y Panama PA Y Y Papua New Guinea PG Y N Paraguay PY Y Y Peru PE Y Y Philippines PH Y Y Pitcairn PN N N Poland PL Y Y Portugal PT Y Y Puerto Rico PR Y Y Code Ship To Ship From QA Y Y Oman P Country N Country Code Ship To Ship From Namibia NA Y Y Nauru NR N N Nepal NP Y Y Netherlands NL Y Y Y New Caledonia NC Y N New Zealand NZ Y Y Nicaragua NI Y Y Niger NE Y N Nigeria NG Y Y Niue NU N N Norfolk Island NF N N Norman Island VG Y Y North Korea KP N N Northern Ireland GB Y Y Northern Mariana Islands MP Y N Norway NO Y Y Q Country Qatar FedEx Web Services, Developer Guide 366 Appendix A Country Code Tables R Country Country Code Ship To Ship From Somalia SO N Y South Africa ZA Y Y Code Ship To Ship From Reunion RE Y N N N RO Y Y South Georgia and South Sandwich Islands GS Romania Rota MP Y N South Korea KR Y Y Russia RU Y Y Spain ES Y Y Rwanda RW Y Y Sri Lanka LK Y Y St. Barthelemy GP Y Y St. Christopher KN Y Y St. Croix Island VI Y Y S Country Code Ship To Ship From Saba BQ Y Y St. Eustatius BQ Y Y Saipan MP Y N St. Helena SH N N Samoa WS Y N St. John VI Y Y San Marino IT Y Y St. Kitts and Nevis KN Y Y Sao Tome and Principe ST N N St. Lucia LC Y Y Saudi Arabia SA Y Y St. Maarten (Dutch Control) SX Y Y Scotland GB Y Y St. Martin (French Control) MF Y Y Senegal SN Y N St. Pierre PM N N Serbia RS Y Y St. Thomas VI Y Y Seychelles SC Y Y St. Vincent VC Y Y Sierra Leone SL N N Sudan SD N N Singapore SG Y Y Suriname SR Y Y Slovak Republic SK Y Y Svalbard and Jan Mayen Island SJ N N Slovenia SI Y N Swaziland SZ Y Y Solomon Islands SB N N Sweden SE Y Y FedEx Web Services, Developer Guide 367 Appendix A Country Code Tables Country Code Ship To Ship From Switzerland CH Y Y Syria SY N N U Country Code Ship To Ship From UM N N U.S. Virgin Islands VI Y Y Uganda UG Y Y Ukraine UA Y N U.S. Minor Outlying Islands T Country Code Ship To Ship From Tahiti PF Y N Union Island VC Y Y Taiwan TW Y Y United Arab Emirates AE Y Y Tajikistan TJ N N United Kingdom GB Y Y Tanzania TZ Y Y United States US Y Y Thailand TH Y Y Uruguay UY Y Y Tinian MP Y N Uzbekistan UZ Y Y Togo TG Y Y Tokelau TK N N Tonga TO Y N Code Ship To Ship From Tortola Island VG Y Y Vanuatu VU Y N Trinidad and Tobago TT Y Y Vatican City IT Y Y Tunisia TN Y Y Venezuela VE Y Y Turkey TR Y Y Vietnam VN Y Y Turkmenistan TM Y N Turks and Caicos Islands TC Y Y Tuvalu TV N Y Code Ship To Ship From Wales GB Y Y Wallis and Futuna Islands WF Y N V Country W Country FedEx Web Services, Developer Guide 368 Appendix A Country Code Tables Country Western Sahara Code Ship To Ship From EH N N Z Country Y Country Yemen Code Ship To Ship From YE Y Y Code Ship To Ship From Zambia ZM Y Y Zimbabwe ZW Y Y FedEx Web Services, Developer Guide 369 B U.S. State Codes Appendix B U.S. State Codes State Code State Code Alabama AL Mississippi MS Alaska AK Missouri MO Arizona AZ Montana MT Arkansas AR Nebraska NE California CA Nevada NV Colorado CO New Hampshire NH Connecticut CT New Jersey NJ Delaware DE New Mexico NM District of Columbia DC New York NY Florida FL North Carolina NC Georgia GA North Dakota ND Hawaii HI Ohio OH Idaho ID Oklahoma OK Illinois IL Oregon OR Indiana IN Pennsylvania PA Iowa IA Rhode Island RI Kansas KS South Carolina SC Kentucky KY South Dakota SD Louisiana LA Tennessee TN Maine ME Texas TX Maryland MD Utah UT Massachusetts MA Vermont VT Michigan MI Virginia VA Minnesota MN Washington State WA FedEx Web Services, Developer Guide 371 Appendix B U.S. State Codes State Code State Code West Virginia WV Wyoming WY Wisconsin WI Puerto Rico PR FedEx Web Services, Developer Guide 372 C Canada Province Codes Appendix C Canada Province Codes Table 200. Canada Province Codes Province Table 200. Canada Province Codes, continued Code Province Code Alberta AB Nunavut NU British Columbia BC Ontario ON Manitoba MB Prince Edward Island PE New Brunswick NB Quebec QC Newfoundland NL Saskatchewan SK Northwest Territories NT Yukon YT Nova Scotia NS FedEx Web Services, Developer Guide 374 D Mexico State Codes Appendix D Mexico State Codes Table 201. Mexico State Codes State Table 201. Mexico State Codes, continued Code State Code Aguascalientes AG Nayarit NA Baja California Norte BC Nuevo Leon NL Baja California Sur BS Oaxaca OA Campeche CM Puebla PU Chiapas CS Queretaro QT Chihuahua CH Quintana Roo QR Coahuila CO San Luis Potosi SL Colima CL Sinaloa SI Distrito Federal DF Sonora SO Durango DG Tabasco TB Guanajuato GT Tamaulipas TM Guerrero GR Tlaxcala TL Hidalgo HG Veracruz VE Jalisco JA Yucatan YU Mexico MX Zacatecas ZA Michoacán MI Morelos MO FedEx Web Services, Developer Guide 376 E United Arab Emirates (UAE) State Code Table Appendix E United Arab Emirates (UAE) State Code Table This table lists the approved abbreviation codes for each UAE city: Table 202. UAE State Codes City Table 202. UAE State Codes, continued City Code Code Fujairah FU Abu Dhabi AB Ras al-Khaimah RA Ajman AJ Sharjah SH Dubai DU Umm al-Qaiwain UM FedEx Web Services, Developer Guide 378 F Currency Codes Appendix F Currency Codes Table 203. Currency Codes Table 203. Currency Codes, continued Currency Code Currency Code Antilles Guilder ANG Guatemalan Quetzal GTQ Argentinian Peso ARN Hong Kong Dollar HKD Australian Dollar AUD Hungarian Forint HUF Aruban Guilder AWG Israeli Shekel ILS Barbados Dollar BBD Indian Rupee INR Bahraini Dinar BHD Indonesian Rupiah RPA Bermuda Dollar BMD Jamaican Dollar JAD Brunei Dollar BND Japanese Yen JYE Brazilian Real BRL Kenyan Schilling KES Bahamian Dollars BSD Kazachstan Tenge KZT Canadian Dollar CAD Kuwaiti Dinar KUD Cayman Dollars CID Latvian Lats LVL Chilean Peso CHP Libyan Dinar LYD Cayman Dollar CID Lithuanian Litas LTL Chinese Renminbi CNY Macau Patacas MOP Colombian Peso COP Malaysian Ringgits MYR Costa Rican Colon CRC New Mexican Peso NMP Czech Republic Koruny CZK New Taiwan Dollar NTD Danish Krone DKK New Turkish Lira TRY Dominican Peso RDD New Zealand Dollar NZD E. Caribbean Dollar ECD Norwegian Krone NOK Egyptian Pound EGP Pakistan Rupee PKR Euro EUR Panama Balboa PAB FedEx Web Services, Developer Guide 380 Appendix F Currency Codes Table 203. Currency Codes, continued Currency Table 203. Currency Codes, continued Code Currency Code Philippine Peso PHP Thailand Baht THB Polish Zloty PLN Tonga Pa'anga TOP Russian Rouble RUR Trinidad & Tobago Dollar TTD Saudi Arabian Riyal SAR Uganda Schilling UGX Singapore Dollar SID UK Pounds Sterling UKL Solomon Island Dollar SBD United Arab Emirates Dirham DHS South African Rand ZAR Uruguay New Peso UYP South Korean Won WON U.S. Dollar USD Swedish Krona SEK Venezuela Bolivar Fuerte VEF Swiss Francs SFR Western Samoa Tala WST FedEx Web Services, Developer Guide 381 G Harmonized Tariff Unit of Measure Codes Appendix G Harmonized Tariff Unit of Measure Codes Table 204. Harmonized Tariff Unit of Measure Codes Table 204. Harmonized Tariff Unit of Measure Codes, continued Code Unit of Measure Code Unit of Measure 3 MI 3 Thousand Square Inches CY Clean Yield ADJ Adjustments CYD Cubic Yard B56 56 Pound Bushel CYG Clean Yield Gram BBL Barrel CYK Clean Yield Kilogram BFT Board Feet DEG Degree BTU British Thermal Unit DOZ Dozen BU Bushel DPC Dozen Pieces C One Hundred or Celsius DPR Dozen Pair CAR Carat EA Each CD Cord F Fahrenheit CFT Cubic Foot/Feet FT Feet CG Centigrams G Grams CGM Content Gram GAL Gallon CKG Content Kilogram GR Gross CLB Content Pound GRL Gross Lines CLF One Hundred Leaves GRM Gram CM Centimeter GRO Gross CM3 Cubic Centimeters HUN Hundreds CRT Crate HZ Hertz CSI 100 Square Inches JWL Jewels CTN Content Ton K 1,000 CUR Curie KG Kilogram CWT Hundred Weight KGM Kilogram FedEx Web Services, Developer Guide 383 Appendix G Harmonized Tariff Unit of Measure Codes Table 204. Harmonized Tariff Unit of Measure Codes, continued Table 204. Harmonized Tariff Unit of Measure Codes, continued Code Unit of Measure Code Unit of Measure KHZ Kilohertz MBQ Megabacquerel KM 1,000 Meters MC Millicurie KM2 1,000 Square Meters MCF Thousand Cubic Feet KM3 1,000 Cubic Meters MET Meters KN Kilo Newton MFT Thousand Feet KPA Kilopascal MG Milligram KSB 1,000 Standard Brick ML Milliliter KW Kilowatts MLF Thousand Linear Feet KWH Kilowatt-hours MPA Millipascal L Liter MSF Thousand Square Feet LB Pound MSI Thousand Square Inches LBC Pound Including Container MYD Thousand Yards LF Leaf NO Number LFT Linear Foot OZ Ounces LIN Linear PAR Pair LNM Linear Meters PC Piece LTR Liters PCS Pieces LYD Linear Yard PFG Proof Gallon M Meters PFL Proof Liter M2 Square Meters PK Pack (Cards) M3 Cubic Meters PR Pair MBE Thousand Std Brick Equivalent PRS Pair or Pairs MBF Thousand Board Feet PSI Pounds Per Square Inch FedEx Web Services, Developer Guide 384 Appendix G Harmonized Tariff Unit of Measure Codes Table 204. Harmonized Tariff Unit of Measure Codes, continued Table 204. Harmonized Tariff Unit of Measure Codes, continued Code Unit of Measure Code Unit of Measure QT Quart STN Short Ton ROL Roll SYD Square Yard SBE Standard Brick Equivalent TOZ Troy Ounce SFT Square Foot X Quantity Not Required SQ Square(s) YD Yard SQI Square Inch YN Yarn FedEx Web Services, Developer Guide 385 H Vague Commodity Descriptions Appendix H Vague Commodity Descriptions This table lists commodity descriptions considered vague by the U.S. Bureau of Customs and Border Protection (CBP). Table 205. Vague Commodity Descriptions Vague Commodity Vague Commodity Description "A/C Parts" "A/C Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "AC Parts" "AC Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Accessories" "Accessories" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Advertising Material" "Advertising Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Advertising Signs." Clearance delays may result if the contents are not completely and accurately described. "Aircraft Parts" "Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Aircraft Spare Parts" "Aircraft Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Aircraft Spares" "Antibodies" "Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description "Antibody" "Antibody" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibody." Clearance delays may result if the contents are not completely and accurately described. "Apparel" "Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirt." Clearance delays may result if the contents are not completely and accurately described. "Appliance" "Appliance" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial Dishwasher." Clearance delays may result if the contents are not completely and accurately described. "Appliances" "Appliances" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Industrial Dishwasher." Clearance delays may result if the contents are not completely and accurately described. "Art" "Art" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Water Color Painting." Clearance delays may result if the contents are not completely and accurately described. "As Per Attached INV" "As Per Attached INV" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Assorted Merchandise" "Assorted Merchandise" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Auto Part" "Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described. "Auto Parts" "Auto Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described. "Automotive Parts" "Automotive Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured "Antibodies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Human Antibodies." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 387 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Vague Commodity "Autoparts" Table 205. Vague Commodity Descriptions, continued Vague Commodity Description Vague Commodity Vague Commodity Description Alternator." Clearance delays may result if the contents are not completely and accurately described. "Cable" "Autoparts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Used Auto Parts: Remanufactured Alternator." Clearance delays may result if the contents are not completely and accurately described. "Cable" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Cable." Clearance delays may result if the contents are not completely and accurately described. "Cap" "Cap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps." Clearance delays may result if the contents are not completely and accurately described. "Bag" "Bag" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Caps" "Caps" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Baseball Caps." Clearance delays may result if the contents are not completely and accurately described. "Battery" "Battery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Car Battery." Clearance delays may result if the contents are not completely and accurately described. "Carton" "Carton" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Bearing" "Bearing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ball Bearing." Clearance delays may result if the contents are not completely and accurately described. "CD" "CD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CD." Clearance delays may result if the contents are not completely and accurately described. "Belts" "Belts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts." Clearance delays may result if the contents are not completely and accurately described. "CDs" "CDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music CDs." Clearance delays may result if the contents are not completely and accurately described. "Box" "Box" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Cell Line" "Brake Parts" "Brake Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper." Clearance delays may result if the contents are not completely and accurately described. "Cell Line" is an incomplete description and not accepted by Customs. Specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described. "Cells" "Cells" is an incomplete description and not accepted by Customs. Specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described. "Chemical" "Chemical" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Brake" "Business Correspondence" "Brake" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Automobile Brake." Clearance delays may result if the contents are not completely and accurately described. "Business Correspondence" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 388 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Chemicals" "Chemicals" is an incomplete description and not accepted by Customs. Please provide the actual chemical name and UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Clothing" "Clothing" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described. "Chip" "Chip" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Integrated Circuit." Clearance delays may result if the contents are not completely and accurately described. "Comat" "Comat" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described. "Christmas Gifts" "Christmas Gift" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Commercial Invoice" "Commercial Invoice" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "CI Attached" "CI Attached" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Components" "Components" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Civil Aircraft Parts" "Civil Aircraft Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Computer Parts" "Computer Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described. "Civil Aircraft Spares" "Civil Aircraft Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Computer Peripherals" "Computer Peripherals" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer CD Players." Clearance delays may result if the contents are not completely and accurately described. "Clothes / Textiles" "Clothes / Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described. "Connector" "Connector" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Cosmetic Products" "Clothes" "Clothes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described. "Cosmetic Products" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fragrance." Clearance delays may result if the contents are not completely and accurately described. "Clothing and Accessories" "Clothing and Accessories" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's T-shirts." Clearance delays may result if the contents are not completely and accurately described. "Cosmetics" "Cosmetics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fragrance." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 389 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description "Culture" "Culture" is an incomplete description and not accepted by Customs. Specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described. "Dangerous Good" "Dangerous Goods" "Data Processing Part" "Data Processing Parts" "Dangerous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Dangerous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Data Processing Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described. "Data Processing Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "PC Cooling Motor for Motherboard." Clearance delays may result if the contents are not completely and accurately described. Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Clearance delays may result if the contents are not completely and accurately described. "DGs" "DGs" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Disk" "Disk" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence on a Floppy Disk." Clearance delays may result if the contents are not completely and accurately described. "Disks" "Disks" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence on Floppy Disks." Clearance delays may result if the contents are not completely and accurately described. "Display" "Display" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Liquid Crystal Display (LCD) Desktop Projector." Clearance delays may result if the contents are not completely and accurately described. "DNA" "DNA" is an incomplete description and not accepted by Customs. Specify the name of the material, reason for import and its origin: plant, animal, human. Clearance delays may result if the contents are not completely and accurately described. "Defective Goods" "Defective Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Doc" "DESC N" "DESC N" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Doc" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described. "Document" "DESCRI" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Document" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate." Clearance delays may result if the contents are not completely and accurately described. "Documentation" "Documentation" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described. "DESCRI" "DG" "DG" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. FedEx Web Services, Developer Guide 390 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Documents" "Documents" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Birth Certificate." Clearance delays may result if the contents are not completely and accurately described. "Electronic Equipment" "Electronic Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described. "Drug" "Drug" is an incomplete description and not accepted by Customs. Specify the name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Electronic Good" "Electronic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players." Clearance delays may result if the contents are not completely and accurately described. "Electronic Goods" "Drugs" "Drugs" is an incomplete description and not accepted by Customs. Specify the name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Electronic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Players." Clearance delays may result if the contents are not completely and accurately described. "Electronic Part" "Dry Ice" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Pork Ribs in Dry Ice." Clearance delays may result if the contents are not completely and accurately described. "Electronic Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described. "Electronic Parts" "DVD" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described. "Electronic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistors." Clearance delays may result if the contents are not completely and accurately described. "Electronic" "DVDs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Movies." Clearance delays may result if the contents are not completely and accurately described. "Electronic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described. "Electronics" "Electrical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described. "Electronics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "DVD Player." Clearance delays may result if the contents are not completely and accurately described. "Equipment" "Equipment" is an incomplete description and not accepted by Customs. Specific Description of the Type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. "Fabric Samples" "Fabric Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing 100% Cotton." Clearance delays may result if the contents are not completely and accurately described. "Fabric" "Fabric" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing - 100% "Dry Ice" "DVD" "DVDs" "Electrical Parts" "Electronic Component" "Electronic Component" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Transistor." Clearance delays may result if the contents are not completely and accurately described. "Electronic Components" "Electronic Components" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Capacitor." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 391 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Vague Commodity "Fabrics" Table 205. Vague Commodity Descriptions, continued Vague Commodity Description Vague Commodity Vague Commodity Description Cotton." Clearance delays may result if the contents are not completely and accurately described. "General Cargo" "Fabrics" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Fabric for Clothing - 100% Cotton." Clearance delays may result if the contents are not completely and accurately described. "General Cargo" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Gift" "Gift" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Book sent as a Christmas Gift." Clearance delays may result if the contents are not completely and accurately described. "Gifts" "Gifts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Books sent as a Christmas Gift." Clearance delays may result if the contents are not completely and accurately described. "FAC " "FAC " is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "FAK " "FAK " is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Goods" "Flooring" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described. "Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Effects." Clearance delays may result if the contents are not completely and accurately described. "Hardware" "Food Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Canned Pasta." Clearance delays may result if the contents are not completely and accurately described. "Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "CD Player." Clearance delays may result if the contents are not completely and accurately described. "Haz Mat" "Haz Mat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Haz Material" "Haz Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Haz Materials" "Haz Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Flooring" "Food Items" "Food" "Food" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Homemade Cookies." Clearance delays may result if the contents are not completely and accurately described. "Foodstuff" "Foodstuff" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars." Clearance delays may result if the contents are not completely and accurately described. "Foodstuffs" "Foodstuffs" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Chocolate Bars." Clearance delays may result if the contents are not completely and accurately described. "Freight Of All Kinds" "Freight Of All Kinds" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Hazardous Chemical" "Hazardous Chemical" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 392 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Hazardous Chemicals" "Hazardous Chemicals" Materials is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "HS NON" "HS NON" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described. "Hazardous Good" "Hazardous Good" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "HS#" "HS#" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described. "Hazardous Goods" "Hazardous Goods" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "I C" "I C" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described. "IC" "Hazardous Material" "Hazardous Material" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "IC" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits - EEPROM." Clearance delays may result if the contents are not completely and accurately described. "ILLEDG" "ILLEDG" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Illegible" "Illegible" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Implants" "Implants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Dental Implants." Clearance delays may result if the contents are not completely and accurately described. "Hazardous Materials" "Hazardous Materials" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "HazMat" "HazMat" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Household Goods" "Household Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Industrial Goods" "Industrial Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "HS #" "HS #" is an incomplete description and not accepted by Customs. Please provide the full digit Harmonized Code if available and the description of the product. Clearance delays may result if the contents are not completely and accurately described. "Integrated Circuit" "Integrated Circuit" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuit EEPROM." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 393 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Integrated Circuits" "Integrated Circuits" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Integrated Circuits EEPROM." Clearance delays may result if the contents are not completely and accurately described. "Leather" "Leather" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Belts." Clearance delays may result if the contents are not completely and accurately described. "Letter" "Iron" "Iron" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steam Iron." Clearance delays may result if the contents are not completely and accurately described. "Letter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Personal Correspondence." Clearance delays may result if the contents are not completely and accurately described. "Liquid" "Items" "Items" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Liquid" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Jeans" "Jeans" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ladies Denim Jeans." Clearance delays may result if the contents are not completely and accurately described. "Luggage" "Luggage" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Jewelry" "Jewelry" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold Necklace." Clearance delays may result if the contents are not completely and accurately described. "Machine Part" "Laboratory Reagents" "Laboratory Reagents" is an incomplete description and not accepted by Customs. Please provide the actual chemical or product name and the UN HAZMAT #. Clearance delays may result if the contents are not completely and accurately described. "Machine Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described. "Machine Parts" "Ladies Apparel" "Ladies Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's leather shoes." Clearance delays may result if the contents are not completely and accurately described. "Machine Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Remanufactured Alternator for a Farm Tractor." Clearance delays may result if the contents are not completely and accurately described. "Machinery" "Machinery" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting Machine." Clearance delays may result if the contents are not completely and accurately described. "Leather Article" "Leather Article" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse." Clearance delays may result if the contents are not completely and accurately described. "Machines" "Machines" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Wood Cutting Machine." Clearance delays may result if the contents are not completely and accurately described. "Leather Articles" "Leather Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Leather Purse." Clearance delays may result if the contents are not completely and accurately described. "Medical Equipment" "Medical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Defibrillator." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 394 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Medical Parts" "Medical Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric Wire for Medical Equipment." Clearance delays may result if the contents are not completely and accurately described. "Meds" "Meds" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Medical Spare Parts" "Medical Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Electric Wire for Medical Equipment." Clearance delays may result if the contents are not completely and accurately described. "Men’s Apparel" "Men’s Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Summer T-Shirt." Clearance delays may result if the contents are not completely and accurately described. "Medical Supplies" "Medical Supplies" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Metal Work" "Metal Work" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Copper Pipe." Clearance delays may result if the contents are not completely and accurately described. "Medicaments" "Medicaments" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Miscellaneous Items" "Miscellaneous Items" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "NAFTA" "NAFTA" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "New Goods" "New Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "No CI" "No CI" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "NO COM" "NO COM" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "NO DES" "NO DES" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Medication" "Medication" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Medications" "Medications" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Medicine" "Medicine" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "Medicines" "Medicines" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 395 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "NON G" "NON G" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Parts" "Non-Hazardous" "Non-Hazardous" is an incomplete description and not accepted by Customs. Please provide the proper name of the goods, if chemical, proper name and the UN #. Clearance delays may result if the contents are not completely and accurately described. "Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "PC Hardware" "PC Hardware" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer CD Player." Clearance delays may result if the contents are not completely and accurately described. "PCB" "PCB" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board with Components for Television Set." Clearance delays may result if the contents are not completely and accurately described. "PCBA" "Pants" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Boy's Cotton Twill Pants." Clearance delays may result if the contents are not completely and accurately described. "PCBA" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board Assembly for Computer." Clearance delays may result if the contents are not completely and accurately described. "Peripheral" "Paper" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described. "Peripheral" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Computer Printer." Clearance delays may result if the contents are not completely and accurately described. "Personal Effects" "Paperwork" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Legal Contract." Clearance delays may result if the contents are not completely and accurately described. "Personal Effects" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Personal Item" "Part" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Caliper for Aircraft." Clearance delays may result if the contents are not completely and accurately described. "Personal Item" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Personal Items" "Personal Items" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Pharmaceuticals" "Pharmaceuticals" is an incomplete description and not accepted by Customs. Please provide the specific name of the medication or product being shipped and its intended use. Clearance delays may result if the contents are not completely and accurately described. "NOT GI" "NOT GI" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Packaging Supplies" "Packaging Supplies" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Bubble Plastic Wrap." Clearance delays may result if the contents are not completely and accurately described. "Pants" "Paper" "Paperwork" "Part" "Parts Of" "Parts Of" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Brake Calipers for Aircraft." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 396 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description "PIB" "PIB" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Machines." Clearance delays may result if the contents are not completely and accurately described. "Precious Metal" "Precious Metal" is an incomplete description and not accepted by Customs. An example of an acceptable description is "18 Carat Gold Necklace." Clearance delays may result if the contents are not completely and accurately described. "Printed Circuit Board" "Printed Circuit Board" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Printed Circuit Board with Components for Television Set." Clearance delays may result if the contents are not completely and accurately described. "PIBs" "PIBs" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Pipe" "Pipe" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipe." Clearance delays may result if the contents are not completely and accurately described. "Pipes" "Pipes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Pipes." Clearance delays may result if the contents are not completely and accurately described. "Printed Material" "Printed Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manual." Clearance delays may result if the contents are not completely and accurately described. "Plastic Good" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knife." Clearance delays may result if the contents are not completely and accurately described. "Printed Materials" "Plastic Goods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives." Clearance delays may result if the contents are not completely and accurately described. "Printed Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manuals." Clearance delays may result if the contents are not completely and accurately described. "Printed Matter" "Plastic Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Knives." Clearance delays may result if the contents are not completely and accurately described. "Printed Matter" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manual" Clearance delays may result if the contents are not completely and accurately described. "Printed Matters" "Plastic" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Plastic Shoes." Clearance delays may result if the contents are not completely and accurately described. "Printed Matters" is an incomplete description and not accepted by Customs. An example of an acceptable description is "TV Owner's Manuals" Clearance delays may result if the contents are not completely and accurately described. "Promo Item" "Polyurethane" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Polyurethane Medical Gloves." Clearance delays may result if the contents are not completely and accurately described. "Promo Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Promo Items" "Promo Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Plastic Good" "Plastic Goods" "Plastic Parts" "Plastic" "Polyurethane" "Power Supply" "Power Supply" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Supply Module for ADP FedEx Web Services, Developer Guide 397 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Promo Material" "Promo Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Records" "Records" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Office Correspondence." Clearance delays may result if the contents are not completely and accurately described. "Report" "Promo Materials" "Promo Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Report" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Business Correspondence - Annual Report." Clearance delays may result if the contents are not completely and accurately described. "Rod" "Promotional Item" "Promotional Item" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Rod" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Fishing Rod." Clearance delays may result if the contents are not completely and accurately described. "Rods" "Rods" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Aluminum Rods." Clearance delays may result if the contents are not completely and accurately described. "Rubber Articles" "Rubber Articles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Hoses." Clearance delays may result if the contents are not completely and accurately described. "Rubber" "Rubber" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Rubber Tires." Clearance delays may result if the contents are not completely and accurately described. "Said To Contain" "Said To Contain" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Sample" "Sample" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags - SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "Samples" "Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Bags - SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "Scrap" "Scrap" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Steel Scrap Billets." Clearance delays may result if the contents are not completely and accurately described. "Promotional Items" "Promotional Items" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Promotional Material" "Promotional Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Promotional Materials" "Promotional Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Promotional" "Receivers" "Promotional" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Promotional Inflatable Balloons not for resale." Clearance delays may result if the contents are not completely and accurately described. "Receivers" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stereo Receiver." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 398 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "See Attached" "See Attached" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Sportswear" "SEE CO" "SEE CO" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Sportswear" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Men's Running Shorts." Clearance delays may result if the contents are not completely and accurately described. "STC " "SEE IN" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "STC" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Steel" "Steel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Stainless Steel Pots." Clearance delays may result if the contents are not completely and accurately described. "Surgical Instruments" "Surgical Equipment" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Scalpels." Clearance delays may result if the contents are not completely and accurately described. "Swatches" "Swatches" is an incomplete description and not accepted by Customs. An example of an acceptable description is "100% Cotton Fabric Sample Swatches." Clearance delays may result if the contents are not completely and accurately described. "Tape" "Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described. "Tapes" "Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described. "Textile Samples" "Textile Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "Textile" "Textile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Dress - 100% Cotton SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "SEE IN" "See Invoice" "Shirt" "Software" "See Invoice" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Shirt" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's 100% Cotton Long Sleeve Shirt." Clearance delays may result if the contents are not completely and accurately described. "Software" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Software Game on CD-ROM - "Halo 2"." Clearance delays may result if the contents are not completely and accurately described. "Spare Parts for Machine" "Spare Parts for Machine" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - New." Clearance delays may result if the contents are not completely and accurately described. "Spare Parts" "Spare Parts" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - Used." Clearance delays may result if the contents are not completely and accurately described. "Spares" "Spares" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Alternator - New." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 399 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Textiles Samples" "Textiles Samples" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "Unlist" "Unlist" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Used Goods" "Textiles" "Textiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Men's Shirt 100% Cotton SAMPLE." Clearance delays may result if the contents are not completely and accurately described. "Used Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Various Goods" "Tile" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described. "Various Goods" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Video Tape" "Tiles" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Ceramic Tiles." Clearance delays may result if the contents are not completely and accurately described. "Video Tape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described. "Video Tapes" "Tools" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Power Drill." Clearance delays may result if the contents are not completely and accurately described. "Video Tapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described. "Video" "Toy" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Plastic Doll House." Clearance delays may result if the contents are not completely and accurately described. "Video" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described. "Videotape" "Videotape" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tape." Clearance delays may result if the contents are not completely and accurately described. "Videotapes" "Videotapes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Jazz Music Video Tapes." Clearance delays may result if the contents are not completely and accurately described. "VISA MDR Table" "VISA MDR Table" is an incomplete description and not accepted by Customs. Specify the description of the contents being shipped. Clearance delays may result if the contents are not completely and accurately described. "Wafer" "Wafer" is an incomplete description and not accepted by Customs. An example of an acceptable description is "semiconductor wafers." Clearance delays may result if the contents are not completely and accurately described. "Tile" "Tiles" "Tools" "Toy" "Training Material" "Training Material" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training Material for Basketball." Clearance delays may result if the contents are not completely and accurately described. "Training Materials" "Training Materials" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Training Materials for Basketball." Clearance delays may result if the contents are not completely and accurately described. "Tubes" "Tubes" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Glass Tubes." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 400 Appendix H Vague Commodity Descriptions Table 205. Vague Commodity Descriptions, continued Table 205. Vague Commodity Descriptions, continued Vague Commodity Vague Commodity Description Vague Commodity Vague Commodity Description "Waste" "Waste" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Oil Waste for Testing." Clearance delays may result if the contents are not completely and accurately described. "Wire" "Wire" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire." Clearance delays may result if the contents are not completely and accurately described. "Wearing Apparel" "Wearing Apparel" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Women's Leather Sandals." Clearance delays may result if the contents are not completely and accurately described. "Wires" "Wires" is an incomplete description and not accepted by Customs. An example of an acceptable description is "Insulated Copper Wire." Clearance delays may result if the contents are not completely and accurately described. FedEx Web Services, Developer Guide 401 I Waybill Legal Terms and Conditions Appendix I Waybill Legal Terms and Conditions In addition to creating and printing the waybill label, you need to print copies of the International Legal Terms and Conditions to accompany each label with your international shipments. The following defines international handling instructions for the waybill labels and Legal Terms and Conditions document. Note: For all Mexico to Mexico shipments, if no language is specified, the Legal Terms and Conditions will be provided in Spanish. If international: U.S. export — Print 2 copies of the waybill label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to the shipment so that the barcode portion of the label can be read and scanned. Place the additional recipient copy of the waybill label in the pouch. If U.S. shipment — Print 1 copy of the waybill label to your laser printer, fold the printed page in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the barcode portion of the label can be read and scanned. If international: Shipments originating outside of the U.S. — Print 3 copies of the waybill label to your laser printer, fold 1 copy in half and use as the shipping label. Place it in the waybill pouch and affix it to your shipment so that the barcode portion of the label can be read and scanned. Place the 2 recipient copies of the waybill label in the pouch. The following defines U.S. handling instructions for the waybill labels and Legal Terms and Conditions. Note: The International and U.S. waybill Legal Terms and Conditions information must be supplied with test labels when completing the certification process. Warning: To ensure timely delivery, use only printed original labels for shipping. FedEx Web Services, Developer Guide 403 J Postal-Aware Countries and Formats Appendix J Postal-Aware Countries and Formats Table 206. Postal Aware Countries and Formats Table 206. Postal Aware Countries and Formats, continued Country Postal Format Country Postal Format Australia (AU) NNNN Portugal (PT) NNNN Austria (AT) NNNN Puerto Rico (PR) NNNNN Belgium (BE) NNNN Russia (RU) NNNNNN Brazil (BR) NNNNNNNN Canada (CA) ANANAN Singapore (SG) NNNNNN China (CN) NNNNNN South Africa (ZA) NNNN Denmark (DK) NNNN South Korea (KR) NNNNNN Finland (FI) NNNNN France (FR) NNNNN Spain (ES) NNNNN Germany (DE) NNNNN Sweden (SE) NNNNN Greece (GR) NNNNN Switzerland (CH) NNNN India (IN) NNNNNN Thailand (TH) NNNNN Indonesia (ID) NNNNN Turkey (TR) NNNNN Italy (IT) NNNNN United Kingdom (GB) ANNAA Japan (JP) NNNNNNN United Kingdom (GB) ANNNAA Luxembourg (LU) NNNN United Kingdom (GB) ANANAA Malaysia (MY) NNNNN United Kingdom (GB) AANNAA Mexico (MX) NNNNN United Kingdom (GB) AANANAA Netherlands (NL) NNNN United Kingdom (GB) AANNNAA Norway (NO) NNNN United States (U.S.) NNNNN Philippines (PH) NNNN NNN-NNN NNN-NNN FedEx Web Services, Developer Guide 405 K Physical Packaging Type Codes Appendix K Physical Packaging Type Codes Table 207. Physical Packaging Type Codes Table 207. Physical Packaging Type Codes, continued Package Code Package Type Package Code Package Type BAG Bag ENV Envelope BBL Barrel BSK Basket BOX Other BOX Box PAL Pail BXT Bucket PLT Pallet BDL Bundle PC Piece CTN Carton REL Reel CAS Case ROL Roll CNT Container SKD Skid CRT Crate TNK Tank CYL Cylinder TBE Tube DRM Drum Hamper FedEx Web Services, Developer Guide 407 L Customs-Approved Document Descriptions Appendix L Customs-Approved Document Descriptions This table lists document descriptions approved by the U.S. Bureau of Customs and Border Protection: Table 208. Customs-Approved Document Descriptions Table 208. Customs-Approved Document Descriptions, continued Description Escrow Instructions Description Export Papers Correspondence/ No Commercial Value Financial Statements Accounting Documents Immigration Papers Analysis Reports Income Statements Applications (Completed) Insurance Documents Bank Statements Interoffice Memos Bid Quotations Inventory Reports Birth Certificates Invoices (Completed) Bills of Sale Leases Bonds Legal Documents Business Correspondence Letters and Cards Checks (Completed) Letter of Credit Packets Claim Files Loan Documents Closing Statements Marriage Certificates Conference Reports Medical Records Contracts Office Records Cost Estimates Operating Agreements Court Transcripts Patent Applications Credit Applications Permits Data Sheets Photocopies Deeds Proposals Employment Papers Prospectuses FedEx Web Services, Developer Guide 409 Appendix L Customs-Approved Document Descriptions Table 208. Customs-Approved Document Descriptions, continued Table 208. Customs-Approved Document Descriptions, continued Description Description Purchase Orders Statements/Reports Quotations Statistical Data Reservation Confirmation Stock Information Resumes Tax Papers Sales Agreements Trade Confirmation Sales Reports Transcripts Shipping Documents Warranty Deeds FedEx Web Services, Developer Guide 410 M Time Zones Appendix M Time Zones This table lists the global time zones (Standard time). Use this table to determine the Greenwich Mean Time Zone code to enter as a value in elements: LatestPickupDateTime datetime, ReadyDateTime date time, ShipTimestamp datetime.. GMT Differential ¾ Location (GMT-12:00) – Eniwetok, Kwajalein (GMT-11:00) – Midway Island, Samoa (GMT-10:00) – Hawaii (GMT-09:00) – Alaska (GMT-08:00) – Pacific Time (US & Canada); Tijuana (GMT-07:00) – Arizona, Mountain Time (US & Canada) (GMT-06:00) – Central Time (US & Canada), Mexico City, Tegucigalpa, Saskatchewan (GMT-05:00) – Bogota, Lima, Quito, Eastern Time (US & Canada), Indiana (East) (GMT-04:00) – Atlantic Time (Canada), Caracas, La Paz (GMT-03:30) – Newfoundland (GMT-03:00) – Brasilia, Buenos Aires, Georgetown (GMT-02:00) – Mid-Atlantic (GMT-01:00) – Azores, Cape Verde ls. GMT Differential ¾ Location (GMT+01:00) – Amsterdam, Copenhagen, Madrid, Paris, Vilnius, Belgrade, Sarajevo, Sofija, Zagreb, Bratislava, Budapest, Ljubljana, Prague, Warsaw, Brussels, Berlin, Rome, Stockholm, Vienna (GMT+02:00) – Athens, Istanbul, Minsk, Bucharest, Cairo, Harare, Pretonia, Helsinki, Riga, Tallinn (GMT+02:00) – Israel (GMT+03:00) – Baghdad, Kuwait, Riyadh, Moscow, St. Petersburg, Volgograd, Nairobi, Tehran (GMT+04:00) – Abu Dhabi, Muscat, Baku, Tbilisi (GMT+04:30) – Kabul (GMT+05:00) – Ekaterinburg, Islamabad, Karachi, Tashkent (GMT+05:30) – Bombay, Calcutta, Madras, New Delhi (GMT+06:00) – Almaty, Dhaka, Colombo (GMT+07:00) – Bangkok, Hanoi, Jakarta (GMT+08:00) – Beijing, Chongging, Hong Kong, Urumqi, Perth, Singapore, Taipei (GMT+09:00) – Osaka, Sapporo, Tokyo, Seoul, Yakutsk (GMT+09:30) – Adelaide, Darwin (GMT+10:00) – Brisbane, Canberra, Melbourne, Sydney, Guam, Port Moresby, Hobart, Vladivostok (GMT+11:00) – Magadan, Solomon lsland, New Caledonia (GMT+12:00) – Auckland, Wellington, Fiji, Kamachatka, Marshall lslands (GMT-00:00) – Greenwich Mean Time: Dublin, Edinburgh, Lisbon, London, Casablanca, Monrovia FedEx Web Services, Developer Guide 412 N Minimum Customs Value Appendix N Minimum Customs Value The following countries require a minimum customs value of $1USD for all shipments, including document shipments: Country Montenegro Country Nepal Algeria New Zealand Armenia Papua New Guinea Australia Philippines Azerbaijan Romania Belarus Russia Canada Samoa China Serbia and Montenegro Czech Republic Slovenia El Salvador Slovak Republic Georgia South Korea Indonesia Turkmenistan Japan Tonga Kuwait Uzbekistan Kyrgyzstan Libya Note: The value must be the selling price or the fair market value. Unacceptable values are $0, NDV, NVD or NCV. Moldova Mongolia FedEx Web Services, Developer Guide 414 O Error Code Messages Chained SSL Certificate Error Messages Rate Service Error Messages Close Service Error Messages Ship Service and Open Shipping Error Messages Electronic Trade Documents Error Messages FedEx SmartPost Shipping Error Messages GlobalShipAddress Service Error Messages SPOD Error Messages Package Movement Information Service Error Messages Track Service Error Messages Pickup Service Error Messages Appendix O Error Code Messages The following messages may be returned in a reply to notify you of some sort of issue with your request. Chained SSL Certificate Error Messages The Chained Secure Socket Layer (SSL) is the secure protocol for transmitting data securely using encryption over the web. SSL creates a secure connection between a client and a server, over which any amount of data can be sent; SHTTP (https) is designed to transmit individual messages securely between a client and a web server. Call Handling Process for Customers requesting a copy of the FedEx Chained SSL Certificate If a customer requests a local copy of the FedEx certificate be installed on their configuration, it is available fro download from the Developer Resource Center. Note: If a customer requests additional technical assistance, outside of downloading the Chained SSL certificate, direct customers to their Server Software Provider. If the customer calls back after consulting with their software provider and it has been discovered that something may be corrupt with the new certificate, agents should follow the current process and escalate the case to Senior Support. Use call type "SSL Certificate" on any call concerning this issue. The following error messages are common ones that customer's may experience when the SSL Certificate has been applied to the test and production environments. Chained Secure Socket Layer (SSL) Error Messages Possible Customer Error Action Exception : javax.net.ssl.SSLHandshakeException: unknown certificate Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. java.security.cert.CertificateException: CA certificate does not include basic constraints extension" error when we try to generate labels. Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. Exception in FedEx exchange javax.net.ssl.SSLHandshakeException: unknown certificate Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. java.net.SocketException: Xport: SSL handshake failed: SSL routines:SSL3_GET_SERVER_CERTIFICATE:certificate verify failed SSL handshake failed Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. Master VeriSign Certificate does not match Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. java.security.cert.CertificateException: Unable to parse certificate(s) cannot process input. Potential middleware application problem. Contact vendor of middleware application. This may show in the customers WebSphere Application log: SystemErr.log Download and install the FedEx gateway certificate and the intermediate VeriSign CA certificate into customer's keystore. SystemErr: Content is not allowed in prolog. FedEx Web Services, Developer Guide 416 Appendix O Error Code Messages Close Service Error Messages GroundCloseReportReprints Code Message 5060 OP_950 Details are missing. 5061 Could not generate the OP_950 ASCII report. 5062 GTM could not generate the OP_950 PDF report. 5063 Manifest Shipping Records are missing. 5064 Could not generate the Manifest ASCII report. 5065 Could not generate Reports. Close Operation Successful. 5066 Document Type is missing. 6067 Request or Document Specification is missing. 6068 OP950Detail present, but no shipping records. 9802 System Error. 9802 System Error : Generating Report. 9802 System Error : Access denied. 9802 System Error : Retrieving Shipments. 9804 No Reprint Reports. GroundClose Code Message 5060 OP_950 Details are missing. 5061 Could not generate the OP_950 ASCII report. 5062 GTM could not generate the OP_950 PDF report. 5063 Manifest Shipping Records are missing. 5064 Could not generate the Manifest ASCII report. 5065 Could not generate Reports. Close Operation Successful. 5066 Document Type is missing. 5067 Request or Document Specification is missing. 5068 OP950Detail present, but no shipping records. 5069 No shipments Qualified for OP_950 Report. 9802 System Error Executing Close. 9802 Your shipments closed successfully. Reprint to obtain the manifest (if required). 9802 System Error : Access denied. 9804 Your shipments closed successfully. Reprint to obtain the manifest (if required). GroundCloseWithDocuments 9804 No Shipments to Close For Date Provided. Code Message 9804 No Shipments to Close For Meter Number. 1000 System Error. 9804 No Shipments to Close For Account Number. 1001 System Error. 9804 No Shipments to Close for Tracking Number 2000 System Error. 9804 NO Shipment to CLOSE. 2001 System Error. 5060 OP_950 Details are missing. 5061 Could not generate the OP_950 ASCII report. 5062 GTM could not generate the OP_950 PDF report. FedEx Web Services, Developer Guide 417 Appendix O Error Code Messages GroundCloseWithDocuments ReprintGroundCloseDocuments Code Message Code Message 5063 Manifest Shipping Records are missing. 9804 No Shipments to Close For Tracking Number. 5064 Could not generate the Manifest ASCII report. 5065 Could not generate Reports. Close Operation Successful. Electronic Trade Documents Error Messages 5066 Document Type is missing. These error messages apply to FedEx® Electronic Trade Documents: 5067 Request or Document Specification is missing. 5068 OP950Detail present, but no shipping records. 9804 No Shipments to Close. ReprintGroundCloseDocuments Code Message 1000 System Error. 1001 System Error. 2000 System Error. 2001 System Error. 5060 OP_950 Details are missing. 5061 Could not generate the OP_950 ASCII report. 5062 GTM could not generate the OP_950 PDF report. 5063 Manifest Shipping Records are missing. 5064 Could not generate the Manifest ASCII report. 5065 Could not generate Reports. Close Operation Successful. 5066 Document Type is missing. 5067 Request or Document Specification is missing. 5068 OP950Detail present, but no shipping records. 9804 No Documents for Reprint. Electronic Trade Documents Code Message 498 Electronic Trade Documents is not allowed with the service selected. 499 Electronic Trade Document is not allowed. 500 Package {PACKAGE_INDEX} - Electronic Trade Documents cannot be entered at the package level. GlobalShipAddress Service Error Messages These error messages apply to the FedEx GlobalShipAddress Reply: GlobalShipAddress Service Code Message 001 City Name or Postal Code is required. 002 Postal Code must have at least 3 characters. 003 State Code must be 2 characters long. 004 Country Code is required and must be 2 characters long. 005 Results to skip must be a non-negative integer. 006 No result returned. 007 More than 500 matches were found. 008 Results requested must be a non-negative integer. FedEx Web Services, Developer Guide 418 Appendix O Error Code Messages GlobalShipAddress Service GlobalShipAddress Service Code Message Code Message 009 Service is not valid. 033 Duplicate addressIds found. 010 At least one Service is required. 034 Request time stamp is invalid. 011 ClientDetail is required. 035 This method is not available in the offline mode. 012 Version id is required. 036 This method does not support {CARRIER_CODE} in the offline mode. 013 Application id is invalid. 037 Result condition {RESULT_CONDITION} was ignored. 014 Origin Country Code is required and must be 2 characters long. 038 Match condition {MATCH_CONDITION} is not supported in the offline mode. 015 Destination Country Code is required and must be 2 characters long. 039 Either verifyAddresses or verifyGeocode must be set to true. 016 Invalid Date. 040 Invalid value in {FIELD_ID}. 018 Invalid Carrier Code 041 MATCH_BY_EXACT_LOCATION_CODE must be specified. 019 Match Conditions is null. 042 MATCH_BY_POSTAL_CODE or MATCH_BY_PARTIAL_POSTAL_CODE must be specified. 020 Postal Code is required. 043 021 City is required. MATCH_BY_CITY, MATCH_BY_PARTIAL_CITY or MATCH_BY_STATE_OR_PROVINCE_NAME must be specified. 022 State Code is required. 044 PMIS could not be contacted to clean the postal code. Used the original postal code provided. 023 Results Conditions is null. 045 Request cannot be null. 024 Services or Service Categories must be provided. 046 MatchAndResultCriteria cannot be null. 025 Invalid Service Category 047 At least one address to validate must be provided. 026 Invalid Region Code. 048 Address validation options must be provided. 027 Invalid Source Format. 049 EAS System Error. 028 Location Id is Required. 050 The length of the postal code was changed to the SRG postal length. 029 MATCH_BY_PARTIAL_CITY or MATCH_BY_EXACT_CITY must be specified. 101 LoadResourceDetail cannot be null. 030 Maximum number of matches is invalid. 102 LoadResourceDetail Type is invalid. 031 At least one street line must be provided. 103 LoadResourceParameters are not provided. 032 AddressId is required. 104 Jar file at index {INDEX} does not exist, cannot be read or is empty. FedEx Web Services, Developer Guide 419 Appendix O Error Code Messages GlobalShipAddress Service GlobalShipAddress Service Code Message Code Message 106 Jar file at index {INDEX} does not have all the required files. 130 Match Location Types is not provided. 107 An internal error occurred while loading data. 131 Match conditions are ambiguous. 108 Invalid LoadResourceParameter ID at index {INDEX}. 132 Origin Address is required. 109 Invalid LoadResourceParameter value at index {INDEX}. 133 Invalid Origin Geographic Coordinates. 109 Could not find file specified at load parameter {INDEX}. 134 Destination Address is required. 109 Could not delete file specified at load parameter {INDEX}. 135 Invalid Destination Geographic Coordinates. 109 Data was loaded from the Safe Jar. 136 Invalid Origin Match Type. 114 File at load parameter {INDEX} already exists in the config property file. 137 Invalid Destination Match Type. 115 Could not copy file at load parameter {INDEX} to the data directory. 138 Invalid Content Options. 116 Could not add load parameter {INDEX} file name to the data config file. 139 Invalid Map Url Protocol. 117 Could not remove the file name specified in load parameter {INDEX} from the data config file. 140 Invalid Distance Units. 141 Location Type is not provided. 118 More than one carrier code must not be specified. 142 Invalid Location Content Option. 119 MATCH_POSTAL_CODE_TO_PREFERRED_HOLD_LOCATION must be specified. 143 The Address is required. 120 Invalid effective date. 144 The Locations Search Criterion is required. 121 Preferred Ground Hold Location could not be matched for the effective date. 145 Phone number is required. 122 File {FILE_NAME} does not exist. 146 Geographical Coordinates is blank or invalid. 123 SQL {SQL} failed. 147 MultipleMatchesAction is null or invalid. 124 MATCH_BY_EXACT_POSTAL_CODE must be specified. 148 Invalid Drop off Time. 125 Invalid FedExAdminLocationType. 149 Invalid Results Filters. 126 The matchAddress object is null. 150 Invalid Results Filters. 127 Invalid Postal Code. 151 Invalid Location Attributes. 128 Invalid Fedex Location Type. 152 Invalid Location Search Criterion. 129 Store Number is not provided. FedEx Web Services, Developer Guide 420 Appendix O Error Code Messages GlobalShipAddress Service Package Movement Information Service Error Messages Code Message 153 Origin Address is ambiguous. 154 Destination Address is ambiguous. 155 Invalid Origin Address. Package Movement Information Service 156 Invalid Destination Address. Code Message 157 Invalid Sort criterion. 013 Invalid Date. 158 Invalid Sort order. 310 Accessible Dangerous Goods is not allowed. 159 Invalid Radius value. 322 Dry Ice is not allowed. 160 Invalid Radius units. 407 Service is invalid. 161 This Country Code is not supported. 417 Astra location not found. 400 User id provided is invalid. 423 Exhibition is not allowed with the service selected. 407 Invalid origin country. 424 Exhibition is not allowed. 408 Invalid destination country. 425 Extreme Length is not allowed with the service selected. 411 Invalid origin postal code. 426 Extreme Length is not allowed. 412 Invalid destination postal code. 427 Flatbed Trailer is not allowed with the service selected. 415 Invalid origin state code. 428 Flatbed Trailer is not allowed. 416 Invalid destination state code. 429 Freight Guarantee is not allowed with the service selected. 419 Invalid origin city name. 430 Freight Guarantee is not allowed. 420 Invalid destination city name. 431 Liftgate Delivery is not allowed with the service selected. 432 Service Types did not contain a Freight Service Type. 432 Liftgate Delivery is not allowed. 435 Results to skip is less than 0. 433 Liftgate Pickup is not allowed with the service selected. 436 Results requested to return is less than 1. 434 Liftgate Pickup is not allowed. 437 GSAI internal error. 435 Limited Access Delivery is not allowed with the service selected. 436 Limited Access Delivery is not allowed. 437 Limited Access Pickup is not allowed with the service selected. These error messages apply to the Package Movement Information Service: FedEx Web Services, Developer Guide 421 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 438 Limited Access Pickup is not allowed. 473 Package {PACKAGE_INDEX} - Extreme Length cannot be entered at the package level. 439 Pre Delivery Notification is not allowed with the service selected. 474 Package {PACKAGE_INDEX} - Flatbed Trailer cannot be entered at the package level. 440 Pre Delivery Notification is not allowed. 475 Package {PACKAGE_INDEX} - Freight Guarantee cannot be entered at the package level. 441 Protection From Freezing is not allowed with the service selected. 476 Package {PACKAGE_INDEX} - Liftgate Delivery cannot be entered at the package level. 442 Protection From Freezing is not allowed. 477 Package {PACKAGE_INDEX} - Liftgate Pickup cannot be entered at the package level. 443 Regional Mall Delivery is not allowed with the service selected. 478 444 Regional Mall Delivery is not allowed. Package {PACKAGE_INDEX} - Limited Access Delivery cannot be entered at the package level. 445 Regional Mall Pickup is not allowed with the service selected. 479 Package {PACKAGE_INDEX} - Limited Access Pickup cannot be entered at the package level. 446 Regional Mall Pickup is not allowed. 480 450 The origin does not allow pickup for Express services. Package {PACKAGE_INDEX} - Pre Delivery Notification cannot be entered at the package level. 451 The origin does not allow pickup for Freight services. 481 Package {PACKAGE_INDEX} - Protection From Freezing cannot be entered at the package level. 452 The origin is not served for Express services. 482 453 The origin is not served for Freight services. Package {PACKAGE_INDEX} - Regional Mall Delivery cannot be entered at the package level. 454 Signature option type is invalid. 483 Package {PACKAGE_INDEX} - Regional Mall Pickup cannot be entered at the package level. 455 Signature option type is required and cannot be null. 484 Invalid currency type for validation. Only {CURRENCY_TYPE} is allowed. 456 SignatureOptionDetail object cannot be null. 502 Address object for the destination cannot be null. 457 Package {PACKAGE_INDEX} - Pending Complete cannot be entered at the package level. 503 Address object for the origin cannot be null. 458 Package {PACKAGE_INDEX} - Pending Shipment cannot be entered at the package level. 504 Airbill is not allowed for Destination Country. 459 PendingShipmentDetail object cannot be null. 505 Airbill is not allowed for Origin Country. 460 Pending shipment type is required and cannot be null. 506 Airbill validation failed. 461 Pending shipment type is invalid. 508 An invalid destination country was entered. 462 Service option type {SERVICE_OPTION_TYPE} is invalid. 509 An invalid destination zip/postal code was entered. 472 Package {PACKAGE_INDEX} - Exhibition cannot be entered at the package level. 510 An invalid or null CarrierCodeType was entered. FedEx Web Services, Developer Guide 422 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 511 An invalid or null SacApplicationId was entered. 547 Dim unit of measure must be the same for all packages. 512 An invalid origin country was entered. 548 Package {PACKAGE_INDEX} - Dimensions exceed height limit allowed. 513 An invalid origin zip/postal code was entered. 549 Dimensions exceed length and girth limit allowed. {ORIGIN_OR_DESTINATION}. 514 An invalid weight was entered. 550 Dimensions exceed length limit allowed. {ORIGIN_OR_DESTINATION}. 517 Requested Package Detail Type {REQUESTED_PACKAGE_DETAIL_TYPE} is not allowed for this request. 551 Dry Ice weight (in kilograms) is required and cannot be a negative value with Dry Ice special service. 518 Cannot ship from this origin zip/postal code to this destination zip/postal code. 552 ShipmentDryIceDetail object cannot be null. 521 ClientDetail object cannot be null. 553 Dry Ice weight over limit of 2.5 Kg for destination. 525 COD collection type is required and cannot be null. 555 Envelope weight over limit. Upgrade Packaging. 526 CodDetail object cannot be null. 556 Express and Freight packages cannot be mixed in the same shipment. 528 Package {PACKAGE_INDEX} - Currency type for Declared Value is required. 558 Home Delivery premium type is invalid. 532 Customer not eligible for Priority Alert. 559 Home Delivery premium type is required and cannot be null. 533 Customer not eligible for Third Party Consignee. 561 HomeDeliveryPremiumDetail object cannot be null. 534 Package {PACKAGE_INDEX} - Dangerous goods accessibility type is invalid. 563 Inside Delivery is not allowed. 535 Package {PACKAGE_INDEX} - Dangerous goods accessibility type is required and cannot be null. 564 Inside Pickup is not allowed. 565 Declared Value exceeds limit allowed. 537 Destination Country is Invalid. 568 Invalid currency type for validation. Only CAD is allowed. 538 Destination Country Not Served. 569 Invalid currency type for validation. Only USD is allowed. 540 Destination P.O. Box Zip. 570 Invalid destination postal code/routing code input. 541 Destination Postal Code Not Served. 571 Invalid Destination Postal Format. 542 Destination postal code/routing code and country do not match. 572 Invalid dimensions have been entered. 543 Destination Postal Not Found. 573 Drop off type is not allowed. 544 Destination Postal-City Mismatch. 574 Invalid drop off type. 546 Destination Postal-State Mismatch. 575 Invalid form ID. FedEx Web Services, Developer Guide 423 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 576 Invalid origin postal code/routing code input. 621 ServiceAvailabilityAndValidationRequest object cannot be null. 577 Invalid Origin Postal Format. 622 Package {PACKAGE_INDEX} - Signature option type is invalid. 585 Max Declared Value = $1,000. 623 Package {PACKAGE_INDEX} - Signature option type is required and cannot be null. 586 Max Declared Value = $100 for Envelope or Pak. 624 Package {PACKAGE_INDEX} - SignatureOptionDetail object cannot be null. 588 Max Declared Value = $50,000. 625 Special service conflict. 589 Max Declared Value = $500 for Envelope or Pak. 627 The format for Home Delivery Date Certain is CCYY-MM-DD. 592 No valid services available. 628 The date is required. Format is CCYY-MM-DD. 593 Package {PACKAGE_INDEX} - Only "IN" and "CM" are valid values for LinearUnits. 629 The destination country is required and must not exceed the limit of 2 characters. 594 Package {PACKAGE_INDEX} - Only "LB" and "KG" are valid values for WeightUnits. 631 The drop off type is required and cannot be null or empty. 595 Origin Country Not Served. 633 The length of the destination postal code exceeds the limit of 16 characters. 597 Origin Location-Postal Mismatch. 634 The length of the destination state or province exceeds the limit of 2 characters. 598 Origin P.O. Box Zip. 635 The length of the origin postal code exceeds the limit of 16 characters. 599 Origin Postal Code Not Served. 636 The length of the origin state or province exceeds the limit of 2 characters. 600 Origin postal code/routing code and country do not match. 640 The origin country is required and must not exceed the limit of 2 characters. 601 Origin Postal Not Found. 642 The packaging is required and cannot be null or empty. 602 Origin Postal-City Mismatch. 643 The service is required and cannot be null or empty. 603 Origin Postal-State Mismatch. 645 There are no valid Express services available. 605 Package is too large. 646 There are no valid Ground services available. 606 Packaging is invalid. 648 Total packages cannot exceed 1 for FedEx 10Kg/25Kg Box. 608 Please select a valid Date Certain delivery date: {DATE_1}; {DATE_2}; {DATE_3}; {DATE_4}; {DATE_5}; {DATE_6}; {DATE_7}; {DATE_8}; {DATE_9}; {DATE_10}; {DATE_11}. 649 Total packages cannot exceed 1 for FedEx Envelope. 650 Total packages cannot exceed 1 for FedEx Pak. 613 Return type is invalid. 651 Total packages cannot exceed 99 for FedEx Express Tag. 614 Return type is required and cannot be null. 655 UserDetail object cannot be null. 616 Saturday Pickup is not allowed. FedEx Web Services, Developer Guide 424 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 656 ValidateOriginDestinationRequest object cannot be null. 698 Package {PACKAGE_INDEX} - Max Declared Value = $200,000. 658 VersionId object cannot be null. 699 Package {PACKAGE_INDEX} - Max Declared Value = $250,000. 659 Package {PACKAGE_INDEX} - Weight below minimum requirement. 700 Invalid Signature option combination among packages. 660 Weight exceeds limit allowed. {ORIGIN_OR_DESTINATION} 701 Special service {SPECIAL_SERVICE_TYPE} is invalid. 661 Package {PACKAGE_INDEX} - Weight object cannot be null. 702 Package {PACKAGE_INDEX} - Special service {SPECIAL_SERVICE_TYPE} is invalid. 662 Weight unit of measure must be the same for all packages. 703 664 COD collection type is invalid. Package {PACKAGE_INDEX} - Broker Select Option cannot be entered at the package level for the service selected. 665 Currency type must be the same for all packages. 704 Package {PACKAGE_INDEX} - COD cannot be entered at the package level for the service selected. 668 Max Declared Value = $100,000. 705 Package {PACKAGE_INDEX} - COD Remittance cannot be entered at the package level. 669 Max Declared Value = $150,000. 706 Package {PACKAGE_INDEX} - Cut Flowers cannot be entered at the package level. 670 Max Declared Value = $200,000. 708 Package {PACKAGE_INDEX} - E-mail Notification cannot be entered at the package level. 671 Max Declared Value = $250,000. 709 Package {PACKAGE_INDEX} - Future Day Shipment cannot be entered at the package level. 679 Residential Pickup is not allowed. 710 Package {PACKAGE_INDEX} - Hold At Location cannot be entered at the package level. 683 An invalid date was entered. The date cannot be more than one year before or after the current date. {DATE} 711 Package {PACKAGE_INDEX} - Hold Saturday cannot be entered at the package level. 684 ReturnShipmentDetail object cannot be null. 712 Package {PACKAGE_INDEX} - Inside Delivery cannot be entered at the package level. 685 Packaging is not allowed. 713 Package {PACKAGE_INDEX} - Inside Pickup cannot be entered at the package level. 686 Service is not allowed. 714 Package {PACKAGE_INDEX} - Intl Controlled Export Service cannot be entered at the package level. 687 Residential Delivery is not allowed. 715 Package {PACKAGE_INDEX} - Intl Mail Service cannot be entered at the package level. 692 The destination postal code is required. 716 Priority Alert cannot be entered at the shipment level. 693 The origin postal code is required. 717 Package {PACKAGE_INDEX} - Return Shipment cannot be entered at the package level. 695 Package {PACKAGE_INDEX} - Max Declared Value = $500 for Envelope or Pak. 718 Package {PACKAGE_INDEX} - Saturday Delivery cannot be entered at the package level. 696 Package {PACKAGE_INDEX} - Max Declared Value = $100,000. 719 Package {PACKAGE_INDEX} - Saturday Pickup cannot be entered at the package level. 697 Package {PACKAGE_INDEX} - Max Declared Value = $150,000. FedEx Web Services, Developer Guide 425 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 720 Package {PACKAGE_INDEX} - Third Party Consignee cannot be entered at the package level. 742 Package {PACKAGE_INDEX} - Dangerous Goods is not allowed for the origin/destination pair. 721 Package {PACKAGE_INDEX} - Weekday Delivery cannot be entered at the package level. 743 Dangerous Goods is not allowed with the service selected. 722 Appointment Delivery cannot be entered at the shipment level. 744 Dangerous Goods is not allowed for the origin/destination pair. 725 Dangerous Goods cannot be entered at the shipment level for the service selected. 745 Accessible Dangerous Goods is not allowed with the service selected. 726 Package {PACKAGE_INDEX} - Home Delivery Premium cannot be entered at the package level. 746 Inaccessible Dangerous Goods is not allowed. 747 Inaccessible Dangerous Goods is not allowed with the service selected. 727 Non Standard Container cannot be entered at the shipment level. 748 Package {PACKAGE_INDEX} - Dry Ice is not allowed with the service selected. 728 Piece Count Verification cannot be entered at the shipment level. 749 Dry Ice is not allowed with the service selected. 729 Signature Option cannot be entered at the shipment level. 750 Hold At Location is not allowed with the service selected. 730 Package {PACKAGE_INDEX} - Appointment Delivery is not allowed with the service selected. 751 Hold At Location is not allowed. 731 Appointment Delivery is not allowed. 752 Hold Saturday is not allowed with the service selected. 732 Package {PACKAGE_INDEX} - Broker Select Option is not allowed with the service selected. 753 Hold Saturday is not allowed. 754 Package {PACKAGE_INDEX} - Home Delivery Premium Appointment is not allowed with the service selected. 755 Package {PACKAGE_INDEX} - Home Delivery Premium Appointment is not allowed for the origin/destination pair. 756 Home Delivery Premium Appointment is not allowed with the service selected. 757 Home Delivery Premium Appointment is not allowed for the origin/destination pair. 758 Package {PACKAGE_INDEX} - Home Delivery Premium Date Certain is not allowed with the service selected. 759 Package {PACKAGE_INDEX} - Home Delivery Premium Date Certain is not allowed for the origin/destination pair. 760 Home Delivery Premium Date Certain is not allowed with the service selected. 761 Home Delivery Premium Date Certain is not allowed for the origin/destination pair. 733 Broker Select Option is not allowed. 734 Package {PACKAGE_INDEX} - COD is not allowed with the service selected. 735 Package {PACKAGE_INDEX} - COD is not allowed for the origin/destination pair. 736 COD is not allowed with the service selected. 737 COD is not allowed for the origin/destination pair. 738 COD Remittance is not allowed with the service selected. 739 Cut Flowers is not allowed with the service selected. 740 Cut Flowers is not allowed. 741 Package {PACKAGE_INDEX} - Dangerous Goods is not allowed with the service selected. FedEx Web Services, Developer Guide 426 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 762 Package {PACKAGE_INDEX} - Home Delivery Premium Evening is not allowed with the service selected. 783 Return Shipment Voice Call Tag is not allowed for the origin/destination pair. 784 Return Shipment Printed Label is not allowed with the service selected. 763 Package {PACKAGE_INDEX} - Home Delivery Premium Evening is not allowed for the origin/destination pair. 785 Return Shipment Printed Label is not allowed for the origin/destination pair. 764 Home Delivery Premium Evening is not allowed with the service selected. 786 Return Shipment E-mail Label is not allowed with the service selected. 765 Home Delivery Premium Evening is not allowed for the origin/destination pair. 787 Return Shipment E-mail Label is not allowed for the origin/destination pair. 766 Package {PACKAGE_INDEX} - Home Delivery Premium is not allowed with the service selected. 788 Return Shipment FedEx Tag is not allowed with the service selected. 790 Saturday Delivery is not allowed with the service selected. 767 Inside Delivery is not allowed with the service selected. 791 Saturday Delivery is not allowed. 768 Inside Pickup is not allowed with the service selected. 792 Saturday Pickup is not allowed with the service selected. 769 Intl Controlled Export Service is not allowed with the service selected. 793 Package {PACKAGE_INDEX} - Adult Signature is not allowed with the service selected. 770 Intl Controlled Export Service is not allowed. 794 Package {PACKAGE_INDEX} - Adult Signature is not allowed for the origin/destination pair. 771 Intl Mail Service is not allowed with the service selected. 795 Adult Signature is not allowed with the service selected. 772 Intl Mail Service is not allowed. 796 Adult Signature is not allowed for the origin/destination pair. 773 Package {PACKAGE_INDEX} - Non Standard Container is not allowed with the service selected. 797 Adult Signature is not allowed. 798 Package {PACKAGE_INDEX} - Direct Signature is not allowed with the service selected. 774 Package {PACKAGE_INDEX} - Non Standard Container is not allowed for the origin/ destination pair. 799 Package {PACKAGE_INDEX} - Direct Signature is not allowed for the origin/destination pair. 800 Direct Signature is not allowed with the service selected. 775 Non Standard Container is not allowed with the service selected. 776 Non Standard Container is not allowed for the origin/destination pair. 801 Direct Signature is not allowed for the origin/destination pair. 777 Package {PACKAGE_INDEX} - Piece Count Verification is not allowed with the service selected. 802 Direct Signature is not allowed. 778 Piece Count Verification is not allowed. 803 Package {PACKAGE_INDEX} - Indirect Signature is not allowed with the service selected. 779 Priority Alert is not allowed with the service selected. 804 Package {PACKAGE_INDEX} - Indirect Signature is not allowed for the origin/destination pair. 781 Return Shipment FedEx Tag is not allowed for the origin/destination pair. 805 Indirect Signature is not allowed with the service selected. 782 Return Shipment Voice Call Tag is not allowed with the service selected. FedEx Web Services, Developer Guide 427 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 806 Indirect Signature is not allowed for the origin/destination pair. 830 807 Indirect Signature is not allowed. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Date Certain. 808 Third Party Consignee is not allowed with the service selected. 831 Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Evening. 809 Special service conflict. COD is not valid with COD Remittance. 832 811 Special service conflict. COD is not valid with Return Shipment FedEx Tag. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Adult Signature. 812 Special service conflict. COD is not valid with Return Shipment Printed Label. 833 Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Direct Signature. 814 Special service conflict. COD Remittance is not valid with Return Shipment FedEx Tag. 834 815 Special service conflict. COD Remittance is not valid with Return Shipment Printed Label. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Indirect Signature. 816 Special service conflict. Priority Alert is not valid with COD. 835 817 Special service conflict. Priority Alert is not valid with COD Remittance. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Appointment. 819 Special service conflict. Priority Alert is not valid with Return Shipment FedEx Tag. 836 Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Date Certain. 820 Special service conflict. Priority Alert is not valid with Return Shipment Printed Label. 837 823 Package {PACKAGE_INDEX} - Special service conflict. Direct Signature is not valid with COD. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Evening. 838 Special service conflict. Direct Signature is not valid with COD. 824 Package {PACKAGE_INDEX} - Special service conflict. Indirect Signature is not valid with COD. 839 Special service conflict. Indirect Signature is not valid with COD. 825 Package {PACKAGE_INDEX} - Special service conflict. Indirect Signature is not valid with Dangerous Goods. 840 Special service conflict. Indirect Signature is not valid with Dangerous Goods. 841 Special service conflict. Return Shipment FedEx Tag is not valid with Adult Signature. 826 Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Adult Signature. 842 Special service conflict. Return Shipment FedEx Tag is not valid with Direct Signature. 843 Special service conflict. Return Shipment FedEx Tag is not valid with Indirect Signature. 827 Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Direct Signature. 844 Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Appointment. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Indirect Signature. 845 Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Date Certain. Package {PACKAGE_INDEX} - Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Appointment. 846 Special service conflict. Return Shipment FedEx Tag is not valid with Home Delivery Premium Evening. 828 829 FedEx Web Services, Developer Guide 428 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 847 Special service conflict. Return Shipment Voice Call Tag is not valid with Adult Signature. 869 848 Special service conflict. Return Shipment Voice Call Tag is not valid with Direct Signature. Package {PACKAGE_INDEX} - E-mail Notification Aggregate cannot be entered at the package level. 849 Special service conflict. Return Shipment Voice Call Tag is not valid with Indirect Signature. 872 Package {PACKAGE_INDEX} - Dry Ice weight (in kilograms) is required and cannot be a negative value with Dry Ice special service. 850 Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Appointment. 873 Package {PACKAGE_INDEX} - Dry Ice weight is required and cannot be null. 851 Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Date Certain. 875 Package {PACKAGE_INDEX} - Accessible Dangerous Goods is not allowed with the service selected. 852 Special service conflict. Return Shipment Voice Call Tag is not valid with Home Delivery Premium Evening. 876 Package {PACKAGE_INDEX} - Inaccessible Dangerous Goods is not allowed with the service selected. 853 Package {PACKAGE_INDEX} - An invalid weight was entered. 877 Package {PACKAGE_INDEX} - Accessible Dangerous Goods is not allowed. 854 Package {PACKAGE_INDEX} - COD amount is not within the limits for this collection type. 878 Package {PACKAGE_INDEX} - Adult Signature is not allowed. 855 Package {PACKAGE_INDEX} - COD collection amount is required and cannot be a negative value. 879 Package {PACKAGE_INDEX} - Appointment Delivery is not allowed. 880 Broker Select Option is not allowed for the origin/destination pair. 856 Package {PACKAGE_INDEX} - COD collection currency type is required and cannot be null. 881 Package {PACKAGE_INDEX} - Cut Flowers is not allowed. 860 Package {PACKAGE_INDEX} - Dimensions exceed length and girth limit allowed for the origin. 882 Package {PACKAGE_INDEX} - Direct Signature is not allowed. 883 Package {PACKAGE_INDEX} - Dry Ice is not allowed. 861 Package {PACKAGE_INDEX} - Dimensions exceed length limit allowed for the origin. 884 Package {PACKAGE_INDEX} - Hold At Location is not allowed. 862 Package {PACKAGE_INDEX} - Dry Ice weight over limit of 2.5 Kg for destination. 885 Package {PACKAGE_INDEX} - Hold Saturday is not allowed. 863 Package {PACKAGE_INDEX} - Declared Value exceeds limit allowed. 886 Package {PACKAGE_INDEX} - Inaccessible Dangerous Goods is not allowed. 864 Package {PACKAGE_INDEX} - Invalid dimensions have been entered. 887 Package {PACKAGE_INDEX} - Indirect Signature is not allowed. 865 Package {PACKAGE_INDEX} - Max Declared Value = $1,000. 888 Package {PACKAGE_INDEX} - Intl Controlled Export Service is not allowed. 866 Package {PACKAGE_INDEX} - Max Declared Value = $50,000. 889 Package {PACKAGE_INDEX} - Intl Mail Service is not allowed. 867 Package {PACKAGE_INDEX} - Please select a valid Date Certain delivery date: {DATE_1}; {DATE_2}; {DATE_3}; {DATE_4}; {DATE_5}; {DATE_6}; {DATE_7}; {DATE_8}; {DATE_9}; {DATE_10}; {DATE_11}. 890 Package {PACKAGE_INDEX} - Piece Count Verification is not allowed. 891 Package {PACKAGE_INDEX} - Saturday Delivery is not allowed. Package {PACKAGE_INDEX} - Weight exceeds limit allowed for the origin. 892 Package {PACKAGE_INDEX} - Special service conflict. 868 FedEx Web Services, Developer Guide 429 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 893 Third Party Consignee is not allowed. 919 Broker Select Option is not allowed with the service selected. 894 Package {PACKAGE_INDEX} - Third Party Consignee is not allowed. 920 Special service conflict. Inside Delivery is not valid with Hold At Location. 895 Special service conflict. Priority Alert is not valid with Return Shipment E-mail Label. 922 Hold At Location is not allowed with Residential Delivery. 896 Special service conflict. COD is not valid with Return Shipment E-mail Label. 924 Package count cannot be zero or a negative value. 897 Special service conflict. COD Remittance is not valid with Return Shipment E-mail Label. 925 Package count cannot be less than the amount of packages entered. 898 Dry Ice package count is required and cannot be a negative value. 926 Invalid drop off type for service selected. 899 Appointment Delivery is not allowed with the service selected. 927 Package {PACKAGE_INDEX} - Envelope weight over limit. Upgrade Packaging. 900 Home Delivery Premium is not allowed with the service selected. 928 Invalid currency type for validation. Only USD or CAD is allowed. 901 Piece Count Verification is not allowed with the service selected. 929 Dangerous Goods must be entered on all packages. 902 Package {PACKAGE_INDEX} - COD Remittance is not allowed with the service selected. 930 The Dangerous Goods type cannot be different across packages. 903 Package {PACKAGE_INDEX} - Cut Flowers is not allowed with the service selected. 931 Signature Option must be entered on all packages. 904 Package {PACKAGE_INDEX} - Hold At Location is not allowed with the service selected. 932 Dry Ice cannot be entered at the shipment level. 905 Package {PACKAGE_INDEX} - Hold Saturday is not allowed with the service selected. 933 CommitmentRequest object cannot be null. 907 Package {PACKAGE_INDEX} - Inside Delivery is not allowed with the service selected. 934 Package {PACKAGE_INDEX} - Dimensions exceed height limit allowed for the destination. 909 Package {PACKAGE_INDEX} - Inside Pickup is not allowed with the service selected. 935 Package {PACKAGE_INDEX} - Dimensions exceed height limit allowed for the origin. 910 Package {PACKAGE_INDEX} - Intl Controlled Export Service is not allowed with the service selected. 936 Package {PACKAGE_INDEX} - Dimensions exceed length and girth limit allowed for the destination. 911 Package {PACKAGE_INDEX} - Intl Mail Service is not allowed with the service selected. 937 Package {PACKAGE_INDEX} - Dimensions exceed length limit allowed for the destination. 912 Package {PACKAGE_INDEX} - Priority Alert is not allowed with the service selected. 938 Package {PACKAGE_INDEX} - Weight exceeds limit allowed for the destination. 913 Package {PACKAGE_INDEX} - Saturday Delivery is not allowed with the service selected. 939 Service {SERVICE_TYPE} is invalid. 915 Package {PACKAGE_INDEX} - Saturday Pickup is not allowed with the service selected. 940 East Coast Special is not allowed. 916 Package {PACKAGE_INDEX} - Third Party Consignee is not allowed with the service selected. 941 East Coast Special is not allowed with the service selected. 942 Package {PACKAGE_INDEX} - East Coast Special cannot be entered at the package level. 918 Package {PACKAGE_INDEX} - Package is too large. 943 Package {PACKAGE_INDEX} - East Coast Special is not allowed. FedEx Web Services, Developer Guide 430 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 944 Package {PACKAGE_INDEX} - East Coast Special is not allowed with the service selected. 968 Dimensions exceed height limit allowed. 946 RequestedShipment object cannot be null. 969 Dimensions exceed length and girth limit allowed for the destination. 947 The ship date is required. Format is YYYY-MM-DDThh:mm:ssTZD. 970 Dimensions exceed length and girth limit allowed for the origin. 948 RequestedPackage object cannot be null or empty. 971 Dimensions exceed length limit allowed for the destination. 949 customsClearanceDetail object cannot be null. 972 Dimensions exceed length limit allowed for the origin. 950 Broker Address object cannot be null. 973 Only "IN" and "CM" are valid values for LinearUnits. 951 Broker city, postal code or location must be provided. 974 Only "LB" and "KG" are valid values for WeightUnits. 952 The length of the broker postal code exceeds the limit of 9 characters. 975 Weight below minimum requirement. 953 The length of the broker state or province exceeds the limit of 2 characters. 976 Weight exceeds limit allowed for the destination. 954 The length of the broker country exceeds the limit of 2 characters. 977 Weight exceeds limit allowed for the origin. 955 The length of the broker location exceeds the limit of 5 characters. 978 Weight object cannot be null. 956 Commodity object cannot be null. 979 CarrierCodeType {OPERATING_COMPANY} is invalid or not supported. 957 Commodity {COMMODITY_INDEX} - Commodity is required. 980 Destination city is invalid. 958 Commodity {COMMODITY_INDEX} - Customs value is invalid. 981 Origin city is invalid. 959 Commodity {COMMODITY_INDEX} - Customs value currency type is required and must be three characters. 982 Service {SERVICE_TYPE} is not allowed for the destination. 983 Service {SERVICE_TYPE} is not allowed for the origin. 960 Total packages cannot exceed 99 for FedEx Ground Tag. 984 Commodity {COMMODITY_NAME} is invalid. 961 Customs Value currency type must be the same for all packages. 985 Commodity {COMMODITY_NAME} is not allowed. 963 Commodity {COMMODITY_INDEX} - Number of pieces is required and cannot be a negative value or exceed 9,999. 986 Declared Value cannot be a negative value. 964 An invalid or null RequestedPackageDetailType was entered. 987 Package {PACKAGE_INDEX} - Declared Value cannot be a negative value. 965 Currency type for Declared Value is required. 988 Dangerous goods accessibility type is invalid. 966 Dimensions exceed height limit allowed for the destination. 989 Dangerous goods accessibility type is required and cannot be null. 967 Dimensions exceed height limit allowed for the origin. 992 PMIS System Error. FedEx Web Services, Developer Guide 431 Appendix O Error Code Messages Package Movement Information Service Package Movement Information Service Code Message Code Message 2006 FedEx Ground and FedEx Home Delivery shipments may require one additional day in transit to your destination zip code. 2029 Destination is routed through another country. 2030 2007 FedEx Home Delivery Saturday service is not available to destination zip code. The service option type {SERVICE_OPTION_TYPE} was ignored because it was incompatible with the original request. 2008 Money Back Guarantee is not eligible for this pick up/delivery postal/zip code. 2031 2010 The origin state/province code has been changed. Special service {SPECIAL_SERVICE_TYPE} was ignored since it is not relevant to the PMIS request. 2011 The destination state/province code has been changed. 2032 The shipdate has been changed for commitment purposes. 2013 The origin country code has been changed. 9000 Failed to connect to WebLogic at - Please make sure the URL is correct and the server is running. 2014 The destination country code has been changed. 9001 2017 The country's default routing code was used for the origin. Notification not found in reply class: [class_name] returned by method: [method_name] returning null. 2018 The routing code was derived from the postal code for the origin. 9002 Notification array not found in reply class: [class_name] returned by method: [method_name] - returning null. 2019 The routing code was derived from the city for the origin. 9003 2020 Service was validated at the country level, but might not be valid for the actual intended city for the origin. Failed to create reply class for called method: [method_name]. Exception: [exception_text]. Cause: [cause_text | N/A]. 9004 2021 Service was not fully validated since the country level information could not be determined for the origin. Remote EJB method: not called. Unable to create the remote bean. Exception: . Cause: . 9005 Service is busy, max [ connect | invoke ] limit reached: . 2022 Origin is routed through another country. 9006 Unable to invoke method: . Service is currently unavailable. 2023 Commitment cannot be obtained for service {SERVICE_TYPE}. {CODE} 9999 Remote EJB method: failed. Exception: . Cause: . 2023 Commitment cannot be obtained for service {SERVICE_TYPE}. {CODE} 2024 The country's default routing code was used for the destination. 2025 The routing code was derived from the postal code for the destination. Pickup Service Error Messages 2026 The routing code was derived from the city for the destination. The following error messages apply to the Pickup Service: 2027 Service was validated at the country level, but might not be valid for the actual intended city for the destination. Pickup Service Code Message 2028 Service was not fully validated since the country level information could not be determined for the destination. 1000 General Failure. 1001 Unexpected reply from service. FedEx Web Services, Developer Guide 432 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 1002 Missing or illegal argument or parameter 2019 Account number missing from the Client Detail. 1003 Information may have been defaulted to process this request. 2020 Meter number missing from the Client Detail. 1004 Information may have been defaulted to process this request. 2021 Invalid package count or invalid package sequence number. 2000 Invalid streetLine 1. 2022 The masterTrackingId is invalid. 2001 Invalid countryCode. 2023 Weight must be expressed in pound units (LB) for Domestic Express Shipments. 2002 An Address is required for a Party. 2024 2003 A Contact is required for a Party. Dimensions of package {PACKAGE_INDEX} must be expressed in inches (IN) for Domestic Express Shipments. 2004 The payor's account number is invalid. 2025 Package Count exceeds the maximum allowed. 2005 The payor's countryCode is invalid. 2026 Packaging Type is invalid for Service Type. 2006 Package weight exceeds maximum for requested service/packaging. 2027 PRINT_RETURN_LABEL is not available with FUTURE_DAY_SHIPMENT. 2007 Package weight is less than the minimum for requested service/packaging. 2028 Invalid ShippingChargesPayment cashAmount. 2008 Duties payment type is not valid for international, non-intra-Canada non-document shipment. 2029 Bill Recipient or Bill Third Party invalid for this service. 2030 All Currency Types in the Requested Shipment must match. 2009 Duties payment type is not compatible with destination country. 2031 Signature option not allowed with Intra CA 1 Day Freight. 2010 Destination country is not Thermal Air WayBill enabled. 2032 Broker country should be the same as Recipient country. 2011 Destination country code is invalid. 2033 Customs Value is required for Intl shipments. 2012 Shipper/origin country is not Thermal Air WayBill enabled. 2034 Broker Select Option not allowed with this service type. 2013 Origin/shipper country code is invalid. 2035 NO_SIGNATURE_REQUIRED not allowed with COD. 2014 Shipments to Syria are not allowed from the specified origin country. 2036 Invalid Package Detail. 2015 Intra-country (domestic) service not supported for that origin/destination country. 2037 Requested Package Summary cannot be populated. 2016 IntraCanada shipments must have Canadian dollars as preferred currency. 2038 Inconsistent weight and dimension units, please use English or Metric. 2017 Package {PACKAGE_INDEX} carriage value exceeds maximum declared value for intraCanada shipping. 2039 Incomplete commodity description {COMMODITY_INDEX}. 2040 Invalid loadData() parameters. 2018 IntraCanada shipments must have Canadian dollars as carriage value currency. 2041 loadData failed to install Country.dat. Please see log for details. FedEx Web Services, Developer Guide 433 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 2200 Missing or Invalid Shipment purpose for Commercial Invoice. 2223 Alcohol not allowed with return shipments. 2201 Number of Commodities exceeds min or max limit. 2224 Evening delivery not allowed with return shipments. 2202 Commodity Description is required. 2225 Appointment delivery not allowed with return shipments. 2203 Commodity country of manufacture is required. 2226 Insured value can not be greater than 100 for ground return shipments. 2204 Commodity units of quantity is required. 2227 Only 2D Common label allowed with ground return shipments. 2205 Commodity units is required. 2228 Insight shipment fields are not allowed with ground return shipments. 2206 Commodity unit price is required. 2229 Insured value can not be greater than $1000 for express return shipments. 2207 Commercial Invoice not allowed for origin destination. 2230 Alternate shipper not allowed with return shipments. 2208 The FTR Exemption or AES Citation you provided is not valid for SED. 2231 DG or Hazmat not allowed with return shipments. 2209 Inactive customer account. 2232 Invalid RMA number. 2210 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2233 Invalid or missing notification recipient type. 2211 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2234 Invalid or missing notification recipient e-mail format. 2212 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2235 E-mail address can not exceed 120 characters. 2213 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2236 Invalid or missing E-mail address. Party may not get notified. 2214 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2237 Invalid or Missing language code for notification, defaulting to English. 2215 Insured value exceeds limit for the selected service in package {PACKAGE_INDEX}. 2238 Tracking number required for Deleting a shipment. 2216 Invalid Insured value currency. 2239 Tracking number not in database. 2217 Hazmat not allowed with selected service. 2240 Label Format type can not be empty. 2218 Return type not supported. 2241 Label Image type can not be empty. 2219 Origin country code must be U.S. for return shipments. 2242 Ground Shipping is not authorized for this User. 2220 Destination country code must be U.S. for return shipments. 2243 Shipments for Home Delivery Service must be designated as Residential Delivery also. 2221 Only bill shipper or bill third party allowed with return shipments. 2244 Sequence number of the package can not be zero for MPS packages. 2222 COD not allowed with return shipments. 2245 COD can not be specified at package level for Express Shipments. FedEx Web Services, Developer Guide 434 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 2246 COD can not be specified at Shipment level for Ground Shipments. 2402 SpecialServiceTypes is required when ShipmentSpecialServicesRequested is present. 2247 Dangerous Goods can not be specified at package level for Express Shipments. 2403 CodDetail required when Special Service Type is COD. 2248 Dangerous Goods can not be specified at Shipment level for Ground Shipments. 2404 DangerousGoodsDetail required when Special Service Type is DANGEROUS_GOODS. 2249 TIN Number can not exceed 18 characters. 2405 DryIceWeight required when Special Service Type is DRY_ICE. 2250 Currency of insured value defaulted to the currency of origin country. 2406 EmailNotificationDetail required when Special Service Type is EMAIL_NOTIFICATION. 2251 Insured Value can not exceed customs value. 2407 2252 Declared value exceeds amount allowed for this country. HoldAtLocationDetail required when Special Service Type is HOLD_AT_LOCATION or HOLD_AT_LOCATION with SATURDAY_DELIVERY. 2253 Multiple Country of Manufacture not allowed for Commodity {COMMODITY_INDEX}. 2408 HomeDeliveryPremiumDetail required when Special Service Type is HOME_DELIVERY_PREMIUM. 2254 Minimum dimensions not met for service type. 2409 ReturnShipmentDetail required when Special Service Type is RETURN_SHIPMENT. 2255 COD add transportation charge is not allowed for supplied Origin and Destination. 2410 SignatureOptionDetail required when Special Service Type is SIGNATURE_OPTION. 2271 Master information not allowed for first package in MPS. 2411 Invalid value for Signature Service. 2272 Payor country code must match either Origin or Destination country code. 2412 MPS is not allowed for NON-COD shipment. 2273 Invalid Shipping Charges Payment Type for Payor country code. 2413 Invalid addTransportationCharges. 2274 Invalid Duties Payment Type for Payor country code. 2414 Invalid CodCollectionType. 2275 Weight and dimension values are less than service minimums. 2415 codRecipient must be supplied when Special Service Type is COD. 2276 Invalid booking confirmation number. 2416 codReferenceIndicator is invalid. 2277 Invalid shipper load and count. 2417 companyName OR personName is required. 2278 Commodity line item row is not populated. 2418 phoneNumber is required. 2279 No more than two elements of the PriorityAlertDetail contents array will be used. 2419 Invalid CodCollectionType. 2300 Weight exceeds max limit for country specified. 2421 Phone number must be valid. 2301 Package height exceeds the max height for this service/packaging combination. 2422 2400 SpecialServiceTypes is required when PackageSpecialServicesRequested is present. Invalid customerReferenceType for customer reference {CUSTOMER_REFERENCE_INDEX} in requestedPackage {PACKAGE_INDEX}. 2401 Invalid SpecialServiceType in package {PACKAGE_INDEX}. 2423 customerReference value length must not exceed 40 characters for customer reference {CUSTOMER_REFERENCE_INDEX} in requestedPackage {PACKAGE_INDEX}. FedEx Web Services, Developer Guide 435 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 2424 hazMatCertificateData is required. 2447 Signature on File is required for export shipments. 2425 Invalid dangerousGoodsAccessibilityType. 2448 Export detail data are missing from this shipment. 2426 dangerousGoodsAccessibilityType is required. 2449 International detail information is required for non-domestic-U.S. shipments. 2427 clientDetail is required. 2450 Destination country does not accept international document shipments. 2428 Invalid tracking number. 2451 Destination country does not accept international non-document shipments. 2429 Invalid units for dimensions. 2452 International document type is required for non-domestic-U.S. shipment. 2430 length, width, and height must be greater than 0. 2453 Invalid Localization languageCode. 2431 streetLines[1] is required for HoldAtLocationDetail. 2454 Invalid currencyType. 2432 Invalid phoneNumber for HoldAtLocationDetail. 2455 Invalid amount. 2433 City is required for HoldAtLocationDetail. 2456 Payor is required. 2434 shippingChargesPaymentType must be shipper for COD. 2457 requestedShipment is required. 2435 COD not allowed for service type. 2458 Weight is required. 2436 Package girth exceeds the max girth for this service/packaging combination. 2459 Weight must be greater than 0. 2437 Package length exceeds the max length for this service/packaging combination. 2460 Invalid weight units. 2438 Package width exceeds the max width for this service/packaging combination. 2461 labelSpecification is required. 2439 Package girth is less than the min girth for this service/packaging combination. 2462 Invalid packaging type. 2440 Package length is less than the min length for this service/packaging combination. 2463 The number of RequestedPackages in the RequestedShipment must be equal to 1. 2441 Package width is less than the min width for this service/packaging combination. 2464 Invalid service type. 2442 Invalid statementData for the exportDetail. 2465 Invalid preferredCurrency. 2443 B13A Filing Option data are inconsistent. 2466 Invalid dropoffType. 2444 B13A Filing Option is missing or invalid. 2467 shippingChargesPayment is required. 2445 Export permit number is invalid. 2468 totalWeight is required. 2446 Hold At Location not allowed with this service. 2469 shipTimestamp is invalid. FedEx Web Services, Developer Guide 436 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 2470 recipient is required. 2493 Piece Count Verification Box Count is invalid with this Service Type. 2471 shipper is required. 2494 Package dry ice weight cannot be greater than package weight. 2472 Dry Ice not allowed with Ground service, use Haz Mat instead. 2495 Packaging Type changed to YOUR_PACKAGING for EXPRESS_SAVER service. 2473 Invalid State Or Province Code. 2496 No INSIDE_DELIVERY with service type. 2474 Invalid city. 2497 No INSIDE_PICKUP with service type. 2475 Invalid accountNumber. 2498 Recipient/Third party account validation failed. 2476 Invalid meterNumber. 2499 Recipient/Third party account not authorized for ground billing. 2477 Invalid collectionAmount. 2500 Signature option requested is not valid for this service type. 2478 Invalid country code for HoldAtLocationDetail. 2501 Weight value cannot be < 1. 2479 Invalid streetLine[1] for HoldAtLocationDetail. 2502 2480 Invalid stateOrProvinceCode for HoldAtLocationDetail. This shipment was designated as Residential Delivery but qualifies for FedEx Home Delivery. Please mark this shipment with the service 'FedEx Home Delivery' and re-ship. 2481 signatureOptionType specified is invalid. 2503 Signature option has been changed to INDIRECT. 2482 Specified Signature Option is invalid for Express Freight Service. 2504 Invalid Smart post special service type. 2483 signatureReleaseNumber is required for signature option NO_SIGNATURE_REQUIRED. 2505 "USPS_DELIVERY_CONFIRMATION" was added to the smart post special services. 2484 Signature Option Type has been changed to SERVICE_DEFAULT. 2506 Invalid Tracking Id Type for Package {PACKAGE_INDEX}. 2485 Signature Option Type has been changed to DIRECT. 2507 Invalid Master Tracking Id Type. 2486 Signature Option Type has been changed to ADULT. 2508 Invalid Tracking Id Type. 2487 Dimensions are required for Express Freight Services. 2516 Shipper Account Number cannot be different from ClientDetail AccountNumber. 2488 Invalid ShipmentSpecialServiceType. 2517 When payment Type is shipper, ShippingChargesPayment Payor AccountNumber should match the shipper account number. 2489 Invalid Home Delivery Premium Type. 2519 Total Insured value exceeds customs value. 2490 Home Delivery Premium Detail Date must be supplied when requesting DATE_CERTAIN delivery. 2520 Duties Payor Account Number does not match Shipper Account Number. 2491 Invalid Phone Number for Home Delivery Premium Detail. 2521 Importer Account Number does not match Shipper Account Number. 2492 Piece Count Verification Box Count must be greater than 0. 2522 Shipper is the Importer of Record. FedEx Web Services, Developer Guide 437 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 2523 Broker information cannot be populated for Broker Inclusive shipment. 2714 Packaging is required for hazardous commodity content. 2524 Duties Payor Account Number is required with THIRD_PARTY as payment type. 2715 Invalid hazardous commodity packaging count. 2525 Recipient has been defaulted to the Importer of Record. 2716 Invalid hazardous commodity packaging units. 2526 Importer has been defaulted to the Third Party. 2717 2528 Invalid Importer Data. Package {PACKAGE_INDEX} - Dangerous goods hazardous commodity option type is invalid or missing. 2529 GAA form could not be generated. 2998 General Failure. 2530 GAA instructions could not be generated. 2999 Document content type is invalid. 2531 Package insured value can not exceed Total insured value. 3000 Invalid Shipper city. 2532 Hold at Location country must match Recipient country. 3001 Invalid Shipper Country Code. 2700 Service Factory exception received in Ship.init. 3002 Invalid Shipper streetLine 1. 2701 Exception in Ship.deleteShipment. 3003 Invalid Shipper state Or Province Code. 2702 Exception in Ship.processShipment. 3004 Shipper Company Name OR Person Name is required. 2703 Exception in Ship.validateShipment. 3005 Shipper Phone Number is required. 2704 Exception in ValidateDeleteShipment.doValidateDeleteShipment. 3006 Invalid paymentType. 2705 Exception in ValidateProcessShipment.doValidateProcessShipment. 3007 Shipper Person Name must be at least 2 characters. 2706 Exception in ValidateShipment.doValidateShipment. 3008 Invalid labelImageType. 2707 Child piece cannot continue processing. The shipment has been deleted. 3009 Invalid labelStockType. 2708 Dangerous Goods special service type is required with the dangerous goods hazardous commodity option type. 3010 Invalid labelPrintingOrientation. 3011 Shipper Company Name must be at least 2 characters. 2709 Invalid number of commodities in hazardous commodity content. 3012 Shipper Phone Number is invalid. 2710 Invalid hazmat commodity emergency phone number. 3013 Recipient Company Name OR Person Name is required. 2711 Quantity is required for hazardous commodity content. 3014 Recipient Phone Number is required. 2712 Invalid hazardous commodity quantity amount. 3015 Invalid Recipient city. 2713 Invalid hazardous commodity quantity units. 3016 Recipient Company Name must be at least 2 characters. FedEx Web Services, Developer Guide 438 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3017 Invalid Recipient Country Code. 3040 Shipper Postal-City Mismatch. 3018 Invalid Recipient StreetLine 1. 3041 Shipper Country not served. 3019 Recipient Person Name must be at least 2 characters. 3042 Shipper Country code is required and must not exceed the limit of 2 characters. 3020 Recipient Phone Number is invalid. 3043 Invalid Shipper postal code/routing code input. 3021 Recipient State Code is missing. 3044 Shipper zip is a P.O. Box - Not allowed. 3022 General Failure. 3045 Shipper Postal code or routing code is required. 3023 Postal Code not found. 3046 Shipper Postal/Routing code and country do not match. 3024 Shipper Postal Code not found. 3047 The length of the Shipper postal code exceeds the limit of 16 characters. 3025 Invalid Postal Code Format. 3048 The length of the Shipper state or province exceeds the limit of 3 characters. 3026 Postal Code not Served. 3049 Recipient Postal Code not found. 3027 Postal-State Mismatch. 3050 Invalid Recipient Postal Code Format. 3028 Postal-City Mismatch. 3051 Recipient Postal Code not Served. 3029 Country not served. 3052 Recipient Postal-State Mismatch. 3030 Country code is required and must not exceed the limit of 2 characters. 3053 Recipient Postal-City Mismatch. 3031 Invalid postal code/routing code input. 3054 Recipient Country not served. 3032 P.O. Box zip. 3055 Recipient Country code is required and must not exceed the limit of 2 characters. 3033 Postal code or routing code is required. 3056 Invalid Recipient postal code/routing code input. 3034 Postal/Routing code and country do not match. 3057 Recipient zip is a P.O. Box - Not allowed. 3035 The length of the postal code exceeds the limit of 16 characters. 3058 Recipient Postal code or routing code is required. 3036 The length of the state or province exceeds the limit of 3 characters. 3059 Recipient Postal/Routing code and country do not match. 3037 Invalid Shipper Postal Code Format. 3060 The length of the Recipient postal code exceeds the limit of 16 characters. 3038 Shipper Postal Code not Served. 3061 The length of the Recipient state or province exceeds the limit of 3 character. 3039 Shipper Postal-State Mismatch. 3062 Hold at Location Postal Code not found. FedEx Web Services, Developer Guide 439 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3063 Invalid Hold at Location Postal Code Format. 3086 Recipient Postal-Country mismatch. 3064 Hold at Location zip is a P.O. Box - Not allowed. 3087 Hold-at-Location Postal-Country mismatch. 3065 Hold at Location Postal-State Mismatch. 3088 Postal Code not found. 3066 Hold at Location Postal-City Mismatch. 3089 Shipper Postal Code not found. 3067 Hold at Location Country not served. 3090 Postal Code not found. 3068 Hold at Location Country code is required and must not exceed the limit of 2 characters. 3091 Hold-at-Location Postal Code not found. 3069 Invalid Hold at Location postal code/routing code input. 3092 Destination Control Statement type not allowed for selected service. 3070 Hold at Location zip is a P.O. Box - Not allowed. 3093 Destination Control Statement type is not valid. 3071 Hold at Location Postal code or routing code is required. 3094 The provided FTR Exemption or AES Citation is invalid. 3072 Hold at Location Postal/Routing code and country do not match. 3366 Origin country code must be the same as shipper Country Code. 3073 The length of the Hold at Location postal code exceeds the limit of 16 characters. 3367 Origin - Invalid streetLine 1. 3074 The length of the Hold at Location state or province exceeds the limit of 3 character. 3368 Origin - Invalid countryCode. 3075 Location Not Found. 3369 Origin - Company Name OR Person Name is required. 3076 Shipper Location Not Found. 3370 Origin - Phone Number is required. 3077 Recipient Location Not Found. 3371 Origin - Company Name must be at least 2 characters. 3078 Hold at Location Address - Location Not Found. 3372 Origin - Person Name must be at least 2 characters. 3079 Unable to process requested shipment at this time. Please try later. 3373 Origin - Phone Number is invalid. 3080 Location-Zip mismatch. 3374 Origin - Invalid State Or Province Code. 3081 Shipper Location-Zip mismatch. 3375 Origin - Invalid city. 3082 Recipient Location-Zip mismatch. 3376 Origin - Postal Code not found. 3083 Hold-at-Location Location-Zip mismatch. 3377 Origin - Invalid Postal Code Format. 3084 Postal-Country mismatch. 3378 Origin - Postal Code not Served. 3085 Shipper Postal-Country mismatch. 3379 Origin - Postal-State Mismatch. FedEx Web Services, Developer Guide 440 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3380 Origin - Postal-City Mismatch. 3403 International Broker - Postal-City Mismatch. 3381 Origin - Country not served. 3404 International Broker - Country not served. 3382 Origin - Country code is required and must not exceed the limit of 2 characters. 3405 3383 Origin - Invalid postal code/routing code input. International Broker - Country code is required and must not exceed the limit of 2 characters. 3384 Origin - P.O. Box zip. 3406 International Broker - Invalid postal code/routing code input. 3385 Origin Postal code or routing code is required. 3407 International Broker - P.O. Box zip. 3386 Origin - Postal/Routing code and country do not match. 3408 International Broker - Postal code or routing code is required. 3387 Origin - The length of the postal code exceeds the limit of 16 characters. 3409 International Broker - Postal/Routing code and country do not match. 3388 Origin - The length of the state or province exceeds the limit of 3 characters. 3410 International Broker - The length of the postal code exceeds the limit of 16 characters. 3389 Origin - Location Not Found. 3411 International Broker - The length of the state or province exceeds the limit of 3 characters. 3390 International Broker - Invalid streetLine 1. 3412 International Broker - Location Not Found. 3391 International Broker - Invalid countryCode. 3413 International Importer of Record - Invalid streetLine 1. 3392 International Broker - Invalid streetLine 1. 3414 International Importer of Record - Invalid countryCode. 3393 International Broker - Phone Number is required. 3415 International Importer of Record - Invalid Company Name. 3394 International Broker - Invalid Broker Company Name. 3416 International Importer of Record - Phone Number is required. 3395 International Broker - Invalid Person Name. 3417 International Importer of Record - Company Name must be at least 2 characters. 3396 International Broker - Phone Number is invalid. 3418 International Importer of Record - Person Name must be at least 2 characters. 3397 International Broker - Invalid State Or Province Code. 3419 International Importer of Record - Phone Number is invalid. 3398 International Broker - Invalid city. 3420 International Importer of Record - Invalid State Or Province Code. 3399 International Broker - Postal Code not found. 3421 International Importer of Record - Invalid city. 3400 International Broker - Invalid Postal Code Format. 3422 International Importer of Record - Postal Code not found. 3401 International Broker - Postal Code not Served. 3423 International Importer of Record - Invalid Postal Code Format. 3402 International Broker - Postal-State Mismatch. 3424 International Importer of Record - Postal Code not Served. 3425 International Importer of Record - Postal-State Mismatch. FedEx Web Services, Developer Guide 441 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3426 International Importer of Record - Postal-City Mismatch. 3448 Printed Label of Origin - Postal-State Mismatch. 3427 International Importer of Record - Country not served. 3449 Printed Label of Origin - Postal-City Mismatch. 3428 International Importer of Record - Country code is required and must not exceed the limit of 2 characters. 3450 Printed Label of Origin - Country not served. 3451 3429 International Importer of Record - Invalid postal code/routing code input. Printed Label of Origin - Country code is required and must not exceed the limit of 2 characters. 3430 International Importer of Record - P.O. Box zip. 3452 Printed Label of Origin - Invalid postal code/routing code input. 3431 International Importer of Record - Postal code or routing code is required. 3453 Printed Label of Origin - P.O. Box zip. 3432 International Importer of Record - Postal/Routing code and country do not match. 3454 Printed Label of Origin - Postal code or routing code is required. 3433 International Importer of Record - The length of the postal code exceeds the limit of 16 characters. 3455 Printed Label of Origin - Postal/Routing code and country do not match. 3456 Printed Label of Origin - The length of the postal code exceeds the limit of 16 characters. 3434 International Importer of Record - The length of the state or province exceeds the limit of 3 characters. 3457 Printed Label of Origin - The length of the state or province exceeds the limit of 3 characters. 3435 International Importer of Record - Location Not Found. 3458 Printed Label of Origin - Location Not Found. 3436 Printed Label of Origin - Invalid streetLine 1. 3459 Hold at Location in Special Services Requested - Invalid streetLine 1. 3437 Printed Label of Origin - Invalid countryCode. 3460 Hold at Location in Special Services Requested - Invalid countryCode. 3438 Printed Label of Origin - Invalid streetLine 1. 3461 Hold at Location in Special Services Requested - Invalid streetLine 1. 3439 Printed Label of Origin - Phone Number is required. 3462 Hold at Location in Special Services Requested - Phone Number is required. 3440 Printed Label of Origin - Company Name must be at least 2 characters. 3463 3441 Printed Label of Origin - Person Name must be at least 2 characters. Hold at Location in Special Services Requested - Company Name must be at least 2 characters. 3442 Printed Label of Origin - Phone Number is invalid. 3464 3443 Printed Label of Origin - Invalid State Or Province Code. Hold at Location in Special Services Requested - Person Name must be at least 2 characters. 3444 Printed Label of Origin - Invalid city. 3465 Hold at Location in Special Services Requested - Phone Number is invalid. 3445 Printed Label of Origin - Postal Code not found. 3466 Hold at Location in Special Services Requested - Invalid State Or Province Code. 3446 Printed Label of Origin - Invalid Postal Code Format. 3467 Hold at Location in Special Services Requested - Invalid city. 3447 Printed Label of Origin - Postal Code not Served. 3468 Hold at Location in Special Services Requested - Postal Code not found. FedEx Web Services, Developer Guide 442 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3469 Hold at Location in Special Services Requested - Invalid Postal Code Format. 3489 COD Recipient in Special Services Requested - Invalid State Or Province Code. 3470 Hold at Location in Special Services Requested - Postal Code not Served. 3490 COD Recipient in Special Services Requested - Invalid city. 3471 Hold at Location in Special Services Requested - Postal-State Mismatch. 3491 COD Recipient in Special Services Requested - Postal Code not found. 3472 Hold at Location in Special Services Requested - Postal-City Mismatch. 3492 COD Recipient in Special Services Requested - Invalid Postal Code Format. 3473 Hold at Location in Special Services Requested - Country not served. 3493 COD Recipient in Special Services Requested - Postal Code not Served. 3474 Hold at Location in Special Services Requested - Country code is required and must not exceed the limit of 2 characters. 3494 COD Recipient in Special Services Requested - Postal-State Mismatch. 3495 COD Recipient in Special Services Requested - Postal-City Mismatch. 3475 Hold at Location in Special Services Requested - Invalid postal code/routing code inpu. 3496 COD Recipient in Special Services Requested - Country not served. 3476 Hold at Location in Special Services Requested - P.O. Box zip. 3497 3477 Hold at Location in Special Services Requested - Postal code or routing code is required. COD Recipient in Special Services Requested - Country code is required and must not exceed the limit of 2 characters. 3478 Hold at Location in Special Services Requested - Postal/Routing code and country do not match. 3498 COD Recipient in Special Services Requested - Invalid postal code/routing code input. 3499 COD Recipient in Special Services Requested - P.O. Box zip. 3479 Hold at Location in Special Services Requested - The length of the postal code exceeds the limit of 16 characters. 3500 COD Recipient in Special Services Requested - Postal code or routing code is required. 3480 Hold at Location in Special Services Requested - The length of the state or province exceeds the limit of 3 characters. 3501 COD Recipient in Special Services Requested - Postal/Routing code and country do not match. 3481 Hold at Location in Special Services Requested - Location Not Found. 3502 COD Recipient in Special Services Requested - The length of the postal code exceeds the limit of 16 characters. 3482 COD Recipient in Special Services Requested - Invalid streetLine 1. 3503 3483 COD Recipient in Special Services Requested - Invalid countryCode. COD Recipient in Special Services Requested - The length of the state or province exceeds the limit of 3 characters. 3484 COD Recipient in Special Services Requested - Invalid streetLine 1. 3504 COD Recipient in Special Services Requested - Location Not Found. 3485 COD Recipient in Special Services Requested - Phone Number is required. 3505 3486 COD Recipient in Special Services Requested - Company Name must be at least 2 characters. COD Recipient in Shipment Special Services Requested - Contact or Company name is required. 3506 COD Recipient in Shipment Special Services Requested - Invalid countryCode. 3487 COD Recipient in Special Services Requested - Person Name must be at least 2 characters. 3507 3488 COD Recipient in Special Services Requested - Phone Number is invalid. COD Recipient in Special Services Requested - Invalid streetLine 1 for Package {PACKAGE_INDEX}. FedEx Web Services, Developer Guide 443 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3508 COD Recipient in Special Services Requested - Phone Number is required for Package {PACKAGE_INDEX}. 3526 COD Recipient in Special Services Requested - The length of the state or province exceeds the limit of 3 characters. 3509 COD Recipient in Special Services Requested - Company Name must be at least 2 characters for Package {PACKAGE_INDEX}. 3527 COD Recipient in Special Services Requested - Location Not Found for Package# {PACKAGE_INDEX}. 3510 COD Recipient in Special Services Requested - Person Name must be at least 2 characters for Package {PACKAGE_INDEX}. 3530 Invalid credit card transaction detail data. 3531 MPS is not allowed with authorized credit card shipments. 3511 COD Recipient in Special Services Requested - Phone Number is invalid for Package {PACKAGE_INDEX}. 3532 Only U.S. domestic shipments are allowed with authorized credit card shipping. 3512 COD Recipient in Special Services Requested - Invalid State Or Province Code. 3533 Electronic Trade Documents are not available for domestic shipments. 3513 COD Recipient in Special Services Requested - Invalid city. 3534 Electronic Trade Documents request are not supported with future day shipments. 3514 COD Recipient in Special Services Requested - Postal Code not found. 3535 Customer documents cannot be requested for return. Only FedEx generated documents can be returned. 3515 COD Recipient in Special Services Requested - Invalid Postal Code Format. 3536 Electronic Trade Document file type or name is invalid. 3516 COD Recipient in Special Services Requested - Postal Code not served. 3537 Number of Electronic Trade Documents attached exceed the maximum allowed. 3517 COD Recipient in Special Services Requested - Postal-State Mismatch. 3538 3518 COD Recipient in Special Services Requested - Postal-City Mismatch. Customer documents or request to generate shipping documents is required to process a shipment with Electronic Trade Document request. 3519 COD Recipient in Special Services Requested - Country not served. 3539 Uploaded Electronic Trade Document Type is not valid. 3520 COD Recipient in Special Services Requested - Country code is required and must not exceed the limit of 2 characters. 3540 Estimated duties and taxes are returned only for shipping charges payment type of shipper. 3541 Electronic Trade Documents are not allowed with the special services selected. 3521 COD Recipient in Special Services Requested - Invalid postal code/routing code input. 3542 ETD not allowed with document shipments with no commercial value. 3522 COD Recipient in Special Services Requested - P.O. Box zip. 3543 Document {DOC_INDEX} size exceeds maximum allowed. 3523 COD Recipient in Special Services Requested - Postal code or routing code is required. 3544 3524 COD Recipient in Special Services Requested - Postal/Routing code and country do not match. Customer provided CI is not allowed when the original FedEx generated shipping document request has a CI/PI. 3545 3525 COD Recipient in Special Services Requested - The length of the postal code exceeds the limit of 16 characters. Customer should attach at least one CI or PI or select option to create FedEx generated CI or PI to ship ETD. 3601 At least one freight shipment line item is required. FedEx Web Services, Developer Guide 444 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3602 Freight shipment line item {FREIGHT_SHIPMENT_LINE_ITEM} -commodity description is required. 3931 Invalid date format at ready date time. 3932 Invalid date format at latest pickup date time. 3603 Freight shipment role type invalid or missing. 3938 Ready date, pickup date and the shipment date are not the same. 3604 Freight account payment type invalid or missing. 3939 Invalid ready date time for commercial pickup. 3605 Account number is not valid for the role selected. 3940 For commercial pickup the ready date time should be before the business close time. 3606 Freight payment type is not valid for the role selected. 3941 Ready date should be after the current date. 3900 Invalid Recipient Customs Tax ID. 3942 Courier instructions field should not be more than 30 characters. 3901 Invalid Tax ID Type. 3943 Business close time does not contain a time between 08:00am and 06:00pm. 3902 Description not valid for documents with value. 3944 The requested pickup date is not a business day. 3903 Commodity customs value cannot be greater than zero if commodity description is Correspondence/No Commercial Value. 3945 The requested pickup date may not be more than 14 days from today. 3904 Commodity unit value cannot be greater than zero if commodity description is Correspondence/No Commercial Value. 3946 Call tag may only be canceled by the shipper who originally requested it. 3947 Unable to retrieve details: confirmation number not found. 3905 A commercial invoice is not allowed if the country of manufacture is XX. 3948 Unable to cancel call tag; it has been already canceled. 3906 Electronic Commercial Invoice not allowed for non-dutiable document shipment. 3949 The Ground system indicated the call tag cannot be canceled. 3907 Invalid Customs Value. 3950 Invalid time stamp. 3908 Weight is required for commodity {COMMODITY_INDEX}. 3951 Invalid special service option type at package {PACKAGE_INDEX}. 3909 Customs Value cannot be zero for commodity {COMMODITY_INDEX}. 3952 Confirmation number required to cancel a tag transaction. 3910 Invalid description of contents for commodity {COMMODITY_INDEX}. 3953 Invalid payment type. 3911 Quantity is required for commodity {COMMODITY_INDEX}. 3954 Past Cut Off Time. 3913 Unit value is required for commodity {COMMODITY_INDEX}. 3955 Cannot schedule pickup beyond 1 working day. 3914 Unit of measurement required for commodity {COMMODITY_INDEX}. 3956 Cannot schedule pickup request for previous day. 3928 Pickup date time is required. 3957 Customer reference number contains an invalid character. 3929 Invalid ready date time, must contain a time between 08:00am and 06:00pm. 3958 Duplicate cancel request. 3930 Total insured value for express tag should be between 0 and 50000. FedEx Web Services, Developer Guide 445 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 3959 No dispatch found for this location. 4010 Invalid Physical Packaging. 3960 Zip state mismatch. 5010 Account Number Is Empty or NULL. 3961 Incomplete recipient data. 5011 Meter Number Is Empty or NULL. 3962 Dispatch already exists. 5012 Account Number Not In database. 3963 Package Count exceeds the maximum allowed. 5013 FedEx account number and meter inconsistent 3964 Difference between Ready Time and Business Close / Last Pickup Time is too small. 5014 Invalid or blank package count. 3965 The payment details used to schedule the ground call tag is required for cancellation. 5015 weight.value missing or invalid 3966 Destination address is not provided/ invalid. 5016 No Contact Name specified. 3967 Invalid Company Close Time. 5017 Invalid Company close time. 3970 PickupDetail Request Type - Pickup Request Type is invalid. 5018 Unable To Pickup before Close time. 3971 PickupDetail Request Source - Pickup Request Source is invalid. 5019 Too late for pickup. 3975 Duplicate sequence or Missing sequence number in the package list. 5020 No pickup service today. 3976 Harmonized code is invalid. 5021 Ready Date is not available for Pickup. 4000 Invalid or blank FICE type. 5022 Unable to process request 4001 FICE license or permit number is required. 5023 Bad transaction number 4002 FICE license or permit number expiration date is invalid. 5024 Bad Address; it is Empty or NULL. 4003 Document shipment is not allowed with FICE. 5025 Bad City; Field is empty or null. 4004 Invalid service type selected for FICE shipment. 5026 State field is empty or null. 4005 FICE license or permit number is not required. 5027 Missing or invalid postalCode 4006 FICE license or permit number expiration date is not required. 5028 Invalid ready time. 4007 FICE entry number is required. 5029 Missing or invalid countryCode 4008 FICE entry number isn't required. 5030 Invalid Zip Code. 4009 FICE Foreign Trade Zone code is required. 5031 Destination Zip Code is Invalid. FedEx Web Services, Developer Guide 446 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 5032 Destination Zip Code is an Unserved P.O. Box 504F Pickup was canceled - cannot update. 5033 Destination Zip Code is a served P.O. Box. 5050 Pickup is over 2 days old - cannot update. 5034 Same-day service not available to this location. 5051 Remote location - call FedEx. 5035 Service is not available to this location. 5052 Database failure. 5036 Too Late For PickUp Service. Drop off available. 5053 Unable to process request 5037 CSS Service is not allow to this location. 5054 Dispatch already exists. 5038 Dangerous goods are not allow to this location. 5055 Intra-country service not available. 5039 Dry Ice is not allow to this location. 5056 Pickup Date too far in future 5040 No HAL service to this location. 5057 Invalid date. 5041 Original Zip Code is a P.O. Box. 5058 Past Express Freighter cutoff - use international priority. 5042 Invalid Pickup Time. 5059 Cannot schedule dispatch for more than a given number of working days. 5043 Destination Zip Code is out of Delivery Area. 505A State or zip code change not allowed. 5044 Ready Time after Cutoff Time. 505B Must reschedule to change pickup day. 5045 Unable to process request 505C Location is missing or invalid 5046 Missing Authentication Flag. 505D Carrier missing or invalid 5047 Missing or invalid confirmation number 505E Courier remarks missing or invalid. 5048 Invalid Location ID. 505F Invalid package width 5049 No Dispatch found for this account 5060 Invalid package length 504A Invalid Customer Name 5061 Invalid package height 504B Invalid phone number. 5062 Invalid Service Type 504C Previous day pickup, cannot cancel or update. 5063 Invalid Truck Type 504D Pickup already made, cannot cancel or update. 5064 Invalid Trailer Size 504E General update error. 5065 Invalid Booking Number ( Only Numeric ). FedEx Web Services, Developer Guide 447 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 5066 Invalid Girth. ( This is returned by P2D ). 5083 Recipient streetLine missing. 5067 Invalid Dept, Floor, Suite Code. 5084 Recipient city missing 5068 Max Weight allowed Per Piece is 2200 for F1/F2/F3 as per P2D 5085 Invalid Recipient State. ExpressTag Only. 5069 More then 1 record matches phone number from 1source. IVRDispatch only. 5087 Recipient countryCode missing 5070 1 Source cannot find account number. IVRDispatch only. 5088 Neither Recipient Company Name nor Contact Name populated. ExpressTag Only. 5071 Unable to call Rate. IVRDispatch only. 5089 Postal code and state/province mismatch. 5072 Unable to call 1source. IVRDispatch only. 508A Recipient Zip State Combination doesn't match. ExpressTag Only. 5073 Response from P2D is too Large. IVRDispatch only. 508B Duplicate cancel request. 5074 Unable to connect to Ursa Error. 508C Cannot schedule a Pickup Request for the previous day. 5075 Incomplete Date Returned from P2D. ExpressTag Only. 508D Same day Express Tag not available at pickup address 5076 Incomplete Time Returned from P2D. ExpressTag Only. 508E Saturday Delivery not available for standard overnight. 5077 Package Count is invalid. ExpressTag Only. 508F PRP Indicator is set but PRP not populated. IVR Dispatch Only. 5078 Exp Tag Service Code is invalid. ExpressTag Only. 5090 Sat. Hold at Loc. not available for Standard Overnight 5079 Both Contact Name and Company Name are blank. ExpressTag Only. 5091 Max Weight for Letter Exceeded. 507A Currency Code must be USD. 5092 Special services conflict 507B Declared Value is too large, blank, or not valid. 5093 Difference between LatestPickupTime and ReadyTime too small 507C Weight UOM must be LBS. 509D Unique UserId missing or invalid 507D Bad RMA Number. 509E softwareId missing or invalid 507E Bad Pay Type. 50A0 Unable to process request 507F Pay Type is Other but Payor AcctNbr is blank . 50A2 Unable to process request 5080 P2D Returns a different Date then requested. ExpressTag Only. 50A3 Invalid FedEx account number 5081 Average Package Weight Exceeds Service Code Limit. ExpressTag Only. 50A4 Invalid meter number 5082 Invalid Recipient Phone Number. ExpressTag Only. 50A6 Invalid courierRemarks FedEx Web Services, Developer Guide 448 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 50A7 Missing or invalid Ground shipper number 5106 Unable to schedule pickup 50A8 Unable to process request 5107 Package access needed 50A9 Unable to process request 5108 Unable to process request 50AA Unable to process request 5109 Unable to process request 50AB Unable to process request 510A softwareRelease missing or invalid 50AC Unable to process request 510B clientDetail missing 50AD Postal code and country do not match 510C dimensions.units missing or invalid 50AE Country not served 510D weight.units missing or invalid 50AF Unable to process request 510E region code missing or invalid. 50B0 Unable to process request 510F address missing or Invalid. 50B1 Unable to process request 5110 callCenterId missing or invalid 50B2 Client softwareId and softwareRelease not supported 5111 streetLine missing 50B4 PickupRequestType array missing or empty 5112 lastAccessTime missing or invalid 50B5 PickupRequestType array contains an invalid value 5113 weight missing 50B6 Express Tag not available for this address 5114 weight.value missing or invalid 5094 Prohibited shipper State Code. 5115 getFurtherLocationDescription.type is missing or invalid 5095 Prohibited Recipient State Code. 5116 getFurtherLocationDescriptions.description is missing or invalid. 5100 Unable to process request 5117 undefined serviceType 5101 Unable to process request 5118 Service not available to this location. 5102 Unable to process request 5119 invalid serviceType 5103 Unable to process request 511A invalid packagingType 5104 Unable to process request 511B invalid pickupType 5105 Pickup more than 4 days old 511C Unable to process request FedEx Web Services, Developer Guide 449 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 511D account not Ground enabled 5134 Cargo account in active status 511E Unable to process request 5135 Cargo account in inactive status 511F state code and postal does not match 5136 Cargo account in inactive status - cannot dispatch 5120 invalid carrier for service 5137 numberOfBusinessDays is invalid 5121 Recipient address missing 5138 undefined packagingType 5122 PackageDetails array must contain at least one item 5139 Invalid countryRelationships value. 5123 Package weight value missing or invalid 5145 Pickup Date not a working day. 5124 Package weight units missing or invalid 5146 Same Day Metro service not enabled. 5125 Package insuredValue missing or invalid 5147 Max weight for PO service is 31 KG per package. 5126 Package insuredValue units missing or invalid 5148 A pickup already exists 5127 Total insuredValue value missing or invalid 5149 Unable to create ground account number. 5128 Total insuredValue value missing or invalid 514A No tracking or account number provided for ground pickup for return. 5129 Package insuredValue value missing 514B Invalid tracking id. 512A Requested Account does not match Existing Account 5150 Unable to process request 512B payor accountNumber is invalid 5151 Unable to process request 512C paymentType is invalid 5152 No reason text specified 512D payor accountNumber is missing 5153 Pickup request has been assigned. Cannot cancel pickup 512E paymentType is missing 5154 Account number, shipment type, and shipment terms do not match 512F payor is missing 5155 Poison not allowed in, out, or within Mexico 5130 TagDetail is missing 5156 Poison not allowed in, out, or within Mexico for shipment {PARAM_ID_1} 5131 Service and Packaging are required for Express Tag 5157 Invalid role 5132 Service level invalid 5158 Invalid email for shipment {PARAM_ID_1} 5133 Could not communicate with freight service 5159 Zip code must be no more than 5 characters FedEx Web Services, Developer Guide 450 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 515A Canada postal codes must be no more than 6 characters 5171 Invalid zip code for COD shipments 515B Pickup has been combined with a previous request 5172 515C User to call customer service Intra Canada shipment not available for {PARAM_ID_2} shipments for shipment {PARAM_ID_1} 515D Invalid pieces for shipment {PARAM_ID_1} 5173 Intra Mexico shipment not available for shipment {PARAM_ID_1} 515E Invalid total handling units for shipment {PARAM_ID_1} 5174 Intra service not available for shipments in overseas states for shipment {PARAM_ID_1} 515F Invalid weight for shipment {PARAM_ID_1} 5175 Service not available for shipments from overseas states to Canada for shipment {PARAM_ID_1} 5160 Guaranteed service not available for this route for shipment {PARAM_ID_1} 5176 Canada to US is not allowed for {PARAM_ID_2} shipments for shipment {PARAM_ID_1} 5161 PO number is not specified 5177 Mexico to US is not allowed for {PARAM_ID_2} shipments for shipment {PARAM_ID_1} 5162 Freeze protection not allowed for shipment {PARAM_ID_1} 5178 Canada to Mexico shipments are not allowed for shipment {PARAM_ID_1} 5163 Hazmat not allowed to Mexico for shipment {PARAM_ID_1} 5179 Mexico to Canada shipments are not allowed for shipment {PARAM_ID_1} 5164 Invalid origin country 517A Account address does not match 5165 Invalid origin postal code 517B Pickup time is past service center cutoff time 5166 Invalid origin city 517C The pickup has been assigned to a driver, cannot update pickup 5167 Invalid origin state 517D Additional documentation needed for pickups in D.C. 5168 Invalid origin address 517E Shipment {PARAM_ID_1} is invalid 5169 No service center exists for pickup location 517F Pickup date is a Canadian holiday or weekend 516A Invalid destination country for shipment {PARAM_ID_1} 5180 Pickup date is a US holiday or weekend 516B Invalid destination postal code for shipment {PARAM_ID_1} 5181 Pickup date is in the past 516C Invalid payment terms 5182 Close time is prior to 1200 516D Pickups in the Washington D.C. area require 1 day advance notice. 5183 Dock close time is before pickup time 516E The required international shipping forms must be presented to driver at time of pickup. 5184 Pickup time is less than 90 minutes before dock close time 516F No service center exists for destination location for shipment {PARAM_ID_1} 5185 Invalid origin contact name 5170 Pickups from Mexico to Puerto Rico are not allowed for shipment {PARAM_ID_1} 5186 Dock close time is before current service center time FedEx Web Services, Developer Guide 451 Appendix O Error Code Messages Pickup Service Pickup Service Code Message Code Message 5187 Service center time is less than 90 minutes from dock close time 530D Missing or Invalid Phone Number on Cancel request. 5188 Service center time is less than 120 minutes from dock close time 530E Missing or Invalid Account Number on Cancel request. 5189 Company Name or Account Number required 530F Unable to process history detail request. 518A Begin Date missing or invalid 5310 Unable