How do I tell a carrier that a product contains Dangerous Goods?

You can use the parameters listed in the table below to flag to a carrier that a product within a consignment contains Dangerous Goods.

Having declared the product within the <consignment>, you set up a <dangerousGoods> array containing the relevant parameters from those indicated in the Dangerous Goods table in the Products Array.

For an example of the parameters' use, refer to the section at the end of this article.

Note

You cannot set Carrier Allocation Rules for Dangerous Goods.

Example: Notifying a carrier that a product contains lithium batteries

You add the parameters within a <dangerousGoods> array inside a product.

The following example shows you how to notify a carrier via the Shipping API method despatchConsignmentWithBookingCode that a parcel contains Dangerous Goods in the form of lithium batteries:

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="urn:DeliveryManager/services" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:despatchConsignmentWithBookingCode soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
          <consignment xsi:type="typ:Consignment" xmlns:typ="urn:DeliveryManager/types">
               <consignmentWeight xsi:type="xsd:double">2.0</consignmentWeight>
               <orderNumber xsi:type="soapenc:string">Danger 1234</orderNumber>
              <parcelCount xsi:type="xsd:int">1</parcelCount>
               <parcels soapenc:arrayType="ns2:Parcel[1]" xsi:type="soapenc:Array">
                  <parcels xsi:type="ns2:Parcel">
                  ...                    
                     <products soapenc:arrayType="ns2:Product[1]" xsi:type="soapenc:Array">
                        <products xsi:type="ns2:Product">
                           <countryOfOrigin xsi:type="soapenc:string">GBR</countryOfOrigin>
                          ...
                           <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>
                     <recipientReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <reference xsi:type="soapenc:string" xsi:nil="true"/>
                     <senderReference xsi:type="soapenc:string" xsi:nil="true"/>
                     <trackingCode xsi:type="soapenc:string" xsi:nil="true"/>
                     <trackingUrl xsi:type="soapenc:string" xsi:nil="true"/>
                  </parcels>   
                  </parcels>            
               ...
        </consignment>
        <bookingCode xsi:type="soapenc:string">@NEXT</bookingCode>
        <calculateTaxAndDuty xsi:type="xsd:boolean">false</calculateTaxAndDuty>
        ...
      </ser:despatchConsignmentWithBookingCode>
   </soapenv:Body>
</soapenv:Envelope>

When you open the resulting 'Ready to manifest' consignment in the GUI and look under the Dangerous Goods tab, you will see the information that was entered via the API, e.g.

Dangerous_Goods.png