POST /shipments/{version}/ship

Indicates Ship API to display the new release features in Ship API response based on Ship release.

Valid values:

• v2409

Default value: "v2409"

Default value: "application/json"

An identifier of the client/source application that is making the request.Length 512

Default value: "testing"

An identifier unique to the request. Length 32

Valid Values: city = validation will include city.Length 15

Shipment Request.

Request Container

Optional Processing.

Note: Full address validation is not performed. Therefore, it is the responsibility of the Shipping Tool User to ensure the address entered is correct to avoid an address correction fee. Valid values: nonvalidate = No street level address validation would be performed, but Postal Code/State combination validation would still be performed.

validate = No street level address validation would be performed, but City/State/Postal Code/ combination validation would still be performed.

When UPS introduces new elements in the response that are not associated with new request elements, Subversion is used. This ensures backward compatibility.

To get such elements you need to have the right Subversion. The value of the subversion is explained in the Response element Description.

Example: Itemized Charges are returned only when the Subversion element is present and greater than or equal to 1601.

Format: YYMM = Year and month of the release.

Example: 1607 = 2016 July Supported values: 1601, 1607, 1701, 1707, 1801, 1807, 2108, 2205

TransactionReference identifies transactions between client and server.

The CustomerContext Information which will be echoed during response.

Container used to allow the user to choose to print a thermal receipt.

ImageFormat Container.

Print code that determines the receipt format. Valid Codes are: EPL, SPL, ZPL and HTML.

Description of the receipt format code.

Container used to define the properties required by the user to print and/or display the UPS shipping label. Required for shipment without return service or shipments with PRL return service. Required for Electronic Return Label or Electronic Import Control Label shipments with SubVersion greater than or equal to 1707.

For Exchange Forward Shipment, by default Label will have Exchange Routing instruction Text as EXCHANGE-LIKE ITEM ONLY. If code value is: 01- EXCHANGE-LIKE ITEM ONLY, 02- EXCHANGE-DRIVER INSTRUCTIONS INSIDE.

Description of the label Instruction code.

Browser HTTPUserAgent String. This is the preferred way of identifying GIF image type to be generated. Required if /ShipmentRequest/LabelSpecificationLabelSpecification/LabelImageFormat/Code = Gif. Default to Mozilla/4.5 if this field is missing or has invalid value.

Container for the EPL2, ZPL or SPL label size. Valid for EPL2, ZPL and SPL Labels.

Width of the label image. For IN, use whole inches. For EPL2, ZPL and SPL Labels. Valid value is 4. Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.

Height of the label image. For IN, use whole inches. For EPL2, ZPL and SPL Labels. Only valid values are 6 or 8. Note: Label Image will only scale up to 4 X 6, even when requesting 4 X 8.

LabelImageFormat Container.

Label print method code determines the format in which Labels are to be generated. For EPL2 formatted Labels use EPL, for SPL formatted Labels use SPL, for ZPL formatted Labels use ZPL and for image formats use GIF. For shipments without return service the valid value is GIF, ZPL, EPL and SPL. For shipments with PRL return service, the valid values are EPL, ZPL, SPL and GIF. For UPS Premier Silver shipment only ZPL is supported.

Description of the label image format code.

Language character set expected on label. Valid values: dan = Danish (Latin-1) nld = Dutch (Latin-1) fin = Finnish (Latin-1) fra = French (Latin-1) deu = German (Latin-1) itl = Italian (Latin-1) nor = Norwegian (Latin-1) pol = Polish (Latin-2) por = Poruguese (Latin-1) spa = Spanish (Latin-1) swe = Swedish (Latin-1) ces = Czech (Latin-2) hun = Hungarian (Latin-2) slk = Slovak (Latin-2) rus = Russian (Cyrillic) tur = Turkish (Latin-5) ron = Romanian (Latin-2) bul = Bulgarian (Latin-2) est = Estonian (Latin-2) ell = Greek (Latin-2) lav = Latvian (Latin-2) lit = Lithuanian (Latin-2) eng = English (Latin-1) Default is English (Latin-1).

Shipment Container

Shipment Value Threshold Code. 01 = Shipment value is below or equals to threshold value 02 = Shipment value is above threshold value. NA = Not Applicable

User can send up to 7 days in the future with current date as day zero. Format: YYYYMMDD

AlternateDeliveryAddress Container. Alternate Delivery Address (UPS Access Point Address) required if ShipmentIndicationType is 01 or 02.

UPS Access Point ID.

Retail Location Name.

Attention Name.

Address Container.

Retail Location City.

Address Line of the Retail Location.

Retail Location state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/Canadian Province code.

If the country or territory is Ireland, the StateProvinceCode will contain the county.

Retail Location country or territory code.

If the Alternate Delivery Address country or territory is US or Puerto Rico, 5 or 9 digits are required. The character - may be used to separate the first five digits and the last four digits. If the Alternate Delivery Address country or territory is CA, then the postal code is required and must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit. Otherwise optional. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.

Payment information container for detailed shipment charges. The two shipment charges that are available for specification are Transportation charges and Duties and Taxes. It is required for non-Ground Freight Pricing shipments only.

Container for the BillReceiver billing option. This element or its sibling element, BillShipper, BillThirdParty or Consignee Billed, must be present but no more than one can be present. For a return shipment, Bill Receiver is invalid for Transportation charges.

The UPS account number. The account must be a valid UPS account number that is active.

For US, PR and CA accounts, the account must be a daily pickup account, an occasional account, a customer B.I.N account, or a dropper shipper account.

All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.

Container for additional information for the bill receiver's UPS accounts address.

The postal code for the UPS accounts pickup address. The pickup postal code was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Receiver account number pickup address postal code.

Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS accounts pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits.

The character - may be used to separate the first five digits and the last four digits.

If the UPS accounts pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit

Container for the third party billing option. This element or its sibling element, BillShipper, BillReceiver or Consignee Billed, must be present but no more than one can be present.

The UPS account number of the third party shipper. The account must be a valid UPS account number that is active.

For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account, or a drop shipper account.

All other accounts must be either a daily pickup account, an occasional account, a drop shipper account, or a non-shipping account.

Posta Elettronica Certificata (PEC) which is the recipient code for the customers certified electronic mail value.

Container for additional information for the third party UPS accounts address.

The country or territory code for the UPS accounts pickup address.

The postal code for the UPS accounts pickup address. The pickup postal code is the one that was entered in the UPS system when the account was set-up. The postal code must be the same as the UPS Bill Third Party account number pickup address postal code.

Required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS accounts pickup country or territory is US or Puerto Rico, the postal code is 5 or 9 digits.

The character - may be used to separate the first five digits and the last four digits.

If the UPS accounts pickup country or territory is CA, the postal code is 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.

Sistema Di Interscambio(SDI) which is the recipient code for the customer's interchange value or Interchange System Code

Container for the BillShipper billing option. The three payment methods that are available for the Bill Shipper billing option are alternate payment method, account number or credit card. This element or its sibling element, BillReceiver, BillThirdParty or ConsigneeBilledIndicator, must be present but no more than one can be present.

UPS account number. Must be the same UPS account number as the one provided in Shipper/ShipperNumber.

Either this element or one of the sibling elements CreditCard or AlternatePaymentMethod must be provided, but all of them may not be provided.

Credit card information container. Required if neither of the following is present:

/ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AccountNumber or /ShipmentRequest/Shipment/PaymentInformation/ShipmentCharge/BillShipper/AlternatePaymentMethod.

Credit card payment is valid for shipments without return service only.

Three or four digits that can be found either on top of credit card number or on the back of credit card. Number of digits varies for different type of credit card. Valid values are 3 or 4 digits. It is required to provide the security code if credit card information is provided and when the ShipFrom countries or territories are other than the below mentioned countries or territories. Argentina, Bahamas, Costa Rica, Dominican Republic, Guatemala, Panama, Puerto Rico and Russia.

Credit Card number.

Valid values:

• 01 = American Express
• 03 = Discover
• 04 = MasterCard
• 05 = Optima
• 06 = VISA
• 07 = Bravo
• 08 = Diners Club
• 13 = Dankort
• 14 = Hipercard
• 15 = JCB
• 17 = Postepay
• 18 = UnionPay/ExpressPay
• 19 = Visa Electron
• 20 = VPAY
• 21 = Carte Bleue

Container to hold the Credit card Billing Address. It is required to provide billing address if credit card information is provided and when the ShipFrom country or territory is the US, PR, and CA.

City of the credit card billing address.

Address Line 1 of the credit card billing address. Usually Street address information.

State or province code of the credit card billing address.

Credit card billing address country or territory code. Must be a valid UPS Billing country or territory code.

Credit card billing addressee postal code.

Format is MMYYYY where MM is the 2 digit month and YYYY is the 4 digit year. Valid month values are 01-12 and valid year values are Present Year - (Present Year + 10 years)

Alternate Payment Method.

Valid value: 01= PayPal

Only valid for forward shipments. It is not valid for Return or Import Control shipments.

This element or one of the sibling elements CreditCard or AccountNumber must be provided, but all of them may not be provided. PayPal 01: Is only valid for forward shipments. It is not valid for Return or Import Control shipments.

This element or one of the sibling elements CreditCard or AccountNumber must be provided, but all of them may not be provided.

Valid values: 01 = Transportation 02 = Duties and Taxes 03 = Broker of Choice A shipment charge type of 01 = Transportation is required.

A shipment charge type of 02 = Duties and Taxes is not required; however, this charge type is invalid for Qualified Domestic Shipments.

A Qualified Domestic Shipment is any shipment in which one of the following applies:

1. The origin and destination country or territory is the same.

2. US to PR shipment.

3. PR to US shipment.

4. The origin and destination country or territory are both European Union countries or territories and the GoodsNotInFreeCirculation indicator is not present.

5. The origin and destination IATA code is the same. 03 = Broker of Choice

Consignee Billing payment option indicator. The presence indicates consignee billing option is selected. The absence indicates one of the other payment options is selected. This is an empty tag, any value inside is ignored. This element or its sibling element, BillShipper, BillReceiver or BillThirdParty, must be present but no more than one can be present. This billing option is valid for a shipment charge type of Transportation only. Only applies to US/PR and PR/US shipment origins and destination.

This payment method allows you to bill the charges for a specified shipment to a consignee who has agreed to pay the charges. All shipping charges are billed to the consignees UPS account number including the following accessorials: Additional Handling, Delivery Area Surcharges, Delivery Change Requests, Early AM Premium, Early AM Out of Territory, Fuel Surcharge, Hazardous Material Surcharges, Large Package Surcharge, Over Max Limits, and Saturday Delivery.

Declared Value, Delivery Confirmation, On Call Pickup, Remote Area Surcharge, Saturday Pickup of Delivery fees are not passed to the consignee. These charges are billed to the shippers UPS account number.

Split Duty VAT Indicator. The presence indicates the payer specified for Transportation Charges will pay transportation charges and any duties that apply to the shipment. The payer specified for Duties and Taxes will pay the VAT (Value-Added Tax) only. This is an empty tag, any value inside is ignored. The payment method for Transportation charges must be UPS account. The UPS account must be a daily pickup account or an occasional account.

Number of Pieces. Applicable for Air Freight only

Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is over size. Applicable for UPS Worldwide Economy DDU service.

Package Service Options container.

Presence/Absence Indicator. Any value is ignored. If present, indicates that the package contains an item that needs refrigeration. Shippers account needs to have a valid contract for Refrigeration.

Unique identifier for clinical trials

Container for Declared Value.

Declared value amount.

Container for Declared Value Type.

Declared value type. Valid values:

• 01=EVS
• 02=DVS

Defaults to 01 i.e. EVS if declared value type is not provided. The user cannot specify different type of declared value for the shipment. User can either have shipper declared value (DVS) or declared value (EVS) but not both at package level.

