Skip to content

Dangerous Goods API

Consignments

Creation of a consignment with all its contents (batch) or with its first content (interactive), and retrieval and deletion of consignments

Create a consignment in batch or start an interactive consignment

Creates a new consignment, optionally including the first contents for interactive workflows. Overpacks in the body are processed for every regulation (ADR, IMDG and IATA). In batch processing, when a line aborts the transaction of the batch, every remaining line is reported as not added, with its position in the list, starting at 0.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Request Body schema: application/json
required

participants (shipper, carrier, loader ...) and goods

consignmentType
required
string
Enum: "PackagesAndReceptacles" "Tank" "Bulk"

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

workPlaceCode
required
string

Code of the workplace issuing the consignment.

date
required
string <date>

Issue date of the consignment, in ISO 8601 format.

regulation
required
string
Enum: "Adr" "Imdg" "Iata" "Cfr49"

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

predefinedShipperCode
string

Code of an existent Shipper

object

Shipper participant data provided directly without using a predefined record.

name
required
string

Legal or commercial name of the participant.

address
required
string

Postal address of the participant.

city-town
required
string

City or town of the participant.

province-region-state
required
string

Province, region or state of the participant, as free text of up to 50 characters with no fixed format. It cannot be empty when the participant is of type Shipper, Loader, Carrier, Consignee or Supplier; for the other types it may be empty. When the participant has no province, region or state, send a hyphen (-); a dot or a comma are also accepted, and the transport documents and the package marks then leave the value out.

postalCode
required
string

Postal code of the participant address, as free text of up to 50 characters with no fixed format. It cannot be empty when the participant is of type Shipper, Loader, Carrier, Consignee or Supplier; for the other types it may be empty. When the address has no postal code, send a hyphen (-); a dot or a comma are also accepted, and the transport documents and the package marks then leave the value out.

countryId
required
integer

Identifier of the country from master data.

telephone
string

Telephone number of the participant.

fax
string

Fax number of the participant.

contactPerson
string

Name of the contact person at the participant.

taxCode
string

Tax identification code of the participant.

status
string

Position or capacity of the contact person within the participant organisation, such as Managing Director or Shipping Manager.

predefinedConsigneeCode
string

Code of an existent Consignee

object

Consignee participant data provided directly without using a predefined record.

Array of objects (SimpleProductTransportMode)

List of predefined simple products to include in the consignment.

Array [
reference
required
string

Unique reference of the predefined product in the catalogue.

numberOfPackages
required
integer

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

unitaryQuantity
number

Net quantity of substance per outer package.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

unitaryQuantityExplosive
number

Net explosive content per outer package, expressed in kilograms.

fillingDegree
number

Filling degree of the package, expressed as percentage.

authorizations
string

Authorizations or special provisions applicable to the transport.

innerPackagesNumber
integer

Number of inner packages contained in each outer package.

innerPackageQuantity
number

Net quantity per inner package.

innerPackageCapacity
number

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.

innerPackageQuantityExplosive
number

Net explosive content per inner package, expressed in kilograms.

object

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

Array of objects (ProductRadiologicalNuclide)

List of radionuclides contained in the product (1..N). The radiological block is mandatory for every Class 7 product, including the excepted packages UN 2908-2911: at least one entry, with a radionuclide code and a strictly positive activity per package, is required for every package type, because the underlying record requires a radionuclide and a strictly positive activity. Each entry has the radionuclide code and the activity per package in Bq. The server computes the A2 multiple of the consignment detail as the sum over all entries of (activity_i / A2_i_in_Bq).

Array [
radionuclideCode
required
string

Radionuclide code as listed in the radionuclide catalogue (for example 'Co-60', 'Cs-137', 'Ir-192', 'Sr-90').

activityBq
required
number

Maximum activity per package during transport for this radionuclide, expressed in becquerels (Bq). SI units only; strictly positive.

]
packageType
string
Enum: "Excepted" "IndustrialPackage1" "IndustrialPackage2" "IndustrialPackage3" "TypeA" "TypeASpecialForm" "TypeBU" "SpecialArrangement"

Package type. Allowed values: Excepted (UN 2908-2911); IndustrialPackage1 (IP-1, UN 2912 LSA-I, UN 2913 SCO-I); IndustrialPackage2 (IP-2, UN 2913 SCO-II, UN 3321 LSA-II liquid/gas, UN 3322 LSA-III under exclusive use); IndustrialPackage3 (IP-3, UN 3321 LSA-II solid, UN 3322 LSA-III); TypeA (UN 2915, normal form); TypeASpecialForm (UN 3332, certificate reference mandatory); TypeBU (UN 2916 unilateral approval, certificate reference mandatory); SpecialArrangement (UN 2919, transported under special arrangement: category IIIYellow and certificate reference with type code X mandatory).

isSpecialForm
boolean

True if the radioactive material is in special form (special form certificate required). Only meaningful when packageType = TypeASpecialForm.

isFissile
boolean

True if the radioactive material is fissile (not fissile-excepted). Out of scope for this version; must be false.

category
string
Enum: "IWhite" "IIYellow" "IIIYellow"

Package category (ADR 2.2.7.2.4 / IMDG 2.7.2.4 / IATA 10.5.7). Allowed values: IWhite (maximum radiation level less than or equal to 0.005 mSv/h, TI must be zero); IIYellow (greater than 0.005 mSv/h and up to 0.5 mSv/h, TI up to 1); IIIYellow (greater than 0.5 mSv/h and up to 2 mSv/h, TI greater than 1). Optional for Excepted packages. IIIYellow is mandatory for SpecialArrangement packages.

transportIndex
number

Transport Index (TI). Dimensionless, rounded up to one decimal place. Optional for Excepted packages.

certificateRef
string

Certificate reference. Mandatory for TypeASpecialForm (UN 3332), TypeBU (UN 2916) and SpecialArrangement (UN 2919; it must contain the special arrangement mark with type code X). Examples: 'ES/4567/S-96', 'ES/4567/B(U)', 'FIN/123/X'. Not applicable to Industrial Packages (IP-1/2/3) which follow the prescriptive design of ADR 6.4.5-6.4.7.

physicoChemical
string

Description of the physical and chemical form of the contents.

surfaceDoseRate
number

Maximum surface dose rate of the package, in mSv/h. Used together with the transport index to determine the package category, taking the more restrictive of the two (ADR/IMDG 5.1.5.3.4).

packageDimensions
string <= 60 characters

Overall package dimensions including units, in the order length x width (or diameter) x height, for example "L 30 cm x W 30 cm x H 40 cm". Required by the air transport document (ICAO TI 2025-26 5;4.1.5.7.1 f)) for packages of category IIYellow or IIIYellow in IATA consignments; not used by ADR or IMDG.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
Array of objects (SimpleProductTransportModeOnTheFly)

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

