DGAssistant Dangerous Goods API (2.10.0)

Type of consignment by load configuration: PackagesAndReceptacles, Tank or Bulk.

Code of the workplace issuing the consignment.

Issue date of the consignment, in ISO 8601 format.

Dangerous goods regulation applicable to the consignment: Adr, Imdg, Iata or Cfr49.

Code of an existent Shipper

Shipper participant data provided directly without using a predefined record.

Code of an existent Consignee

Consignee participant data provided directly without using a predefined record.

List of predefined simple products to include in the consignment.

List of simple products fully described in the request, without predefined record.

List of predefined mixed packing products to include in the consignment.

List of mixed packing products fully described in the request, without predefined record.

Overpacks of the consignment. Processed for every regulation (ADR 5.1.2, IMDG 5.1.2, IATA 5.0.1.5). Up to version 2.7.2 they were only applied to air consignments and silently ignored otherwise.

Code of an existent Loader

Loader participant data provided directly without using a predefined record.

Code of an existent Carrier

Carrier participant data provided directly without using a predefined record.

Full name of the driver in charge of the transport.

Registration plate of the vehicle.

Registration plate of the trailer, if applicable.

Reference number of the delivery note associated with the consignment.

Emergency telephone number available during transport.

Reference number assigned to the consignment by the shipper.

Reference number assigned to the consignment by the freight forwarder.

Additional information of the consignment.

True when the consignment travels under exclusive use. Cross-modal header-level flag: renders the 'EXCLUSIVE USE SHIPMENT' mention on every Class 7 item for the three regulatory documents (ADR 5.4.1.2.5.1, IMDG 5.4.1.5.7.1.7, IATA DGR 10.8.3.9). If the property is omitted (null) the existing header value is preserved.

IATA-specific data of the consignment, when transport mode is air.

IMDG-specific data of the consignment, when transport mode is sea.

ADR-specific data of the consignment, when transport mode is road: the data that only Spain requires, such as the administrative control document.

List of document types to be generated.

Output file format of the generated document: PDF, XLSX or DOCX.

List of document types to be generated.

Output file format of the generated document: PDF, XLSX or DOCX.

Primary email recipient address.

Optional rendering settings to customize the generated document.

Email recipients to receive a carbon copy.

Unique reference of the predefined product in the catalogue.

Number of identical outer packages of this product in the consignment.

Net quantity of substance per outer package.

Gross mass of one outer package, expressed in kilograms.

Net explosive content per outer package, expressed in kilograms.

Filling degree of the package, expressed as percentage.

Authorizations or special provisions applicable to the transport.

Number of inner packages contained in each outer package.

Net quantity per inner package.

Capacity of each inner package, in litres (for aerosols, the capacity of the dispenser). It decides the IMDG stowage category of aerosols (SW22) and the statement of IMDG 5.4.1.5.8.

Net explosive content per inner package, expressed in kilograms.

Optional per-shipment radiological override for Class 7 products. Defaults to the values stored in the product catalogue.

Indicates whether the product is regulated as dangerous goods.

Indicates whether the substance is environmentally hazardous (marine pollutant). Optional when the catalogue determines it for every regulation enabled for the product: if omitted, the value is taken from the catalogue marks of the enabled regulations (UN 3077 and UN 3082 for IATA); when the catalogue leaves it undecided for any of them, the field is required.

Indicates whether the package is empty and uncleaned.

Physical state of the substance: Liquid, Solid or Gas.

Measurement unit for quantities: Kg or L.

Indicates whether the substance is pure, a mixture or a solution.

Number of identical outer packages of this product in the consignment.

Identifier of the outer package type from master data.

Indicates whether the outer package contains inner packages.

Commercial name of the product.

Internal product code assigned by the customer.

Identifier of the dangerous good entry in master data.

Percentage of the dangerous component in the mixture or solution.

Closed-cup flash point of the substance, expressed in Celsius. For Class 3 it is checked against the packing group of the dangerous good in each enabled regulation (ADR 2.2.3.1.3, IMDG 2.3.2.6, IATA 3.3.2): a flash point of 23 °C or above with packing group II is rejected when strictPackingInstructionCheck is true and reported as a warning otherwise, and a flash point below 23 °C with packing group III is always reported as a warning, since it is only admissible for viscous substances. Under 49 CFR, which is not available yet, this behaviour will be described when it is.

Control temperature in Celsius (ADR 5.4.1.2.3.1 / IMDG 5.4.1.5.4 and 5.4.1.5.5). Mandatory together with emergencyTemperature for temperature-controlled substances (UN 3111-3120, 3231-3240, 3533 and 3534); optional for stabilized substances that allow temperature control. Must be lower than emergencyTemperature.

