Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

FreightCommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item

FreightCommodityDetail commodity = new FreightCommodityDetail();
commodity.Description = "Computer software"
commodity.Manufacturer = "US"
commodity.Weight = "1.0"
commodity.QuantityUnit = "EA"
commodity.UnitPrice = "99.99"
commodity.HarmonizedCode = "9031.80.90"

The fields contained by this type are listed below.

Fields

Description
String

Complete and accurate description of this commodity line item.

It is applicable to all international forms and freight shipments. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

If the shipment contains documents only (i.e., Documents is set to True), then the Description has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

Description
Correspondence/No Commercial Leases
Accounting Documents Legal Documents
Analysis Reports Letters and Cards
Applications (Completed) Letter of Credit Packets
Bank Statements Loan Documents
Bid Quotations Marriage Certificates
Birth Certificates Medical Records
Bills of Sale Office Records
Bonds Operating Agreements
Business Correspondence Patent Applications
Checks (Completed) Permits
Claim Files Photocopies
Closing Statements Proposals
Conference Reports Prospectuses
Contracts Purchase Orders
Cost Estimates Quotations
Court Transcripts Reservation Confirmation
Credit Applications Resumes
Data Sheets Sales Agreements
Deeds Sales Reports
Employment Papers Shipping Documents
Escrow Instructions Statements/Reports
Export Papers Statistical Data
Financial Statements Stock Information
Immigration Papers Tax Papers
Income Statements Trade Confirmation
Insurance Documents Transcripts
Interoffice Memos Warranty Deeds
Inventory Reports
Invoices (Completed)

FreightClass
TFreightClass

Indicates the freight class of the commodity.

The following table lists freight classes available from FedEx freight services.

Freight Class
50
55
60
65
70
77.5
85
92.5
100
110
125
150
175
200
250
300
400
500

FreightPackagingType
TFreightCommodityPackagingTypes

Identifies the Commodity item's packaging type. Possible values are:

fcptOther (0)
fcptBag (1)
fcptBarrel (2)
fcptBasket (3)
fcptBox (4)
fcptBucket (5)
fcptBundle (6)
fcptCarton (7)
fcptCase (8)
fcptContainer (9)
fcptCrate (10)
fcptCylinder (11)
fcptDrum (12)
fcptEnvelope (13)
fcptHamper (14)
fcptPail (15)
fcptPallet (16)
fcptPieces (17)
fcptReel (18)
fcptRoll (19)
fcptSkid (20)
fcptTank (21)
fcptTube (22)

HandlingUnits
Integer

Number of individual handling units to which this commodity applies. (NOTE: Total of commodity-level handling units may not balance to shipment-level total handling units.)

HarmonizedCode
String

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in Description, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the HarmonizedCode is optional to be entered for each commodity line item included in shipment. At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

HazardousMaterialsOptions
Integer

Indicates the kind of hazardous material content in this commodity.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple options:

Value Meaning
0x00000001 Hazardous Materials
0x00000002 Lithium Ion Battery Exception
0x00000004 Other Regulated Materials - Domestic (ORM-D)
0x00000008 Reportable Quantities
0x00000010 Small Quantity Exception

Height
Integer

The height of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Length
Integer

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Manufacturer
String

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the Manufacturer is required to be entered.

When the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the Manufacturer and Description are required to be provided in the request. If the Manufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The Manufacturer has to be provided for each commodity item included in that international shipment.

XX may be used to indicate multiple countries of manufacturer.

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

Country Name Country Code Currency CodeMax WeightAddress Validation SupportedPostal Code Req.Euro Country
Albania AL ALL 70 KGS No No No
Algeria DZ DZD 70 KGS No No No
Andorra AD PTS 70 KGS No No No
Angola AO AOK 70 KGS No No No
Anguilla AI XCD 150 LBS No No No
Antigua & Barbuda AG XCD 150 LBS No No No
Argentina AR ARP 70 KGS Yes Yes No
Armenia AM USD 70 KGS No Yes No
Aruba AW AWG 150 LBS No No No
Australia AU AUD 70 KGS Yes Yes No
Austria (EU Member) AT EUR 70 KGS No Yes Yes
Azerbaijan AZ RUR 70 KGS No Yes No
Bahamas BS BSD 150 LBS No No No
Bahrain BH BHD 70 KGS No No No
Bangladesh BD BDT 70 KGS No Yes No
Barbados BB BBD 150 LBS No No No
Belarus BY RUR 70 KGS No Yes No
Belgium (EU Member) BE EUR 70 KGS No Yes Yes
Belize BZ BZD 150 LBS No No No
Benin BJ XOF 70 KGS No No No
Bermuda BM BMD 150 LBS No No No
Bolivia BO BOP 70 KGS No No No
Bosnia-Herzegovina BA BAD 70 KGS No Yes No
Botswana BW BWP 70 KGS No No No
Brazil BR BRC 70 KGS Yes Yes No
British Virgin IslandsVG USD 150 LBS No No No
Brunei BN BND 70 KGS No No No
Bulgaria BG BGL 70 KGS No Yes No
Burkina Faso BF XOF 70 KGS No No No
Burundi BI BIF 70 KGS No No No
Cambodia KH USD 70 KGS No No No
Cameroon CM XAF 70 KGS No No No
Canada CA CAD 150 LBS Yes Yes No
Cape Verde CV USD 70 KGS No No No
Cayman Islands KY KYD 150 LBS No No No
Central African Rep CF XAF 70 KGS No No No
Chad TD XAF 70 KGS No No No
Channel Islands CD GBP 70 KGS No Yes No
Chile CL CLP 70 KGS Yes No No
China CN CNY 70 KGS Yes Yes No
Colombia CO COP 70 KGS Yes No No
Congo CG XAF 70 KGS No No No
Cook Islands CK NZD 70 KGS No No No
Costa Rica CR CRC 70 KGS No No No
Croatia HR YUD 70 KGS No Yes No
Cyprus CY CYP 70 KGS No No No
Czech Republic CZ CZK 70 KGS No Yes No
Dem Rep of Congo (Zaire)ZR ZRZ 70 KGS No No No
Denmark (EU Member) DK DKK 70 KGS Yes Yes Yes
Djibouti DJ DJF 70 KGS No No No
Dominica DM XCD 150 LBS No No No
Dominican Republic DO DOP 150 LBS No No No
Ecuador EC ECS 70 KGS No No No
Egypt EG EGP 70 KGS No No No
El Salvador SV SVC 70 KGS No No No
Equatorial Guinea GQ XAF 70 KGS No No No
Eritrea ER DKK 70 KGS No No No
Estonia EE EEK 70 KGS No Yes No
Ethiopia ET ETB 70 KGS No No No
Faeroe Islands FO DKK 70 KGS No Yes No
Fiji FJ FJD 70 KGS No No No
Finland (EU Member) FI EUR 70 KGS No Yes Yes
France (EU Member) FR EUR 70 KGS Yes Yes Yes
French Guiana GF FRF 70 KGS No No No
French Polynesia PF XPF 70 KGS No No No
Gabon GA XAF 70 KGS No No No
Gambia GM GMD 70 KGS No No No
Georgia GE RUR 70 KGS No Yes No
Germany (EU Member) DE EUR 70 KGS Yes Yes Yes
Ghana GH GHC 70 KGS No No No
Gibraltar GI GIP 70 KGS No No No
Greece (EU Member) GR EUR 70 KGS No Yes Yes
Greenland GL DKK 70 KGS No Yes No
Grenada GD XCD 150 LBS No No No
Guadeloupe GP FRF 150 LBS No No No
Guam GU USD 150 LBS No No No
Guatemala GT GTO 70 KGS No No No
Guinea GN GNS 70 KGS No No No
Guinea-Bissau GW GWP 70 KGS No No No
Guyana GY GYD 70 KGS No No No
Haiti HT HTG 150 LBS No No No
Honduras HN HNL 70 KGS No No No
Hong Kong HK HKD 70 KGS No No No
Hungary HU HUF 70 KGS No Yes Yes
Iceland IS ISK 70 KGS No Yes Yes
India IN INR 70 KGS Yes Yes No
Indonesia ID IDR 70 KGS No Yes No
Iran IR IRR 70 KGS No No No
Iraq IQ IQD 70 KGS No No No
Ireland (EU Member) IE EUR 70 KGS Yes No Yes
Israel IL ILS 70 KGS No Yes Yes
Italy (EU Member) IT EUR 70 KGS Yes Yes Yes
Ivory Coast CI XOF 70 KGS No No No
Jamaica JM KMD 70 KGS No No No
Japan JP JPY 70 KGS Yes Yes No
Jordan JO JOD 70 KGS No No No
Kazakhstan KZ RUR 70 KGS No Yes No
Kenya KE KES 70 KGS No No No
Kiribati KI AUD 70 KGS No No No
Kuwait KW KWD 70 KGS No No No
Kyrgyzstan KG RUR 70 KGS No Yes No
Laos LA USD 70 KGS No No No
Latvia LV RUR 70 KGS No Yes No
Lebanon LB LBP 70 KGS No No No
Lesotho LS ZAR 70 KGS No No No
Liberia LR LRD 70 KGS No No No
Libya LY LYD 70 KGS No No No
Liechtenstein LI CHF 70 KGS No Yes No
Lithuania LT LTL 70 KGS No Yes No
Luxembourg LU LUF 70 KGS No Yes Yes
Macau MO MOP 70 KGS No No No
Macedonia (FYROM) MK USD 70 KGS No Yes Yes
Madagascar MG MGF 70 KGS No No No
Malawi MW MWK 70 KGS No No No
Malaysia MY MYR 70 KGS Yes Yes No
Maldives MV MVR 70 KGS No No No
Mali ML MLF 70 KGS No No No
Malta MT MTP 70 KGS No No No
Marshall Islands MH USD 70 KGS No Yes No
Martinique MQ FRF 150 LBS No Yes No
Mauritania MR MRO 70 KGS No No No
Mauritius MU MUR 70 KGS No No No
Mexico MX MXP 70 KGS Yes Yes No
Micronesia FM USD 70 KGS No Yes No
Moldova MD EUR 70 KGS No Yes Yes
Monaco (EU Member) MC EUR 70 KGS No Yes Yes
Mongolia MN USD 70 KGS No Yes No
Montserrat MS XCD 150 LBS No No No
Morocco MA MAD 70 KGS No No No
Mozambique MZ MZM 70 KGS No No No
Myanmar MM USD 70 KGS No No No
N. Mariana Islands MP USD 150 LBS No No No
Namibia NA ZAR 70 KGS No No No
Nepal NP NPR 70 KGS No Yes No
Netherlands (EU Member) NL EUR 70 KGS Yes Yes Yes
Netherlands Antilles AN ANG 150 LBS No No No
New Caledonia NC XPF 70 KGS No No No
New Zealand NZ NZD 70 KGS Yes Yes No
Nicaragua NI NIC 70 KGS No No No
Niger NE XOF 70 KGS No No No
Nigeria NG NGN 70 KGS No No No
Norfolk Island NF AUD 70 KGS No No No
Norway NO NOK 70 KGS No Yes Yes
Oman OM OMR 70 KGS No No No
Pakistan PK PKR 70 KGS No Yes No
Palau PW USD 70 KGS No Yes No
Panama PA PAB 70 KGS No No No
Papua New Guinea PG PGK 70 KGS No No No
Paraguay PY PYG 70 KGS No No No
Peru PE PES 70 KGS Yes No No
Philippines PH PHP 70 KGS Yes Yes No
Poland PL PLZ 70 KGS No Yes Yes
Portugal(EU Member) PT EUR 70 KGS No Yes Yes
Puerto Rico PR USD 150 LBS Yes Yes No
Qatar QA QAR 70 KGS No No No
Reunion Is. RE FRF 70 KGS No Yes No
Romania RO ROL 70 KGS No Yes Yes
Russia RU RUR 70 KGS No Yes No
Rwanda RW RWF 70 KGS No No No
Samoa (Amer.) AS USD 70 KGS No No No
Samoa (Western) WS NZD 70 KGS No No No
San Marino IT ITL 70 KGS No Yes Yes
Saudi Arabia SA SAR 70 KGS No Yes No
Senegal SN XOF 70 KGS No No No
Serbia & Montenegro CS YUD 70 KGS No Yes Yes
Seychelles SC SCR 70 KGS No No No
Sierra Leone SL SLL 70 KGS No No No
Singapore SG SGD 70 KGS Yes Yes No
Slovak Republic SK SKK 70 KGS No Yes Yes
Slovenia SI SIT 70 KGS No Yes Yes
Solomon Islands SB SBD 70 KGS No No No
South Africa ZA GBP 70 KGS Yes Yes No
South Korea KR KRW 70 KGS No Yes No
Spain (EU Member) ES EUR 70 KGS Yes Yes Yes
Sri Lanka LK LKR 70 KGS No Yes No
St. Christopher KN XCD 150 LBS No No No
St. Lucia LC XCD 150 LBS No No No
St. Vincent/GrenadinesVC XCD 150 LBS No No No
Sudan SD SDP 70 KGS No No No
Suriname SR SRG 70 KGS No No No
Swaziland SZ SZL 70 KGS No No No
Sweden (EU Member) SE SEK 70 KGS No Yes Yes
Switzerland CH CHF 70 KGS Yes Yes Yes
Syria SY SYP 70 KGS No No No
Taiwan TW NTD 70 KGS No Yes No
Tajikistan TJ RUR 70 KGS No Yes No
Tanzania TZ TZS 70 KGS No No No
Thailand TH THB 70 KGS No Yes No
Togo TG XOF 70 KGS No No No
Tonga TO TOP 70 KGS No No No
Trinidad & Tobago TT TTD 150 LBS No No No
Tunisia TN TND 70 KGS No No No
Turkey TR TRL 70 KGS No Yes Yes
Turkmenistan TM RUR 70 KGS No Yes No
Turks & Caicos IslandsTC USD 150 LBS No No No
Tuvalu TV AUD 70 KGS No No No
Uganda UG UGS 70 KGS No No No
Ukraine UA UAK 70 KGS No Yes No
United Arab Emirates AE AED 70 KGS No No No
United Kingdom(EU Member)GBGBP 70 KGS Yes Yes Yes
United States US USD 150 LBS Yes Yes No
Uruguay UY UYP 70 KGS No Yes No
US Virgin Islands VI USD 150 LBS No Yes No
Uzbekistan UZ RUR 70 KGS No Yes No
Vanuatu VU VUV 70 KGS No No No
Venezuela VE VEB 70 KGS Yes No No
Vietnam VN USD 70 KGS No Yes No
Wake Island WK USD 70 KGS No No No
Wallis & Futuna Isle WF XPF 70 KGS No No No
Yemen YE YER 70 KGS No No No
Zambia ZM ZMK 70 KGS No No No
Zimbabwe ZW ZWD 70 KGS No No No

NmfcCode
String

NMFC Code for commodity.

NumberOfPieces
Integer

The total number of packages, cartons, or containers for the commodity line item.

If the Documents is set to False in ship request, the NumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

PONumber
String

The PO Number for printed reference per commodity.

Quantity
Integer

Number of units contained in this commodity line item measured in units specified by the QuantityUnit. This is used in conjunction with the QuantityUnit and UnitPrice.

If the Documents is set to False in ship request, the Quantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

QuantityUnit
String

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

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the QuantityUnit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Here is a list of possible values for FedEx:

Value Description
AR Carat
CG Centigram
CM Centimeters
CM3 Cubic Centimeters
CFT Cubic Feet
M3 Cubic Meters
DOZ Dozen
DPR Dozen Pair
EA Each
GAL Gallon
G Grams
GR Gross
KGM Kilogram
KG Kilograms
LFT Linear Foot
LNM Linear Meters
LYD Linear Yard
L Liter
LTR Liters
M Meters
MG Milligram
ML Milliliter
NO Number
OZ Ounces
PR Pair
PRS Pairs
PCS Pieces
LB Pound
CM2 Square centimeters
SFT Square feet
SQI Square inches
M2 Square meters
SYD Square yards
YD Yard

UnitPrice
String

Value of each QuantityUnit in Quantity of this commodity line item. This is used in conjunction with the QuantityUnit and Quantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

When the shipment contains non-documents item(s) (i.e., the Documents is set to False), the UnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

Value
String

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

Volume
String

This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Weight
String

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the Weight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Width
Integer

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

Constructors

[VB.NET]
Public FreightCommodityDetail()

[C#]
public FreightCommodityDetail();



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal FreightClass As Integer, ByVal FreightPackagingType As Integer, ByVal HandlingUnits As Integer, ByVal HarmonizedCode As String, ByVal Manufacturer As String, ByVal NumberOfPieces As Integer, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Volume As String)

[C#]
public FreightCommodityDetail(string description, int freightClass, int freightPackagingType, int handlingUnits, string harmonizedCode, string manufacturer, int numberOfPieces, int quantity, string quantityUnit, string unitPrice, string weight, int length, int width, int height, string volume);



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal FreightClass As Integer, ByVal FreightPackagingType As Integer, ByVal HandlingUnits As Integer, ByVal Weight As String, ByVal Length As Integer, ByVal Width As Integer, ByVal Height As Integer, ByVal Volume As String)

[C#]
public FreightCommodityDetail(string description, int freightClass, int freightPackagingType, int handlingUnits, string weight, int length, int width, int height, string volume);



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal HarmonizedCode As String, ByVal Manufacturer As String, ByVal NumberOfPieces As Integer, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal Weight As String)

[C#]
public FreightCommodityDetail(string description, string harmonizedCode, string manufacturer, int numberOfPieces, int quantity, string quantityUnit, string unitPrice, string weight);



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal HarmonizedCode As String, ByVal Manufacturer As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String, ByVal Weight As String)

[C#]
public FreightCommodityDetail(string description, string harmonizedCode, string manufacturer, int quantity, string quantityUnit, string unitPrice, string weight);



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal HarmonizedCode As String, ByVal Manufacturer As String, ByVal Quantity As Integer, ByVal QuantityUnit As String, ByVal UnitPrice As String)

[C#]
public FreightCommodityDetail(string description, string harmonizedCode, string manufacturer, int quantity, string quantityUnit, string unitPrice);



[VB.NET]
Public FreightCommodityDetail(ByVal Description As String, ByVal Manufacturer As String, ByVal Weight As String)

[C#]
public FreightCommodityDetail(string description, string manufacturer, string weight);



 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0