Skip to content

Dangerous Goods API

Master consignments

Master consignments with their consignments and approval workflow

Create a master consignment

Creates a master consignment in status Draft. Consignments can be added on creation or later, and the number is generated when omitted.

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

master consignment

consolidationType
required
string
Enum: "Road" "SeaLcl" "SeaFcl" "Air"

Kind of consolidation, which decides the fields that apply: sea consolidations use the vessel and ports, air consolidations the master air waybill and airports, and road consolidations the vehicles. It cannot change once the master consignment has consignments or its own transport equipment.

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

Regulation of the master consignment, which must be the one of its type of consolidation: Adr for road consolidation, Imdg for sea and Iata for air; Cfr49 is rejected with 400 until it is available. It is the regulation of the documentation of the consignments: today every consignment must have the regulation of the master consignment.

workPlaceCode
required
string

Code of the workplace that issues the master consignment, as in the consignment API; on creation, a workplace in which the user can write. On update it must be the workplace of the master consignment.

masterConsignmentNumber
string <= 50 characters

Number of the master consignment, unique in the company; generated from the sequence of the company when omitted.

bookingNumber
string <= 50 characters

Booking number given by the shipping line or airline; the main search key for sea consolidations.

masterDocumentNumber
string <= 50 characters

Master document number: the 11-digit master air waybill number (three-digit airline prefix and eight digits, the last of which is a modulus 7 check digit) or the master bill of lading number.

description
string <= 250 characters

Free description of the master consignment.

date
string <date>

Date of the master consignment, in ISO 8601 format; today when omitted.

originLocationCode
string <= 20 characters

Code of the contractual port or airport of loading (POL) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group (UN/LOCODE or code given by the account).

destinationLocationCode
string <= 20 characters

Code of the contractual port or airport of discharge (POD) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group (UN/LOCODE or code given by the account).

finalDestinationLocationCode
string <= 20 characters

Code of the final place of delivery (FPOD) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group, when it differs from the destination, such as an inland terminal.

nominatedMovementId
integer

Identifier of the transport movement (vessel and voyage, flight or journey) nominated for the booking. It must be of a workplace of the company of the master consignment. The Document of Compliance of the vessel and the port restrictions of the route are checked when transport equipment is placed on that transport movement, not when consignments are added.

isCargoAircraftOnly
boolean or null

For air consolidations only: true when the goods are restricted to cargo aircraft (IATA DGR packing instructions for cargo aircraft only); null for sea and road.

Array of objects (MasterConsignmentParty)

Parties of the master consignment. The Consolidator is mandatory; the others are optional.

Array [
participantType
required
string
Enum: "Shipper" "Loader" "Carrier" "Consignee" "Supplier" "Driver" "Consolidator" "NotifyParty" "FreightForwarder" "ShippingAgent"

Role of the party in the master consignment: Shipper, Consignee, Carrier, Consolidator, NotifyParty, FreightForwarder or ShippingAgent; any other type is rejected with 400.

predefinedParticipantCode
string

Code of an existing participant of the account, as used in GET /participant/{participantCode}; give it or onTheFlyParticipant, not both.

object

Data of the participant when no predefined participant is used; the participant is created in the account with the role of the party.

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.

]
Array of objects (MasterConsignmentReference)

References of the master consignment.

Array [
referenceType
required
string
Enum: "ShipperReference" "FreightForwarderReference" "DangerousGoodsAcceptanceReference" "BillOfLading" "MasterAirWaybill" "TransportDocumentNumber" "Other"

Kind of reference.

value
required
string <= 100 characters

Value of the reference as printed on the documents.

predefinedIssuerCode
string

Code of the participant that issued the reference, such as the shipping line for the dangerous goods acceptance reference.

date
string <date>

Date on which the reference was issued, in ISO 8601 format.

]
consignmentIds
Array of integers

Identifiers of existing consignments of the account to add on creation, with the same rules as when consignments are added later.

remarks
string <= 1000 characters

Free remarks, such as information on a part load.

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