Array [
isDangerousGood
required
boolean

Indicates whether the product is regulated as dangerous goods.

isEnvironmentallyHazardous
required
boolean

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.

isEmpty
required
boolean

Indicates whether the package is empty and uncleaned.

physicalState
required
string
Enum: "Liquid" "Solid" "Gas"

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

measureUnit
required
string
Enum: "Kg" "L"

Measurement unit for quantities: Kg or L.

pureMixOrSolution
required
string
Enum: "Pure" "Mix" "Solution"

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

numberOfPackages
required
integer

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

packageId
required
integer

Identifier of the outer package type from master data.

hasInnerPackages
required
boolean

Indicates whether the outer package contains inner packages.

productName
string

Commercial name of the product.

productCode
string

Internal product code assigned by the customer.

dangerousGoodId
integer

Identifier of the dangerous good entry in master data.

mixOrSolutionPercentage
number

Percentage of the dangerous component in the mixture or solution.

flashPoint
number

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.

controlTemperature
number

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.

emergencyTemperature
number

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
number

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.

packageHomologationId
integer

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.

packingInstructionId
integer

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.

strictPackingInstructionCheck
boolean

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.

imdgSegregationGroupId
integer

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.

englishTechnicalName
string

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.

countryOfOriginLanguageTechnicalName
string

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.

adrPrincipalLanguageTechnicalName
string

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.

unitaryQuantity
number

Net quantity of substance per outer package.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

unitaryQuantityExplosive
number

Net explosive content per outer package, expressed in kilograms.

fillingDegree
number

Filling degree of the package, expressed as percentage.

authorizations
string

Authorizations or special provisions applicable to the transport.

innerPackageMaterialId
integer

Identifier of the inner package material from master data.

innerPackagesNumber
integer

Number of inner packages contained in each outer package.

innerPackageQuantity
number

Net quantity per inner package.

innerPackageCapacity
number

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.

innerPackageQuantityExplosive
number

Net explosive content per inner package, expressed in kilograms.

object

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

specialFeatures
string
Enum: "IsExtraViscousAccordingAdr" "IsExtraViscousAccordingImdg" "IsSalvagePackage"

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.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
Array of objects (MixedPackingProductTransportMode)

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

Array [
reference
required
string

Unique reference of the predefined mixed packing in the catalogue.

numberOfPackages
required
integer

Number of identical outer packages of this mixed packing in the consignment.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
Array of objects (MixedPackingProductTransportModeOnTheFly)

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

Array [
numberOfPackages
required
integer

Number of identical outer packages of this mixed packing in the consignment.

outerPackageId
required
integer

Identifier of the outer package type from master data.

outerPackageHomologationId
required
integer

Identifier of the outer package UN homologation code from master data.

required
Array of objects (MixedPackingProductTransportModeContent)

List of contents within the mixed packing.

Array [
isEnvironmentallyHazardous
required
boolean

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.

physicalState
required
string
Enum: "Liquid" "Solid" "Gas"

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

measureUnit
required
string
Enum: "Kg" "L"

Measurement unit for quantities: Kg or L.

pureMixOrSolution
required
string
Enum: "Pure" "Mix" "Solution"

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

numberOfInnerPackages
required
integer

Number of inner packages of this content within the mixed packing.

innerPackageMaterialId
required
integer

Identifier of the inner package material from master data.

innerPackageQuantity
required
number

Net quantity per inner package.

dangerousGoodId
integer

Identifier of the dangerous good entry in master data. Class 7 (radioactive) entries are rejected as contents of a mixed packing: declare radioactive material as a simple product with radiological.nuclides[].

mixOrSolutionPercentage
number

Percentage of the dangerous component in the mixture or solution.

flashPoint
number

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.

density
number

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 content, such as the net quantity limit in kilograms of the outer packaging for a content declared in liters, or an excepted quantity limit in milliliters for a liquid declared in kilograms; 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.

imdgSegregationGroupId
integer

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.

englishTechnicalName
string

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.

countryOfOriginLanguageTechnicalName
string

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.

adrPrincipalLanguageTechnicalName
string

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.

authorizations
string

Authorizations or special provisions applicable to the transport.

packingInstructionId
integer

Identifier of the applicable packing instruction. Under ADR and IMDG it may be omitted: the packing instruction of the dangerous good that admits the outer packaging of the mixed packing and the inner packaging material of the content is then applied, and its quantity limits are checked. When none or several of them admit it, 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.

strictPackingInstructionCheck
boolean

Optional. When true, for each enabled ADR or IMDG regulation the packing instruction of the content must belong to the dangerous good, and the outer packaging of the mixed packing and the inner packaging material of the content must be included in its list. 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, 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 packaging of the content. Under 49 CFR, which is not available yet, this behaviour will be described when it is.

innerPackageCapacity
number

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.

innerPackageQuantityExplosive
number

Net explosive content per inner package, expressed in kilograms.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
productName
string

Commercial name of the mixed packing product.

productCode
string

Internal product code assigned by the customer.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
Array of objects (Overpack)

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.

Array [
identifiersOfOverpacks
required
Array of strings

identifier for each identical overpacks

numberOfOverpacks
required
integer >= 1

number of identical overpacks

Array of objects (SimpleProductTransportMode)

Predefined simple products grouped within the overpack.

Array of objects (SimpleProductTransportModeOnTheFly)

Simple products fully described in the request, grouped within the overpack.

Array of objects (MixedPackingProductTransportMode)

Predefined mixed packing products grouped within the overpack.

Array of objects (MixedPackingProductTransportModeOnTheFly)

Mixed packing products fully described in the request, grouped within the overpack.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

]
predefinedLoaderCode
string

Code of an existent Loader

object

Loader participant data provided directly without using a predefined record.

predefinedCarrierCode
string

Code of an existent Carrier

object

Carrier participant data provided directly without using a predefined record.

driver
string

Full name of the driver in charge of the transport.

vehicleRegistration
string

Registration plate of the vehicle.

trailerRegistration
string

Registration plate of the trailer, if applicable.

deliveryNoteNumber
string

Reference number of the delivery note associated with the consignment.

emergencyPhone
string

Emergency telephone number available during transport.

shipperReferenceNumber
string

Reference number assigned to the consignment by the shipper.

freightForwarderReference
string

Reference number assigned to the consignment by the freight forwarder.

additionalInformation
string

Additional information of the consignment.

isExclusiveUseShipment
boolean

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.

object

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

signatureNameAndStatusOfDeclarant
required
string

Name and status of the declarant signing the document.

signatureDate
required
string <date>

Date of the declarant signature, in ISO 8601 format.

airWaybillNumber
string

Air waybill number of the consignment.

airportOfDeparture
string <= 250 characters

Airport of departure of the consignment.

airportOfDestination
string <= 250 characters

Airport of destination of the consignment.

signaturePlace
string

Place where the declarant signature is performed.

object

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

signatureCompany
required
string

Company of the declarant signing the transport document.

signatureNameAndStatusOfDeclarant
required
string

Name and status of the declarant signing the document.

signatureDate
required
string <date>

Date of the declarant signature, in ISO 8601 format.

signaturePlace
required
string

Place where the declarant signature is performed.

vessel
string <= 250 characters

Identification of the vessel transporting the consignment.

portOfDeparture
string <= 250 characters

Port of departure of the consignment.

portOfDischarge
string <= 250 characters

Port of discharge of the consignment.

containerOrVehicleIdentification
string <= 250 characters

Identification of the container or vehicle transporting the consignment.

sealNumber
string <= 250 characters

Identification number of the security seal.

sizeAndType
string <= 250 characters

Size and type of the container or vehicle.

tareMass
number [ 0 .. 999999999 ]

Tare mass of the container or vehicle, in kilograms.

totalGrossMass
number [ 0 .. 999999999 ]

Total gross mass of the container or vehicle, in kilograms.

packingCertificateCompany
string

Company issuing the container packing certificate.

packingCertificateNameAndStatusOfDeclarant
string

Name and status of the declarant of the container packing certificate.

packingCertificateDate
string <date>

Date of the container packing certificate, in ISO 8601 format, between 1900-01-01 and 2079-06-06.

packingCertificatePlace
string

Place where the container packing certificate is issued.

object

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

object

Data of the consignment that only Spain requires: the administrative control document.

object

Data of the administrative control document. Only necessary for the administrative control document of national road transport in Spain; not required for ADR, IMDG, IATA or CFR49 documentation.

predefinedContractualShipperCode
string or null

Code of the predefined participant acting as contractual shipper, when different from the shipper of the consignment.

object (ParticipantOnTheFly)

Participant (shipper, consignee, loader and others) that is not predefined in the catalogue and is described on the fly.

predefinedEffectiveCarrierCode
string or null

Code of the predefined participant acting as effective carrier, when different from the carrier of the consignment.

object (ParticipantOnTheFly)

Participant (shipper, consignee, loader and others) that is not predefined in the catalogue and is described on the fly.

specialTransportAuthorization
string or null <= 250 characters

Special circulation authorisation reference, when applicable.

shipperRemarks
string or null <= 1000 characters

Remarks and reservations of the contractual shipper.

carrierRemarks
string or null <= 1000 characters

Remarks and reservations of the effective carrier.

specialFeatures
Array of strings (ConsignmentSpecialFeature)
Items Enum: "ShowRedStripes" "ShowBlueStripes" "ShowMarksForAllPackages" "ShowLabelsForAllPackages" "ShowMultimodalIataDeclaration" "DuplicateIataIdentification" "AdministrativeControlDocument"

Optional features of the consignment. Each one enables a specific behaviour or document and applies only to certain regulations; a feature that does not apply to the regulation of the consignment is rejected. When the field is omitted, the applicable defaults are applied.

Responses

201

Created

Response Schema: application/json

newItemId
integer

Identifier assigned to the newly created item.

newItemIsValid
boolean

Indicates whether the newly created item passed regulatory validation.

success
boolean

Indicates whether the item creation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the item creation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

Array [
code
required
string
Enum: "ACCOUNT_0001" "ACCOUNT_0002" "ACCOUNT_0003" "ACCOUNT_LICENSE_EXPIRED" "AMBIGUOUS_URL" "AUTHENTICATION_FAILED" "CONSIGNMENT_0001" "CONSIGNMENT_0002" "CONSIGNMENT_0003" "CONSIGNMENT_0004" "CONSIGNMENT_0005" "CONSIGNMENT_0006" "CONSIGNMENT_0007" "CONSIGNMENT_0008" "CONSIGNMENT_0009" "CONSIGNMENT_0010" "CONSIGNMENT_0011" "CONSIGNMENT_0012" "CONSIGNMENT_0013" "CONSIGNMENT_0014" "CONSIGNMENT_0015" "CONSIGNMENT_0016" "CONSIGNMENT_0017" "CONSIGNMENT_0018" "CONSIGNMENT_0019" "CONSIGNMENT_0020" "CONSIGNMENT_0021" "CONSIGNMENT_0022" "CONSIGNMENT_0023" "CONSIGNMENT_0024" "CONSIGNMENT_0025" "CONSIGNMENT_0026" "CONSIGNMENT_0027" "CONSIGNMENT_0028" "CONSIGNMENT_0029" "CONSIGNMENT_0030" "CONSIGNMENT_0031" "CONSIGNMENT_0032" "CONSIGNMENT_0033" "CONSIGNMENT_0034" "CONSIGNMENT_NOTE_0001" "CONSIGNMENT_NOTE_0002" "CONSIGNMENT_NOTE_0003" "CONSIGNMENT_NOTE_0004" "CONSIGNMENT_NOTE_0005" "CONSIGNMENT_NOTE_0006" "CONSIGNMENT_NOTE_0007" "CONSIGNMENT_NOTE_0008" "CONSIGNMENT_NOTE_0009" "CONSIGNMENT_NOTE_0010" "CONSIGNMENT_NOTE_0011" "CONSIGNMENT_NOTE_0012" "CONSIGNMENT_NOTE_0013" "CONSIGNMENT_NOTE_0014" "CONSIGNMENT_NOTE_0015" "CONSIGNMENT_NOTE_0016" "CONSIGNMENT_NOTE_0017" "CONSIGNMENT_NOTE_0018" "CONSIGNMENT_NOTE_0019" "CONSIGNMENT_NOTE_0020" "CONSIGNMENT_NOTE_0021" "CONSIGNMENT_NOTE_0022" "CONSIGNMENT_NOTE_0023" "CONSIGNMENT_NOTE_0024" "CONSIGNMENT_NOTE_0025" "CONSIGNMENT_NOTE_0026" "CONSIGNMENT_NOTE_0027" "CONSIGNMENT_NOTE_0028" "CONSIGNMENT_NOTE_0029" "CONSIGNMENT_NOTE_0030" "CONSIGNMENT_NOTE_0031" "CONSIGNMENT_NOTE_0032" "CONSIGNMENT_NOTE_0033" "CONSIGNMENT_NOTE_0034" "CONSIGNMENT_NOTE_0035" "CONSIGNMENT_NOTE_0036" "CONSIGNMENT_NOTE_0037" "CONSIGNMENT_NOTE_0038" "CONSIGNMENT_NOTE_0039" "CONSIGNMENT_NOTE_0040" "CONSIGNMENT_NOTE_0041" "CONSIGNMENT_NOTE_0042" "CONSIGNMENT_NOTE_0043" "CONSOLIDATION_0001" "CONSOLIDATION_0002" "CONSOLIDATION_0003" "CONSOLIDATION_0004" "CONSOLIDATION_0005" "CONSOLIDATION_0006" "CONSOLIDATION_0007" "CONSOLIDATION_0008" "CONSOLIDATION_0009" "CONSOLIDATION_0010" "CONSOLIDATION_0011" "CONSOLIDATION_0012" "CONSOLIDATION_0013" "CONSOLIDATION_0014" "CONSOLIDATION_0015" "CONSOLIDATION_0016" "CONSOLIDATION_0017" "CONSOLIDATION_0018" "CONSOLIDATION_0019" "CONSOLIDATION_0020" "CONSOLIDATION_0021" "CONSOLIDATION_0022" "CONSOLIDATION_0023" "CONSOLIDATION_0024" "CONSOLIDATION_0025" "CONSOLIDATION_0026" "CONSOLIDATION_0027" "CONSOLIDATION_0028" "CONSOLIDATION_0029" "CONSOLIDATION_0030" "CONSOLIDATION_0031" "CONSOLIDATION_0032" "CONSOLIDATION_0033" "CONSOLIDATION_0034" "CONSOLIDATION_0035" "CONSOLIDATION_0036" "CONSOLIDATION_0037" "CONSOLIDATION_0038" "CONSOLIDATION_0039" "CONSOLIDATION_0040" "CONSOLIDATION_0041" "CONSOLIDATION_0042" "CONSOLIDATION_0043" "CONSOLIDATION_0044" "CONSOLIDATION_0045" "CONSOLIDATION_0046" "CONSOLIDATION_0047" "CONSOLIDATION_0048" "CONSOLIDATION_0049" "CONSOLIDATION_0050" "CONSOLIDATION_0051" "CONSOLIDATION_0052" "CONSOLIDATION_0053" "CONSOLIDATION_0054" "CONSOLIDATION_0055" "CONSOLIDATION_0056" "CONSOLIDATION_0057" "CONSOLIDATION_0058" "CONSOLIDATION_0059" "CONSOLIDATION_0060" "CONSOLIDATION_0061" "CONSOLIDATION_0062" "CONSOLIDATION_0063" "CONSOLIDATION_0064" "CONSOLIDATION_0065" "CONSOLIDATION_0066" "CONSOLIDATION_0067" "CONSOLIDATION_0068" "CONSOLIDATION_0069" "CONSOLIDATION_0070" "CONSOLIDATION_0071" "CONSOLIDATION_0072" "CONSOLIDATION_0073" "CONSOLIDATION_0074" "CONSOLIDATION_0075" "CONSOLIDATION_0076" "CONSOLIDATION_0077" "CONSOLIDATION_0078" "CONSOLIDATION_0079" "CONSOLIDATION_0080" "CONSOLIDATION_0081" "CONSOLIDATION_0082" "CONSOLIDATION_0083" "CONSOLIDATION_0084" "CONSOLIDATION_0085" "CONSOLIDATION_0086" "CONSOLIDATION_0087" "CONSOLIDATION_0088" "CONSOLIDATION_0089" "CONSOLIDATION_0090" "CONSOLIDATION_0091" "CONSOLIDATION_0092" "CONSOLIDATION_0093" "CONSOLIDATION_0094" "CONSOLIDATION_0095" "CONSOLIDATION_0096" "CONSOLIDATION_0097" "CONSOLIDATION_0098" "CONSOLIDATION_0099" "CONSOLIDATION_0100" "CONSOLIDATION_0101" "CONSOLIDATION_0102" "CONSOLIDATION_0103" "CONSOLIDATION_0104" "CONSOLIDATION_0105" "CONSOLIDATION_0106" "CONSOLIDATION_0107" "CONSOLIDATION_0108" "CONSOLIDATION_0109" "CONSOLIDATION_0110" "CONSOLIDATION_0111" "CONSOLIDATION_0112" "CONSOLIDATION_0113" "CONSOLIDATION_0114" "CONSOLIDATION_0115" "CONSOLIDATION_0116" "CONSOLIDATION_0117" "CONSOLIDATION_0118" "CONSOLIDATION_0119" "CONSOLIDATION_0120" "CONSOLIDATION_0121" "CONSOLIDATION_0122" "CONSOLIDATION_0123" "CONSOLIDATION_0124" "CONSOLIDATION_0125" "CONSOLIDATION_0126" "DOCUMENT_0001" "DOCUMENT_0002" "DOCUMENT_0003" "DOCUMENT_0004" "DOCUMENT_0005" "DOCUMENT_0006" "DOCUMENT_0007" "DOCUMENT_0008" "FIELDS_HAVE_INVALID_VALUE" "GOOD_0001" "GOOD_0002" "GOOD_0003" "GOOD_0004" "GOOD_0005" "GOOD_0006" "GOOD_0007" "GOOD_0008" "GOOD_0009" "GOOD_0010" "GOOD_0011" "INVALID_CONTENT_TYPE" "INVALID_DATA" "INVALID_NAME" "INVALID_NUMBER_OF_IDENTIFIERS" "INVALID_REQUEST_GUID" "MORE_THAN_ONE_ITEM_FOUND" "NAME_CAN_NOT_CONTAIN" "NAME_IS_TOO_LONG" "NOT_ALLOWED_TO_PERFORM_OPERATION" "NOT_AUTHENTICATED" "NOT_AVAILABLE_FOR_REGULATION" "NOT_DEFINED_OR_NOT_GRANTED_DATA" "NOT_VALID_VALUE_FOR_PARAMETER" "NO_ONE_ITEM_SELECTED" "NUMBER_OF_ITEMS_EXCEED" "OPERATION_NOT_ACCOMPLISHED" "PACKAGE_0001" "PACKAGE_0002" "PACKAGE_0003" "PACKAGE_0004" "PACKAGE_0005" "PACKAGE_0006" "PACKAGE_0007" "PACKAGE_0008" "PARTICIPANT_0001" "PARTICIPANT_0002" "PARTICIPANT_0003" "PARTICIPANT_0004" "PARTICIPANT_0005" "PARTICIPANT_0006" "PARTICIPANT_0007" "PARTICIPANT_0008" "PARTICIPANT_0009" "PARTICIPANT_0010" "PARTICIPANT_0011" "PARTICIPANT_0012" "PRODUCT_0001" "PRODUCT_0002" "PRODUCT_0003" "PRODUCT_0004" "PRODUCT_0005" "PRODUCT_0006" "PRODUCT_0007" "PRODUCT_0008" "PRODUCT_0009" "PRODUCT_0010" "PRODUCT_0011" "PRODUCT_0012" "PRODUCT_0013" "PRODUCT_0014" "PRODUCT_0015" "PRODUCT_0016" "PRODUCT_0017" "PRODUCT_0018" "PRODUCT_0019" "PRODUCT_0020" "PRODUCT_0021" "PRODUCT_0022" "PRODUCT_0023" "PRODUCT_0024" "PRODUCT_0025" "PRODUCT_0026" "PRODUCT_0027" "PRODUCT_0028" "PRODUCT_0029" "PRODUCT_0030" "PRODUCT_0031" "PRODUCT_0032" "PRODUCT_0033" "PRODUCT_0034" "PRODUCT_0035" "PRODUCT_0036" "PRODUCT_0037" "PRODUCT_0038" "RADIOLOGICAL_0001" "RADIOLOGICAL_0002" "REGULATION_LICENSE_REQUIRED" "REGULATION_NO_ONE_REGULATION" "REQUEST_NOT_AUTHORIZED" "REQUEST_VALUE_NOT_VALID" "REQUIRED_FIELDS_ARE_EMPTY_OR_NOT_VALID" "ROLE_NOT_ALLOWED" "UNEXPECTED_ERROR" "UNSUPPORTED_MEDIA_TYPE" "WASTE_0001" "WASTE_0002" "WEBHOOK_0001" "WEBHOOK_0002" "WEBHOOK_0003" "WEBHOOK_0004"

Stable machine-readable code of the error or the warning. General errors have a descriptive code; the errors and warnings of the rules of each functional area have the name of the area, an underscore and four digits, and message describes the problem. New values may be added; clients must accept unknown values.

message
required
string

Text of the error or the warning, in the language of the user.

parameter
string

Element of the request that the entry refers to, with the JSON names of its path joined by dots and without list positions. Absent when the entry does not refer to an element of the request.

parameterValue
string

Value received for the element that the entry refers to, when it is known.

parameterPosition
string

Position of the element in the innermost list of its path, starting at 0. Absent when the element is not inside a list.

pointer
string

JSON Pointer (RFC 6901) to the element of the request body, with every list position starting at 0. An empty string refers to the whole body. Absent for path, query and header parameters and when the entry does not refer to the body.

ruleReference
string

Paragraph of the regulation or packing instruction on which the finding is based, when the rule has one.

object

Pair of items, required separation and verdict, only for the entries of a segregation check.

leftConsignmentId
required
integer

Identifier of the consignment of the first item.

rightConsignmentId
required
integer

Identifier of the consignment of the second item.

requiredSeparation
required
string
Enum: "NotRequired" "AwayFrom" "SeparatedFrom" "SeparatedByCompleteCompartmentOrHold" "SeparatedLongitudinallyByInterveningCompleteCompartmentOrHold" "MixedLoadingProhibited"

Separation required by the rule.

verdict
required
string
Enum: "Allowed" "AllowedWithConditions" "Forbidden"

Verdict for the pair.

leftConsignmentItemCode
string

Code of the first item in its consignment.

leftEquipmentId
integer

Identifier of the transport equipment of the first item, for the movement scope.

rightConsignmentItemCode
string

Code of the second item in its consignment.

rightEquipmentId
integer

Identifier of the transport equipment of the second item, for the movement scope.

ruleReference
string

Rule applied: IMDG 7.2.4, a segregation code (SG), IMDG 7.4.2.2, ADR 7.5.2.1 or the name of a rule of the account.

remarks
string

Regulatory text, condition or recommended action, such as moving the item to other transport equipment.

]
400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

404

Consignment not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

post/consignment
https://emea.dgassistant.com/api/v2/rest/consignment
https://amer.dgassistant.com/api/v2/rest/consignment
https://apac.dgassistant.com/api/v2/rest/consignment

Request samples

Content type
application/json
{
  • "consignmentType": "PackagesAndReceptacles",
  • "regulation": "Adr",
  • "date": "2020-12-31",
  • "workPlaceCode": "WP001",
  • "predefinedShipperCode": "SHI001",
  • "onTheFlyShipper": {
    • "name": "TransOne Inc.",
    • "address": "Mary Ann St",
    • "city-town": "Cardiff",
    • "province-region-state": "Wales",
    • "postalCode": "CF10 2EQ",
    • "countryId": 234,
    • "telephone": "+44 29 2023 4500",
    • "fax": "",
    • "contactPerson": "",
    • "taxCode": "",
    • "status": "Shipping manager"
    },
  • "predefinedConsigneeCode": "CON001",
  • "onTheFlyConsignee": {
    • "name": "TransOne Inc.",
    • "address": "Mary Ann St",
    • "city-town": "Cardiff",
    • "province-region-state": "Wales",
    • "postalCode": "CF10 2EQ",
    • "countryId": 234,
    • "telephone": "+44 29 2023 4500",
    • "fax": "",
    • "contactPerson": "",
    • "taxCode": "",
    • "status": "Shipping manager"
    },
  • "predefinedSimpleProducts": [
    • {
      • "reference": "PROMOD001",
      • "numberOfPackages": 3,
      • "unitaryQuantity": 1.2,
      • "unitaryGrossQuantity": 2,
      • "unitaryQuantityExplosive": 0,
      • "fillingDegree": 100,
      • "authorizations": "Auth 0001",
      • "innerPackagesNumber": 0,
      • "innerPackageQuantity": 0,
      • "innerPackageCapacity": 0.5,
      • "innerPackageQuantityExplosive": 0,
      • "radiological": {
        • "nuclides": [
          • {
            • "radionuclideCode": "Co-60",
            • "activityBq": 50000000
            }
          ],
        • "packageType": "Excepted",
        • "isSpecialForm": false,
        • "isFissile": false,
        • "category": "IWhite",
        • "transportIndex": 0,
        • "certificateRef": "",
        • "physicoChemical": "Sealed source, solid",
        • "surfaceDoseRate": 0.05,
        • "packageDimensions": "string"
        },
      • "consignmentItemCode": "ITEM-9515-4013-AA46"
      }
    ],
  • "onTheFlySimpleProducts": [
    • {
      • "productName": "PRONAM001",
      • "productCode": "PROCOD001",
      • "isDangerousGood": true,
      • "dangerousGoodId": 2301,
      • "isEnvironmentallyHazardous": false,
      • "isEmpty": false,
      • "physicalState": "Liquid",
      • "measureUnit": "Kg",
      • "pureMixOrSolution": "Pure",
      • "mixOrSolutionPercentage": 0,
      • "flashPoint": 30.2,
      • "controlTemperature": 15,
      • "emergencyTemperature": 20,
      • "density": 1,
      • "numberOfPackages": 3,
      • "packageId": 14,
      • "packageHomologationId": 43,
      • "packingInstructionId": 0,
      • "strictPackingInstructionCheck": true,
      • "imdgSegregationGroupId": 0,
      • "englishTechnicalName": "XYLENE AND BENZENE",
      • "countryOfOriginLanguageTechnicalName": "XILENO Y BENCENO",
      • "adrPrincipalLanguageTechnicalName": "XYLOL UND BENZOL",
      • "hasInnerPackages": false,
      • "unitaryQuantity": 1.2,
      • "unitaryGrossQuantity": 2,
      • "unitaryQuantityExplosive": 0,
      • "fillingDegree": 100,
      • "authorizations": "Auth 0001",
      • "innerPackageMaterialId": 0,
      • "innerPackagesNumber": 0,
      • "innerPackageQuantity": 0,
      • "innerPackageCapacity": 0.5,
      • "innerPackageQuantityExplosive": 0,
      • "radiological": {
        • "nuclides": [
          • {
            • "radionuclideCode": "Co-60",
            • "activityBq": 50000000
            }
          ],
        • "packageType": "Excepted",
        • "isSpecialForm": false,
        • "isFissile": false,
        • "category": "IWhite",
        • "transportIndex": 0,
        • "certificateRef": "",
        • "physicoChemical": "Sealed source, solid",
        • "surfaceDoseRate": 0.05,
        • "packageDimensions": "string"
        },
      • "specialFeatures": "IsExtraViscousAccordingAdr",
      • "consignmentItemCode": "ITEM-9515-4013-AA46"
      }
    ],
  • "predefinedMixedPackingProducts": [
    • {
      • "reference": "MIXPACMOD001",
      • "numberOfPackages": 3,
      • "unitaryGrossQuantity": 21,
      • "consignmentItemCode": "ITEM-9515-4013-AA46"
      }
    ],
  • "onTheFlyMixedPackingProducts": [
    • {
      • "productName": "MIXPACNAM001",
      • "productCode": "MIXPACCOD001",
      • "numberOfPackages": 3,
      • "unitaryGrossQuantity": 21,
      • "outerPackageId": 14,
      • "outerPackageHomologationId": 43,
      • "contents": [
        • {
          • "dangerousGoodId": 2301,
          • "isEnvironmentallyHazardous": false,
          • "physicalState": "Liquid",
          • "measureUnit": "Kg",
          • "pureMixOrSolution": "Pure",
          • "mixOrSolutionPercentage": 0,
          • "flashPoint": 30.2,
          • "density": 1,
          • "imdgSegregationGroupId": 0,
          • "englishTechnicalName": "XYLENE AND BENZENE",
          • "countryOfOriginLanguageTechnicalName": "XILENO Y BENCENO",
          • "adrPrincipalLanguageTechnicalName": "XYLOL UND BENZOL",
          • "authorizations": "Auth 0001",
          • "innerPackageMaterialId": 1,
          • "packingInstructionId": 0,
          • "strictPackingInstructionCheck": true,
          • "numberOfInnerPackages": 3,
          • "innerPackageQuantity": 0.1,
          • "innerPackageCapacity": 0.5,
          • "innerPackageQuantityExplosive": 0,
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          }
        ],
      • "consignmentItemCode": "ITEM-9515-4013-AA46"
      }
    ],
  • "overpacks": [
    • {
      • "numberOfOverpacks": 2,
      • "identifiersOfOverpacks": [
        • "#OV1",
        • "#OV2"
        ],
      • "predefinedSimpleProducts": [
        • {
          • "reference": "PROMOD001",
          • "numberOfPackages": 3,
          • "unitaryQuantity": 1.2,
          • "unitaryGrossQuantity": 2,
          • "unitaryQuantityExplosive": 0,
          • "fillingDegree": 100,
          • "authorizations": "Auth 0001",
          • "innerPackagesNumber": 0,
          • "innerPackageQuantity": 0,
          • "innerPackageCapacity": 0.5,
          • "innerPackageQuantityExplosive": 0,
          • "radiological": {
            • "nuclides": [
              • {
                • "radionuclideCode": "Co-60",
                • "activityBq": 50000000
                }
              ],
            • "packageType": "Excepted",
            • "isSpecialForm": false,
            • "isFissile": false,
            • "category": "IWhite",
            • "transportIndex": 0,
            • "certificateRef": "",
            • "physicoChemical": "Sealed source, solid",
            • "surfaceDoseRate": 0.05,
            • "packageDimensions": "string"
            },
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          }
        ],
      • "onTheFlySimpleProducts": [
        • {
          • "productName": "PRONAM001",
          • "productCode": "PROCOD001",
          • "isDangerousGood": true,
          • "dangerousGoodId": 2301,
          • "isEnvironmentallyHazardous": false,
          • "isEmpty": false,
          • "physicalState": "Liquid",
          • "measureUnit": "Kg",
          • "pureMixOrSolution": "Pure",
          • "mixOrSolutionPercentage": 0,
          • "flashPoint": 30.2,
          • "controlTemperature": 15,
          • "emergencyTemperature": 20,
          • "density": 1,
          • "numberOfPackages": 3,
          • "packageId": 14,
          • "packageHomologationId": 43,
          • "packingInstructionId": 0,
          • "strictPackingInstructionCheck": true,
          • "imdgSegregationGroupId": 0,
          • "englishTechnicalName": "XYLENE AND BENZENE",
          • "countryOfOriginLanguageTechnicalName": "XILENO Y BENCENO",
          • "adrPrincipalLanguageTechnicalName": "XYLOL UND BENZOL",
          • "hasInnerPackages": false,
          • "unitaryQuantity": 1.2,
          • "unitaryGrossQuantity": 2,
          • "unitaryQuantityExplosive": 0,
          • "fillingDegree": 100,
          • "authorizations": "Auth 0001",
          • "innerPackageMaterialId": 0,
          • "innerPackagesNumber": 0,
          • "innerPackageQuantity": 0,
          • "innerPackageCapacity": 0.5,
          • "innerPackageQuantityExplosive": 0,
          • "radiological": {
            • "nuclides": [
              • {
                • "radionuclideCode": "Co-60",
                • "activityBq": 50000000
                }
              ],
            • "packageType": "Excepted",
            • "isSpecialForm": false,
            • "isFissile": false,
            • "category": "IWhite",
            • "transportIndex": 0,
            • "certificateRef": "",
            • "physicoChemical": "Sealed source, solid",
            • "surfaceDoseRate": 0.05,
            • "packageDimensions": "string"
            },
          • "specialFeatures": "IsExtraViscousAccordingAdr",
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          }
        ],
      • "predefinedMixedPackingProducts": [
        • {
          • "reference": "MIXPACMOD001",
          • "numberOfPackages": 3,
          • "unitaryGrossQuantity": 21,
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          }
        ],
      • "onTheFlyMixedPackingProducts": [
        • {
          • "productName": "MIXPACNAM001",
          • "productCode": "MIXPACCOD001",
          • "numberOfPackages": 3,
          • "unitaryGrossQuantity": 21,
          • "outerPackageId": 14,
          • "outerPackageHomologationId": 43,
          • "contents": [
            • {
              • "dangerousGoodId": 2301,
              • "isEnvironmentallyHazardous": false,
              • "physicalState": "Liquid",
              • "measureUnit": "Kg",
              • "pureMixOrSolution": "Pure",
              • "mixOrSolutionPercentage": 0,
              • "flashPoint": 30.2,
              • "density": 1,
              • "imdgSegregationGroupId": 0,
              • "englishTechnicalName": "XYLENE AND BENZENE",
              • "countryOfOriginLanguageTechnicalName": "XILENO Y BENCENO",
              • "adrPrincipalLanguageTechnicalName": "XYLOL UND BENZOL",
              • "authorizations": "Auth 0001",
              • "innerPackageMaterialId": 1,
              • "packingInstructionId": 0,
              • "strictPackingInstructionCheck": true,
              • "numberOfInnerPackages": 3,
              • "innerPackageQuantity": 0.1,
              • "innerPackageCapacity": 0.5,
              • "innerPackageQuantityExplosive": 0,
              • "consignmentItemCode": "ITEM-9515-4013-AA46"
              }
            ],
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          }
        ],
      • "consignmentItemCode": "ITEM-9515-4013-AA46"
      }
    ],
  • "predefinedLoaderCode": "LOA001",
  • "onTheFlyLoader": {
    • "name": "TransOne Inc.",
    • "address": "Mary Ann St",
    • "city-town": "Cardiff",
    • "province-region-state": "Wales",
    • "postalCode": "CF10 2EQ",
    • "countryId": 234,
    • "telephone": "+44 29 2023 4500",
    • "fax": "",
    • "contactPerson": "",
    • "taxCode": "",
    • "status": "Shipping manager"
    },
  • "predefinedCarrierCode": "CAR001",
  • "onTheFlyCarrier": {
    • "name": "TransOne Inc.",
    • "address": "Mary Ann St",
    • "city-town": "Cardiff",
    • "province-region-state": "Wales",
    • "postalCode": "CF10 2EQ",
    • "countryId": 234,
    • "telephone": "+44 29 2023 4500",
    • "fax": "",
    • "contactPerson": "",
    • "taxCode": "",
    • "status": "Shipping manager"
    },
  • "driver": "David Martin",
  • "vehicleRegistration": "VEHREG 8917",
  • "trailerRegistration": "TRAREG 4885",
  • "deliveryNoteNumber": "INV0001",
  • "emergencyPhone": "+1 888 387 2848",
  • "shipperReferenceNumber": "SRN001",
  • "freightForwarderReference": "FFN001",
  • "additionalInformation": "Contact person: John Smith",
  • "isExclusiveUseShipment": false,
  • "iataData": {
    • "airWaybillNumber": "WBN001",
    • "airportOfDeparture": "Stewart International Airport",
    • "airportOfDestination": "Heathrow",
    • "signatureNameAndStatusOfDeclarant": "David Martin - Safety Adviser",
    • "signatureDate": "2020-12-31",
    • "signaturePlace": "New York"
    },
  • "imdgData": {
    • "vessel": "VES003",
    • "portOfDeparture": "Houston",
    • "portOfDischarge": "Hamburg",
    • "containerOrVehicleIdentification": "CONID001",
    • "sealNumber": "SEALZHN",
    • "sizeAndType": "",
    • "tareMass": 1002.5,
    • "totalGrossMass": 1092.5,
    • "packingCertificateCompany": "Cert Comp",
    • "packingCertificateNameAndStatusOfDeclarant": "Maria Johnson - Certification Manager",
    • "packingCertificateDate": "2020-12-31",
    • "packingCertificatePlace": "Houston",
    • "signatureCompany": "TransOne Inc.",
    • "signatureNameAndStatusOfDeclarant": "David Martin - Safety Adviser",
    • "signatureDate": "2020-12-31",
    • "signaturePlace": "Houston"
    },
  • "adrData": {
    • "spainData": {
      • "administrativeControlData": {
        • "predefinedContractualShipperCode": "string",
        • "onTheFlyContractualShipper": {
          • "name": "TransOne Inc.",
          • "address": "Mary Ann St",
          • "city-town": "Cardiff",
          • "province-region-state": "Wales",
          • "postalCode": "CF10 2EQ",
          • "countryId": 234,
          • "telephone": "+44 29 2023 4500",
          • "fax": "",
          • "contactPerson": "",
          • "taxCode": "",
          • "status": "Shipping manager"
          },
        • "predefinedEffectiveCarrierCode": "string",
        • "onTheFlyEffectiveCarrier": {
          • "name": "TransOne Inc.",
          • "address": "Mary Ann St",
          • "city-town": "Cardiff",
          • "province-region-state": "Wales",
          • "postalCode": "CF10 2EQ",
          • "countryId": 234,
          • "telephone": "+44 29 2023 4500",
          • "fax": "",
          • "contactPerson": "",
          • "taxCode": "",
          • "status": "Shipping manager"
          },
        • "specialTransportAuthorization": "string",
        • "shipperRemarks": "string",
        • "carrierRemarks": "string"
        }
      }
    },
  • "specialFeatures": [
    • "ShowRedStripes"
    ]
}

Response samples

Content type
application/json
{
  • "newItemId": 23,
  • "newItemIsValid": true,
  • "success": true,
  • "httpStatusCode": 201,
  • "message": "Item Created OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 404,
  • "message": "Item not found",
  • "messageType": "Error",
  • "parameter": "productId",
  • "parameterValue": "Prod001",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Get a consignment

Returns the consignment header, participants, items and calculated regulatory data in JSON format.

Note on overpacks: for ADR and IMDG consignments the items collection does not include overpack containers nor their nesting; the contents of an overpack are returned as top-level items. Overpack items are only returned for IATA.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

path Parameters

consignmentId
required
integer <int64>

Id of the consignment

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

object (ConsignmentResponseData)

Consignment with its participants, items and regulatory calculated data.

consignmentType
required
string
Enum: "PackagesAndReceptacles" "Tank" "Bulk"

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

workPlaceCode
required
string

Code of the workplace issuing the consignment.

date
required
string <date>

Issue date of the consignment, in ISO 8601 format.

regulation
required
string
Enum: "Adr" "Imdg" "Iata" "Cfr49"

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

object

Shipper participant of the consignment.

accountCode
required
string

Customer account code identifying the tenant in the system.

types
required
Array of strings (ParticipantType) non-empty
Items Enum: "Shipper" "Loader" "Carrier" "Consignee" "Supplier" "Driver" "Consolidator" "NotifyParty" "FreightForwarder" "ShippingAgent"

List of participant types: Shipper, Loader, Carrier, Consignee, Supplier, Driver, Consolidator, NotifyParty, FreightForwarder or ShippingAgent.

code
required
string

Unique code identifying this participant within the account.

name
required
string

Legal or commercial name of the participant.

address
required
string

Postal address of the participant.

city-town
required
string

City or town of the participant.

province-region-state
required
string

Province, region or state of the participant. A hyphen (-), a dot or a comma means that the participant has none, and the transport documents and the package marks leave the value out.

postalCode
required
string

Postal code of the participant address. A hyphen (-), a dot or a comma means that the address has none, and the transport documents and the package marks leave the value out.

countryId
required
integer

Identifier of the country from master data.

telephone
string

Telephone number of the participant.

fax
string

Fax number of the participant.

contactPerson
string

Name of the contact person at the participant.

taxCode
string

Tax identification code of the participant.

status
string

Position or capacity of the contact person within the participant organisation, such as Managing Director or Shipping Manager.

object

Data of ADR of the participant: the ADR driver training certificate when it is recorded.

object

ADR driver training certificate (ADR 8.2.1 and 8.2.2.8) of a participant of type Driver. In a request, an adrData block without it removes the recorded certificate.

certificateNumber
required
string <= 50 characters

Number of the certificate.

validUntil
required
string <date>

Date until which the certificate is valid, in ISO 8601 format, between 1900-01-01 and 2079-06-06 (ADR 8.2.2.8.2).

specializations
Array of strings
Items Enum: "Tanks" "Class1" "Class7"

Specializations that the certificate includes besides the basic training: Tanks (carriage in tanks, ADR 8.2.1.3), Class1 and Class7 (ADR 8.2.1.4). Empty or omitted when the certificate covers only the basic training.

object

Consignee participant of the consignment.

object

Loader participant of the consignment.

object

Carrier participant of the consignment.

driver
string

Full name of the driver in charge of the transport.

vehicleRegistration
string

Registration plate of the vehicle.

trailerRegistration
string

Registration plate of the trailer, if applicable.

deliveryNoteNumber
string

Reference number of the delivery note associated with the consignment.

emergencyPhone
string

Emergency telephone number available during transport.

shipperReferenceNumber
string

Reference number assigned to the consignment by the shipper.

freightForwarderReference
string

Reference number assigned to the consignment by the freight forwarder.

additionalInformation
string

Additional information regarding the consignment.

object

Calculated common regulatory data of the consignment.

hasDangerousGoods
required
boolean

Indicates whether the consignment contains at least one dangerous good.

isExclusiveUseShipment
boolean

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.

object

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

signatureNameAndStatusOfDeclarant
required
string

Name and status of the declarant signing the document.

signatureDate
required
string <date>

Date of the declarant signature, in ISO 8601 format.

airWaybillNumber
string

Air waybill number of the consignment.

airportOfDeparture
string <= 250 characters

Airport of departure of the consignment.

airportOfDestination
string <= 250 characters

Airport of destination of the consignment.

signaturePlace
string

Place where the declarant signature is performed.

object

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

signatureCompany
required
string

Company of the declarant signing the transport document.

signatureNameAndStatusOfDeclarant
required
string

Name and status of the declarant signing the document.

signatureDate
required
string <date>

Date of the declarant signature, in ISO 8601 format.

signaturePlace
required
string

Place where the declarant signature is performed.

vessel
string <= 250 characters

Identification of the vessel transporting the consignment.

portOfDeparture
string <= 250 characters

Port of departure of the consignment.

portOfDischarge
string <= 250 characters

Port of discharge of the consignment.

containerOrVehicleIdentification
string <= 250 characters

Identification of the container or vehicle transporting the consignment.

sealNumber
string <= 250 characters

Identification number of the security seal.

sizeAndType
string <= 250 characters

Size and type of the container or vehicle.

tareMass
number [ 0 .. 999999999 ]

Tare mass of the container or vehicle, in kilograms.

totalGrossMass
number [ 0 .. 999999999 ]

Total gross mass of the container or vehicle, in kilograms.

packingCertificateCompany
string

Company issuing the container packing certificate.

packingCertificateNameAndStatusOfDeclarant
string

Name and status of the declarant of the container packing certificate.

packingCertificateDate
string <date>

Date of the container packing certificate, in ISO 8601 format, between 1900-01-01 and 2079-06-06.

packingCertificatePlace
string

Place where the container packing certificate is issued.

object

Calculated IATA regulatory data of the consignment.

shipmentLimitations
required
string
Enum: "PAX" "CAO" "Forbidden"

Calculated IATA shipment limitation: PAX, CAO or Forbidden.

isCargoAircraftOnly
boolean

Aircraft acceptance limitation: true if the shipment is restricted to Cargo Aircraft Only (CAO); false if accepted on both Passenger and Cargo aircraft (PAX). Set at consignment level and consistent with shipmentLimitations (CAO <-> true, PAX <-> false).

isRadioactiveShipment
boolean

True when the consignment contains radioactive material (Class 7) shown on the DGD. Marks the 'Radioactive' Shipment Type box on the DGD (IATA 10.8.3.7); radioactive consignments are issued in a DGD separate from non-radioactive dangerous goods (IATA 10.8.3.8.2). Radioactive material in excepted packages is not shown on the DGD and does not set this flag.

object

Dangerous goods statements to be shown on the air waybill (ICAO Technical Instructions 5;4.2, 3;5.5 and 5;1.2.4.2): Handling Information (box 21) and Nature and Quantity of Goods (box 22). Response only.

handlingInformation
Array of strings

Statements for the Handling Information box (box 21): the reference to the attached Shipper's Declaration and, when applicable, Cargo aircraft only.

natureAndQuantityOfGoods
Array of strings

Statements for the Nature and Quantity of Goods box (box 22) for dangerous goods carried without a Shipper's Declaration: excepted quantities, lithium and sodium ion batteries in Section II, radioactive material in excepted packages and dry ice.

Array of objects (ConsignmentItemResponse)

List of items contained in the consignment.

Array [
consignmentItemType
string
Enum: "SimpleProduct" "MixedPackingProduct" "Overpack"

Type of consignment item: SimpleProduct, MixedPackingProduct or Overpack.

object

Simple product item, present when item type is SimpleProduct.

isDangerousGood
required
boolean

Indicates whether the product is regulated as dangerous goods.

isEmpty
required
boolean

Indicates whether the package is empty and uncleaned.

measureUnit
required
string
Enum: "Kg" "L"

Measurement unit for quantities: Kg or L.

pureMixOrSolution
required
string
Enum: "Pure" "Mix" "Solution"

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

numberOfPackages
required
integer

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

packageId
required
integer

Identifier of the outer package type from master data.

hasInnerPackages
required
boolean

Indicates whether the outer package contains inner packages.

reference
string

Unique reference of the predefined product in the catalogue.

productCode
string

Internal product code assigned by the customer.

productName
string

Commercial name of the product.

dangerousGoodId
integer

Identifier of the dangerous good entry in master data.

isEnvironmentallyHazardous
boolean

Indicates whether the substance is environmentally hazardous (marine pollutant).

physicalState
string
Enum: "Liquid" "Solid" "Gas"

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

mixOrSolutionPercentage
number

Percentage of the dangerous component in the mixture or solution.

flashPoint
number

Closed-cup flash point of the substance, expressed in Celsius.

controlTemperature
number

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.

emergencyTemperature
number

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
number

Density of the substance, expressed in kilograms per liter.

packageHomologationId
integer

Identifier of the package UN homologation code from master data.

packingInstructionId
integer

Identifier of the applicable packing instruction.

imdgSegregationGroupId
integer <int32>

Identifier of the IMDG segregation group declared for the substance.

technicalName
string

Technical name of the substance, when applicable.

object

Technical names of the substance in every language stored for it. Complements the single technicalName above, which keeps returning the name in the language of the transport document. The englishTechnicalName supplied on creation is always retrievable here; the other technical names supplied on creation appear under the concrete language to which they correspond, such as Spanish or French, with a single entry for each language.

englishTechnicalName
string

Technical name of the substance in English.

spanishTechnicalName
string

Technical name of the substance in Spanish.

frenchTechnicalName
string

Technical name of the substance in French.

germanTechnicalName
string

Technical name of the substance in German.

portugueseTechnicalName
string

Technical name of the substance in Portuguese.

russianTechnicalName
string

Technical name of the substance in Russian.

chineseTechnicalName
string

Technical name of the substance in Chinese.

italianTechnicalName
string

Technical name of the substance in Italian.

dutchTechnicalName
string

Technical name of the substance in Dutch.

turkishTechnicalName
string

Technical name of the substance in Turkish.

polishTechnicalName
string

Technical name of the substance in Polish.

swedishTechnicalName
string

Technical name of the substance in Swedish.

norwegianTechnicalName
string

Technical name of the substance in Norwegian.

czechTechnicalName
string

Technical name of the substance in Czech.

danishTechnicalName
string

Technical name of the substance in Danish.

greekTechnicalName
string

Technical name of the substance in Greek.

hungarianTechnicalName
string

Technical name of the substance in Hungarian.

slovakTechnicalName
string

Technical name of the substance in Slovak.

romanianTechnicalName
string

Technical name of the substance in Romanian.

finnishTechnicalName
string

Technical name of the substance in Finnish.

unitaryQuantity
number

Net quantity of substance per outer package.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

unitaryQuantityExplosive
number

Net explosive content per outer package, expressed in kilograms.

fillingDegree
number

Filling degree of the package, expressed as percentage.

authorizations
string

Authorizations or special provisions applicable to the transport.

innerPackageMaterialId
integer

Identifier of the inner package material from master data.

innerPackagesNumber
integer

Number of inner packages contained in each outer package.

innerPackageQuantity
number

Net quantity per inner package.

innerPackageCapacity
number

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.

innerPackageQuantityExplosive
number

Net explosive content per inner package, expressed in kilograms.

object

Radiological data of the consignment line product. Only populated for Class 7 (radioactive) products. Includes radionuclide code, activity in Bq, package type, special form flag, fissile flag, category, transport index, certificate reference and physico-chemical description.

Array of objects (ProductRadiologicalNuclide)

List of radionuclides contained in the product (1..N). The radiological block is mandatory for every Class 7 product, including the excepted packages UN 2908-2911: at least one entry, with a radionuclide code and a strictly positive activity per package, is required for every package type, because the underlying record requires a radionuclide and a strictly positive activity. Each entry has the radionuclide code and the activity per package in Bq. The server computes the A2 multiple of the consignment detail as the sum over all entries of (activity_i / A2_i_in_Bq).

Array [
radionuclideCode
required
string

Radionuclide code as listed in the radionuclide catalogue (for example 'Co-60', 'Cs-137', 'Ir-192', 'Sr-90').

activityBq
required
number

Maximum activity per package during transport for this radionuclide, expressed in becquerels (Bq). SI units only; strictly positive.

]
packageType
string
Enum: "Excepted" "IndustrialPackage1" "IndustrialPackage2" "IndustrialPackage3" "TypeA" "TypeASpecialForm" "TypeBU" "SpecialArrangement"

Package type. Allowed values: Excepted (UN 2908-2911); IndustrialPackage1 (IP-1, UN 2912 LSA-I, UN 2913 SCO-I); IndustrialPackage2 (IP-2, UN 2913 SCO-II, UN 3321 LSA-II liquid/gas, UN 3322 LSA-III under exclusive use); IndustrialPackage3 (IP-3, UN 3321 LSA-II solid, UN 3322 LSA-III); TypeA (UN 2915, normal form); TypeASpecialForm (UN 3332, certificate reference mandatory); TypeBU (UN 2916 unilateral approval, certificate reference mandatory); SpecialArrangement (UN 2919, transported under special arrangement: category IIIYellow and certificate reference with type code X mandatory).

isSpecialForm
boolean

True if the radioactive material is in special form (special form certificate required). Only meaningful when packageType = TypeASpecialForm.

isFissile
boolean

True if the radioactive material is fissile (not fissile-excepted). Out of scope for this version; must be false.

category
string
Enum: "IWhite" "IIYellow" "IIIYellow"

Package category (ADR 2.2.7.2.4 / IMDG 2.7.2.4 / IATA 10.5.7). Allowed values: IWhite (maximum radiation level less than or equal to 0.005 mSv/h, TI must be zero); IIYellow (greater than 0.005 mSv/h and up to 0.5 mSv/h, TI up to 1); IIIYellow (greater than 0.5 mSv/h and up to 2 mSv/h, TI greater than 1). Optional for Excepted packages. IIIYellow is mandatory for SpecialArrangement packages.

transportIndex
number

Transport Index (TI). Dimensionless, rounded up to one decimal place. Optional for Excepted packages.

certificateRef
string

Certificate reference. Mandatory for TypeASpecialForm (UN 3332), TypeBU (UN 2916) and SpecialArrangement (UN 2919; it must contain the special arrangement mark with type code X). Examples: 'ES/4567/S-96', 'ES/4567/B(U)', 'FIN/123/X'. Not applicable to Industrial Packages (IP-1/2/3) which follow the prescriptive design of ADR 6.4.5-6.4.7.

physicoChemical
string

Description of the physical and chemical form of the contents.

surfaceDoseRate
number

Maximum surface dose rate of the package, in mSv/h. Used together with the transport index to determine the package category, taking the more restrictive of the two (ADR/IMDG 5.1.5.3.4).

packageDimensions
string <= 60 characters

Overall package dimensions including units, in the order length x width (or diameter) x height, for example "L 30 cm x W 30 cm x H 40 cm". Required by the air transport document (ICAO TI 2025-26 5;4.1.5.7.1 f)) for packages of category IIYellow or IIIYellow in IATA consignments; not used by ADR or IMDG.

specialFeatures
string
Enum: "IsExtraViscousAccordingAdr" "IsExtraViscousAccordingImdg" "IsSalvagePackage"

Special features of the substance.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

object

Mixed packing product item, present when item type is MixedPackingProduct.

numberOfPackages
required
integer

Number of identical outer packages of this mixed packing in the consignment.

outerPackageId
required
integer

Identifier of the outer package type from master data.

outerPackageHomologationId
required
integer

Identifier of the outer package UN homologation code from master data.

required
Array of objects (MixedPackingProductTransportModeContentResponse)

List of contents within the mixed packing.

Array [
measureUnit
required
string
Enum: "Kg" "L"

Measurement unit for quantities: Kg or L.

pureMixOrSolution
required
string
Enum: "Pure" "Mix" "Solution"

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

numberOfInnerPackages
required
integer

Number of inner packages of this content within the mixed packing.

innerPackageMaterialId
required
integer

Identifier of the inner package material from master data.

innerPackageQuantity
required
number

Net quantity per inner package.

isDangerousGood
boolean

Indicates whether the content is regulated as dangerous goods.

dangerousGoodId
integer

Identifier of the dangerous good entry in master data.

mixOrSolutionPercentage
number

Percentage of the dangerous component in the mixture or solution.

flashPoint
number

Closed-cup flash point of the substance, expressed in Celsius.

density
number

Density of the substance, expressed in kilograms per liter.

technicalName
string

Technical name of the substance, when applicable.

authorizations
string

Authorizations or special provisions applicable to the transport.

packingInstructionId
integer

Identifier of the applicable packing instruction.

innerPackageCapacity
number

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.

innerPackageQuantityExplosive
number

Net explosive content per inner package, expressed in kilograms.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

isEnvironmentallyHazardous
boolean

Indicates whether the substance is environmentally hazardous (marine pollutant).

physicalState
string
Enum: "Liquid" "Solid" "Gas"

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

imdgSegregationGroupId
integer <int32>

Identifier of the IMDG segregation group declared for the substance.

object

Technical names of the substance in every language stored for it. Complements the single technicalName above, which keeps returning the name in the language of the transport document. The englishTechnicalName supplied on creation is always retrievable here; the other technical names supplied on creation appear under the concrete language to which they correspond, such as Spanish or French, with a single entry for each language.

]
productName
string

Commercial name of the mixed packing product.

productCode
string

Internal product code assigned by the customer.

unitaryGrossQuantity
number

Gross mass of one outer package, expressed in kilograms.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

object

Overpack item, present when item type is Overpack.

identifiersOfOverpacks
required
Array of strings

identifier for each identical overpacks

numberOfOverpacks
required
integer >= 1

number of identical overpacks

contents
Array of objects (ConsignmentItemResponse) Recursive

List of items contained in the overpack.

consignmentItemCode
string

Optional client identifier of the item within the consignment.

object

Calculated IATA regulatory data of the item.

unOrIdNumber
string

UN number or identification number assigned to the substance.

properShippingName
string

Proper shipping name of the substance.

classOrDivision
string

Class or division of the dangerous goods.

packingGroup
string

Packing group of the substance.

quantityAndTypeOfPacking
string

Calculated description of quantity and type of packaging.

packingInstruction
string

Applicable IATA packing instruction code.

authorizations
string

Authorizations or special provisions applicable to the transport.

mixedPackingQValue
number

Calculated Q value used for mixed packing compatibility check.

radiologicalDescription
string

Class 7 (radioactive material) additional information block (IATA DGR 10.8.3.9): radionuclides, physical-chemical form, activity, category, transport index, certificate, exclusive use and A2 multiple. Populated only for in-scope Class 7 items; empty otherwise.

object

Calculated IMDG regulatory data of the item.

load
string

Calculated description of the load for the transport document.

quantityAndTypeOfPacking
string

Calculated description of quantity and type of packaging.

netQuantityText
string

Calculated descriptive text of the net quantity.

grossQuantityText
string

Calculated descriptive text of the gross quantity.

radiologicalDescription
string

Class 7 (radioactive material) additional information block (IMDG 5.4.1.5.7.1): radionuclides, physical-chemical form, activity, category, transport index, certificate, exclusive use and A2 multiple. Populated only for in-scope Class 7 items; empty otherwise.

object

Calculated ADR regulatory data of the item.

load
string

Calculated description of the load for the transport document.

quantityAndTypeOfPacking
string

Calculated description of quantity and type of packaging.

transportCategory
string

ADR transport category of the load.

quantityText
string

Calculated descriptive text of the net and gross quantities.

tunnelRestrictionCode
string

ADR tunnel restriction code applicable to the load.

radiologicalDescription
string

Class 7 (radioactive material) additional information block (ADR 5.4.1.2.5.1): radionuclides, physical-chemical form, activity, category, transport index, certificate, exclusive use and A2 multiple. Populated only for in-scope Class 7 items; empty otherwise.

]
object

ADR-specific data of the consignment: the data that only Spain requires, such as the administrative control document. Only present when the consignment has any.

object

Data of the consignment that only Spain requires: the administrative control document.

object

Data of the administrative control document, including the resolved contractual shipper and effective carrier. Only present when the consignment issues an administrative control document.

object (ParticipantResponseData)

Participant (shipper, consignee, loader and others) as returned from the catalogue.

object (ParticipantResponseData)

Participant (shipper, consignee, loader and others) as returned from the catalogue.

specialTransportAuthorization
string or null

Special circulation authorisation reference, when applicable.

shipperRemarks
string or null

Remarks and reservations of the contractual shipper.

carrierRemarks
string or null

Remarks and reservations of the effective carrier.

documentUrl
string or null

Public URL of the frozen administrative control document, the same one encoded in the QR code of the printed document. Only present once the document has been generated.

specialFeatures
Array of strings (ConsignmentSpecialFeature)
Items Enum: "ShowRedStripes" "ShowBlueStripes" "ShowMarksForAllPackages" "ShowLabelsForAllPackages" "ShowMultimodalIataDeclaration" "DuplicateIataIdentification" "AdministrativeControlDocument"

Optional features of the consignment. Each one enables a specific behaviour or document. Null when the consignment has none.

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

404

Consignment not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

get/consignment/{consignmentId}
https://emea.dgassistant.com/api/v2/rest/consignment/{consignmentId}
https://amer.dgassistant.com/api/v2/rest/consignment/{consignmentId}
https://apac.dgassistant.com/api/v2/rest/consignment/{consignmentId}

Response samples

Content type
application/json
{
  • "consignmentResponse": {
    • "consignmentType": "PackagesAndReceptacles",
    • "regulation": "Adr",
    • "date": "2020-12-31",
    • "workPlaceCode": "WP001",
    • "shipper": {
      • "accountCode": "CO001",
      • "types": [
        • "Shipper"
        ],
      • "code": "PAR01",
      • "name": "TransOne Inc.",
      • "address": "Mary Ann St",
      • "city-town": "Cardiff",
      • "province-region-state": "Wales",
      • "postalCode": "CF10 2EQ",
      • "countryId": 234,
      • "telephone": "+44 29 2023 4500",
      • "fax": "",
      • "contactPerson": "",
      • "taxCode": "",
      • "status": "string",
      • "adrData": {
        • "driverTrainingCertificate": {
          • "certificateNumber": "ES-ADR-118734",
          • "validUntil": "2029-05-31",
          • "specializations": [
            • "Tanks"
            ]
          }
        }
      },
    • "consignee": {
      • "accountCode": "CO001",
      • "types": [
        • "Shipper"
        ],
      • "code": "PAR01",
      • "name": "TransOne Inc.",
      • "address": "Mary Ann St",
      • "city-town": "Cardiff",
      • "province-region-state": "Wales",
      • "postalCode": "CF10 2EQ",
      • "countryId": 234,
      • "telephone": "+44 29 2023 4500",
      • "fax": "",
      • "contactPerson": "",
      • "taxCode": "",
      • "status": "string",
      • "adrData": {
        • "driverTrainingCertificate": {
          • "certificateNumber": "ES-ADR-118734",
          • "validUntil": "2029-05-31",
          • "specializations": [
            • "Tanks"
            ]
          }
        }
      },
    • "loader": {
      • "accountCode": "CO001",
      • "types": [
        • "Shipper"
        ],
      • "code": "PAR01",
      • "name": "TransOne Inc.",
      • "address": "Mary Ann St",
      • "city-town": "Cardiff",
      • "province-region-state": "Wales",
      • "postalCode": "CF10 2EQ",
      • "countryId": 234,
      • "telephone": "+44 29 2023 4500",
      • "fax": "",
      • "contactPerson": "",
      • "taxCode": "",
      • "status": "string",
      • "adrData": {
        • "driverTrainingCertificate": {
          • "certificateNumber": "ES-ADR-118734",
          • "validUntil": "2029-05-31",
          • "specializations": [
            • "Tanks"
            ]
          }
        }
      },
    • "carrier": {
      • "accountCode": "CO001",
      • "types": [
        • "Shipper"
        ],
      • "code": "PAR01",
      • "name": "TransOne Inc.",
      • "address": "Mary Ann St",
      • "city-town": "Cardiff",
      • "province-region-state": "Wales",
      • "postalCode": "CF10 2EQ",
      • "countryId": 234,
      • "telephone": "+44 29 2023 4500",
      • "fax": "",
      • "contactPerson": "",
      • "taxCode": "",
      • "status": "string",
      • "adrData": {
        • "driverTrainingCertificate": {
          • "certificateNumber": "ES-ADR-118734",
          • "validUntil": "2029-05-31",
          • "specializations": [
            • "Tanks"
            ]
          }
        }
      },
    • "driver": "David Martin",
    • "vehicleRegistration": "VEHREG 8917",
    • "trailerRegistration": "TRAREG 4885",
    • "deliveryNoteNumber": "INV0001",
    • "emergencyPhone": "+1 888 387 2848",
    • "shipperReferenceNumber": "SRN001",
    • "freightForwarderReference": "FFN001",
    • "additionalInformation": "Contact person: John Smith",
    • "commonDataResponse": {
      • "hasDangerousGoods": true
      },
    • "isExclusiveUseShipment": false,
    • "iataData": {
      • "airWaybillNumber": "WBN001",
      • "airportOfDeparture": "Stewart International Airport",
      • "airportOfDestination": "Heathrow",
      • "signatureNameAndStatusOfDeclarant": "David Martin - Safety Adviser",
      • "signatureDate": "2020-12-31",
      • "signaturePlace": "New York"
      },
    • "imdgData": {
      • "vessel": "VES003",
      • "portOfDeparture": "Houston",
      • "portOfDischarge": "Hamburg",
      • "containerOrVehicleIdentification": "CONID001",
      • "sealNumber": "SEALZHN",
      • "sizeAndType": "",
      • "tareMass": 1002.5,
      • "totalGrossMass": 1092.5,
      • "packingCertificateCompany": "Cert Comp",
      • "packingCertificateNameAndStatusOfDeclarant": "Maria Johnson - Certification Manager",
      • "packingCertificateDate": "2020-12-31",
      • "packingCertificatePlace": "Houston",
      • "signatureCompany": "TransOne Inc.",
      • "signatureNameAndStatusOfDeclarant": "David Martin - Safety Adviser",
      • "signatureDate": "2020-12-31",
      • "signaturePlace": "Houston"
      },
    • "iataDataResponse": {
      • "shipmentLimitations": "PAX",
      • "isCargoAircraftOnly": false,
      • "isRadioactiveShipment": false,
      • "airWaybillStatements": {
        • "handlingInformation": [
          • "Dangerous goods as per attached Shipper's Declaration"
          ],
        • "natureAndQuantityOfGoods": [
          • "UN 2910, RADIOACTIVE MATERIAL, EXCEPTED PACKAGE - LIMITED QUANTITY OF MATERIAL, Number of Packages: 1"
          ]
        }
      },
    • "items": [
      • {
        • "consignmentItemType": "SimpleProduct",
        • "simpleProduct": {
          • "reference": "REF001",
          • "productCode": "PROCOD001",
          • "productName": "PRONAM001",
          • "isDangerousGood": true,
          • "dangerousGoodId": 2301,
          • "isEmpty": false,
          • "isEnvironmentallyHazardous": true,
          • "physicalState": "Liquid",
          • "measureUnit": "Kg",
          • "pureMixOrSolution": "Pure",
          • "mixOrSolutionPercentage": 0,
          • "flashPoint": 30.2,
          • "controlTemperature": 15,
          • "emergencyTemperature": 20,
          • "density": 1,
          • "numberOfPackages": 3,
          • "packageId": 14,
          • "packageHomologationId": 43,
          • "packingInstructionId": 0,
          • "imdgSegregationGroupId": 0,
          • "technicalName": "XYLENE AND BENZENE",
          • "technicalNames": {
            • "englishTechnicalName": "XYLENE AND BENZENE",
            • "spanishTechnicalName": "XILENO Y BENCENO",
            • "frenchTechnicalName": "XYLÈNE ET BENZÈNE",
            • "germanTechnicalName": "XYLOL UND BENZOL",
            • "portugueseTechnicalName": "XILENO E BENZENO",
            • "russianTechnicalName": "КСИЛОЛ И БЕНЗОЛ",
            • "chineseTechnicalName": "二甲苯和苯",
            • "italianTechnicalName": "XILENE E BENZENE",
            • "dutchTechnicalName": "XYLEEN EN BENZEEN",
            • "turkishTechnicalName": "KSİLEN VE BENZEN",
            • "polishTechnicalName": "KSYLEN I BENZEN",
            • "swedishTechnicalName": "XYLEN OCH BENSEN",
            • "norwegianTechnicalName": "XYLEN OG BENSEN",
            • "czechTechnicalName": "XYLEN A BENZEN",
            • "danishTechnicalName": "XYLEN OG BENZEN",
            • "greekTechnicalName": "ΞΥΛΟΛΙΟ ΚΑΙ ΒΕΝΖΟΛΙΟ",
            • "hungarianTechnicalName": "XILOL ÉS BENZOL",
            • "slovakTechnicalName": "XYLÉN A BENZÉN",
            • "romanianTechnicalName": "XILEN ȘI BENZEN",
            • "finnishTechnicalName": "KSYLEENI JA BENTSEENI"
            },
          • "hasInnerPackages": false,
          • "unitaryQuantity": 1.2,
          • "unitaryGrossQuantity": 2,
          • "unitaryQuantityExplosive": 0,
          • "fillingDegree": 100,
          • "authorizations": "Auth 0001",
          • "innerPackageMaterialId": 0,
          • "innerPackagesNumber": 0,
          • "innerPackageQuantity": 0,
          • "innerPackageCapacity": 0.5,
          • "innerPackageQuantityExplosive": 0,
          • "radiological": {
            • "nuclides": [
              • {
                • "radionuclideCode": "Co-60",
                • "activityBq": 50000000
                }
              ],
            • "packageType": "Excepted",
            • "isSpecialForm": false,
            • "isFissile": false,
            • "category": "IWhite",
            • "transportIndex": 0,
            • "certificateRef": "",
            • "physicoChemical": "Sealed source, solid",
            • "surfaceDoseRate": 0.05,
            • "packageDimensions": "string"
            },
          • "specialFeatures": "IsExtraViscousAccordingAdr",
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          },
        • "mixedPackingProduct": {
          • "productName": "MIXPACNAM001",
          • "productCode": "MIXPACCOD001",
          • "numberOfPackages": 3,
          • "unitaryGrossQuantity": 21,
          • "outerPackageId": 14,
          • "outerPackageHomologationId": 43,
          • "contents": [
            • {
              • "isDangerousGood": true,
              • "dangerousGoodId": 2301,
              • "measureUnit": "Kg",
              • "pureMixOrSolution": "Pure",
              • "mixOrSolutionPercentage": 0,
              • "flashPoint": 30.2,
              • "density": 1,
              • "technicalName": "XYLENE AND BENZENE",
              • "authorizations": "Auth 0001",
              • "innerPackageMaterialId": 1,
              • "packingInstructionId": 0,
              • "numberOfInnerPackages": 3,
              • "innerPackageQuantity": 0.1,
              • "innerPackageCapacity": 0.5,
              • "innerPackageQuantityExplosive": 0,
              • "consignmentItemCode": "ITEM-9515-4013-AA46",
              • "isEnvironmentallyHazardous": true,
              • "physicalState": "Liquid",
              • "imdgSegregationGroupId": 0,
              • "technicalNames": {
                • "englishTechnicalName": "XYLENE AND BENZENE",
                • "spanishTechnicalName": "XILENO Y BENCENO",
                • "frenchTechnicalName": "XYLÈNE ET BENZÈNE",
                • "germanTechnicalName": "XYLOL UND BENZOL",
                • "portugueseTechnicalName": "XILENO E BENZENO",
                • "russianTechnicalName": "КСИЛОЛ И БЕНЗОЛ",
                • "chineseTechnicalName": "二甲苯和苯",
                • "italianTechnicalName": "XILENE E BENZENE",
                • "dutchTechnicalName": "XYLEEN EN BENZEEN",
                • "turkishTechnicalName": "KSİLEN VE BENZEN",
                • "polishTechnicalName": "KSYLEN I BENZEN",
                • "swedishTechnicalName": "XYLEN OCH BENSEN",
                • "norwegianTechnicalName": "XYLEN OG BENSEN",
                • "czechTechnicalName": "XYLEN A BENZEN",
                • "danishTechnicalName": "XYLEN OG BENZEN",
                • "greekTechnicalName": "ΞΥΛΟΛΙΟ ΚΑΙ ΒΕΝΖΟΛΙΟ",
                • "hungarianTechnicalName": "XILOL ÉS BENZOL",
                • "slovakTechnicalName": "XYLÉN A BENZÉN",
                • "romanianTechnicalName": "XILEN ȘI BENZEN",
                • "finnishTechnicalName": "KSYLEENI JA BENTSEENI"
                }
              }
            ],
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          },
        • "overpack": {
          • "numberOfOverpacks": 2,
          • "identifiersOfOverpacks": [
            • "#OV1",
            • "#OV2"
            ],
          • "contents": [
            • {}
            ],
          • "consignmentItemCode": "ITEM-9515-4013-AA46"
          },
        • "iataDataItemResponse": {
          • "unOrIdNumber": "UN 1203",
          • "properShippingName": "Chemical Kits",
          • "classOrDivision": "9",
          • "packingGroup": "II",
          • "quantityAndTypeOfPacking": "1 Fibreboard box x 3kg",
          • "packingInstruction": "960",
          • "authorizations": "Auth 0001",
          • "mixedPackingQValue": 0.1,
          • "radiologicalDescription": ""
          },
        • "imdgDataItemResponse": {
          • "load": "UN 1266, PERFUMERY PRODUCTS (Contains denat alcohol) , 3, III, MARINE POLLUTANT . LIMITED QUANTITY Segregation Group: Without Segregation Group Flash Point (°C): 13 F-E, S-D",
          • "quantityAndTypeOfPacking": "6 Fibreboard boxes with 10 Packagings of glass x 1.065 L",
          • "netQuantityText": "63.9 L 60.72 kg",
          • "grossQuantityText": "66 kg",
          • "radiologicalDescription": ""
          },
        • "adrDataItemResponse": {
          • "load": "UN 2735, AMINES, LIQUID, CORROSIVE, N.O.S. (Contains 3-Aminomethyl-3,5, 5-trimethylcyclohexylamin; trimethylhexane-1, 6-diamine) , 8, II, (E)",
          • "quantityAndTypeOfPacking": "1 Fibreboard box",
          • "transportCategory": "2",
          • "quantityText": "Net: 1.59 L Gross: 15.7 kg",
          • "tunnelRestrictionCode": "D/E",
          • "radiologicalDescription": ""
          }
        }
      ],
    • "adrData": {
      • "spainData": {
        • "administrativeControlData": {
          • "contractualShipper": {
            • "accountCode": "CO001",
            • "types": [
              • "Shipper"
              ],
            • "code": "PAR01",
            • "name": "TransOne Inc.",
            • "address": "Mary Ann St",
            • "city-town": "Cardiff",
            • "province-region-state": "Wales",
            • "postalCode": "CF10 2EQ",
            • "countryId": 234,
            • "telephone": "+44 29 2023 4500",
            • "fax": "",
            • "contactPerson": "",
            • "taxCode": "",
            • "status": "string",
            • "adrData": {
              • "driverTrainingCertificate": {
                • "certificateNumber": "ES-ADR-118734",
                • "validUntil": "2029-05-31",
                • "specializations": [
                  • "Tanks"
                  ]
                }
              }
            },
          • "effectiveCarrier": {
            • "accountCode": "CO001",
            • "types": [
              • "Shipper"
              ],
            • "code": "PAR01",
            • "name": "TransOne Inc.",
            • "address": "Mary Ann St",
            • "city-town": "Cardiff",
            • "province-region-state": "Wales",
            • "postalCode": "CF10 2EQ",
            • "countryId": 234,
            • "telephone": "+44 29 2023 4500",
            • "fax": "",
            • "contactPerson": "",
            • "taxCode": "",
            • "status": "string",
            • "adrData": {
              • "driverTrainingCertificate": {
                • "certificateNumber": "ES-ADR-118734",
                • "validUntil": "2029-05-31",
                • "specializations": [
                  • "Tanks"
                  ]
                }
              }
            },
          • "specialTransportAuthorization": "string",
          • "shipperRemarks": "string",
          • "carrierRemarks": "string",
          • "documentUrl": "string"
          }
        }
      },
    • "specialFeatures": [
      • "ShowRedStripes"
      ]
    },
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 404,
  • "message": "Item not found",
  • "messageType": "Error",
  • "parameter": "productId",
  • "parameterValue": "Prod001",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Delete a consignment

Permanently removes the consignment and all its associated items and overpacks. The consignment is removed from its master consignment, its packages are unloaded from every transport equipment, and its live consolidation request is withdrawn when it is pending or rejected when it was accepted. The request is rejected with 400 when the master consignment of the consignment, or one that owns transport equipment carrying its packages, is approved, closed or cancelled.

Authorizations:

basicAuth or bearerAuth
HTTP: basicAuth
HTTP Authorization Scheme: basic
HTTP: bearerAuth

OAuth2 access token obtained from POST /oauth2/token using the client_credentials grant. Send it as Authorization: Bearer <access_token>. The token is opaque: it must not be parsed by the client. It is an alternative transport for the same identity as HTTP Basic, with the same roles and the same licensing, so any operation accepts either scheme.

HTTP Authorization Scheme: bearer

path Parameters

consignmentId
required
integer <int64>

Id of the consignment

query Parameters

requestGuid
required
string

Identifier of the request, up to 36 characters, used to trace it.

Responses

200

Successful request

Response Schema: application/json

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order, each one with its stable code. A warning does not prevent the operation. Omitted when there is no warning.

400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

404

Not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

messageType
string
Enum: "Error" "Warning" "Information"

Severity classification of the message.

parameter
string

Aggregated list of the parameter of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without parameter. Absent when no entry has a parameter.

parameterValue
string

Aggregated list of the parameterValue of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry without value. Absent when no entry has a value.

parameterPosition
string

Aggregated list of the parameterPosition of each entry of errors, separated by ", " and in the same order: element n belongs to entry n of errors, and it is empty for an entry outside a list. Positions start at 0. Absent when no entry is inside a list.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry.

Array of objects (ApiIssue)

Every warning found while processing the request, in detection order. Omitted when there is no warning.

delete/consignment/{consignmentId}
https://emea.dgassistant.com/api/v2/rest/consignment/{consignmentId}
https://amer.dgassistant.com/api/v2/rest/consignment/{consignmentId}
https://apac.dgassistant.com/api/v2/rest/consignment/{consignmentId}

Response samples

Content type
application/json
{
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 404,
  • "message": "Item not found",
  • "messageType": "Error",
  • "parameter": "productId",
  • "parameterValue": "Prod001",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}