Note: The Shipper Declared Value is applicable for forward shipments when the billing option is freight collect or third party.

Declared value Description.

Declared value amount currency type. Defaults to the non-Euro currency used in the shippers country or territory. Code must represent a currency that is a valid for Shipper country or territory.

Receiver Return Notification. Applicable for Shipment with returned service.

Container for the e-mail message.

The e-mail address where an undeliverable email message is sent if the Receiver Return Notification email is undeliverable. Defaults to FromEMailAddress. Only allowed at the first package.

The destination email address of the receiver returns notification email.

The eMails subject. Defaults to the UPS Receiver Return Notification plus the shipment ID. Only allowed at the first package.

Specifies a reference code and reference number to display in the subject of the Receiver Return Notification.

When the subject code is provided, the subject will contain the following: UPS Receiver Return Notification.

The reference code (the reference code will be mapped to the corresponding ANSI value) Plus the reference number.

The valid subject codes are:

• 01 - Shipment Reference Number 1,
• 02 - Shipment Reference Number 2,
• 03 - package Reference Number 1,
• 04 - package Reference Number 2,
• 05 - package Reference Number 3,
• 06 - package Reference Number 4,
• 07 - package Reference Number 5,
• 08 - Subject Text (Return Notification only).

If the subject code tag is not provided and the subject text is provided, the subject of the notification will be the subject text.

If the subject text is provided, and subject code tag exists, then the subject code value must be 08.

If the subject code is 08, the subject text must exist. If a subject code is provided that refers to a nonexistent reference number, the subject will default to the tracking number. Only allowed at the first package.

The email address listed in the Reply To field of the message header, includes name and e-mail address of sender. The "From" field of the message header contains pkginfo@ups.com. Only allowed at the first package.

User defined text that will be included in the email. Only allowed at the first package.

The name the receiver return notification will appear to be from. Defaults to the Shipper Name. Only allowed at the first package.

Notification Code. Valid values: 3 - Receiver Return Notification 6 - QV Email Notification 7 - QV Exception Notification 8 - QV Delivery Notification For Mail Innovations forward shipments, QV Email Notifications are allowed for First Class, Priority Mail, and Expedited Mail Innovation services.

Access Point COD indicates Package COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type. Package Access Point COD is valid only for shipment without return service from US/PR to US/PR and CA to CA. Not valid with COD at package level.

Access Point COD Monetary Value.

Access Point COD Currency Code.

Field to be used when a shipment contains a HazMat. It will specify the existence of HazMat, and what type. Initially this will be used for SurePost and Mail Innovations 'USPS Limited Quantities HazMat' Shipments (but may be extended for other types of HazMat in the future). Valid values are 01.

• USPS Limited Quantities HazMat - 01

Delivery Confirmation container. Refer to Delivery Confirmation Origin- Destination Pairs in the Appendix for a list of valid values. Valid only for forward shipment only.

Type of delivery confirmation. Valid values:

• 1 - Unsupported
• 2 - Delivery Confirmation Signature Required
• 3 - Delivery Confirmation Adult Signature Required

Delivery Confirmation Control number associated with the delivery confirmation for the package. Valid for forward shipments only.

Container for COD. Indicates COD is requested. Package level COD is available for shipment without return service from US/PR to US/PR, CA to CA, and CA to US. CA to US COD is not allowed for package Letter/ Envelope. COD is not valid for return service movements.

For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the Appendix.

COD Amount container.

COD Amount. Valid values: 0.01 USD to 50000.00 USD

COD amount currency code type.

An UPSPremiumCareIndicator indicates special handling is required for shipment having controlled substances. Empty Tag means indicator is present.

The UPSPremiumCareIndicator cannot be requested for package with Delivery Confirmation - Adult Signature Required and Delivery Confirmation- Signature Required.

UPSPremiumCareIndicator is valid for following Return services:

• Returns Exchange (available with a contract)
• Print Return Label
• Print and Mail
• Electronic Return Label
• Return Service Three Attempt

The UPSPremiumCareIndicator can be requested with following UPS services:

• UPS Express® Early
• UPS Express
• UPS Express Saver
• UPS Standard
• Valid only for Canada to Canada movements.

Presence/Absence Indicator. Any value is ignored. If present, the package is rated for UPS Proactive Response and proactive package tracking. Contractual accessorial for health care companies to allow package monitoring throughout the UPS system. Shippers account needs to have valid contract for UPS Proactive Reponse.

Reserved for future use.

Reserved for future use.

Proper shipping name in local langauge.

Reserved for future use.

The Proper Shipping Name assigned by ADR, CFR or IATA. Required if CommodityRegulatedLevelCode = LR, LQ or FR.

This is the hazard class associated to the specified commodity.

Required if CommodityRegulatedLevelCode is 'EQ', 'LQ' or 'FR'

The emergency information, contact name and/or contract number, required to be communicated when a call is placed to the EmergencyPhoneNumber. The information is required if there is a value in the EmergencyPhoneNumber field above and the shipment is with a US50 or PR origin and/or destination and the RegulationSet is IATA.

The number of pieces of the specific commodity. Required if CommodityRegulatedLevelCode = LQ or FR. Valid values are 1 to 999.

Additional remarks or special provision information. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.

Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers.

The Regulatory set associated with every regulated shipment. It must be same across the shipment. Valid values: ADR = Europe to Europe Ground Movement CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada IATA= Worldwide Air movement TDG= Canada to Canada ground movement or Canada to U.S. standard movement. Valid values are ADR, CFR, IATA and TDG. For multiple Chemical Records per package or multiple packages containing different RegulationSet, RegulationSet of first Chemical Record would be considered for validating and rating the entire shipment.

The type of package used to contain the regulated good. (Ex: Fiberboard Box). Required if CommodityRegulatedLevelCode = LQ or FR. Ex. FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM, OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER, PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON, ALUMINUM BOX

The technical name (when required) for the specified commodity. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.

The packing instructions related to the chemical record. Required if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.

24 Hour Emergency Phone Number of the shipper. Valid values for this field are (0) through (9) with trailing blanks. For numbers within the U.S., the layout is 1, area code, 7-digit number. For all other countries or territories the layout is country or territory code, area code, number.

The following are restricted in the phone number period ".", dash "-", plus sign "+" and conventional parentheses "(" and ")", "EXT" or "OPT"

Required if the field applies to the material by regulation. Field input is Arabic numerals, output is Roman numerals. Will be shown in Roman Numerals. Valid values:

• "1" = "I",
• "2" = "II",
• "3" = "III",
• and blank.

Defines what is restricted to pass through a tunnel.

Defines the type of label that is required on the package for the commodity.

Not applicable if CommodityRegulatedLevelCode = LR or EQ.

Required if CommodityRegulatedLevelCode = EQ, LQ or FR. The numerical value of the mass capacity of the regulated good. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." (Decimal point) and can hold up to 1 decimal place.

This is the ID number (UN/NA/ID) for the specified commodity. Required if CommodityRegulatedLevelCode = LR, LQ or FR and if the field applies to the material by regulation. UN/NA/ID Identification Number assigned to the specified regulated good. (Include the UN/NA/ID as part of the entry).

The type of regulated good for an ADR package where ADR is for Europe to Europe ground movement.

This is the packing group category associated to the specified commodity. Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Must be shown in Roman Numerals. Valid values: I II III blank

Technical name in local language.

Required if CommodityRegulatedLevelCode = LQ, EQ or FR. The unit of measure used for the mass capacity of the regulated good.

For Example: ml, L, g, mg, kg, cylinder, pound, pint, quart, gallon, ounce etc.

Not applicable for ADR regulation set. Required for any other regulation set. Declares that a package was prepared according to ground passenger aircraft or cargo aircraft only. Valid values: Highway=Highway Ground=Ground PAX=Passenger Aircraft Passenger Aircraft=Passenger Aircraft CAO=Cargo Aircraft Only Cargo Aircraft Only=Cargo Aircraft Only Valid entries include: Highway, Ground, PAX, Passenger Aircraft, CAO and Cargo Aircraft Only.

Transport Category. Valid values are 0 to 4.

Identifies the Chemical Record. Required if SubVersion is greater than or equal to 1701.

Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation.

Secondary hazardous characteristics of a package. (There can be more than one – separate each with a comma).

Indicates the type of commodity - Fully Regulated (FR), Limited Quantity (LQ), Excepted Quantity (EQ) or Lightly Regulated (LR). Valid values are LR, FR, LQ and EQ. Required for subversion 1701 or greater. LR and EQ are validated if subversion is 1701 or greater. FR, LQ will be validated if subversion is 1807 or greater

Optional reference number. It will be displayed only on label.

Recommended if CommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. If reportable quantity is met, 'RQ' should be entered.

The presence indicates that the package may be released by driver without a signature from the consignee. Empty Tag. Only available for US50/PR to US50/PR packages without return service.

Container for Dry Ice. Maximum 1 Dry Ice is allowed. Lane check will happen based on postal code/ city.

Presence/Absence Indicator. Any value inside is ignored. Relevant only in CFR regulation set. If present it is used to designate the dry Ice is for any medical use and rates are adjusted for DryIce weight more than 2.5 Kgs or 5.7 Lbs.

Container for Dry Ice weight.

Container for Unit of measurement for Dry Ice Weight.

DryIce weight unit of measurement code. Valid values:

• 00 = KG (Metric Unit of Measurements) or KGS
• 01 = LB (English Unit of Measurements) or LBS The following values are valid : 00, 01, KG, KGS, LBS.

Description for unit of measurement for Dry Ice Weight.