Work place, participant, consignment, location or nominated transport movement 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/masterConsignment
https://emea.dgassistant.com/api/v2/rest/masterConsignment
https://amer.dgassistant.com/api/v2/rest/masterConsignment
https://apac.dgassistant.com/api/v2/rest/masterConsignment

Request samples

Content type
application/json
{
  • "consolidationType": "Road",
  • "regulation": "Adr",
  • "masterConsignmentNumber": "MC-2026-0007",
  • "bookingNumber": "NPDL-4471209",
  • "masterDocumentNumber": "020-12345675",
  • "description": "Weekly LCL to Hamburg",
  • "date": "2026-11-02",
  • "workPlaceCode": "WP001",
  • "originLocationCode": "ESVLC",
  • "destinationLocationCode": "DEHAM",
  • "finalDestinationLocationCode": "DEDUI",
  • "nominatedMovementId": 311,
  • "isCargoAircraftOnly": true,
  • "parties": [
    • {
      • "participantType": "Shipper",
      • "predefinedParticipantCode": "CON001",
      • "onTheFlyParticipant": {
        • "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"
        }
      }
    ],
  • "references": [
    • {
      • "referenceType": "ShipperReference",
      • "value": "DGA-445120",
      • "predefinedIssuerCode": "CAR001",
      • "date": "2026-11-02"
      }
    ],
  • "consignmentIds": [
    • 48213
    ],
  • "remarks": "Part load shared with booking NPDL-4471210"
}

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."
        }
      }
    ]
}

Search the master consignments of the account

Returns a page of the master consignments of the account, filtered by number, booking, master document, status, kind of consolidation, date or consignment.

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.

masterConsignmentNumber
string
Example: masterConsignmentNumber=MC-2026-0007

Number of the master consignment, exact match.

bookingNumber
string
Example: bookingNumber=NPDL-4471209

Booking number, exact match.

masterDocumentNumber
string
Example: masterDocumentNumber=020-12345675

Master air waybill or master bill of lading number, exact match.

status
string (MasterConsignmentStatus)
Enum: "Draft" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled"

Workflow status of the master consignment.

consolidationType
string (ConsolidationType)
Enum: "Road" "SeaLcl" "SeaFcl" "Air"

Kind of consolidation of the master consignment.

consignmentId
integer <int64>
Example: consignmentId=48213

Identifier of a consignment, to return the master consignment that contains it.

dateFrom
string <date>
Example: dateFrom=2026-11-01

Earliest date of the master consignment, inclusive, in ISO 8601 format.

dateTo
string <date>
Example: dateTo=2026-11-30

Latest date of the master consignment, inclusive, in ISO 8601 format.

page
integer
Default: 1
Example: page=1

Page number, starting at 1.

pageSize
integer [ 1 .. 200 ]
Default: 50
Example: pageSize=50

Number of items per page, between 1 and 200.

Responses

200

Successful request

Response Schema: application/json

Array of objects (MasterConsignmentSummary)

Master consignments found on the page.

Array [
masterConsignmentId
required
integer

Identifier of the master consignment.

masterConsignmentNumber
required
string or null

Number of the master consignment.

consolidationType
required
string
Enum: "Road" "SeaLcl" "SeaFcl" "Air"

Kind of consolidation.

status
required
string
Enum: "Draft" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled"

Workflow status of the master consignment.

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

Regulation of the master consignment.

date
required
string <date>

Date of the master consignment, in ISO 8601 format.

consignmentCount
required
integer

Number of consignments of the master consignment.

equipmentCount
required
integer

Number of pieces of transport equipment assigned.

bookingNumber
string

Booking number given by the shipping line or airline.

masterDocumentNumber
string

Master air waybill or master bill of lading number.

consolidatorName
string

Name of the consolidator party.

nominatedMovementNumber
string

Number of the nominated transport movement, when there is one.

]
page
integer

Page returned, starting at 1.

pageSize
integer

Number of items per page applied to the search.

total
integer

Total number of items that match the filters, across all pages.

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.

get/masterConsignment
https://emea.dgassistant.com/api/v2/rest/masterConsignment
https://amer.dgassistant.com/api/v2/rest/masterConsignment
https://apac.dgassistant.com/api/v2/rest/masterConsignment

Response samples

