Batch File Shipping: UPS

Batch File Shipping Help
File Name	File Format	Date Created	Download
Sample File		07/11/2010	Download

Batch File Shipping Help

Batch File Shipping enables you to create up to 250 shipments using a .csv (comma separated value) or .ssv (semicolon separated value) file format. The origin address must be the same for all the shipments but the destination addresses can be different.

Batch File Shipping only supports single piece shipments where the payment method is either by UPS Shipper Account (prepaid) or Third Party. After confirming the return to address and payment method, you can ship your packages. Prior to processing your file, verify the printer setting. When the process is complete, you will get an indication of how many packages were successfully processed.

The table below contains a sample file for your reference.

File Name

File Format

Date Created

Download

Sample File

07/11/2010

Download

Batch File Import Format

Note: The import file uses a comma/semicolon as the field delimiter. The import file must include the comma/semicolon delimiter, even for optional fields. Column headers should not be included.

If a particular record fails validation during the import, the system will create an error file with the records that the system could not import. Review the report and make any corrections necessary. Once the errors have been resolved, try the import process again.

Batch File Import Format
The Batch File Import format contains a .csv/.ssv extension.
Field Name	Field Type	Maximum Field Length	Required	Valid Values
Contact Name	Alphanumeric	35	Yes (for an international movement or a UPS Next Day Air Early service)	Name of recipient (# entered in front of the first field results in an error)
Company or Name	Alphanumeric	35	Yes	Company or name of recipient
Country	Alphanumeric	2	Yes	Recipient's country (See Country or Territory Code table for valid codes.)
Address 1	Alphanumeric	35	Yes	Address 1 for recipient (required)
Address 2	Alphanumeric	35	No	Address 2 for recipient (optional)
Address 3	Alphanumeric	35	No	Address 3 for recipient (optional)
City	Alphanumeric	30	Yes	Recipient's city
State/Province/Other	Alphanumeric	30	Conditional	Required for certain destination countries. See State/Province code table for valid codes.
Postal Code	Alphanumeric	10	Conditional	Required for certain destination countries.
Telephone	Alphanumeric	15	Conditional	Required for international destinations and UPS Next Day Air Early service.
Extension	Alphanumeric	5	No	Recipient's telephone extension
Residential Indicator	0/1	1	No	1=Residential; 0=Commercial
E-mail address	Alphanumeric	50	No	Recipient's e-mail address
Packaging Type	Alphanumeric	2	Yes	See Packaging Type table for valid codes.
Customs Value	Numeric	15	Conditional	Required from US to CA and US to PR movements. Currency defaults to USD. Decimals allowed.
Weight	Numeric	5	Conditional	Required for a packaging type of Other Packaging = 2. Weights are accepted optionally for a packaging type of Letter/Envelope. If you use commas in numeric fields, such as weights (10,0) they would have to encase that field in double - quotation marks.
Length	Numeric	4	No	Defaults to inches for US/PR; centimeters everywhere else. CA has choice between inches and centimeters.
Width	Numeric	4	No	Defaults to inches for US/PR; centimeters everywhere else. CA has choice between inches and centimeters.
Height	Numeric	4	No	Defaults to inches for US/PR; centimeters everywhere else. CA has choice between inches and centimeters.
Unit of Measure	LB/KG	2		Defaults to pounds/lbs. (US/PR) or kilograms/kgs. CA has choice between lbs./kgs.
Description of Goods	Alphanumeric	35	Conditional	Conditionally required when Ship to/Ship from countries or territories are not the same.
Documents of No Commercial Value	0/1	1	No	Indicates the shipment does not contain any dutiable items.
GNIFC (Goods not in Free Circulation)	0/1	1	Conditional	Required for movements within the EU when the goods are dutiable.
Declared Value	Numeric	7	No	Must be less than 1000 USD or local equivalent if entered. Denominaton will default to the currency of the shipment origin country. UPS's liability for loss or damage to a package. No decimals allowed.
Service	Numeric	2	Yes	See Service table for valid values.
Delivery Confirmation	Alphanumeric	1	No	See Delivery Confirmation table for valid values.
Shipper Release/Deliver Wthout Signature	0/1	1	No	A shipper may request to UPS release a package on the first delivery attempt without a signature. UPS will not be liable to shippers or third parties for any damages arising from the release of the package. (Not supported outside of US)
Return of Document	0/1	1	No	Only used for Poland to Poland movements.
Deliver on Saturday	0/1	1	No	Available with select services. Refer to service guide for additional information.
UPS Carbon Neutral	0/1	1	No	Request the option to offset the climate impact of your shipment.
Large Package	0/1	1	No	Applied when length plus girth (2 * width) + (2* height) combined exceeds 118 inches, but is less than 157 inches. Surcharge accessed. (Outside of US, large package limit is 400cm.)
Additional Handling	0/1	4	No	For US: Applied when an article is encased in an outside shipping container made of metal or wood, packages exceed 70 lbs. or 32 kg., longest side exceeds 150cm. Refer to service guide for additional information. Outside of US: If weight exceeds 32 kg. or the longest side exceeds 150cm then additional handling will be automatically supplied.
Reference 1	Alphanumeric	35	No	Used to record information about a package.
Reference 2	Alphanumeric	35	No	Used to record information about a package.
Reference 3	Alphanumeric	35	No	Only used in UPS CampusShip package level packaging (US, PR, and CA).
E-mail Notification 1 - Address	Alphanumeric	50	No	E-mail address that will receive the specified notification (ship, exception, or delivery).
E-mail Notification 1 - Ship	0/1	1	No	E-mail notification sent when the package is shipped.
E-mail Notification 1 - Exception	0/1	1	No	E-mail notification sent when there has been an exception in delivering the package.
E-mail Notification 1 - Delivery	0/1	1	No	E-mail notification sent upon package delivery.
E-mail Notification 2 - Address	Alphanumeric	50	No	E-mail address that will receive the specified notification (ship, exception, or delivery).
E-mail Notification 2 - Ship	0/1	1	No	E-mail notification sent when the package is shipped.
E-mail Notification 2 - Exception	0/1	1	No	E-mail notification sent when there has been an exception in delivering the package.
E-mail Notification 2 - Delivery	0/1	1	No	E-mail notification sent upon package delivery.
E-mail Notification 3 - Address	Alphanumeric	50	No	E-mail address that will receive the specified notification (ship, exception, or delivery).
E-mail Notification 3 - Ship	0/1	1	No	E-mail notification sent when the package is shipped.
E-mail Notification 3 - Exception	0/1	1	No	E-mail notification sent when there has been an exception in delivering the package.
E-mail Notification 3 - Delivery	0/1	1	No	E-mail notification sent upon package delivery.
E-mail Notification 4 - Address	Alphanumeric	50	No	E-mail address that will receive the specified notification (ship, exception, or delivery).
E-mail Notification 4 - Ship	0/1	1	No	E-mail notification sent when the package is shipped.
E-mail Notification 4 - Exception	0/1	1	No	E-mail notification sent when there has been an exception in delivering the package.
E-mail Notification 4 - Delivery	0/1	1	No	E-mail notification sent upon package delivery.
E-mail Notification 5 - Address	Alphanumeric	50	No	E-mail address that will receive the specified notification (ship, exception, or delivery).
E-mail Notification 5 - Ship	0/1	1	No	E-mail notification sent when the package is shipped.
E-mail Notification 5 - Exception	0/1	1	No	E-mail notification sent when there has been an exception in delivering the package.
E-mail Notification 5 - Delivery	0/1	1	No	E-mail notification sent upon package delivery.
E-mail Message	Alphanumeric	150	No	Additional messaging or special instructions to be provided in the e-mail notification.
E-mail Failure Address	Alphanumeric	50	No	E-mail address that will receive a notification if the e-mail notification to the recipient failed delivery.
Lithium Ion Alone	0/1	1	No	If the package is contained with Lithium Ion Alone battery the column will display 1 (yes)otherwise it will be empty or 0
Lithium Ion In Equipment	0/1	1	No	If the package is contained with Lithium Ion In Equipment battery the column will display 1 (yes)otherwise it will be empty or 0
Lithium Ion With_Equipment	0/1	1	No	If the package is contained with Lithium Ion With Equipment battery the column will display 1 (yes)otherwise it will be empty or 0
Lithium Metal Alone	0/1	1	No	If the package is contained with Lithium Metal Alone battery the column will display 1 (yes)otherwise it will be empty or 0
Lithium Metal In Equipment	0/1	1	No	If the package is contained with Lithium Metal In Equipment battery the column will display 1 (yes)otherwise it will be empty or 0
Lithium Metal With Equipment	0/1	1	No	If the package is contained with Lithium Metal With Equipment battery the column will display 1 (yes)otherwise it will be empty or 0

NOTE: If more than 3 Lithium Battery fields are selected, the Shipment is rejected, and the error message is added to the error file.

Field Name	Field Type	Maximum Field Length	Required	Valid Values
Weekend Commercial Delivery	0/1	1	No	Available with select services (Refer to service guide for additional information.)

The Import Batch File Processing format contains a field named Packaging Type. The valid codes for this field are:

Packaging Type Codes
1=UPS Letter/Envelope
4=UPS PAK
3=UPS Tube
S=UPS Express Box (Small)
M=UPS Express Box (Medium)
L=UPS Express Box (Large)
21=UPS Box
25=UPS 10 KG Box
24=UPS 25 KG Box
2=Other Packaging
30=Pallet (valid only for PL to PL)

The Import Batch File Processing format contains a field named Service. The valid 2-digit codes for this field are:

Service Type Codes
01 = Next Day Air
02 = 2nd Day Air
03 = Ground
07 = International Express
08 = International Expedited
11 = International Standard
12 = 3 Day Select
13 = Next Day Air Saver
14 = Next Day Air Early
54 = International Express Plus
59 = 2 Day Air A.M
64 = UPS Express NA1
65 = UPS Saver
70 = UPS Access Point Economy
74 = UPS Express 12:00
82 = UPS Today Standard
83 = UPS Today Dedicated Courier
84 = UPS Today Intercity
85 = UPS Today Express
86 = UPS Today Express Saver
92 = SurePost Standard Parcel (not supported)
93 =SurePost Parcel Select
94 = SurePost Bound Printed Matter
95 = SurePost Media Mail

The Import Batch File Processing format contains a field named Delivery Confirmation. If you do not want delivery confirmation leave the field blank, otherwise enter a valid code. The valid codes for this field are: