The API makes it possible to provide and process shipment information for dangerous goods in order to ensure the safe and legally compliant transport of these materials. Specific information is required for precise processing, such as UN number, packaging type, weight and risk classification of the dangerous goods. This information complies with the standards of the ADR (European Agreement concerning the International Carriage of Dangerous Goods by Road) and facilitates compliance with international safety regulations.
The detailed information for dangerous goods must be included in the line item (dangerousGoods) and is required if you ship dangerous goods.
This documentation explains the JSON format in which all necessary information for the preparation of quotations and orders should be transmitted.
Here is an example of a shipment of lithium-ion batteries.
"lines": [
{
"unitQuantity": 1,
"unitPackageType": "KT",
"unitLength": 33,
"unitWidth": 31,
"unitHeight": 45,
"unitWeight": 11,
"content": "Batteries",
"wantsPalletExchange": false,
"isStackable": false,
"dangerousGoods": [
{
"unNo": "3480",
"substanceName": "LITHIUM-IONEN-BATTERIEN",
"packageType": "Kiste",
"quantity": 1,
"weightGross": 11,
"weightNetOrVolume": 9,
"weightNetOrVolumeUnit": "NGW",
"riskMain": "9A",
"pointsTotal": 27,
"pointsMultiplier": 3,
"adrVersion": "ADR2023",
"classificationCode": "M4",
"packagingGroup": null,
"isExemptedQuantity": false,
"isLimitedQuantity": false,
"isHighConsequencesDangerousGood": false,
"isSpecialProvision188": false,
"transportCategory": "2",
"tunnelRestriction": "(E)"
}
]
}
]UN Number Lookup (Retrieve ADR Master Data)
Customers can now retrieve dangerous goods (ADR) information directly via the Cargoboard API. They simply provide the UN number of the dangerous goods – the internationally valid identification number for hazardous materials – and instantly receive all relevant master data, e.g. the proper shipping name, hazard class, and packing group.
Previously, customers had to maintain their own external dangerous goods database. That is no longer necessary: the Cargoboard API delivers the data directly, enabling automated processing on the customer side. If an unknown UN number is requested, the API returns a clear, understandable error message instead of an unclear failure.
Use case: A customer wants to ship a vehicle powered by lithium-ion batteries (UN number 3556). Instead of manually looking up the dangerous goods data in an external database, their system queries the Cargoboard API and instantly receives all relevant ADR information – the booking can continue in a fully automated way.
Endpoint:
GET /v1/dangerous-goods/un-numbers/{unNumber}Example response (UN number 3480):
{
"unNumber": "3480",
"properShippingName": "LITHIUM-IONEN-BATTERIEN",
"adrClass": "9",
"packingGroup": null,
"classificationCode": "M4",
"adrRelease": "012",
"labels": {
"mainRisk": "9A",
"subRisks": []
},
"tunnelRestriction": "(E)",
"limitedQuantityCode": "LQ00",
"limitedQuantityQuantityText": "0",
"exemptedQuantityType": "E0",
"packagingInstructions": "P903 P908 P909 P910 P911 LP903 LP904 LP905 LP906",
"generalSpecialRegulations": "188 230 310 348 376 377 387 636 677",
"flags": {
"limitedQuantity": true,
"highConsequenceDangerousGoods": false,
"notOtherwiseSpecifiedRequired": false,
"specialRegulation274": false,
"specialRegulation61": false,
"specialRegulation640": false,
"allowedInCentralCrossDock": true,
"allowedOnLineHaul": true
}
}