Content type
application/json
{
  • "masterConsignments": [
    • {
      • "masterConsignmentId": 97,
      • "masterConsignmentNumber": "MC-2026-0007",
      • "consolidationType": "Road",
      • "status": "Draft",
      • "regulation": "Adr",
      • "bookingNumber": "NPDL-4471209",
      • "masterDocumentNumber": "020-12345675",
      • "date": "2026-11-02",
      • "consolidatorName": "Consolidation Services Ltd",
      • "consignmentCount": 2,
      • "equipmentCount": 3,
      • "nominatedMovementNumber": "PT 092S"
      }
    ],
  • "page": 1,
  • "pageSize": 50,
  • "total": 137,
  • "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."
        }
      }
    ]
}

Get a master consignment

Returns the master consignment with its parties, references, consignments and transport equipment.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

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 (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

masterConsignmentId
required
integer

Identifier of the master consignment.

status
required
string
Enum: "Draft" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled"

Current workflow status.

consolidationType
required
string
Enum: "Road" "SeaLcl" "SeaFcl" "Air"

Kind of consolidation.

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

Regulation of the master consignment.

masterConsignmentNumber
required
string or null

Number of the master consignment.

date
required
string <date>

Date of the master consignment, in ISO 8601 format.

required
Array of objects or null (MasterConsignmentPartyResponse)

Parties of the master consignment with their data.

Array [
participantType
required
string
Enum: "Shipper" "Loader" "Carrier" "Consignee" "Supplier" "Driver" "Consolidator" "NotifyParty" "FreightForwarder" "ShippingAgent"

Role of the party.

predefinedParticipantCode
string

Code of the participant in the account.

object

Data of the participant: name, address, tax code and contact.

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.

]
required
Array of objects or null (MasterConsignmentReference)

References of the master consignment.

Array [
referenceType
required
string
Enum: "ShipperReference" "FreightForwarderReference" "DangerousGoodsAcceptanceReference" "BillOfLading" "MasterAirWaybill" "TransportDocumentNumber" "Other"

Kind of reference.

value
required
string <= 100 characters

Value of the reference as printed on the documents.

predefinedIssuerCode
string

Code of the participant that issued the reference, such as the shipping line for the dangerous goods acceptance reference.

date
string <date>

Date on which the reference was issued, in ISO 8601 format.

]
required
Array of objects or null (HouseConsignmentSummary)

House consignments of the master consignment.

Array [
consignmentId
required
integer

Identifier of the consignment.

consignmentNumber
required
string or null

Number of the consignment, from the sequence of the account.

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

Regulation of the consignment.

isValid
required
boolean

Regulatory validity of the consignment according to the checks of the application; invalid consignments cannot appear in the manifests.

equipmentIdentifications
required
Array of strings or null

Identifications of the transport equipment in which the consignment is loaded, fully or partially.

requesterAccountCode
string

Code of the client account that owns the consignment when it was added through a consolidation request; empty for consignments of the consolidator account.

consolidationRequestId
integer

Identifier of the consolidation request through which the consignment was added, when there is one.

date
string <date>

Issue date of the consignment, in ISO 8601 format.

shipperName
string

Name of the shipper (consignor) of the consignment.

consigneeName
string

Name of the first consignee of the consignment.

hasElectronicDeclaration
boolean or null

For air only: true when the shipper declaration is electronic (IATA XSDG), false when it is on paper and null when unknown. An air consolidation cannot mix both.

houseDocumentNumber
string

House air waybill or house bill of lading number of the consignment, when there is one.

]
required
Array of objects or null (MasterConsignmentEquipmentSummary)

Transport equipment owned by the master consignment and, marked with isShared, equipment of other bookings that carries items of its consignments.

Array [
equipmentId
required
integer

Identifier of the transport equipment.

identification
required
string or null

Container number, registration plate or ULD identifier.

equipmentType
required
string
Enum: "Container" "TankContainer" "Vehicle" "Trailer" "Wagon" "UnitLoadDevice" "SwapBody"

Kind of transport equipment.

loadState
required
string
Enum: "Full" "Empty" "Residue"

Load state of the transport equipment.

isShared
required
boolean

True when another booking owns the transport equipment and it carries items of consignments of this master consignment (part load); false for equipment of this master consignment.

currentMovementNumber
string

Number of the transport movement in which it is currently planned or loaded, when there is one.

ownerMasterConsignmentId
integer

Identifier of the master consignment (booking) that owns shared transport equipment.

ownerMasterConsignmentNumber
string

Number of the master consignment that owns shared transport equipment.

]
bookingNumber
string

Booking number of the carrier.

masterDocumentNumber
string

Master air waybill or master bill of lading number.

description
string

Free description of the master consignment.

workPlaceCode
string

Code of the workplace of the account that issues the master consignment.

object

Contractual origin: port or airport of loading.

countryId
required
integer

Country identifier of the master data (GET /masterdata/country).

isPort
required
boolean

True when the location is a sea port.

isAirport
required
boolean

True when the location is an airport.

isRoadTerminal
required
boolean

True when the location is a road terminal.

isRailTerminal
required
boolean

True when the location is a rail terminal.

isAccountSpecific
required
boolean

True when the location was created by the account; false for a location of the global UN/LOCODE catalogue.

locationCode
string <= 20 characters

Code of the location: the UN/LOCODE for catalogue locations, or the code given by the account to a location of its own.

unlocode
string <= 5 characters

Official UN/LOCODE; empty for a location of the account that has none.

name
string

Name of the port, airport or terminal.

countryCode
string <= 2 characters

ISO 3166-1 alpha-2 code of the country.

iataCode
string <= 3 characters

Three-letter IATA code of the airport, when the location is an airport.

alias
string

Short name given to the location by the account. In the search of locations, when the location is among the locations of several accounts, the alias is the one of the most specific account: the work place, then the company, then the group.

accountCode
string

Code of the customer account whose locations include the location and whose alias is returned. Omitted when the location is not among the locations of the accounts or when the account has no code.

object

Contractual destination: port or airport of discharge.

object

Final place of delivery, when it differs from the destination.

nominatedMovementId
integer

Identifier of the nominated transport movement.

nominatedMovementNumber
string

Number of the nominated transport movement (voyage, flight or journey).

isCargoAircraftOnly
boolean

For air consolidations, true when the goods are restricted to cargo aircraft.

remarks
string

Free remarks on the master consignment.

createdOn
string <date-time>

Date and time of creation, in ISO 8601 format (UTC).

updatedOn
string <date-time>

Date and time of the last update, in ISO 8601 format (UTC).

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

Master 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/masterConsignment/{masterConsignmentId}
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}

Update a master consignment

Updates the data, parties and references of the master consignment; the lists in the request replace the current ones. Consignments are added and removed separately. Not allowed in status Closed or Cancelled. The consolidation type cannot change while the master consignment has consignments or its own transport equipment (400 naming consolidationType).

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

master consignment data that replace the current ones

consolidationType
required
string
Enum: "Road" "SeaLcl" "SeaFcl" "Air"

Kind of consolidation, which decides the fields that apply: sea consolidations use the vessel and ports, air consolidations the master air waybill and airports, and road consolidations the vehicles. It cannot change once the master consignment has consignments or its own transport equipment.

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

Regulation of the master consignment, which must be the one of its type of consolidation: Adr for road consolidation, Imdg for sea and Iata for air; Cfr49 is rejected with 400 until it is available. It is the regulation of the documentation of the consignments: today every consignment must have the regulation of the master consignment.

workPlaceCode
required
string

Code of the workplace that issues the master consignment, as in the consignment API; on creation, a workplace in which the user can write. On update it must be the workplace of the master consignment.

masterConsignmentNumber
string <= 50 characters

Number of the master consignment, unique in the company; generated from the sequence of the company when omitted.

bookingNumber
string <= 50 characters

Booking number given by the shipping line or airline; the main search key for sea consolidations.

masterDocumentNumber
string <= 50 characters

Master document number: the 11-digit master air waybill number (three-digit airline prefix and eight digits, the last of which is a modulus 7 check digit) or the master bill of lading number.

description
string <= 250 characters

Free description of the master consignment.

date
string <date>

Date of the master consignment, in ISO 8601 format; today when omitted.

originLocationCode
string <= 20 characters

Code of the contractual port or airport of loading (POL) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group (UN/LOCODE or code given by the account).

destinationLocationCode
string <= 20 characters

Code of the contractual port or airport of discharge (POD) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group (UN/LOCODE or code given by the account).

finalDestinationLocationCode
string <= 20 characters

Code of the final place of delivery (FPOD) in the lists of the work place given in workPlaceCode (on update, of the account of the master consignment), of its company and of its group, when it differs from the destination, such as an inland terminal.

nominatedMovementId
integer

Identifier of the transport movement (vessel and voyage, flight or journey) nominated for the booking. It must be of a workplace of the company of the master consignment. The Document of Compliance of the vessel and the port restrictions of the route are checked when transport equipment is placed on that transport movement, not when consignments are added.

isCargoAircraftOnly
boolean or null

For air consolidations only: true when the goods are restricted to cargo aircraft (IATA DGR packing instructions for cargo aircraft only); null for sea and road.

Array of objects (MasterConsignmentParty)

Parties of the master consignment. The Consolidator is mandatory; the others are optional.

Array of objects (MasterConsignmentReference)

References of the master consignment.

consignmentIds
Array of integers

Identifiers of existing consignments of the account to add on creation, with the same rules as when consignments are added later.

remarks
string <= 1000 characters

Free remarks, such as information on a part load.

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

Master consignment, work place, participant, consignment, location or nominated transport movement 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.

409

Conflict

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 conflict with the current state of the resource.

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.

put/masterConsignment/{masterConsignmentId}
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}

Request samples

Content type
application/json
{
  • "consolidationType": "Road",
  • "regulation": "Adr",
  • "masterConsignmentNumber": "MC-2026-0007",
  • "bookingNumber": "NPDL-4471209",
  • "masterDocumentNumber": "020-12345675",
  • "description": "Weekly LCL to Hamburg",
  • "date": "2026-11-02",
  • "workPlaceCode": "WP001",
  • "originLocationCode": "ESVLC",
  • "destinationLocationCode": "DEHAM",
  • "finalDestinationLocationCode": "DEDUI",
  • "nominatedMovementId": 311,
  • "isCargoAircraftOnly": true,
  • "parties": [
    • {
      • "participantType": "Shipper",
      • "predefinedParticipantCode": "CON001",
      • "onTheFlyParticipant": {
        • "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"
        }
      }
    ],
  • "references": [
    • {
      • "referenceType": "ShipperReference",
      • "value": "DGA-445120",
      • "predefinedIssuerCode": "CAR001",
      • "date": "2026-11-02"
      }
    ],
  • "consignmentIds": [
    • 48213
    ],
  • "remarks": "Part load shared with booking NPDL-4471210"
}

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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Delete a master consignment

Deletes a master consignment in status Draft or Cancelled. Its consignments and transport equipment are removed from it, not deleted. Its accepted consolidation requests are rejected with the reason that the master consignment was deleted, and their requesters are notified; no consolidation request refers to it afterwards.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}

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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Add consignments to a master consignment

Adds consignments of the account, or of the client accounts of its consultancy (directly or through an accepted consolidation request). Each consignment may belong to one master consignment only. The regulation of every consignment and the rule against mixing paper and electronic shipper declarations in air consolidations are checked; every problem is reported at once. The Document of Compliance of the vessel and the port restrictions of the route are checked when the transport equipment is placed on the transport movement.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

consignments to add

consignmentIds
required
Array of integers non-empty

Identifiers of existing consignments of the account, or of the client accounts of its consultancy, to add.

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

Master consignment or 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/consignment
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/consignment
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/consignment
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/consignment

Request samples

Content type
application/json
{
  • "consignmentIds": [
    • 48213,
    • 48214
    ]
}

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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Remove a consignment from a master consignment

Removes the consignment from the master consignment; its packages are unloaded from the transport equipment of the master consignment.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

consignmentId
required
integer <int64>
Example: 48213

Identifier 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

Master consignment or 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/consignment/{consignmentId}
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/consignment/{consignmentId}
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/consignment/{consignmentId}
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Submit the master consignment to the carrier

Sends the dangerous goods application: allowed in Draft and InformationRequested, leads to Submitted. Takes a data snapshot of the master consignment (dataSnapshotId of the event). The optional remarks are recorded in the event. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/submit
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submit
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submit
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submit

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Request more information about the master consignment

Allowed in Submitted and FinalDocumentationSubmitted, leads to InformationRequested. The remarks are mandatory: they state the information requested. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/requestInformation
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/requestInformation
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/requestInformation
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/requestInformation

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Pre-approve the master consignment

Allowed in Submitted, leads to PreApproved: the transport equipment may be packed. Takes a data snapshot of the master consignment. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/preApprove
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/preApprove
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/preApprove
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/preApprove

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Record the final documentation of the master consignment

Allowed in PreApproved, leads to FinalDocumentationSubmitted. Takes a data snapshot of the master consignment and records the differences with the snapshot taken at the pre-approval. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/submitFinalDocumentation
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submitFinalDocumentation
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submitFinalDocumentation
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/submitFinalDocumentation

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Approve the master consignment

Allowed in FinalDocumentationSubmitted, leads to Approved. Requires a valid segregation check, not obsolete, of every piece of transport equipment and, for road movements under Adr, a valid load threshold calculation (ADR 1.1.3.6) of the nominated transport movement; otherwise every reason is returned at once and the status does not change. Records the differences with the snapshot taken at the pre-approval. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/approve
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/approve
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/approve
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/approve

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Reject the master consignment

Allowed in Submitted, InformationRequested, PreApproved and FinalDocumentationSubmitted, leads to Rejected. The remarks are mandatory: they state the reason. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/reject
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reject
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reject
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reject

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Close the master consignment

Allowed in Approved, leads to Closed: the master consignment becomes read-only and its accepted consolidation requests are completed. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/close
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/close
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/close
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/close

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Cancel the master consignment

Allowed in Draft, InformationRequested, PreApproved and Approved, leads to Cancelled; the consolidation requests accepted into it are rejected. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/cancel
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/cancel
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/cancel
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/cancel

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Reopen a rejected master consignment

Allowed in Rejected, takes the master consignment back to Draft. Every transition is recorded as an event and notified with the MasterConsignmentStatusChanged webhook. A transition that the current status does not allow answers 409.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

remarks of the transition, or an empty object when none are needed

remarks
string <= 1000 characters

Reason for the transition, recorded in its event; mandatory for reject and requestInformation.

Responses

200

Successful request

Response Schema: application/json

object (MasterConsignmentResponseData)

Master consignment with its parties, references, consignments and transport equipment.

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

Master 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.

409

Conflict

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 conflict with the current state of the resource.

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/masterConsignment/{masterConsignmentId}/reopen
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reopen
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reopen
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/reopen

Request samples

Content type
application/json
{
  • "remarks": "Missing safety data sheet"
}

Response samples

