Products Array

This array hold details of each itemised product within a Parcels Array. The properties are as follows:

Table 3. Products Array Properties

Property Name

Type

Manda- tory?

Description

countryOfOrigin

string

The code of the country of origin.

fabricContent

string

Details of the fabric content.

harmonisedProductCode

string

The harmonised product code (maximum length 50 characters).

miscellaneousInfo

array of type string

Additional information about the product (maximum overall length 2000 characters).

This property is is not mapped to any carrier fields for labels and manifests, and so should only be used for ad hoc information that cannot be added in other fields.

productCode

string

The product code (maximum length 50 characters).

productDescription

string

The product description.

productQuantity

long double

The quantity of the product (this must be greater than zero).

productTypeDescription

string

The description of the product type.

totalProductValue

double precision floating point number

The overall product value (in GBP).

unitProductWeight

double precision floating point number

The weight of an individual product. The units default to kilograms if Imperial units are not set (refer to How do I create consignments in Imperial Weights and Measures?).

dangerousGoods

array of type dangerousGoods

An optional set of parameters that tell a carrier that product contains Dangerous Goods.

For the full list of parameters, refer to the table below.


Customs Brokerage Parameters

The parameters are specified at the product level and are as follows:

Table 4. Customs Brokerage Properties

Property Name

Type

Manda- tory?

Description

exportReferenceNumber

alphanumeric string (5)

ECCN (Export Control Classification Number).

exportLicenseNumber

numeric string (10)

HTS (Harmonized Tariff Schedule) 10-digit code.

batteryChemCode

alphanumeric string (2)

Battery Hazard Characteristic Code.


Dangerous Goods Parameters

The parameters are as follows:

Table 5. : Dangerous Goods Parameters

Parameter

Type

Manda- tory?

Description

unId

String, 50

The UN ID standard to identify dangerous goods.

Starts with "UN" and contains a 4-digit number, e.g. "0483".

External references:

https://en.wikipedia.org/wiki/Category:Lists_of_UN_numbers

http://www.unece.org/fileadmin/DAM/trans/danger/publi/adr/adr2015/ADR2015e_WEB.pdf

shippingName

String, 255

Trade description of the goods, e.g. "COMPOUND DISPERSION, WATER-REACTIVE, FLAMMABLE, N.O.S"

External reference:

https://www.unece.org/fileadmin/DAM/trans/danger/publi/unrec/English/part3.pdf (page 147)

productClass

String, 255

Substances (including mixtures and solutions) and articles are assigned to one of nine classes according to either the hazard or the most prominent of the hazards they present, e.g. "9".

Some of these classes are subdivided into divisions, e.g. "2.3".

External reference:

http://www.unece.org/fileadmin/DAM/trans/danger/publi/adr/adr2015/ADR2015e_WEB.pdf (page 97)

packagingGroup

String, 255

From the three packing groups that can be assigned to the substance, the one that indicates the degree of danger it presents, e.g. "III".

measurementUnit

String, 50

Volumetric/mass measurement unit of the material being shipped, e.g. "ml", "kg".

amount

Double

Numeric value of the volumetric/mass measurement unit, e.g. "50", "0.7".

packagingInstructions

String, 2000

The specific standardised packaging instructions from the relevant regulatory agency that have been applied to the parcel/container.

External references:

https://www.unece.org/fileadmin/DAM/trans/danger/publi/unrec/rev16/English/Volume2.pdf

https://www.iata.org/whatwedo/cargo/dgr/Documents/lithium-battery-shipping-guidelines.pdf

packagingInstructionSection

String, 5

(for lithium batteries)

Complementary information to specify the exact 'Section of Packaging' Instructions (a mandatory piece of data for processing lithium batteries shipments).

quantity

Double

Mathematical representation of the copies/pieces/volumes of the material being transported.

This number needs to be multiplied by the amount to calculate the total content of the parcel/container.

additionalInfo

String, 255

Additional information that may be required by regulations concerning hazardous material.

packageType

String, 50

