DGAssistant Dangerous Goods API (2.10.2)

The DGAssistant Dangerous Goods API is a JSON REST API that connects your ERP, warehouse or transport management system to DGAssistant and returns dangerous goods documents compliant with ADR, IMDG, IATA and 49 CFR.

Your system sends the data of each consignment and DGAssistant supplies the regulatory knowledge: it checks every product and package against the applicable regulation, applies the most favourable exemption and returns the Transport Document, the IMO Dangerous Goods Declaration, the Shipper's Declaration for Dangerous Goods, the checklist and the marking and labelling of packages, ready to print.

It also covers consolidation and transport (master consignments, segregation checks, the dangerous goods manifest, the Notification to Captain (NOTOC) and CMR and e-CMR consignment notes), with webhooks that keep your system informed. Fewer manual steps, fewer errors and documents that follow every change in the regulations.

Master data identifiers. The identifier of a master data entry is stable: it designates the same entry in every later version of the catalogue and of the API, and it is never reused for another entry.

Repeated requests. The requestGuid parameter identifies each request in order to trace it, and it is not an idempotency key unless the operation states it: repeating a creation that was processed creates another record, so before repeating a creation whose response was not received, check whether the record was created.

Rate limits. By default, each account may send up to 4 requests per second and up to 4 requests in parallel. These are the default limits: for specific needs, they can be increased on request. Requests above the limits of the account may be rejected with the HTTP status 429 (Too Many Requests). A request rejected for this reason is not processed and does not count towards the calls of the licence, so it can be repeated safely, even when it is a creation.

Licence quotas. Each API licence includes the following quotas in each year of the licence, and each additional API licence adds the same quotas. Each year of an API licence is counted from the date of its activation, not the calendar year.

• Calls: up to 20 000 calls to the API. Every call counts, whatever its result, except the calls answered with a 5xx status (server error), the calls rejected because their credentials are not valid (401 status) and the requests rejected for exceeding the rate limits (429 status). Calls made during the evaluation of the API or during its integration do not count either.
• Consignments: up to 1 500 of those calls may create consignments (POST /consignment). Only the creations answered successfully (2xx status) count; those answered with a 3xx, 4xx or 5xx status do not. A consignment that is deleted later still counts.
• Master data: up to 5 000 master data records stored in the account at the same time: products, participants, locations of the account, vehicles, trailers and vessels.

Each consignment corresponds to one actual shipment, with its own transport document and date, so a consignment may not be reused to check or to issue the documents of other shipments. The licence agreement sets out the conditions of use of the API licence.

OpenAPI 3.0 specification

OpenAPI 2.0 (Swagger 2.0) specification