The table below lists all freight shipment data fields in the Freight Shipment Information, Freight Commodity, COD Remit Information, Freight Reference Number, Shipper Letter of Instruction, and Intermediate Consignee categories that UPS WorldShip can import or export. For data field descriptions in the Shipment Information, Ship To, Ship From, Package, Third Party, Third Party (Receiver), International Documentation, Goods, Importer, Producer, Ultimate Consignee, Dangerous Goods Data, LTL/TL Line Item, Packing List, User Forms, and Freight Handling Unit categories, see Shipment Data Field Descriptions; however, all the fields in the Dangerous Goods Data category are export only.
Notes:
Use only a Western character set to create records for an import file. If you use any other character set to create the field names and data in a record, the import fails for that record.
If you use Character Map (a Windows function) to insert special characters into the data that you plan to import, use only characters that belong to the Windows: Western character set. If you use another character set, the characters are converted to the Windows: Western character set and may not appear as you want.
Table Legend:
The Length column indicates the maximum number of characters you can type for the field.
The Type column indicates A for alphabetic characters, N for numeric characters, and S for special characters (such as, press the Shift and 4 keys to type $). For example, A/N/S means that you can type alphabetic, numeric, and special characters.
The I/E column indicates if the field applies to import (I), export (E), or both import and export (I/E) maps.
The Exceptions and Notes column provides additional information, such as valid values, field formats, or links to additional information.
Category/Field |
Length |
Type |
I/E |
Exceptions and Notes |
Freight Shipment Information |
||||
Custom Clearance |
1 |
A |
I/E |
Y or N. |
Custom Value Option |
1 |
A |
I/E |
Y or N. |
Custom Value Amount |
20 |
N |
I/E |
|
Declared/Insured Value |
1 |
A |
I/E |
Y or N. |
Declared/Insured Amount |
9 |
N |
I/E |
99999.99. |
Declared/Insured Currency |
3 |
N |
I/E |
|
Call Before Delivery |
1 |
A |
I/E |
Y or N. |
Delivery To Door |
1 |
A |
I/E |
Y or N. |
COD Option |
1 |
A |
I/E |
Y or N. |
COD Amount |
20 |
N |
I/E |
|
COD Payment Method |
50 |
A/N/S |
I/E |
|
COD Payment Type |
50 |
A/N/S |
I/E |
|
BOL Format |
5 |
A/N |
I/E |
|
Email AWB/BOL Option |
1 |
A |
I/E |
Y or N. |
AWB/BOL Email 1 |
50 |
A/N/S |
I/E |
|
AWB/BOL Email 2 |
50 |
A/N/S |
I/E |
|
AWB/BOL Email 3 |
50 |
A/N/S |
I/E |
|
AWB/BOL Email 4 |
50 |
A/N/S |
I/E |
|
AWB/BOL Email 5 |
50 |
A/N/S |
I/E |
|
BOL Subject Line |
75 |
A/N/S |
I/E |
|
AWB/BOL Comments |
250 |
A/N/S |
I/E |
|
AWB/BOL Failure Email |
50 |
A/N/S |
I/E |
|
Email Notify Option |
1 |
A |
I/E |
Y or N. |
Email Notify Ship Notification 1 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Exception Notification 1 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Delivery Notification 1 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Company Name 1 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Email Notify Email Address 1 |
50 |
A/N/S |
I/E |
|
Email Notify Ship Notification 2 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Exception Notification 2 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Delivery Notification 2 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Company Name 2 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Email Notify Email Address 2 |
50 |
A/N/S |
I/E |
|
Email Notify Ship Notification 3 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Exception Notification 3 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Delivery Notification 3 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Company Name 3 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Email Notify Email Address 3 |
50 |
A/N/S |
I/E |
|
Email Notify Ship Notification 4 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Exception Notification 4 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Delivery Notification 4 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Company Name 4 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Email Notify Email Address 4 |
50 |
A/N/S |
I/E |
|
Email Notify Ship Notification 5 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Exception Notification 5 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Delivery Notification 5 Option |
1 |
A |
I/E |
Y or N. |
Email Notify Company Name 5 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Email Notify Email Address 5 |
50 |
A/N/S |
I/E |
|
Email Notify Memo |
150 |
A/N/S |
IE |
|
Email Notify Failed Email Address |
50 |
A/N/S |
I/E |
|
Include Duties and Taxes in Memo |
1 |
A |
I/E |
Y or N. |
Extreme Length |
1 |
A |
I/E |
Y or N. |
Extreme Length Longest Side |
2 |
N |
I/E |
1-99 |
Freezable Protection |
1 |
A |
I/E |
Y or N. |
Dangerous Goods Option |
1 |
A |
I/E |
Y or N. |
Dangerous Goods Emergency Contact Name |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Dangerous Goods Emergency Phone Number |
15 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Dangerous Goods Transportation Mode |
20 |
A/N |
I/E |
|
Drop-off at UPS Location |
1 |
A/N |
I/E |
Y or N. |
Drop-off Facility Name |
35 |
A/N/S |
E |
0-9; A-Z; special characters. |
Drop-off Address |
50 |
A/N/S |
E |
0-9; A-Z; special characters. |
Drop-off City |
30 |
A/N/S |
E |
0-9; A-Z; special characters. |
Drop-off State |
30 |
A |
E |
A-Z. |
Drop-off Postal Code |
9 |
A/N |
E |
0-9; A-Z. |
Drop-off Country |
50 |
A |
E |
A-Z. |
Drop-off Phone Number |
15 |
A/N/S |
E |
0-9; A-Z; special characters. |
Pickup at UPS Location |
1 |
A |
I/E |
Y or N. |
Pickup Facility Name |
35 |
A/N/S |
E |
0-9; A-Z; special characters. |
Pickup Address |
50 |
A/N/S |
E |
0-9; A-Z; special characters. |
Pickup City |
30 |
A/N/S |
E |
0-9; A-Z; special characters. |
Pickup State |
30 |
A |
E |
A-Z. |
Pickup Postal Code |
9 |
A/N |
E |
0-9; A-Z. |
Pickup Country |
50 |
A |
E |
A-Z. |
Pickup Phone Number |
15 |
A/N/S |
E |
0-9; A-Z; special characters. |
Holiday Delivery |
1 |
A |
I/E |
Y or N. |
Holiday Pickup |
1 |
A |
I/E |
Y or N. |
Inside Delivery |
1 |
A |
I/E |
Y or N. |
Inside Pickup |
1 |
A |
I/E |
Y or N. |
Lift Gate Service for Pickup |
1 |
A |
I/E |
Y or N. |
Lift Gate Service for Delivery |
1 |
A |
I/E |
Y or N. |
Liftgate Required |
1 |
A |
I/E |
Y or N. |
Limited Access Delivery |
1 |
A |
I/E |
Y or N. |
Limited Access Pickup |
1 |
A |
I/E |
Y or N. |
Residential Delivery |
1 |
A |
I/E |
Y or N. |
Residential Pickup |
1 |
A |
I/E |
Y or N. |
Saturday Delivery |
1 |
A |
I/E |
Y or N. |
Sorting and Segregating at Destination |
1 |
A |
I/E |
Y or N. |
No. Of Pieces to Sort/Segregate |
6 |
N |
I/E |
|
Weekend Delivery |
1 |
A |
I/E |
Y or N. |
Weekend Pickup |
1 |
A |
I/E |
Y or N. |
Total Volume |
5 |
N |
I/E |
|
Cubic feet Value |
5 |
N |
I/E |
|
CWT Value |
5 |
N |
I/E |
|
No. Of Handling Unit Types 1 |
4 |
N |
I/E |
|
Handling Unit Type 1 |
5 |
A |
I/E |
|
No. Of Handling Unit Types 2 |
4 |
N |
I/E |
|
Handling Unit Type 2 |
5 |
A |
I/E |
|
Drop Off |
1 |
A |
I/E |
Y or N. |
Drop-off Date |
8 |
N |
I/E |
YYYYMMDD. |
Drop-off Time |
6 |
N |
I/E |
HHMMSS. |
Special Instructions for Handling |
254 |
A/N/S |
I/E |
|
Special Instructions for Delivery |
254 |
A/N/S |
I/E |
|
Special Instructions for Pickup |
254 |
A/N/S |
I/E |
|
Pickup Date |
8 |
N |
I/E |
YYYYMMDD. |
Pickup Ready Time |
6 |
N |
I/E |
HHMMSS. |
Pickup Location Closing Time |
6 |
N |
I/E |
HHMMSS. |
PRN (Pickup Reference Number) |
20 |
N |
E |
|
Consignee Remarks |
30 |
A/N/S |
I/E |
|
Unit of Measure |
2 |
A/N |
I/E |
|
Total Weight |
7 |
N |
E |
|
Total Pieces |
4 |
N |
E |
|
PRO Number |
20 |
N |
I/E |
|
Shipment ID |
10 |
N |
I/E |
|
Countries of Original Manufacture 1 |
2 |
A |
I/E |
|
Countries of Original Manufacture 2 |
2 |
A |
I/E |
|
Countries of Original Manufacture 3 |
2 |
A |
I/E |
|
Countries of Original Manufacture 4 |
2 |
A |
I/E |
|
Countries of Original Manufacture 5 |
2 |
A |
I/E |
|
Handling Unit Weight Applies to FSHU |
1 |
A |
E |
Y or N. |
PRQ Number |
10 |
A |
E |
|
PRQ Creation Date |
8 |
N |
E |
|
Shipment Marked for Deletion |
1 |
A |
E |
Y or N. |
Required Pre-Authorization |
1 |
A |
E |
Y or N. |
Shipment Consolidated |
1 |
A |
E |
Y or N. |
Arrival Notification Charge |
9 |
N |
E |
|
C.O.D. fee |
9 |
N |
E |
|
Extreme Length Charge |
20 |
N |
E |
|
Freezable Protection Charge |
20 |
N |
E |
|
Inside Pickup/Delivery fee |
9 |
N |
E |
|
Life Gate fee |
9 |
N |
E |
|
Limited Access Charge |
20 |
N |
E |
|
Residential Pickup/Delivery fee |
9 |
N |
E |
|
Holiday/Weekend Pickup or Delivery fee |
9 |
N |
E |
|
Sorting and Segregation fee |
9 |
N |
E |
|
Hazardous Materials Charge |
9 |
N |
E |
|
Fuel Surcharge |
9 |
N |
E |
|
Remote Location fee |
9 |
N |
E |
|
Custom Manifest fee |
9 |
N |
E |
|
Border Processing fee |
9 |
N |
E |
|
High Cost Service Area Surcharge |
9 |
N |
E |
|
Deficit Rate |
9 |
N |
E |
|
Deficit Weight |
9 |
N |
E |
|
Deficit Charge |
9 |
N |
E |
|
Custom Charge |
9 |
N |
E |
|
Minimum Charge Applies |
1 |
A |
E |
Y or N. |
Shipment Total Charge |
9 |
N |
E |
|
Gross Charges |
9 |
N |
E |
|
Discount Rate |
9 |
N |
E |
|
Discounted Amount |
9 |
N |
E |
|
Amount After Discount |
9 |
N |
E |
|
Ocean Fuel Surcharge |
9 |
N |
E |
|
Total Ocean Charges |
9 |
N |
E |
|
Total Island Charges |
9 |
N |
E |
|
Declared/Insured Value Insurance Surcharge |
9 |
N |
E |
|
Guaranteed Service Surcharge |
9 |
N |
E |
|
GFP Fuel Surcharge |
9 |
N |
E |
|
GFP Residential Surcharge |
9 |
N |
E |
|
GFP Large Package Surcharge |
9 |
N |
E |
|
Pickup Notifications for LTL Shipment |
1 |
A |
I/E |
Y or N. |
Pickup Notification Reference Number |
16 |
A/N |
I/E |
|
Pickup Notification Reference Type |
50 |
A |
I/E |
|
Pickup Notification Company Name |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Pickup Notification Failed Email Address |
50 |
A/N/S |
I/E |
|
Pickup Notify Email Address 1 |
50 |
A/N/S |
I/E |
|
Pickup Notify Pickup Scheduled 1 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Driver En Route 1 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Exception 1 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Picked Up 1 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Email Address 2 |
50 |
A/N/S |
I/E |
|
Pickup Notify Pickup Scheduled 2 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Driver En Route 2 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Exception 2 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Pickup Up 2 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Email Address 3 |
50 |
A/N/S |
I/E |
|
Pickup Notify Pickup Scheduled 3 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Driver En Route 3 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Exception 3 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Picked Up 3 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Email Address 4 |
50 |
A/N/S |
I/E |
|
Pickup Notify Pickup Scheduled 4 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Driver En Route 4 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Exception 4 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Pickup Up 4 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Email Address 5 |
50 |
A/N/S |
I/E |
|
Pickup Notify Pickup Scheduled 5 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Driver En Route 5 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Exception 5 |
1 |
A |
I/E |
Y or N. |
Pickup Notify Pickup Up 5 |
1 |
A |
I/E |
Y or N. |
Freight Commodity |
||||
Description |
755 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Is Dangerous Goods Item |
1 |
A |
I/E |
Y or N. |
No of Pieces |
6 |
N |
I/E |
|
Packaging Type |
35 |
A/N |
I/E |
|
NMFC Commodity Code |
8 |
N |
I/E |
This code is the combined value of the NMFC Number and NMFC Sub fields. |
NMFC |
6 |
N |
I/E |
|
Sub |
2 |
N |
I/E |
|
Freight Class |
10 |
N |
I/E |
|
Total Weight |
8 |
N |
I/E |
|
Unit Weight |
8 |
N |
I/E |
|
Length |
3 |
N |
I/E |
|
Width |
3 |
N |
I/E |
|
Height |
3 |
N |
I/E |
|
COD Remit Information |
||||
Customer ID |
30 |
A/N/S |
I/E |
Must be unique. 0-9; A-Z; special characters. |
Company or Name |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Attention |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 1 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 2 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 3 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Country/Territory |
50 |
A/N |
I/E |
|
Postal Code |
9 |
A/N |
I/E |
No
hyphen; 0-9; Canada A-Z. |
City or Town |
30 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
State/Province/County |
30 |
A |
I/E |
|
Telephone |
15 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Fax Number |
15 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
UPS Account Number |
10 |
A/N/S |
I/E |
Six alphanumeric characters for US and Puerto Rico addresses; 10 numbers for all other addresses. |
Freight Reference Number |
||||
Reference Number Type |
50 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Reference Number Value |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Shipper Letter of Instruction |
||||
Ultimate Consignee Same as Ship To |
1 |
A |
I/E |
Y or N. |
Intermediate Consignee |
1 |
A |
I/E |
Y or N. |
Routed Export Transaction |
1 |
A |
I/E |
Y or N. |
Is Party To Transaction Related |
50 |
A |
I/E |
|
Title |
40 |
A/N/S |
I/E |
|
Telephone Number |
15 |
A/N/S |
I/E |
|
Email Address |
50 |
A/N/S |
I/E |
|
Attached Commercial Invoice |
1 |
A |
I/E |
Y or N. |
Attached Certificate of Origin |
1 |
A |
I/E |
Y or N. |
Attached Packing List |
1 |
A |
I/E |
Y or N. |
Attached Letter of Credit |
1 |
A |
I/E |
Y or N. |
Attached Banking (Sight Draft) |
1 |
A |
I/E |
Y or N. |
Attached Import License |
1 |
A |
I/E |
Y or N. |
Attached Export License |
1 |
A |
I/E |
Y or N. |
Attached Dangerous Goods Declaration |
1 |
A |
I/E |
Y or N. |
Attached GBL Option |
1 |
A |
I/E |
Y or N. |
Attached GBL Value |
25 |
N |
I/E |
|
Pro Forma Invoice |
1 |
A |
I/E |
Y or N. |
Certificate of Origin |
1 |
A |
I/E |
Y or N. |
Consular Invoice |
1 |
A |
I/E |
Y or N. |
Banking (Sight Draft) |
1 |
A |
I/E |
Y or N. |
Insurance Certificate |
1 |
A |
I/E |
Y or N. |
Export License |
1 |
A |
I/E |
Y or N. |
Special Instructions For Shipment |
150 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Extra Description |
50 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Certificate of Origin Number |
15 |
N |
I/E |
0-9. |
Duly Authorized Officer Employee |
30 |
A/N |
I/E |
0-9; A-Z. |
Intermediate Consignee |
||||
Customer ID |
30 |
A/N/S |
I/E |
Must be unique. 0-9; A-Z; special characters. |
Company or Name |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Attention |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 1 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 2 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Address 3 |
35 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Country/Territory |
50 |
A |
I/E |
|
Postal Code |
10 |
A/N |
I/E |
0-9;
A-Z. |
City or Town |
30 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
State/Province/County |
30 |
A |
I/E |
|
Telephone |
15 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Tax ID Number |
15 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Freight Packing List |
||||
Memo |
300 |
A/N/S |
I/E |
0-9; A-Z; special characters. |
Paperless Packing List Indicator |
1 |
A |
I/E |
Y or N. |
Language |
3 |
A |
I/E |
See Language Codes. |
Freight Packing List Item |
||||
No of Pieces |
5 |
N |
I/E |
99999. |
Packaging Type |
35 |
A/N |
I/E |
Valid packaging types include Pallet and user-defined package types. |
Unit Price |
9 |
N |
I/E |
999999.99. |
IS Dangerous Goods Item |
1 |
A |
I/E |
Y or N. |
Weight |
3 |
N |
I/E |
0-999. |
Length |
3 |
N |
I/E |
0-999. |
Height |
3 |
N |
I/E |
0-999. |
Width |
3 |
N |
I/E |
0-999. |
Description |
150 |
A/N/S |
I/E |
0-9; A-Z; special characters. |