Specific description of the package/container, e.g. "Wooden pallet", "Polyethylene tubes in fiberboard box".

regulationAuthority

String, 50

Regulatory agency whose standards are being followed for the shipment, e.g. "ADR", "CFR", "IATA", "TDG".

regulationLevelCode

String, 50

Reference to the amount of the substance being transported, used to trigger different levels of controls/restrictions:

  • "LR" - Lightly Regulated

  • "FR" - Fully Regulated

  • "LQ" - Limited Quantities

  • "EQ" - Excepted Quantity.

transportationMean

String, 50

The most critical leg of the journey required to deliver the goods, e.g. "Ground", "Water", "CAO" (Cargo Aircraft Only), "PA" (Passenger Aircraft).

reportableQuantity

Boolean

A flag to indicate whether or not the quantity of a hazardous substance from Title 40, Code of Federal Regulations (40 CFR) is sufficient to trigger a report under the Comprehensive Environmental Response, Compensation, and Liability Act (CERCLA).

radioactive

Boolean

A flag to indicate whether or not the substance is radioactive.

subRiskClass

String, 5

A secondary productClass for substances presenting more than one particular hazard.

techName

String, 255

A widely recognised chemical or technical name. e.g. "Cyclotrimethylenetrinitramine, desensitized".

overPack

String, 255

Additional description for wrapping/overpack,


Code Snippet

Customs Brokerage and Dangerous Goods parameters for shipping a lithium battery product might be specified as follows:

...
<consignments xsi:type="soapenc:Array" soapenc:arrayType="tns1:Consignment[1]">
      <item xsi:type="tns1:Consignment">
      ...
          <parcels soapenc:arrayType="ns2:Parcel[1]" xsi:type="soapenc:Array">          
                <item xsi:type="tns1:Parcel">
                ...
                 <products soapenc:arrayType="ns2:Product[1]" xsi:type="soapenc:Array">
                        <products xsi:type="ns2:Product">
                           <countryOfOrigin xsi:type="soapenc:string">GBR</countryOfOrigin>
                           <exportReferenceNumber xsi:type="soapenc:string">1AA99</exportReferenceNumber>
                           <exportLicenseNumber xsi:type="soapenc:string">48201020</exportLicenseNumber>
                           <batteryChemCode xsi:type="soapenc:string">Z6</batteryChemCode>                           
                           <fabricContent xsi:type="soapenc:string">1</fabricContent>
                           <harmonisedProductCode xsi:type="soapenc:string">1</harmonisedProductCode>
                           <miscellaneousInfo xsi:type="soapenc:Array" xsi:nil="true"/>
                           <productCode xsi:type="soapenc:string">1</productCode>
                           <productDescription xsi:type="soapenc:string">1</productDescription>
                           <productQuantity xsi:type="xsd:long">1</productQuantity>
                           <productTypeDescription xsi:type="soapenc:string">1</productTypeDescription>
                           <totalProductValue xsi:type="xsd:double">20.0</totalProductValue>
                           <unitProductWeight xsi:type="xsd:double">2.0</unitProductWeight>
                               <dangerousGoods soapenc:arrayType="ns2:DangerousGoods[2]" xsi:type="soapenc:Array">
                                 <dangerousGoods xsi:type="ns2:DangerousGoods">
                                 <unId>UNID 3090</unId>
                                 <shippingName>Lithium metal batteries</shippingName>
                                 <productClass>9</productClass>
                                 <packagingGroup>III</packagingGroup>
                                 <packagingInstructions>Must be placed in inner packagings that completely enclose the cell or battery then placed in an outer packaging</packagingInstructions>
                                 <packagingInstructionSection>965</packagingInstructionSection>
                                 <amount>2</amount>
                                 <measurementUnit>Kg</measurementUnit>
                                 <additionalInfo>Lithium ion batteries packed in accordance with packing instruction 965 are forbidden on passenger aircraft</additionalInfo>
                                 </dangerousGoods>
                               </dangerousGoods>
                        </products>
                  </products>
                  ...
           </item>
          </parcels>
      ...
      </item>
</consignments>
...