Dry Ice Weight. Cannot be more than package weight. Should be more than 0.0. Valid characters are 0-9 and "." (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including "." and can hold up to 1 decimal place.

Regulation set for dryIce Shipment. Valid values: CFR = HazMat regulated by US Dept. of Transportation within the U.S. or ground shipments to Canada, IATA= Worldwide Air movement. The following values are valid: IATA, CFR.

Identifies the package containing Dangerous Goods. Required for Hazmat shipment if SubVersion is greater than or equal to 1701.

Packaging container. Container for Packaging Type.

Package types. Values are: 01 = UPS Letter 02 = Customer Supplied Package 03 = Tube 04 = PAK 21 = UPS Express Box 24 = UPS 25KG Box 25 = UPS 10KG Box 30 = Pallet 2a = Small Express Box 2b = Medium Express Box 2c = Large Express Box 56 = Flats 57 = Parcels 58 = BPM 59 = First Class 60 = Priority 61 = Machineables 62 = Irregulars 63 = Parcel Post 64 = BPM Parcel 65 = Media Mail 66 = BPM Flat 67 = Standard Flat.
Note: Only packaging type code 02 is applicable to Ground Freight Pricing. Package type 24, or 25 is only allowed for shipment without return service. Packaging type must be valid for all the following: ShipTo country or territory, ShipFrom country or territory, a shipment going from ShipTo country or territory to ShipFrom country or territory, all Accessorials at both the shipment and package level, and the shipment service type. UPS will not accept raw wood pallets and please refer the UPS packaging guidelines for pallets on UPS.com.

Description of packaging type. Examples are letter, customer supplied, express box.

Container to hold package weight information. Package weight is a required for Ground Freight Pricing shipments and Heavy Goods service. Package Weight will be ignored for Simple Rate.

Container to hold UnitOfMeasurement information for package weight.

Package weight unit of measurement code.

Valid values:

• LBS = Pounds
• KGS = Kilograms
• OZS = Ounces

Unit of Measurement "OZS" is the only valid UOM for some of the Mail Innovations Forward and Worldwide Economy DDU Shipments.

Please refer to Appendix for more details regarding the valid combination of Mail Innovation Forward Shipment services, Package Type and Unit of Measurement.

Description of the unit of measurement for package weight.

Packages weight. Weight accepted for letters/envelopes. Only average package weight is required for Ground Freight Pricing Shipment.

Dimensions information container. Note: Currently dimensions are not applicable to Ground Freight Pricing. Length + 2*(Width + Height) must be less than or equal to 165 IN or 330 CM. Required for Heavy Goods service. Package Dimension will be ignored for Simple Rate

Package width.

Package height.

UnitOfMeasurement container for dimensions.

Package dimensions measurement code. Valid codes: IN = Inches CM = Centimeters 00 = Metric Units Of Measurement 01 = English Units of Measurement The unit of measurement must be valid for the Shipper country or territory.

Description of the package dimensions measurement units.

Package length. Length must be the longest dimension of the container. Valid values are 0 to 108 IN and 0 to 270 CM.

Presence/Absence Indicator. Any value is ignored. If present, indicates that the package is qualified for minimum billable weight. Applicable for UPS Worldwide Economy DDU service.

Additional Handling Required. The presence indicates additional handling is required, the absence indicates no additional handling is required. Additional Handling indicator indicates it's a non-corrugated package.

Unit price of the commodity. Applicable for Air Freight only Limit to 2 digit after the decimal. The maximum length of the field is 12 including '.' and can hold up to 2 decimal place. (e.g. 999999999.99)

UPS Premier Container.

Handling Instruction Container.

Handling Instruction for UPS Premier package. Please refer Apendix UPS Premier Handling Instructions.

UPS Premier Category. Valid values are 01,02,03 UPS Premier Silver -01 UPS Premier Gold - 02 UPS Premier Platinum - 03

SensorID is RFID for UPS Premier Silver. SensorID is MeshID for UPS Premier Gold or UPS Premier Platinum Package.

Merchandise description of package. Required for shipment with return service.

Dimensional weight of shipment. Please visit ups.com for rules on calculating. There is one implied decimal place (e.g. 115 = 11.5). If dimensions are provided, dimensional weight is ignored. For US/PR/CA shipments, dimensional weight is ignored

UnitOfMeasurement Container.

Code representing the unit of measure associated with the package weight.

Valid values:

• LBS = Pounds (default)
• KGS = Kilograms

Text description of the code representing the unit of measure associated with the package weight. Length and value are not validated.

Actual package weight. Weight accepted for letters/envelopes.

Presence of the indicator mentions that the package is Large Package.

This is an empty tag, any value inside is ignored.

If the indicator is present then the reference numbers value will be bar coded on the label.

This is an empty tag, any value inside is ignored. Only one shipment-level or package-level reference number can be bar coded per shipment.

In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.

Reference number type code, for the entire shipment. The code specifies the Reference name.

Refer to the Reference Number Code table. Valid if the origin/destination pair is US/US or PR/PR and character should be alpha-numeric.

Customer supplied reference number. Valid if the origin/destination pair is US/US or PR/PR.

SimpleRate Container

SimpleRate code. Valid Values

• XS = Extra Small
• S = Small
• M = Medium
• L = Large
• XL = Extra Large

Simple Rate description of the code above. Currently ignored if provided in the Request. Length is not validated.

Container to hold the Commodity information. It is required if the Ground Freight Pricing Shipment indicator is present in the request.

Freight Classification. Freight class partially determines the freight rate for the article. Required for Ground Freight Pricing Shipments only.

Container to hold the NMFC codes.

Specifies the Commodity's NMFC sub code. Needs to be provided when the SubCode associated with the PrimeCode is other than 00. UPS defaults the sub value to 00 if not provided. If provided the Sub Code should be associated with the PrimeCode of the NMFC.

Specifies the Commodity's NMFC prime code. Required if NMFC Container is present.

Description of articles & special marks. Applicable for Air Freight only

Required when number of hazmat containers in a package is greater than 1. It indicates whether all the hazmat materials are kept in a single box or multiple boxes. Required when number of hazmat container in a package is greater than 1.

This field is used for the Outer Hazmat packaging type. Ex. FIBERBOARD BOX, WOOD(EN) BOX, PLASTIC JERRICAN, METAL BOX, STEEL DRUM, OTHER, PLASTIC BOX, PLASTIC DRUM, STYROFOAM BOX, CYLINDERS, ENVIROTAINER, PLYWOOD BOX, ALUMINUM DRUM, ALUMINUM CYLINDERS, PLASTIC PAIL, PLYWOOD DRUM, FIBER DRUM, STEEL JERRICAN, ALUMINUM JERRICAN, STEEL BOX, CARTON, ALUMINUM BOX

Presence/Absence Indicator. Any value is ignored. Presence indicates that one or more hazmat/chemicals are in separate boxes in a package. When number of Hazmat containers in a package is more than one, either AllPackedInOneIndicator or OverPackedIndicator is needed

When a HazMat shipment specifies AllPackedInOneIndicator and the regulation set for that shipment is IATA, Ship API must require the shipment to specify a Q-Value with exactly one of the following values: 0.1; 0.2; 0.3; 0.4; 0.5; 0.6; 0.7; 0.8; 0.9; 1.0

Presence/Absence Indicator. Any value is ignored. Presence indicates if multiple, different hazmat/chemicals are contained within one box in a package When number of Hazmat containers in a package is more than one, either AllPackedInOneIndicator or OverPackedIndicator is needed

Container for Shipment Service Options.

Saturday pickup indicator. The presence indicates Saturday pickup is requested and the absence indicates Saturday pickup is not requested. This is an empty tag, any value inside is ignored.

CommercialInvoiceRemovalIndicator allows a shipper to dictate UPS to remove the Commercial Invoice from the user's shipment before the shipment is delivered to the ultimate consignee.

Presence/Absence Indicator. Any value inside is ignored. Direct Delivery Only (DDO) accessorial in a request would ensure that delivery is made only to the ship to address on the shipping label. This accessorial is not valid with Shipment Indication Type "01 - Hold For Pickup At UPS Access Point" and "02 - UPS Access Point™ Delivery".

Container for Email Information.

The address where an undeliverable eMail message is sent if the eMail with the notification is undeliverable. There can be only one UndeliverableEMailAddress for each shipment with Quantum View Shipment Notifications.

Email address where the notification is sent. Up to five email addresses are allowed for each type of Quantum View TM shipment notification. Up to two email address for return notification.

The e-mail address specifies the Reply To E-mail address. The "From" field of the message header contains pkginfo@ups.com. Valid for Return Notification only.

User defined text that will be included in the eMail. The Memo must occur only once for each shipment with Quantum View Shipment Notifications.

The name the email will appear to be from. Defaults to the Shipper Name. The FromName must occur only once for each shipment with Quantum View Shipment Notifications.

This container is used for providing Language and dialect details for Alternate Delivery Location notifications and UAP Shipper notifications. Valid only for Alternate Delivery Location notification and UAP Shipper notification.

Refer to Language/Dialect Combinations in the Appendix for valid pairs.

Refer to Language/Dialect Combinations in the Appendix for valid pairs.

The type of notification requested.

Note:

• QVN Exception notification and return notification are not applicable to GFP.
• QV In-transit and Return Notifications are only valid for ImportControl and Return shipment.
• QV In-transit Notification is allowed for return shipments only.
• QV Ship Notification is allowed for forward moving shipments only.

Valid values:

• 5 - QV In-transit Notification
• 6 - QV Ship Notification
• 7 - QV Exception Notification
• 8 - QV Delivery Notification
• 2 - Return Notification or Label Creation Notification
• 012 - Alternate Delivery Location Notification
• 013 - UAP Shipper Notification.

TextMessage container is used for specifying phone number for receiving text Alternate Delivery Location notification and UAP Shipper notification. Valid only for Alternate Delivery Location notification and UAP Shipper notification. VoiceMessage phone number or TextMessage phone number or email address is required for ADL notification and UAP Shipper notification.

Phone number for receiving Text Alternate Delivery Location notification and UAP Shipper notification.

VoiceMessage container is used for specifying phone number for receiving voice Alternate Delivery Location notification and UAP Shipper notification. Valid only for Alternate Delivery Location notification and UAP Shipper notification. VoiceMessage phone number or TextMessage phone number or email address is required for ADL notification and UAP Shipper notification.

Phone number for receiving Voice Alternate Delivery Location notification and UAP Shipper notification.

Type of ImportControl Label. This container is applicable only for ImportControl shipments. This container is applicable only for ImportControl shipments.

Valid LabelMethod types are: 01 = ImportControl Print and Mail 02 = ImportControl One-Attempt 03 = ImportControl Three-Attempt 04 = ImportControl Electronic Label 05 = ImportControl Print Label

LabelMethod description.

UPS carbon neutral indicator presence at shipment level is required to create carbon neutral Shipments.

Delivery Confirmation container. Valid for forward shipments only.

Refer to Delivery Confirmation Origin-Destination Pairs in the Appendix for a list of valid values.

Type of delivery confirmation. Valid values: 1 - Delivery Confirmation Signature Required 2 - Delivery Confirmation Adult Signature Required. Valid for forward shipments only.

DCIS Number.

COD container Indicates COD is requested. Shipment COD is only available for EU origin countries or territories and for shippers account type Daily Pickup and Drop Shipping. Not available to shipment with return service.

For valid values refer to: Rating and Shipping COD Supported Countries or Territories in the Appendix.

COD Amount container.

COD Amount monetary value.

COD amount currency code type.

Package Release code allows the consignee or claimant to pick-up a package at a UPS Access Point™. The shipper must provide the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. Package Release Code is only valid with ShipmentIndicationType 01 - Hold for Pickup at UPS Access Point™. The release code must be between length 4 and 6 and only contain numbers.

Drop off At UPS Facility indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.

Indicates that the Shipment is an ImportControl shipment.

Container for the Label Delivery accessorial. Note - LabelDelivery is not applicable for GFP and Mail Innovations Forward shipment. Required for shipments with either Electronic Return Label Return Service or ImportControl Electronic LabelMethod type. Optional for shipments with Print Return Label Return Service or ImportControl Print LabelMethod type or Forward movement. If this container is present for shipments with either Electronic Return Label Return Service or ImportControl Electronic LabelMethod type, either of the LabelLinksIndicator or EMail container should be provided. For shipments with Print Return Label Return Service or ImportControl Print LabelMethod type or Forward movement, only LabelLinksIndicator is valid option for LabelDelivery container.

Container for the email message.

The address where an undeliverable email message is sent if the Label Delivery email is undeliverable. Defaults to FromEMailAddress.

The destination eMail address for the Label Delivery.

The eMails subject. Defaults to the Label Delivery Notification plus the shipment ID. Defaults to text provided by UPS.

Specifies a reference code and reference number to display in the subject of the Label Delivery notification.

When the subject code is provided, the subject will contain the following: UPS Label Delivery, the reference code (the reference code will be mapped to the corresponding ANSI value) and the reference number.

The valid subject codes are:

• 01 - Shipment Reference Number 1,
• 02 - Shipment Reference Number 2,
• 03 - package Reference Number 1,
• 04 - package Reference Number 2,
• 05 - package Reference Number 3,
• 06 - package Reference Number 4,
• 07 - package Reference Number 5,
• 08 - Subject Text (Return Notification only).

If the subject code tag is not provided and the subject text is provided, the subject of the notification will be the subject text.

If the subject text is provided, and the subject code tag exists, then the subject code value must be 08. If Subject code is 08, subject text must exist. If a subject code is provided that refers to a nonexistent reference number, the subject will default to the shipment identification number.

The e-mail address specifies the Reply To E-mail address. The "From" field of the message header contains pkginfo@ups.com.

User defined text that will be included in the email.

The "FrontName" is the name from which notification will appear. Defaults to the "Shipper Name".

Indicates the Label and Receipt URLs are to be returned in the XML response.

Lift Gate For Delivery indicator. The empty tag means indicator is present. Lift Gate for Delivery is not allowed with Hold For Pickup for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment.

When both Hold for Pickup and Drop Off At UPS Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment.

This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.

Restricted Articles container.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Alcoholic Beverages Shippers account needs to have a valid contract for Alcohol.

This field is a flag to indicate if the package has Biological substances. True if present; false otherwise. Shippers account needs to have a valid contract for Biological Substances. Lane check will happen based on postal code/ city.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Plants Shippers account needs to have a valid contract for Plants.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Tobacco Shippers account needs to have a valid contract for Tobacco.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Seeds. Shippers account needs to have a valid contract for Seeds.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Ecigarettes Shippers account needs to have a valid contract for Ecigarettes.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Perishable items. Shippers account needs to have a valid contract for Perishables.

Presence/Absence Indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the package contains Special Exception items. Shippers account needs to have a valid contract for Special Exceptions.

Inside delivery accessory. Valid values: 01 - White Glove, 02 - Room of Choice, 03 - Installation, 04 - Over Threshold Fee. Default is Room of Choice. Shippers account needs to have a valid contract for Heavy Goods Service.

Access Point COD indicates COD is requested for a shipment. Valid only for "01 - Hold For Pickup At UPS Access Point" Shipment Indication type. Shipment Access Point COD is valid only for countries or territories within E.U. Not valid with (Shipment) COD. Not available to shipment with return service.

Access Point COD Monetary Value.

Access Point COD Currency Code.

Exchange forward indicator presence at shipment level is required to create exchange forward Shipments. In the label routing Instruction text will be defaulted to "EXCHANGE-LIKE ITEM ONLY".

The flag indicates the ReturnOfDocument accessorial has been requested. Valid for Poland to Poland forward shipment only.

International Forms information.

This is the legal explanation, used by Customs, for the delivering of this shipment. It must be identical to the set of declarations actually used by Customs. Examples of declarations that might be entered in this field are: I hereby certify that the goods covered by this shipment qualify as originating goods for purposes of preferential tariff treatment under the NAFTA. I hereby certify that the information on this invoice is true and correct and the contents and value of this shipment is as stated above. EEA statement: The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin. Applies to Invoice and Partial Invoice forms only. On the invoice for return shipment, the verbiage is as follows (user input is ignored): The exporter of the products covered by this document declares that except where otherwise clearly indicated these products are of EEA preferential origin

For each good described in the Description of Goods field, where the good is subject to a regional value content (RVC) requirement, indicate NC if the RVC is calculated according to the net cost method; otherwise, indicate NO. If the RVC is calculated over a period of time then indicate "NC with begin/end date" by passing code "ND" Applies to NAFTA CO only. Required for NAFTA CO. Valid values:

• NC
• ND
• NO

The total number of packages, cartons, or containers for the commodity. Applicable for CO and is required. Should be numeric. Valid characters are 0 -9.

The part number or reference number for the product contained in the invoice line, as indicated on the customs invoice. Applies to Invoice and Partial Invoice. Required for Invoice forms and optional for Partial Invoice.

Date Range for regional value content (RVC). Applies to NAFTA CO only.

If the RVC is calculated over a period of time, it should be identified by the begin date (yyyyMMdd) of that period. (Reference: Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.

If the RVC is calculated over a period of time, it should be identified by the End date (yyyyMMdd) of that period. (Reference: Articles 402.1, 402.5). Applies to NAFTA CO only. Format is yyyyMMdd.

Code indicating Domestic: Exports that have been produced, manufactured, or grown in the United States or Puerto Rico. This includes imported merchandise which has been enhanced in value or changed from the form in which imported by further manufacture or processing in the United States or Puerto Rico. Foreign: Merchandise that has entered the United States and is being exported again in the same condition as when imported. Applies to EEI forms only. Required for EEI form. Valid values: D: Domestic; F: Foreign.

Indicates the criterion (A through F) for each good described in the Description of Goods field if applicable.

The rules of origin are contained in Chapter Four and Annex 401.

Additional rules are described in Annex 703.2 (certain agricultural goods), Annex 300-B, Appendix 6 (certain textile goods) and Annex 308.1 (certain automatic data processing goods and their parts). Applies to NAFTA CO only.

Container tag for determining whether or not to exclude product information from a particular form. If this container is not present we assume that the DEFAULT is selected which is "none" and all products will appear on all forms.

Indicates the name of the International form requested to NOT have product information. Possible Values are 04 – NAFTA CO. Please note that if this is used and you DO NOT have the corresponding form type requested this will be IGNORED.

6-to-15-alphanumeric commodity code. Customs uses this code to determine what duties should be assessed on the commodity. Applies to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. Should be at least 6 alphanumeric. For NAFTA CO: For each good described in Description of Goods field, identify the H.S. tariff classification to six digits. If the good is subject to a specific rule of origin in Annex 401 that requires eight digits, identify to eight digits, using the H.S. tariff classification of the country or territory into whose territory the good is imported.

Description of the product. Applies to all International Forms. Optional for Partial Invoice. Must be present at least once and can occur for a maximum of 3 times.

This amount will always be USD. Applies to EEI forms only. Required for EEI form. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.

Note: This value is calculated based on the Product/Unit/Value and /Product/Unit/Number (Number of Units * Price per Unit). If the total value is incorrect it will be replaced by the actual calculated total value.

Container tag for the Unit information of each product. (also called as commodity) Required for Invoice forms and optional for Partial Invoice.

Total quantity of each commodity to be shipped, measured in the units specified in the Unit of Measure field. Required for Invoice forms and optional for Partial Invoice. Must be numeric. Valid characters are 0-9.

Container tag for the Unit of measurement for the commodity. Required for Invoice forms and optional for Partial Invoice.

Code for the Unit of measurement of the commodity units. Required for Invoice forms and optional for Partial Invoice.

Refer to Product Unit of Measure Codes in the Appendix for valid values.

The Unit of Measure if OTH (Other) is entered as the UnitOfMeasurement code. Applies to Invoice and Partial Invoice forms. Conditionally Required for the Invoice and Partial Invoice form if OTH is entered as the units UnitOfMeasurement Code.

Monetary amount used to specify the worth or price of the commodity. Amount should be greater than zero. Applies to Invoice and Partial Invoice form. Required for Invoice forms and optional for Partial Invoice. Amount should be greater than zero. Valid characters are 0-9 and. (Decimal point). Limit to 6 digits after the decimal. The maximum length of the field is 19 including '.' and can hold up to 6 decimal places.(#####.######, ######.#####, #######.####, ########.###, #########.##,##########.#,############). The value of this product and the other products should be such that the invoice line total which is the sum of ( number*values) of all products should not exceed 9999999999999999.99

Includes the following information for used self-propelled vehicles as defined in Customs regulations 19 CFR 192.1: The unique Vehicle Identification Number (VIN) in the proper format. Or The Product Identification Number (PIN) for those used self-propelled vehicles for which there are no VINs. Or the Vehicle Title Number. Applies to EEI forms only.

Any special marks, codes, and numbers that may appear on package. Applies to CO Only.

Indicate the following: Yes - If shipper is the producer of the good. If not, state 02, 03, and 04 depending on whether this certificate was based upon:
No [1] - Knowledge of whether the good qualifies as an originating good. No [2] - Reliance on the producers written representation (other than a Certificate of Origin) that the good qualifies as an originating good. No [3] - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer. Applicable for NAFTA CO and is required. Valid values: Yes, No [1], No [2], and No [3].

If present, JNT will be used as the origin of country or territory code on the NAFTA form and the Product/Origincountry or territoryCode tag will be ignored. Applies to NAFTA CO only.

The shipping weight, including containers, for each commodity with a separate Harmonized Tariff Code / Schedule B Number. This weight does not include carrier equipment. Applies to CO and EEI forms only. Required for CO and EEI forms.

Container tag for the Unit of Measurement of weight. Applies to CO and EEI forms only.

Code for unit of Measurement of weight. Applies to CO and EEI forms only. Valid values:

• KGS
• LBS

Description of the Unit of Measure.

Weight of Product. Applies to CO and EEI forms only. Valid characters are 0-9 and '.' (Decimal point). Limit to 1 digit after the decimal. The maximum length of the field is 5 including '.' and can hold up to 1 decimal place.

Required for EEI form. Applies to EEI form only.

Required for EEI form id it is a SDL product. Valid values: LC, LV, SS,MS, GS, DP, HR, UG, IC, SC, DD, HH, SR, TE,TL, IS, CR, GP, RJ, TP, IP, IR, DB, CH, RS, OS Applies to EEI form only. Required if EEIFilingOption code 3 specified for EEI form.

Department of State/ Directorate of Defense Trade Control Information. This element is a container for additional information that is applicable to SDL products. It will only be evaluated if the provided license code is an SDL code. Applies to EEI Form only.

Export Quantity. Applies to EEI form only. It is required for EEIFilingOption code 3. Only positive integer value is valid.

Container for unit of measurement. Applies to EEI form only. It is required for EEIFilingOption code 3.

Required for EEI form. Unit of measurement code. The two or three (3) alpha unit of measurement for the article being shipped. For example: BAG/BG - bags Applies to EEI form only. It is required for EEIFilingOption code 1A and 3.

Description for Unit of Measurement. Applies to EEI form only.

Digit numeric code (e.g. 01-18, 20 or 21). Indicates the U.S. Munitions List (USML) category article, service or related technical data as it applies to the article reported. Applies to EEI form only. It is required for EEIFilingOption code 3.

Presence/Absent indicator. Certification by the U.S. exporter that the exporter is an eligible party to participate in the defense trade.

Approved Community Member Number (ACM). It is required to be provided along with ITARExemptionNumber for some License code (SGB and SAU). The ACM# for the United Kingdom (License code SGB) must begin with UK followed by 9 numbers. The ACM# for Australia (License Code SAU) must begin with DTT followed by 8 numbers. Applies to EEI form only. It is required for EEIFilingOption code 1A and 3.

The specific citation (exemption number) under the International Traffic in Arms Regulations (ITAR) from the Code of Federal Register (see 22 CFR 120-130) that exempts the shipment from the requirements for a license or other written authorization from the Directorate of Trade Controls (DDTC). Refer to EEI License Codes in the Appendix for valid values. Applies to EEI Form only. This field is applicable for EEIFiling option 1A and 3.

Presence/ Absence Indicator. Applies to EEI form only.

It is a unique registration code assigned to the registrant. The DDTC registration code consist of a letter prefix, M (assigned to a manufacturer and/or exporter) or K (assigned to a broker), followed by four or five digits (e.g. K-1234 or M12345). It is required for EEIFilingOption code 3.

Licence information for SDL commodity. Applies to EEI form only.

Product ECCN Number issued by BIS (Bureau of Industry and Security). If the license number is a commerce license, ECCN must be provided. The format is #A### or EAR99 Applies to EEI forms only. It is required for EEIFilingOption code 3. ECCN is required one of the following License Exception Codes is entered: CIV, CTP, ENC, GBS, KMI, LVS, TSR

The standard license code published by US government. Refer to EEI License Codes in the Appendix for valid values. Applies to EEI form only. It is required for EEIFilingOption code 3. It is optionally required for all other filing types; however, it is used to categorize each product as SDL or non-SDL. It is also used to identify which piece of information is applicable.

Represents any one of the following values: export license number, exception code, CFR citation, KPC Number, ACM Number. Applies to EEI form only.

Refer to EEI License Types and Exemptions in the Appendix for valid values and formats.

The export monetary amount allowed per license. Required for a licensable product when the EEI form is selected. Format: Whole numbers only. Applies to EEI form only. Required if EEIFilingOption code 1A (only for SDL shipments) or 3.

Invoice Commodity Level Tax Collected Code for each shipment commodity line.Taxes paid Indicator is only applicable for shipments to Singapore. [TaxesPaid = 0 - No on Report], [TaxesPaid = 1 -Yes on Report], [TaxesPaid = empty - null on Report], [If TaxesPaid is not passed in input request = null on Report]

Container tag for the schedule B information of a commodity. Applies to EEI forms only. Required for EEI form

The count of how many Schedule B units of the current good are in the shipment (EEI only). For example, if the Schedule B unit of measure is dozens and eight dozen, is being shipped, indicate 8 in this field. Applies to EEI forms only. Conditionally required for EEI forms if ScheduleB UnitOfMeasurement is not X. Should be Numeric. Valid characters are 0 -9.

A unique 10-digit commodity classification code for the item being exported. (To classify a commodity access the following Web page: http://www.census.gov/foreign-trade/schedules/b/#search). Applies to EEI forms only. Has to be 10 characters.

The unit of measure indicated on the Export License. Enter an X if there is no unit of measure in the Schedule B Unit field. Applies to EEI forms only. Required for the EEI form.

Refer to ScheduleB Unit of Measure Codes in the Appendix for valid values.

Description of the Unit of Measure.

The country or territory in which the good was manufactured, produced or grown. For detailed information on country or territory of origin, certificate of origin, rules of origin, and any related matters, please refer to the U.S. Customs and Border Protection Web site at www.customs.gov or contact your country or territory's Customs authority.

Data Container holding package related information. Required for packaging list, Air Freight Packing list and multi-piece Economy shipments.

Amount of Product associated with a package. Required for packaging list and Air Freight Packing list.

Product Note.

Package number the product should be allocated to ont he packing list. Required for packaging list and Air Freight Packing list.

Pier where goods are loaded. For vessel shipments only. Applies to EEI forms only. No validation is performed.

EEI Filing option. Applicable for EEI form and is required.

Indicates the EEI UPS Filed option. (option 3) Applicable for EEI form.

Container for POA. Applicable for EEI form.

Indicates the EEI UPS Filed POA filing option. Applicable for EEI form. Valid values are 1- One Time POA; 2- Blanket POA.

Description for POA Code. Applicable for EEI form.

Required for EEI Form. Applicable for EEI form. Valid values: 1 - Shipper filed, 2 - AES Direct, 3 - UPS filed.

Email Address where the notification is sent. Valid for UPS filed (option 3), Shipper filed (option 1- A , 1-C) Applicable for EEI form.

Indicates the EEI Shipper Filed option or AES Direct. (Option 1 or 2). Applicable for EEI form.

Indicates the EEI Shipper sub option. Applicable for EEI form and is required. Valid value is: A- requires the ITN; B- requires the Exemption Legend; C- requires the post departure filing citation.

Shipment Reference Number for use during interaction with AES. Valid for EEI form for Shipper Filed option 'C' and AES Direct Filed.

Description of ShipperFiled Code. Applicable for EEI form.

Input for Shipper Filed option A and AES Direct. The format is available from AESDirect website. Valid and Required for Shipper Filed option A. EEI form only.

Input for Shipper Filed option B. 30.2(d)(2), 30.26(a), 30.36, 30.37(a), 30.37(b), 30.37(c), 30.37(d), 30.37(e), 30.37(f), 30.37(h), 30.37(i), 30.30(j), 30.37(k), 30.37(i), 30.37(j), 30.37(k), 30.37(l), 30.37(m), 30.37(n), 30.37(o), 30.37(p), 30.37(q), 30.37(r), 30.37(s), 30.37(t), 30.37(u), 30.37(x), 30.37(y)(1), 30.37(y)(2), 30.37(y)(3), 30.37(y)(4), 30.37(y)(5), 30.37(y)(6), 30.39, 30.40(a), 30.40(b), 30.40(c), 30.40(d), 30.8(b) Valid and Required for Shipper Filed option B. EEI form only.

Optional Description of Filing Code. Applicable for EEI form.

This field should be entered if the NAFTA Certificate covers multiple shipments of identical goods as described in the Description of Goods field that are imported into a NAFTA country or territory for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between these dates. Applies to NAFTA CO form only. Required for NAFTA CO. This is not valid for a paperless shipment.

Begin date of the blanket period. It is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). Applies to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment.

End Date of the blanket period. It is the date upon which the blanket period expires. Applies to NAFTA CO form only. Required for NAFTA CO. Format is yyyyMMdd. This is not valid for a paperless shipment.

Commercial Invoice number assigned by the exporter. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice.

UPS Premium Care Form is required if UPS Premium Care Indicator is present on a package. Valid only for Canada to Canada movements.

Size of UPS Premium Care Form. Valid values: 01 = A4 Size 02 = Letter Size

Shipment Date associated with UPS Premium Care Shipment. Valid Format: yyyyMMdd

Number of Copies of UPS Premium Care Form. Valid value is 02.

Format of UPS Premium Care Form. Valid values: 01 = PNG 02 = PDF

Container to hold languages in which UPS Premium Care Form is required.

Languages for UPS Premium Care Form. Two languages are required for UPS Premium Care Form. Valid values: eng = US English fra = Canadian French

Should be one of the following-Overland: The U.S. Customs port where the carrier crosses the U.S. border, Vessel and Air: The U.S. Customs port where the goods are loaded on the carrier to be exported from the U.S., Postal: The U.S. Postal Office from where the goods are mailed. Applies to EEI forms only. No validation is performed.

If present indicates that the goods are containerized. This applies to vessel shipments only. Applies to EEI forms only.

Container for the CN22 form. Required if the customer wants to use the UPS generated CN22.

Number of label per page. Currently 1 per page is supported. Required if the CN22 form container is present.

Container for CN22 content weight.

Container for UOM.

Required if weight is provided, valid values are lbs. and ozs. Required if weight is provided.

Short description for UnitOfMeasurement.

Total weight of the content. Pounds and Ounces are allowed up to 2 decimals. Required if the CN22 form container is present.

Detailed description of the content.

If the combined MI package and CN22 label is requested, only the first 30 characters will appear on the combined label. Required if the CN22 form container is present.

Total number of items associated with this content. Required if the CN22 form container is present.

The tariff number associated with the CN22 contents.

Country or Territory of Origin from where the CN22 contents originated.

Total value of the items associated with this content. Required if the CN22 form container is present.

Currently only USD is supported. Required if the CN22 form container is present.

Provide the valid values: 6 = 4X6 1 = 8.5X11 Required if the CN22 form container is present.

Valid Values are pdf, png, gif, zpl, star, epl2 and spl. Required if the CN22 form container is present.

Valid values: 1 = GIFT 2 = DOCUMENTS 3 = COMMERCIAL SAMPLE 4 = OTHER Required if the CN22 form container is present.

Required if CN22Type is OTHER. Required if the CN22 form container is present.

String will replace default "Fold Here" text displayed on the label.

Valid values are : S (for state postal code abbreviation) , F : FTZ Identifier Applies EEI forms only. Required for EEI form.

Date when the Invoice is created. Ideally this is the same as the ship date. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Required for Invoice form for forward shipments. For shipment with return service, the user input will be ignored, and the field will be blank on the invoice. Format is yyyyMMdd.

Container tag that holds the Insurance Charges. Applies to Invoice and Partial Invoice forms only.

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.

The date the goods will be exiting the country or territory. Applies to CO and EEI forms only. Required for CO and EEI forms. Format is yyyyMMdd.

Container tag that holds the Freight Charges. Applies to Invoice and Partial Invoice forms only.

Cost to transport the shipment. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.

Contains description text which identifies the group of International forms. This element does not appear on the forms.

Currency code for all the monetary values of the Invoice form. Applies to Invoice and Partial Invoice forms only.

The name of the carrier that is exporting the shipment. The vessels flag number should also be entered, if the carrier is a vessel.

If value is empty, it will be set to default value as 'UPS' for EEI forms. Applies to CO and EEI forms only. Required for CO forms.

If Present, indicates that it is a routed export transaction. A routed export transaction is one, where the foreign principal party in interest authorizes a U.S. forwarding (or other) agent to export the merchandise outside the U.S. Applies to EEI forms only.

The application will automatically provide a copy of the invoice or NAFTA/CO with each response regardless of whether the user has enabled Paperless account. The user now has the option to print or ignore the copy provided.

Text for the shipper to add additional information. Forward shipment only.

Indicates the name of the International Form requested.

Valid values:

• 01 - Invoice
• 03 - CO
• 04 - NAFTA CO
• 05 - Partial Invoice
• 06 - Packinglist
• 07 - Customer Generated Forms
• 08 – Air Freight Packing List
• 09 - CN22 Form
• 10 – UPS Premium Care Form
• 11 - EEI

For shipment with return service, 05 or 10 are the only valid values.

Note: 01 and 05 are mutually exclusive and 05 are only valid for return shipments only.

This is an empty tag. Presence of the indicator for EEI form means shipment contains hazardous material.

The four-character Standard Carrier Alpha Code (SCAC) for vessel, rail, and truck shipments. For air shipment, enter the two or three character International Air Transport Association (IATA) code. Applies to EEI forms only. No Validations.

Presence of the indicator means user will supply additional document, such as EEI, NAFTA_CO or CO. This indicator should be set when the shipper intends to utilize UPS paperless invoice functionality AND the shipper has SELF-PREPARED other International Forms (EEI, CO, NAFTACO) to accompany the shipment. It is evaluated only when:

1. Account is paperless enabled.
2. Movement requires an invoice.
3. Destination country or territory accepts paperless invoice.
4. Invoice data is supplied by the client and the data passes validation.

A reason to export the current international shipment. Valid values: SALE, GIFT, SAMPLE, RETURN, REPAIR, INTERCOMPANYDATA, Any other reason. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and Optional for Partial Invoice. No validation.

Data container for DocumentID(s). Required if Form Type is 07.

DocumentID represents a document uploaded to Forms History.

Holds the contact information of various parties. Applicable for EEI and NAFTA CO only. Required for NAFTA CO and EEI. Ultimate consignee contact information is required for EEI. Producer contact information is required for NAFTA CO

Information of the producer. The NAFTA Certificate of Origin must be completed, signed, and dated by the exporter. When the Certificate is completed by the producer for use by the exporter, it must be completed, signed, and dated by the producer. The date must be the date the Certificate was completed and signed. Applies to NAFTA CO. Required for NAFTA CO forms.

Producer email address. Applies to NAFTA CO.

Company Name or the Individual name of the Producer. Applies to NAFTA CO. Only applicable when producer option is empty or not present. Conditionally required for: NAFTA CO, when Producer option is not specified.

The text associated with the code will be printed in the producer section instead of producer contact information. Use attached List if more than one producer's good is included on the Certificate, attach a list of additional producers, including the legal name, address (including country or territory), and legal tax identification number, cross-referenced to the goods described in the Description of Goods field. Applies to NAFTA CO.
Valid values: 01 - AVAILABLE TO CUSTOMS UPON REQUEST 02 - SAME AS EXPORTER 03 - ATTACHED LIST 04 - UNKNOWN

Contact name at the Producer location. Applies to NAFTA CO.

Address information of the Producer. Applies to NAFTA CO. Only applicable if producer option is empty or not present. Conditionally required for: NAFTA CO, when Producer option is not specified.

City of the Producer. Applies to NAFTA CO. Conditionally required for: NAFTA CO, when Producer option is not specified.

Town of the Producer.

Address line of the Producer.

State of the Producer. Applies to NAFTA CO. Required for certain countries or territories.

Country or Territory code of the Producer. Applies to NAFTA CO.

Postal code of the Producer. Applies to NAFTA CO. Required for certain countries or territories. The length of the postal code depends on the country or territory code.

Phone number information of Producer. Applies to NAFTA CO.

The locations phone number of the Producer. Applies to NAFTA CO.

The locations phone extension of the Producer. Applies to NAFTA CO.

Tax ID of the Producer. Applies to NAFTA CO. Only applicable when producer option is empty or not present

The ultimate consignee is the person or company who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods. Applicable for EEI form only.

Container for providing UltimateConsignee Type. Applicable for EEI form only.

Ultimate Consignee Type Code. Applicable for EEI form only.

Valid values:
D = Direct Consumer G = Government Entity R = Reseller O = Other/Unknown

Ultimate Consignee Type Description. Applicable for EEI form only.

Company Name or the Individual name of the Ultimate consignee. Applicable for EEI form only.

Address information of the Ultimate consignee. Applicable for EEI form only.

City of the Ultimate consignee. Applicable for EEI form only.

Town of the Ultimate consignee. Applicable for EEI form only.

Address line of the Ultimate consignee. Applicable for EEI form only.

State of the Ultimate consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code

Country or Territory code of the Ultimate consignee. Applicable for EEI form only.

Postal code of the Ultimate consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.

SoldTo Container. The Sold To party's country code must be the same as the Ship To party's country code with the exception of Canada and satellite countries. Applies to Invoice and NAFTA CO Forms. Required if Invoice or NAFTA CO (International Form) is requested.

SoldTo email address.

SoldTo AccountNumber

Company Name.

The text associated with the code will be printed in the sold to section of the NAFTA CO form. The values indicate the following: 01 – Unknown. Applies to NAFTA CO form. Possible Values are 01 and 02.

Sold to contact name.

Sold To Address Container. Applies to NAFTA CO.

SoldTo location's city.

SoldTo location's town code.

SoldTo location's street address. Applies to NAFTA CO.

SoldTo location's state or province code. Required for certain countries or territories.

SoldTo location's country or territory code.

SoldTo location's postal code.

Phone Container.

Sold To contacts phone number.

Sold To contacts phone extension.

SoldTo Tax Identification Number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.

The forwarding agent is the company or person acting as agent in the trans-shipping of freight to the destination country or territory. Applicable for EEI form only.

Company Name or the Individual name of the Forwarding agent. Applicable for EEI form only.

Address information of the Forwarding agent. Applicable for EEI form only.

City of the Forwarding agent. Applicable for EEI form only.

Town of the Forwarding Agent. Applicable for EEI form only.

Address line of the Forwarding agent. Applicable for EEI form only.

State of the Forwarding agent. Applicable for EEI form only.

Country or Territory code of the Forwarding agent. Applicable for EEI form only.

Postal code of the Forwarding agent. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code

Tax ID of the Forwarding agent. Valid Values: (Below values are applicable for EEIFilingOption Code =3) 94-308351500 13-168669100
Applicable for EEI form only.

The intermediate consignee is the person or company in the importing country or territory that makes final delivery to the ultimate consignee. Applicable for EEI form only.

Company Name or the Individual name of the Intermediate consignee. Applicable for EEI form only.

Address information of the Intermediate Consignee. Applicable for EEI form only.

City of the Intermediate Consignee. Applicable for EEI form only.

Town of the Intermediate consignee. Applicable for EEI form only.

Address line of the Intermediate Consignee. Applicable for EEI form only.

State of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories.

Country or Territory code of the Intermediate Consignee. Applicable for EEI form only.

Postal code of the Intermediate Consignee. Applicable for EEI form only. Required for certain countries or territories. The length of the postal code depends on the country or territory code.

Container tag that holds the information of amount that covers additional charges not already listed on the invoice. Applies to Invoice and Partial Invoice forms only.

The Monetary value of Other Charges. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places.

Description of what the other charges are for. Applies to Invoice and Partial Invoice forms only. Required for Complete Invoice and Optional for Partial Invoice forms.

Information about parties to transaction. Use Related, if the parties to the transaction are related. A related party is an export from a U.S. businessperson or business to a foreign business or from a U.S. business to a foreign person or business where the person has at least 10 percent of the voting shares of the business during the fiscal year. If unincorporated, then an equivalent interest in the business. Applies to EEI forms only.

Valid values:

• R - Related
• N - Non-related.

Parties to transaction is required if EEIFilingOption Code is 3 and if valid UPSFiled POA Code present in request.

Default will be set to N - Non-related if invalid code present with length of one.

Indicates the rights to the seller from the buyer. Also, it refers to Terms of Sale. Applies to Invoice and Partial Invoice forms only.

Valid values: CFR: Cost and Freight CIF: Cost Insurance and Freight CIP: Carriage and Insurance Paid CPT: Carriage Paid To DAF: Delivered at Frontier DDP: Delivery Duty Paid DDU: Delivery Duty Unpaid DEQ: Delivered Ex Quay DES: Delivered Ex Ship EXW: Ex Works FAS: Free Alongside Ship FCA: Free Carrier FOB: Free On Board

Container tag that holds the discount. Applies to Invoice and Partial Invoice forms only.

The discount to be subtracted from the sum of the total value on the invoice. Applies to Invoice and Partial Invoice forms only. Required for Invoice forms and optional for Partial Invoice. Valid characters are 0-9 and '.' (Decimal point). Limit to 2 digit after the decimal. The maximum length of the field is 15 including '.' and can hold up to 2 decimal places. This value should be greater than or equal to zero or less than or equal to the value of all goods listed on the invoice.

Contains one of the following: The two-digit U.S. Postal Service abbreviation for the state from which the goods were shipped to the port of export. The state that is the source for the good with the highest value. The state of consolidation. The Foreign Trade Zone number of the zone from where the exports are leaving. If the goods were shipped from Puerto Rico, enter PR. Applies to EEI forms only. Required for EEI.

The country or territory and the port where the goods will be unloaded from the exporting carrier. For vessel and air shipments only. Applies to EEI forms only. No validation is performed.

The two-character In Bond Code. Applies to EEI forms only. Required for EEI forms. Valid values for EEI are: 70: Not in bond; 67: IE from a FTZ; 68: T&E from a FTZ.

The Import Entry Number when the export transaction is used as proof of export for import transactions (examples: In Bond, Temporary Import Bond or Drawbacks). Applies to EEI forms only. Conditionally Required for EEI forms when In bond code value is other than 70 (Not In Bond)

Any extra information about the current shipment. Applies to Invoice and Partial Invoice forms only.

Mode of transport by which the goods are exported. Valid values: Air, AirContainerized, Auto, FixedTransportInstallations, Mail, PassengerHandcarried, Pedestrian, Rail, Rail, Containerized, RoadOther, SeaBarge, SeaContainerized, SeaNoncontainerized, Truck, TruckContainerized. Applies to EEI forms only. Required for EEI. Only allowed values can be entered. Only 10 Characters can appear on the form. Anything greater than 10 characters will be truncated on the form.

The customer's order reference number. Applies to Invoice and Partial Invoice forms only.

Saturday delivery indicator. The presence indicates Saturday delivery is requested and the absence indicates Saturday delivery is not requested. This is an empty tag, any value inside is ignored.

Lift Gate For Pick Up indicator. The empty tag means indicator is present. Lift Gate for Pickup is not allowed with Drop Off At UPS Facility for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment.

When both Hold for Pickup and Drop Off At Facility are selected, neither of the Lift Gate accessorial (Pick Up or Delivery) are allowed for a UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday shipment.

This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.

Presence/Absence indicator. True if present; false otherwise. Any value is ignored. If present, indicates that the customer would like items disposed. Shippers account needs to have a valid contract for Heavy Goods Service.

Presence/Absence Indicator. Any value inside is ignored. DeliverToAddresseeOnlyIndicator is shipper specified restriction that requires the addressee to be the one who takes final delivery of the "Hold For PickUp at UPS Access Point" package. Presence of indicator means shipper restriction will apply to the shipment. Only valid for Shipment Indication type "01 - Hold For PickUp at UPS Access Point".

This container is used for Populating EMailMessage details for PreAlertNotification.

This is used for notification when EMailAddress for PreAlertNotification is undeliverable.

EMailAddress where PreAlertNotification is sent.

This container is used for providing Language and dialect details for PreAlertNotification.

Refer to Language/Dialect Combinations in the Appendix for valid pairs.

Refer to Language/Dialect Combinations in the Appendix for valid pairs.

TextMessage container is used for specifying phone number for receiving text preAlertNotification.

Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.

If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:

1, area code, 7 digit phone number or

1, area code, 7 digit phone number, 4 digit extension number.

For other countries or territories, the layout is country or territory code, area code, 7 digit number.

VoiceMessage container is used for specifying phone number for receiving voice PreAlertNotification.

Phone number for receiving Voice PreAlertNotification. Valid values are 0 – 9.

If the country or territory of the message recipient is US, PR, CA, and VI, the layout is:

1, area code, 7 digit phone number or

1, area code, 7 digit phone number, 4 digit extension number.

For other countries or territories, the layout is country or territory code, area code, 7 digit number.

The presence of the tag SDLShipmentIndicator indicates Shipment is SDL. SDLShipmentIndicator presence means EEI form/ EEI Filing option required.

Hold For Pickup indicator. The empty tag means indicator is present. This accessorial is only valid for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment.

Container used to define the properties required for GlobalTaxID.

The value for origin_country_shipment_value which satisfies Tax-ID Threshold Code is ‘01’=Yes, ‘02’=No, ‘NA’= ‘Not Applicable’

The value for destination_Country_ShipmentValue which satisfies Tax-ID Threshold Code is  ‘01’=Yes, ‘02’=No,‘NA’= ‘Not

The value for idNumber_Consumer_TypeCode which satisfies Tax-ID Threshold Code is  ‘01’=Business, ‘02’=Consumer/Individual,      ‘NA’= ‘Not Applicable’

Container to specify the GlobalTax ID

(SHIP_FROM=20, CONSIGNEE=30)

The value for flexibility and future extensibility of these Identification Numberrequirements,the recommendation is to support up to eight Identification Numbers per shipment party/role.

Code that specifies the purpose of the Identification Number. For all tax ID that are not EORI = ‘01’ Valid values: 00/ Spaces = Unknown 01= Customs/Brokerage (Default) 02= Customs/Brokerage EORI 99= Other

The ISO-defined country code of the country whose regulatory agency is requesting the Identification Number. Typically for Import, the Consignee ID is requested by the Ship To country For export, the Shipper ID is requested by the Ship From country.

Required when a country (e.g., Origin country, Destination country) is requesting an ID Number for a shipment.

Combination of IDnumberCode and IDNumberSubTypeCode were used to form the correct regex for processing

The ISO-defined country code of the country where the Identification Number was issued, when applicable (as per business requirements). Needed for certain types of Identification Numbers (e.g., Passport Number). Sample Values: 'ID' = Indonesia, 'VN' = Vietnam, 'DE' = Germany

The code or number that a shipper or consignee has registered with a particular country’s authority for doing business, or for identification purposes.

A business or individual identification type description (Future Use).specifies the relationship of the customer/ID Number to the shipment 05 =importer Address, 06=Exporter Address , 18=DeliverTo/Consignee/Reciever Address, 37= Shipper Address.

field to determine if the Identification Number should be excluded from Shipping/Brokerage documents (not be passed to Document Services) ‘00’ -> Do Not include 01-> Include.

Valid Values are: 0000 = Unknown IDNumberTypeCode equal to ‘0000’ (unknown) is to be used when an ‘ID Number Type’ is not applicable, or when the front-end/client system cannot determine the type of IdentificationNumber (for any reason). 0001 = Exporter Tax ID Number 0002 = Importer Tax ID Number or EORI Number – When IdentificationNumberPurposeCode = 02 0005 = Personal Tax ID Number 1001 = Other / Free Form 1002 = Company/Business Tax ID Number 1003 = National ID Number 1004 = Passport Number 1005 = Personal ID Number 1006 = Phone Number

to determine if decryption is required. 0 = Identification number is not Encrypted 1 = Identification number is Encrypted

Valid values:

• '01' - Hold for Pickup at UPS Access Point aka Direct to Retail (D2R)
• '02' - UPS Access Point™ Delivery aka Retail to Retail (R2R) If '01' code is present indicates shipment will be send to Retail location where it is held to consignee to claim.

Description for the code.

Presence/Absence Indicator. Any value inside is ignored. TaxInformationIndicator is an indicator. If present, any taxes that may be applicable to a shipment would be returned in response. If this indicator is requested with NegotiatedRatesIndicator, Tax related information, if applicable, would be returned only for Negotiated Rates and not for Published Rates. The Tax related information includes any type of Taxes, corresponding Monetary Values, Total Charges with Taxes and disclaimers (if applicable) would be returned in response.

Type of Return service. When this container exists, the shipment is a return shipment.

Return Service types:

• 2 = UPS Print and Mail (PNM)
• 3 = UPS Return Service 1-Attempt (RS1)
• 5 = UPS Return Service 3-Attempt (RS3)
• 8 = UPS Electronic Return Label (ERL)
• 9 = UPS Print Return Label (PRL)
• 10 = UPS Exchange Print Return Label
• 11 = UPS Pack & Collect Service 1-Attempt Box 1
• 12 = UPS Pack & Collect Service 1-Attempt Box 2
• 13 = UPS Pack & Collect Service 1-Attempt Box 3
• 14 = UPS Pack & Collect Service 1-Attempt Box 4
• 15 = UPS Pack & Collect Service 1-Attempt Box 5
• 16 = UPS Pack & Collect Service 3-Attempt Box 1
• 17 = UPS Pack & Collect Service 3-Attempt Box 2
• 18 = UPS Pack & Collect Service 3-Attempt Box 3
• 19 = UPS Pack & Collect Service 3-Attempt Box 4
• 20 = UPS Pack & Collect Service 3-Attempt Box 5

Return Service description.

The Description of Goods for the shipment. Applies to international and domestic shipments.

Provide a detailed description of items being shipped for documents and non-documents.

Examples: "annual reports" and "9 mm steel screws". Required if all of the listed conditions are true: ShipFrom and ShipTo countries or territories are not the same; The packaging type is not UPS Letter; The ShipFrom and or ShipTo countries or territories are not in the European Union or the ShipFrom and ShipTo countries or territories are both in the European Union and the shipments service type is not UPS Standard.

Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the PackageID field to be barcoded at the bottom of the label.

MIDualReturnShipmentKey is unique key required to process Mail Innovations Dual Return Shipment.

The unique identifier (key) would be returned in response of first phase of Mail Innovations Dual Return Shipments.

This unique identifier (key) would be part of request for second phase of Mail Innovations Dual Return Shipments.

Format: For Package return shipments, the package tracking number is concatenated with the system time (YYYY-MM-DDHH.MM.SS.NNN), followed by service code.

For MI Return shipments, the Mail Manifest ID (MMI) is concatenated with the system time. The unique identifier (key) is required to link the package and the Mail Innovations portion of Dual Return shipment.

If unique identifier (key) is empty in the request for UPS Mail Innovations Return Service, the request will be treated as the first phase of the Mail Innovations Dual Returns Request.

If the MIDualReturnShipmentIndicator is present with empty or null MIDualReturnShipmentKey in UPS Package Return Shipment, the request will be treated as the first phase of Dual MI Return Label Shipment.

This field would be ignored if MIDualReturnShipmentIndicator is not present in UPS Package Return Shipment request.

DGSignatoryInfo Container DGPaperImage will be returned if DGSignatoryInfo container present

Date of signing the declaration form. Valid format is YYYYMMDD.

Name of the person signing the declaration.

Note: The name of person or department he/she is employed with, are both acceptable.

The city of the Signatory.

Valid values: 01 = Shipment level 02 = Package level
Valid only for the Shipper Declaration paper. If missing or invalid DGPaperImage will be returned at package level.

Dangerous Goods Paper Upload Only Indicator. DG Paper will not be returned in response if UploadOnlyIndicator present.

Title of the person signing the declaration. Note: The title of the person or department he/she is employed with, are both acceptable.

Represents 5 character ISO Locale that allows the user to request Reference Number Code on Label, Label instructions and Receipt instructions (if applicable) in desired language. Locale is specified by the combination of language code and country or territory code - 2 character language code and 2 character country or territory code seperated by an underscore ('_') character. If Locale element is requested along with LabelLinksIndicator, the URL to retrieve Label and Receipts (if applicable) will be returned in the requested Locale. Please note only LabelURL and ReceiptURL (if applicable) will be returned. LocalLanguageLabelURL and LocalLanguageReceiptURL will not be returned if Locale element is present in request. Queen's English (en_GB) is the default

A component encoded on the barcode of the Mail Innovations label. Valid values: IR = Irregular MA = Machineable SubClass is only required if the customer's contract have them subclass the package not UPS.

Ship From Container. Required for return shipment.

Required if pickup location is different from the shipper's address.

The ship from location's name or company name. 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label. Required if ShipFrom tag is in the XML.

Not applicable for ShipFrom.

Vendor Information Container

Shipper's VAT Tax collection registration number to be entered by Shipper at time of shipment creation. Presence of this number as part of the shipment information implies the shipper has collected/paid the required VAT tax (outside of UPS/UPS systems). Vendor Colect ID Number will be printed on commercial invoice if present.

Sample Values: 'IMDEU1234567' (IOSS #), 'VOEC1234567' (VOEC #), 'GB1234567' (HMRC #)

Required if the shipment is subject to Vendor Collect ID collection

Consignee Type. 01 = Business 02 = Consumer NA = Not Applicable

Code that identifies the type of Vendor Collect ID Number. Valid Values

• 0356 = IOSS
• 0357 = VOEC
• 0358 = HMRC

Vendor Collect ID Number type code will be printed on commercial invoice if present.

The ship from Attention name. 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label. Required if ShipFrom tag is in the XML and Invoice or CO International forms is requested. If not present, will default to the Shipper Attention Name.

Ship from Address Container. The package will be originating from or being shipped from this address. The shipment will be rated from this origin address to the destination ship to address.

The Ship from city.

30 characters are accepted, but for return Shipment only 15 characters will be printed on the label. Required if ShipFrom is supplied

The Ship from street address including name and number (when applicable). 35 characters are accepted, but for return Shipment only 30 characters will be printed on the label.

Origin location's state or province code. Required if ShipFrom is supplied, and ShipFrom country or territory is US.

If ShipFrom country or territory is US or CA, then the value must be a valid US State/ Canadian Province code. If the country or territory is Ireland, the StateProvinceCode will contain the county or territory.

Origin locations country or territory code. Required if ShipFrom tag is supplied. For Return Shipment the country or territory code must meet the following conditions:

• At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper.
• None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper.
• If any of the two following country or territory codes: ShipTo/ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.

The ship from locations postal code. 9 characters are accepted. Required if ShipFrom is supplied and the ShipFrom country or territory is the US and Puerto Rico.

For US and Puerto Rico, it must be valid 5 or 9 digit postal code. The character "-" may be used to separate the first five digits and the last four digits.

If the ShipFrom country or territory is CA, then the postal code must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.

For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.

The Ship from fax number. If Ship from country or territory is US 10 digits allowed, otherwise 1-15 digits allowed.

Container for Phone Number. If ShipFrom country or territory is US, PR, CA, and VI, the layout is: area code, 7 digit phone number or area code, 7 digit phone number, 4 digit extension number.

For other countries or territories, the layout is: country or territory code, area code, 7 digit number.

If ShipFrom tag is in the XML and International forms is requested.

The Ship from phone Number.

The Ship from phone extension.

Company's Tax Identification Number at the pick up location. Conditionally required if EEI form (International forms) is requested. Applies to EEI Form only. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.

Tax Identification Container. Applies to EEI form only.

Company's tax Identification type. Valid values: EIN, DNS, and FGN. Applies to EEI form only.

Description of TaxID submitted. Applies to EEI form only.

Goods Not In Free Circulation indicator. This is an empty tag, any value inside is ignored. This indicator is invalid for a package type of UPS Letter and DocumentsOnly.

Presence/Absence Indicator. Any value inside is ignored. RatingMethodRequestedIndicator is an indicator. If present, Billable Weight Calculation method information and Rating Method information would be returned in response.

MIDualReturnShipmentIndicator is an indicator to identify a Package Shipment is part of UPS Mail Innovations Dual Label Shipment.

Its presence means Package Shipment is part of UPS Mail Innovations Dual Label shipment. If the indicator is present in Package Shipment request, shipment would be considered as part of a Dual Mail Innovations Returns.

This indicator is not valid with UPS Mail Innovations Returns Service code.

Master Carton Indicator. Presence of the indicator means Master Carton ID will be created and returned to client. This is an empty tag, any value inside is ignored. MasterCartonIndicator is only valid with Econmoy Shipment (Service Code 17 or 72). Will be ignored if master carton id present.

Mail classification defined by the USPS. Valid values: 1 = Balloon 2 = Oversize 3 = Not Applicable

Indicates a shipment contains written, typed, or printed communication of no commercial value.

If DocumentsOnly is not specified then it implies that the shipment contains non documents or documents of commercial value.

Default is a shipment contains non- documents or documents of commercial value. This is an empty tag, any value inside is ignored.

Valid only for shipments with different origin and destination countries or territories. The origin country or territory is not US, and the destination country or territory is not CA, PR or MX.

Ship To Container.

Consignee's email address.

Consignee's company name. All other accounts must be either a daily pickup account or an occasional account.

Not applicable for ShipTo

Contact name at the consignee's location. Required for: UPS Next Day Air® Early service, and when ShipTo country or territory is different than ShipFrom country or territory.

Required if Invoice International form is requested.

Address Container.

Consignee's city. 30 characters are accepted, but only 15 characters will be printed on the label.

Address Line of the consignee. All three Address Lines will be printed on the label.

Consignee's state or province code. Required for US or Canada. If destination is US or CA, then the value must be a valid US State/ Canadian Province code.

If the country or territory is Ireland, the StateProvinceCode will contain the county.

Consignee's country or territory code. Must be a valid UPS Billing country or territory code. For Return Shipment the country or territory code must meet the following conditions:

• At least two of the following country or territory codes are the same: ShipTo, ShipFrom, and Shipper.
• None of the following country or territory codes are the same and are a member of the EU: ShipTo, ShipFrom, and Shipper.
• If any of the two following country or territory codes: ShipTo/ ShipFrom/ Shipper are members in EU otherwise check if the shipper has Third country or territory Contract.

This field is a flag to indicate if the receiver address has PO box indicator. True if POBoxIndicator tag exists; false otherwise.

Consignee's postal code. If the ShipTo country or territory is US or Puerto Rico, 5 or 9 digits are required.

If the ShipTo country or territory is CA, then the postal code is required and must be 6 alphanumeric characters whose format is A#A#A# where A is an uppercase letter and # is a digit.

Otherwise optional. For all other countries or territories the postal code is optional and must be no more than 9 alphanumeric characters long.

This field is a flag to indicate if the receiver is a residential location. True if ResidentialAddressIndicator tag exists. This is an empty tag, any value inside is ignored.

Consignee's fax number. If ShipTo country or territory is US 10 digits allowed, otherwise 1-15 digits allowed.

Container for Phone Number

Consignee's phone Number. Required for: UPS Next Day Air® Early service, and when Ship To country or territory is different than the ShipFrom country or territory.

If ShipTo country or territory is US, PR, CA, and VI, the layout is: area code, 7 digit PhoneNumber or area code, 7 digit PhoneNumber, 4 digit extension number; number.

For other countries or territories, the layout is: country or territory code, area code, 7 digit number.

Consignee's phone extension.

Location ID is a unique identifier referring to a specific shipping/receiving location. Location ID must be alphanumeric characters. All letters must be capitalized.

Consignee's tax identification number. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.

Container to hold InvoiceLineTotal Information. Required for forward shipments whose origin is the US and destination is Puerto Rico or Canada. Not available for any other shipments. FOR OTHER DESTINATIONS the InvoiceLineTotal in the International Forms Container must be used.

Invoice Line Total amount for the entire shipment. Valid values are from 1 to 99999999

Invoice Line Total currency type.

USPS Endorsement. Valid values: 1 = Return Service Requested 2 = Forwarding Service Requested 3 = Address Service Requested 4 = Change Service Requested and 5 = No Service Selected. Note: For International Mail Innovations shipments use No Service Selected. International Mail Innovations shipments are applicable for Priority Mail Innovations and Mail Innovations Economy Mail Innovations services only. Required for Mail Innovations forward shipments.

Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title. Required for Mail Innovations Return shipments. It is shown on the bottom of the shipping label as reference 2.

Cost Center length is alphanumeric with a max length of 30 for Mail Innovations forward shipments.

Cost Center length is numeric with a max length of 4 for Mail Innovations Return shipments.

WorldEase is a contract service offering in the UPS shipping that decreases brokerage fees by consolidating loose packages into one shipment for customs clearance.

This field is a flag to indicate if the request is a master shipment. This is required for Master shipment only. If MasterHasDocBox is "0" then request is considered a master shipment.

Container for port of entry details

Port of entry name

Port code

City

Address Line 2

Address Line 1

The code of the address's admininstrative division (state, province, distict, prefecture, etc...).

Country code

Postal code

Port of entry consignee

This field indicates if VendorCollectIDTypeCode and VendorCollectIDNumber should be exempt from validation. "0" indicates VendorCollectIDTypeCode and VendorCollectIDNumber fields are required.

The final destination country code.

The Global Consolidation Clearance Number(GCCN) generated for the master shipment. This is required for child shipment.

The final destination postal code.

1 indicates a Master Consolidation request for the European Union.

Code that indicates how shipping charges will be paid.

Possible values:

• "CAF"
• "SDT"
• "PRE"
• "COL"
• "DDP"
• "FOB"

Container to hold Freight Shipment information.

The presence of the tag indicates that the rate request is density based. For Density Based Rating (DBR), the customer must have DBR Contract Service.

Freight Density Info container. Required if DensityEligibleIndicator is present.

Handling Unit Quantity for Density based rating.

Dimension of the HandlingUnit container for density based pricing.

The width of the line item used to determine dimensional weight.

The height of the line item used to determine dimensional weight.

UnitOfMeasurement container.

Code for UnitOfMeasurement for the line item dimension. Valid value is IN

Description for UnitOfMeasurement for the line item dimension.

The length of the line item used to determine dimensional weight.

Handling Unit Type for Density based rating.

Handling Unit Code for Density based rating. Valid values:

• SKD = Skid
• CBY = Carboy
• PLT = Pallet
• TOT = Totes
• LOO = Loose
• OTH = Other

A description of the code for the Handling Unit type.

The presence of the AdjustedHeightIndicator indicates that allow the height reduction adjustment for density based rate request.

Container for the adjusted height. Required if AdjustedHeightIndicator is present.

Container for UnitOfMeasurement for the adjusted height.

Code associated with Unit of Measurement for the Adjusted height. Valid value: IN Unit of measurement code for Adjusted height is validated only when Handling unit type is SKD = Skid or PLT = Pallet.

Description for UnitOfMeasurement for the adjusted height.

Adjusted height value.

ShipmentRatingOptions container.

RateChartIndicator, if present in request, response will contain RateChart element.

If this indicator is present user level discount will be applied to rates if applicable Conditions checked: This indicator should be present Shipper number should not be present User should be eligible for user level discount

Ground Freight Pricing Rates option indicator. If the Ground Freight Pricing Shipment indicator is enabled and Shipper number is authorized then Ground Freight Pricing rates should be returned in the response. The Shipper account number must be qualified to receive Ground Freight Pricing Density Based Shipment rates. Only the Shipper account number taken from /ShipmentRequest/Shipment/FRSPaymentInformation/AccountNumber is used when checking qualification for Ground Freight Pricing Density Based rates.

This indicator applies for a third party (3P) / Freight collect (FC) shipment only.

For 3P/FC shipment if the shipper wishes to request for the negotiated rates of the third party then this indicator should be included in the request.

If authorized the 3P/FC negotiated rates will be applied to the shipment and rates will be returned in response.

Negotiated Rates option indicator. If the indicator is present and the Shipper is authorized then Negotiated Rates should be returned in the response. Negotiated Rates are of two types Account Based Rates (ABR) and Web Discount Rates. Negotiated Rates are only returned for qualified Shipper Account Numbers.

Eligibility is determined using the combination of UserId and the Shipper's Shipper Account Number. If the user is qualified, both Published rates and Negotiated rates are returned to the user. If the UserId and Shipper Account

Number are not qualified for Negotiated rates, a warning message is returned that indicates ineligibility and only the Published rates are returned in the response. As per discount eligibility of user, negotiated rates in the response may contain ABR or Web discount rates.

Container to hold the Payment information for the Ground Freight Pricing Shipments. Required for Ground Freight Pricing Shipments only.

The UPS account number. If the Ground Freight Pricing indicator and FreightShipmentInformation/DensityEligibleIndicator is present in the request, this account number must be validated to check if it is Ground Freight Pricing Density Based Rating enabled.

Container to hold the Ground Freight Pricing payment type information. It is required if the request has Ground Freight Pricing shipment indicator.

Valid codes:

• 01 = Prepaid
• 02 = FreightCollect
• 03 = ThirdParty

Specifies the description for Ground Freight Pricing payment type.

Container to hold the information for the FreightCollect and PrepaidThirdParty Address. Note: The Address is required only when the billing option is Freight collect or ThirdParty.

The country or territory code for the Ground Freight Pricing payment information address.

The postal code for the Ground Freight Pricing payment information address.

Presence/Absence indicator. Presence of this indicator means that the customer is requesting for the CostCenter field to be barcoded at the bottom of the label.

PromotionalDiscountInformation container. This container contains discount information that the customer wants to request each time while placing a shipment.

Promotion Code. A discount that is applied to the user. Required if PromotionalDiscountInformation container is present.

Promotion Alias code Required if PromotionalDiscountInformation container is present.

Customer-assigned unique piece identifier that returns visibility events. Required only for Mail Innovations forward shipments. Alpha numeric values only. It is shown on the bottom of the shipping label as reference 1.

Container for the Shipper's information.

Shipper's email address. Must be associated with the UserId specified in the AccessRequest XML.

Shippers company name.

For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label.

Shipper's CompanyDisplayableName.

The CompanyDisplayableName will be displayed in tracking results and notification messages in place of the name associated with the shipper account. The original shipper account name will be displayed for all Return Services and Import Control Shipments. This is available for Shipper accounts enabled by UPS and applies to Forward Shipments.

Shippers Attention Name.

For forward Shipment 35 characters are accepted, but only 30 characters will be printed on the label. Required if destination is international. Required if Invoice and CO International forms are requested and the ShipFrom address is not present.

Address tag Container. The package should be returned to this address if the package is undeliverable.

This address appears on the upper left hand corner of the label.

Note: If the ShipFrom container is not present then this address will be used as the ShipFrom address. If this address is used as the ShipFrom the shipment will be rated from this origin address.

Shipper's City. For forward Shipment 30 characters are accepted, but only 15 characters will be printed on the label.

The Shipper street address including name and number (when applicable). Up to three occurrences are allowed; only the first is printed on the label.

35 characters are accepted, but for the first occurrence, only 30 characters will be printed on the label for return shipments.

Shipper's state or province code.

For forward Shipment 5 characters are accepted, but only 2 characters will be printed on the label. For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account.

Shipper's country or territory code.

Refer to country or territory Codes in the Appendix for valid values.

Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled.

Shipper's postal code.

Shipper's Fax Number.

Container tag for Phone Number.

Shipper's phone Number. Valid values are 0 - 9.

If Shipper country or territory is US, PR, CA, and VI, the layout is: area code, 7 digit PhoneNumber or area code, 7 digit PhoneNumber, 4 digit extension number.

For other countries or territories, the layout is: country or territory code, area code, 7 digit number.

A phone number is required if destination is international.

Shipper's phone extension.

Shipper's Tax Identification Number. Conditionally required if EEI form (International forms) is requested and ship From is not mentioned. This element has been deprecated, replacement can be found in the GlobalTaxInformation container.

Shipper's six digit alphanumeric account number.

Must be associated with the UserId specified in the AccessRequest XML.

The account must be a valid UPS account number that is active.

For US, PR and CA accounts, the account must be either a daily pickup account, an occasional account, or a customer B.I.N account.

Drop Shipper accounts are valid for return service shipments only if the account is Trade Direct (TD) enabled.

All other accounts must be either a daily pickup account or an occasional account.

UPS service type.

Valid values:

• 01 = Next Day Air
• 02 = 2nd Day Air
• 03 = Ground
• 07 = Express
• 08 = Expedited
• 11 = UPS Standard
• 12 = 3 Day Select
• 13 = Next Day Air Saver
• 14 = UPS Next Day Air® Early
• 17 = UPS Worldwide Economy DDU
• 54 = Express Plus
• 59 = 2nd Day Air A.M.
• 65 = UPS Saver
• M2 = First Class Mail
• M3 = Priority Mail
• M4 = Expedited MaiI Innovations
• M5 = Priority Mail Innovations
• M6 = Economy Mail Innovations
• M7 = MaiI Innovations (MI) Returns
• 70 = UPS Access Point™ Economy
• 71 = UPS Worldwide Express Freight Midday
• 72 = UPS Worldwide Economy DDP
• 74 = UPS Express®12:00
• 75 = UPS Heavy Goods
• 82 = UPS Today Standard
• 83 = UPS Today Dedicated Courier
• 84 = UPS Today Intercity
• 85 = UPS Today Express
• 86 = UPS Today Express Saver
• 96 = UPS Worldwide Express Freight.
• C6 = Roadie XD AM (Morning delivery)
• C7 = Roadie XD PM (Afternoon delivery)
• C8 = Roadie XD (Anytime delivery)

Note: Only service code 03 is used for Ground Freight Pricing shipments The following Services are not available to return shipment: 13, 59, 82, 83, 84, 85, 86, C6, C7, C8

Description of the service code. Examples are Next Day Air, Worldwide Express, and Ground.

Master Carton ID. If Economy Service (17 or 72) : Economy Shipment will be associated with given Master Carton ID. If Non-Economy Service: Master Carton Shipment will be created for given Master Carton ID.

Total number of pieces in all pallets in a UPS Worldwide Express Freight Shipment. It is required for UPS Worldwide Express Freight and UPS Worldwide Express Freight Midday Shipment. Valid values are 1 to 99999.

Indicates single label with both MI label and CN22 form. International CN22 form is required.

If the indicator is present then the reference number's value will be bar coded on the label. This is an empty tag, any value inside is ignored. Only one shipment-level or package-level reference number can be bar coded per shipment. In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.

Shipment Reference number type code. The code specifies the Reference name. Refer to the Reference Number Code table. Valid if the origin/destination pair is not US/US or PR/PR and character should be alpha-numeric.

Customer supplied reference number. Valid if the origin/destination pair is not US/US or PR/PR

This field is used to pass the Quote ID generated from the Global Checkout API. This is mandatory to validate your Global Checkout Guaranteed Landed Cost.

Movement Reference Number (MRN) information. Must contain alphanumeric characters only. Must be a length of 18 characters. The 3rd and 4th Characters must be the Shipper country or territory ISO Code.