Content type
application/json
{
  • "masterConsignmentResponse": {
    • "masterConsignmentId": 97,
    • "status": "Draft",
    • "consolidationType": "Road",
    • "regulation": "Adr",
    • "masterConsignmentNumber": "MC-2026-0007",
    • "bookingNumber": "NPDL-4471209",
    • "masterDocumentNumber": "020-12345675",
    • "description": "Weekly LCL to Hamburg",
    • "date": "2026-11-02",
    • "workPlaceCode": "WP001",
    • "origin": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "destination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "finalDestination": {
      • "locationCode": "ESVLC",
      • "unlocode": "ESVLC",
      • "name": "Valencia",
      • "countryId": 208,
      • "countryCode": "ES",
      • "iataCode": "VLC",
      • "isPort": true,
      • "isAirport": true,
      • "isRoadTerminal": true,
      • "isRailTerminal": true,
      • "isAccountSpecific": true,
      • "alias": "Valencia terminal",
      • "accountCode": "WP001"
      },
    • "nominatedMovementId": 311,
    • "nominatedMovementNumber": "PT 092S",
    • "isCargoAircraftOnly": true,
    • "parties": [
      • {
        • "participantType": "Shipper",
        • "predefinedParticipantCode": "CON001",
        • "participant": {
          • "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"
                ]
              }
            }
          }
        }
      ],
    • "references": [
      • {
        • "referenceType": "ShipperReference",
        • "value": "DGA-445120",
        • "predefinedIssuerCode": "CAR001",
        • "date": "2026-11-02"
        }
      ],
    • "consignments": [
      • {
        • "requesterAccountCode": "WP001",
        • "consolidationRequestId": 88,
        • "consignmentId": 48213,
        • "consignmentNumber": "445",
        • "regulation": "Adr",
        • "date": "2026-11-02",
        • "shipperName": "Pinturas Levante S.L.",
        • "consigneeName": "Farben Nord GmbH",
        • "isValid": true,
        • "hasElectronicDeclaration": true,
        • "houseDocumentNumber": "HWB-2026-0031",
        • "equipmentIdentifications": [
          • "MSCU1234566"
          ]
        }
      ],
    • "equipment": [
      • {
        • "equipmentId": 1207,
        • "identification": "MSCU1234566",
        • "equipmentType": "Container",
        • "loadState": "Full",
        • "currentMovementNumber": "PT 092S",
        • "isShared": true,
        • "ownerMasterConsignmentId": 96,
        • "ownerMasterConsignmentNumber": "MC-2026-0006"
        }
      ],
    • "remarks": "Part load shared with booking NPDL-4471210",
    • "createdOn": "2026-11-02T10:00:00Z",
    • "updatedOn": "2026-11-02T10:00:00Z"
    },
  • "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."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 409,
  • "message": "Only a master consignment in draft or cancelled status can be deleted.",
  • "messageType": "Error",
  • "parameter": "masterConsignmentId",
  • "parameterValue": "1234",
  • "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."
        }
      }
    ]
}

Get the history of a master consignment

Returns the history of the master consignment: status transitions, consignments added and removed, transport equipment assigned and released, and comments, oldest first.

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

masterConsignmentId
required
integer <int64>
Example: 97

Identifier of the master consignment, as returned in newItemId on creation.

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

Array of objects (MasterConsignmentEvent)

History of the master consignment, oldest first.

Array [
eventId
required
integer

Identifier of the entry.

eventType
required
string
Enum: "Created" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled" "Reopened" "ConsignmentAttached" "ConsignmentDetached" "EquipmentAssigned" "EquipmentReleased" "CommentAdded"

Kind of entry.

occurredOn
required
string <date-time>

Date and time of the entry, in ISO 8601 format (UTC).

fromStatus
string
Enum: "Draft" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled"

Previous status, when the entry is a status transition.

toStatus
string
Enum: "Draft" "Submitted" "InformationRequested" "PreApproved" "FinalDocumentationSubmitted" "Approved" "Rejected" "Closed" "Cancelled"

New status, when the entry is a status transition.

performedBy
string

Login of the user who produced the entry.

consignmentId
integer

Identifier of the related consignment, when the entry concerns one.

equipmentId
integer

Identifier of the related transport equipment, when the entry concerns one.

remarks
string

Reason, information requested or comment.

dataSnapshotId
integer

Identifier of the data snapshot of the master consignment taken at Submitted, PreApproved and FinalDocumentationSubmitted; the final documentation is compared with the snapshot taken at PreApproved. Absent once the snapshot has been deleted at the end of its storage period.

]
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

Master 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/masterConsignment/{masterConsignmentId}/event
https://emea.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/event
https://amer.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/event
https://apac.dgassistant.com/api/v2/rest/masterConsignment/{masterConsignmentId}/event

Response samples

Content type
application/json
{
  • "masterConsignmentEvents": [
    • {
      • "eventId": 20118,
      • "eventType": "Created",
      • "fromStatus": "Draft",
      • "toStatus": "Draft",
      • "occurredOn": "2026-11-02T10:00:00Z",
      • "performedBy": "planner@example.com",
      • "consignmentId": 48213,
      • "equipmentId": 1207,
      • "remarks": "Please provide the safety data sheet of item 2",
      • "dataSnapshotId": 3312
      }
    ],
  • "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."
        }
      }
    ]
}