Emergency temperature in Celsius (ADR 5.4.1.2.3.1 / IMDG 5.4.1.5.4 and 5.4.1.5.5). Provided in pair with controlTemperature and strictly higher than it.

Density of the substance, expressed in kilograms per liter. Under ADR and IMDG it is needed to verify a quantity limit expressed in a unit other than the measure unit of the product, such as a limit in kilograms for a product declared in liters; without it, that limit is not verified and the response reports it as a warning (an error with strictPackingInstructionCheck). Under 49 CFR, which is not available yet, this behaviour will be described when it is.

Identifier of the package UN homologation code from master data. Under ADR and IMDG, the net quantity and gross mass limits of the single or outer packaging are taken from the row of this homologation in the packing instruction: when it is omitted for a packaging that requires homologation, those limits are not verified and the response reports it as a warning (an error with strictPackingInstructionCheck). Under 49 CFR, which is not available yet, this behaviour will be described when it is.

Identifier of the applicable packing instruction. Under ADR and IMDG it may be omitted: the packing instruction of the dangerous good that admits the declared packaging is then applied, and its quantity limits are checked. When none or several of them admit the packaging, none is applied and its quantity limits are not verified: with strictPackingInstructionCheck the request is rejected, naming the candidates when there are several, and otherwise the response reports it as a warning with the rule reference ADR 4.1.4 or IMDG 4.1.4. Under IATA, when omitted, it is deduced from the packaging and the net quantity. Under 49 CFR, which is not available yet, this behaviour will be described when it is.

Optional. When true, the packing instruction must belong to the dangerous good and the packaging must be included in the packing instruction list for each enabled ADR or IMDG regulation: the homologation of the single or outer packaging and the inner packaging material. When absent or false, these verifications are not performed for ADR and IMDG. The IATA regulation applies this verification in all cases. Under ADR and IMDG, a quantity limit that cannot be verified because the request lacks the density (in a packing instruction or in the excepted quantity code) or the homologation of the packaging is reported as an error when true and as a warning otherwise; when true, a flash point that is not consistent with packing group II is also reported as an error instead of a warning. Not returned by any response: it is a write-time validation switch only and is not stored. When true and packingInstructionId is omitted for ADR or IMDG, the request is rejected when no packing instruction, or more than one, admits the declared packaging. Under 49 CFR, which is not available yet, this behaviour will be described when it is.

Identifier of the IMDG segregation group of the substance (IMDG Code 3.1.4), or 255 for no segregation group. It applies to the IMDG Code only. When the entry of the Dangerous Goods List already assigns segregation groups, those apply and this value is ignored. Otherwise, when it is omitted, an entry that is not an N.O.S. entry is recorded without segregation group, and an N.O.S. entry is rejected, because the consignor has to state its group.

Technical name of the substance in English: the name, such as the chemical name of the components that give the hazard, that is added in parentheses to the proper shipping name of an N.O.S. entry or of another entry that requires a technical name. It is required when the dangerous good requires a technical name under the regulations that apply to the product, and it is the name printed on the IMDG Multimodal Dangerous Goods Form and on the Shipper's Declaration for Dangerous Goods, which are issued in English.

Technical name of the substance in the language of the country of the account, such as Spanish for an account in Spain. It is printed on the transport documents that are issued in that language, such as the IMDG Multimodal Dangerous Goods Form, which uses it as second language after English. It is required, together with englishTechnicalName, when the dangerous good requires a technical name and this language is not English. It is ignored when this language is English or when another technical name of the product is already given in this language.

Technical name of the substance in the ADR official language configured for the user (English, French or German). The ADR transport document is printed in the language of the country of the account and also in this language when it is a different one. It applies to ADR only, and it is required, together with englishTechnicalName, when the dangerous good requires a technical name and the ADR official language of the user is French or German; when that language is English, englishTechnicalName is used and this value is ignored.

Net quantity of substance per outer package.

Gross mass of one outer package, expressed in kilograms.

Net explosive content per outer package, expressed in kilograms.

Filling degree of the package, expressed as percentage.

Authorizations or special provisions applicable to the transport.

Identifier of the inner package material from master data.

Number of inner packages contained in each outer package.

Net quantity per inner package.

Capacity of each inner package, in litres (for aerosols, the capacity of the dispenser). It decides the IMDG stowage category of aerosols (SW22) and the statement of IMDG 5.4.1.5.8.

Net explosive content per inner package, expressed in kilograms.

Radiological data. Mandatory when the on-the-fly product belongs to Class 7 (radioactive). Must be omitted for non-radioactive products.

Special features of the product transport mode. The extra viscous features apply to Class 3 substances under the corresponding regulation; the salvage packaging feature has no restriction.