Skip to content

Dangerous Goods API

Consolidation requests

Consolidation requests of client accounts, or of their adviser on their behalf, and decisions of the consolidator

Request the consolidation of a consignment

For client accounts of an external safety adviser that holds the consolidation add-on, and for that adviser on behalf of its clients: a user with consolidation can also request it, so one user can both request and decide. The consignment, given by consignmentId, must be valid, must not belong to a master consignment and must not have a pending or accepted request. A data snapshot of the consignment is taken, the request is recorded and the consolidator is notified by email and by the ConsolidationRequestCreated webhook event. Every problem is reported at once.

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

consignment to consolidate, with an optional reference and remarks for the consolidator

consignmentId
required
integer

Identifier of the consignment to consolidate; it must belong to the account of the user.

clientReference
string <= 50 characters

Reference of the client, such as an order or delivery note number.

remarks
string <= 1000 characters

Remarks for the consolidator, such as the requested date or delivery instructions.

Responses

201

Created

Response Schema: application/json

newItemId
integer

Identifier assigned to the newly created item.

newItemIsValid
boolean

Indicates whether the newly created item passed regulatory validation.

success
boolean

Indicates whether the item creation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the item creation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

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

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

message
required
string

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

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

pointer
string

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

ruleReference
string

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

object

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

leftConsignmentId
required
integer

Identifier of the consignment of the first item.

rightConsignmentId
required
integer

Identifier of the consignment of the second item.

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

Separation required by the rule.

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

Verdict for the pair.

leftConsignmentItemCode
string

Code of the first item in its consignment.

leftEquipmentId
integer

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

rightConsignmentItemCode
string

Code of the second item in its consignment.

rightEquipmentId
integer

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

ruleReference
string

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

remarks
string

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

]
400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

404

Consignment not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

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

Request samples

Content type
application/json
{
  • "consignmentId": 48213,
  • "clientReference": "PO-9001",
  • "remarks": "Delivery required before 15 November"
}

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

Search consolidation requests

Returns a page of consolidation requests: a client account sees its own requests and a consolidator account sees the requests addressed to it.

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.

status
string (ConsolidationRequestStatus)
Enum: "Requested" "Accepted" "Rejected" "Withdrawn" "Completed"

Status of the request.

consignmentId
integer <int64>
Example: consignmentId=48213

Identifier of the consignment to consolidate.

masterConsignmentId
integer <int64>
Example: masterConsignmentId=97

Identifier of the master consignment into which the request was accepted.

requesterAccountCode
string
Example: requesterAccountCode=WP001

Code of the client account, for consolidator accounts.

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

Earliest request date, inclusive, in ISO 8601 format.

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

Latest request date, 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 (ConsolidationRequestSummary)

Consolidation requests found on the page.

Array [
consolidationRequestId
required
integer

Identifier of the consolidation request.

consolidationRequestNumber
required
string or null

Number of the request.

status
required
string
Enum: "Requested" "Accepted" "Rejected" "Withdrawn" "Completed"

Status of the request.

consignmentId
required
integer

Identifier of the consignment to consolidate.

consignmentNumber
required
string or null

Number of the consignment.

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

Regulation of the consignment.

isValid
required
boolean

Regulatory validity of the consignment.

requestedOn
required
string <date-time>

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

hasChangedAfterAcceptance
required
boolean

True when the client changed the consignment after the acceptance.

shipperName
string

Name of the shipper of the consignment.

consigneeName
string

Name of the first consignee of the consignment.

requesterAccountCode
string

Code of the client account.

clientReference
string

Reference of the client.

decidedOn
string <date-time>

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

masterConsignmentNumber
string

Number of the master consignment, once accepted.

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

Response samples

Content type
application/json
{
  • "consolidationRequests": [
    • {
      • "consolidationRequestId": 88,
      • "consolidationRequestNumber": "PC-2026-0031",
      • "status": "Requested",
      • "consignmentId": 48213,
      • "consignmentNumber": "445",
      • "regulation": "Adr",
      • "shipperName": "Pinturas Levante S.L.",
      • "consigneeName": "Farben Nord GmbH",
      • "isValid": true,
      • "requesterAccountCode": "WP001",
      • "clientReference": "PO-9001",
      • "requestedOn": "2026-11-02T10:00:00Z",
      • "decidedOn": "2026-11-03T09:00:00Z",
      • "masterConsignmentNumber": "MC-2026-0007",
      • "nominatedMovementNumber": "PT 092S",
      • "hasChangedAfterAcceptance": true
      }
    ],
  • "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 consolidation request

Returns the request, the summary of the consignment and, once accepted, the master consignment, the nominated transport movement and its planned dates.

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

consolidationRequestId
required
integer <int64>
Example: 88

Identifier of the consolidation request.

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

Consolidation request with its decision and, once accepted, the data of the master consignment that the client may follow.

consolidationRequestId
required
integer

Identifier of the consolidation request.

consolidationRequestNumber
required
string or null

Number of the request.

status
required
string
Enum: "Requested" "Accepted" "Rejected" "Withdrawn" "Completed"

Status of the request.

requestedOn
required
string <date-time>

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

hasChangedAfterAcceptance
required
boolean

True when the client changed the consignment after the acceptance, so that its content no longer matches the accepted snapshot; the consolidator must check the transport equipment and the calculations again.

object

Consignment to consolidate.

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.

requesterAccountCode
string

Code of the client account.

requesterAccountName
string

Name of the client account.

consolidatorAccountCode
string

Code of the consolidator (consultancy) account.

consolidatorAccountName
string

Name of the consolidator account.

clientReference
string

Reference of the client.

remarks
string

Remarks of the client.

requestedBy
string

Login of the user who sent the request.

decidedOn
string <date-time>

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

decidedBy
string

Login of the consolidator user who took the decision.

decisionRemarks
string

Reason for the rejection or conditions of the acceptance.

completedOn
string <date-time>

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

object

Master consignment to which the consignment was added, once accepted.

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.

nominatedMovementNumber
string

Voyage, flight or journey nominated for the master consignment, when there is one.

nominatedMovementDeparture
string <date-time>

Planned departure of the nominated transport movement, in ISO 8601 format (UTC).

nominatedMovementArrival
string <date-time>

Planned arrival of the nominated transport movement, in ISO 8601 format (UTC).

requestSnapshotId
integer

Identifier of the data snapshot of the consignment taken when the request was sent. Absent once the snapshot has been deleted at the end of its storage period.

acceptedSnapshotId
integer

Identifier of the data snapshot of the consignment taken at acceptance. 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

Consolidation request 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/consolidationRequest/{consolidationRequestId}
https://emea.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}
https://amer.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}
https://apac.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}

Response samples

Content type
application/json
{
  • "consolidationRequestResponse": {
    • "consolidationRequestId": 88,
    • "consolidationRequestNumber": "PC-2026-0031",
    • "status": "Requested",
    • "consignment": {
      • "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"
        ]
      },
    • "requesterAccountCode": "WP001",
    • "requesterAccountName": "Pinturas Levante S.L.",
    • "consolidatorAccountCode": "CO001",
    • "consolidatorAccountName": "Consolidation Services Ltd",
    • "clientReference": "PO-9001",
    • "remarks": "Delivery required before 15 November",
    • "requestedOn": "2026-11-02T10:00:00Z",
    • "requestedBy": "client@example.com",
    • "decidedOn": "2026-11-03T09:00:00Z",
    • "decidedBy": "planner@example.com",
    • "decisionRemarks": "Delivery to the terminal by 10 November",
    • "completedOn": "2026-11-12T16:00:00Z",
    • "masterConsignment": {
      • "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"
      },
    • "nominatedMovementNumber": "PT 092S",
    • "nominatedMovementDeparture": "2026-11-02T10:00:00Z",
    • "nominatedMovementArrival": "2026-11-06T08:00:00Z",
    • "hasChangedAfterAcceptance": true,
    • "requestSnapshotId": 3401,
    • "acceptedSnapshotId": 3402
    },
  • "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."
        }
      }
    ]
}

Withdraw a consolidation request

For the client account, or for its adviser on its behalf. Withdraws a request in status Requested and notifies the consolidator; in any other status the request is rejected with 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

consolidationRequestId
required
integer <int64>
Example: 88

Identifier of the consolidation request.

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

Consolidation request with its decision and, once accepted, the data of the master consignment that the client may follow.

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

Consolidation request 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/consolidationRequest/{consolidationRequestId}/withdraw
https://emea.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/withdraw
https://amer.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/withdraw
https://apac.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/withdraw

Response samples

Content type
application/json
{
  • "consolidationRequestResponse": {
    • "consolidationRequestId": 88,
    • "consolidationRequestNumber": "PC-2026-0031",
    • "status": "Requested",
    • "consignment": {
      • "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"
        ]
      },
    • "requesterAccountCode": "WP001",
    • "requesterAccountName": "Pinturas Levante S.L.",
    • "consolidatorAccountCode": "CO001",
    • "consolidatorAccountName": "Consolidation Services Ltd",
    • "clientReference": "PO-9001",
    • "remarks": "Delivery required before 15 November",
    • "requestedOn": "2026-11-02T10:00:00Z",
    • "requestedBy": "client@example.com",
    • "decidedOn": "2026-11-03T09:00:00Z",
    • "decidedBy": "planner@example.com",
    • "decisionRemarks": "Delivery to the terminal by 10 November",
    • "completedOn": "2026-11-12T16:00:00Z",
    • "masterConsignment": {
      • "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"
      },
    • "nominatedMovementNumber": "PT 092S",
    • "nominatedMovementDeparture": "2026-11-02T10:00:00Z",
    • "nominatedMovementArrival": "2026-11-06T08:00:00Z",
    • "hasChangedAfterAcceptance": true,
    • "requestSnapshotId": 3401,
    • "acceptedSnapshotId": 3402
    },
  • "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."
        }
      }
    ]
}

Accept a consolidation request

For the consolidator account. Adds the consignment to the given master consignment, or to a new one created in status Draft, with the same checks as addConsignmentsToMasterConsignment; takes the acceptance snapshot and notifies the client. Only in status Requested; otherwise the request is rejected with 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

consolidationRequestId
required
integer <int64>
Example: 88

Identifier of the consolidation request.

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 that receives the consignment

masterConsignmentId
integer

Identifier of an existing master consignment of the consolidator account, with the same regulation and in status Draft, Submitted, InformationRequested or PreApproved.

object

Master consignment to create in status Draft for this request, when no masterConsignmentId is given.

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.

remarks
string <= 1000 characters

Conditions of the acceptance, shown to the client.

Responses

200

Successful request

Response Schema: application/json

object (ConsolidationRequestResponseData)

Consolidation request with its decision and, once accepted, the data of the master consignment that the client may follow.

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

Consolidation request, master consignment or a reference of the new 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/consolidationRequest/{consolidationRequestId}/accept
https://emea.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/accept
https://amer.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/accept
https://apac.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/accept

Request samples

Content type
application/json
{
  • "masterConsignmentId": 97,
  • "newMasterConsignment": {
    • "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"
    },
  • "remarks": "Delivery to the terminal by 10 November"
}

Response samples

Content type
application/json
{
  • "consolidationRequestResponse": {
    • "consolidationRequestId": 88,
    • "consolidationRequestNumber": "PC-2026-0031",
    • "status": "Requested",
    • "consignment": {
      • "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"
        ]
      },
    • "requesterAccountCode": "WP001",
    • "requesterAccountName": "Pinturas Levante S.L.",
    • "consolidatorAccountCode": "CO001",
    • "consolidatorAccountName": "Consolidation Services Ltd",
    • "clientReference": "PO-9001",
    • "remarks": "Delivery required before 15 November",
    • "requestedOn": "2026-11-02T10:00:00Z",
    • "requestedBy": "client@example.com",
    • "decidedOn": "2026-11-03T09:00:00Z",
    • "decidedBy": "planner@example.com",
    • "decisionRemarks": "Delivery to the terminal by 10 November",
    • "completedOn": "2026-11-12T16:00:00Z",
    • "masterConsignment": {
      • "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"
      },
    • "nominatedMovementNumber": "PT 092S",
    • "nominatedMovementDeparture": "2026-11-02T10:00:00Z",
    • "nominatedMovementArrival": "2026-11-06T08:00:00Z",
    • "hasChangedAfterAcceptance": true,
    • "requestSnapshotId": 3401,
    • "acceptedSnapshotId": 3402
    },
  • "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 a consolidation request

For the consolidator account. The reason is mandatory and is shown to the client. Only in status Requested; otherwise the request is rejected with 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

consolidationRequestId
required
integer <int64>
Example: 88

Identifier of the consolidation request.

query Parameters

requestGuid
required
string

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

Request Body schema: application/json
required

reason for the rejection

remarks
required
string <= 1000 characters

Reason for the rejection, shown to the client.

Responses

200

Successful request

Response Schema: application/json

object (ConsolidationRequestResponseData)

Consolidation request with its decision and, once accepted, the data of the master consignment that the client may follow.

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

Consolidation request 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/consolidationRequest/{consolidationRequestId}/reject
https://emea.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/reject
https://amer.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/reject
https://apac.dgassistant.com/api/v2/rest/consolidationRequest/{consolidationRequestId}/reject

Request samples

Content type
application/json
{
  • "remarks": "The consignment is not ready for the cut-off"
}

Response samples

Content type
application/json
{
  • "consolidationRequestResponse": {
    • "consolidationRequestId": 88,
    • "consolidationRequestNumber": "PC-2026-0031",
    • "status": "Requested",
    • "consignment": {
      • "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"
        ]
      },
    • "requesterAccountCode": "WP001",
    • "requesterAccountName": "Pinturas Levante S.L.",
    • "consolidatorAccountCode": "CO001",
    • "consolidatorAccountName": "Consolidation Services Ltd",
    • "clientReference": "PO-9001",
    • "remarks": "Delivery required before 15 November",
    • "requestedOn": "2026-11-02T10:00:00Z",
    • "requestedBy": "client@example.com",
    • "decidedOn": "2026-11-03T09:00:00Z",
    • "decidedBy": "planner@example.com",
    • "decisionRemarks": "Delivery to the terminal by 10 November",
    • "completedOn": "2026-11-12T16:00:00Z",
    • "masterConsignment": {
      • "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"
      },
    • "nominatedMovementNumber": "PT 092S",
    • "nominatedMovementDeparture": "2026-11-02T10:00:00Z",
    • "nominatedMovementArrival": "2026-11-06T08:00:00Z",
    • "hasChangedAfterAcceptance": true,
    • "requestSnapshotId": 3401,
    • "acceptedSnapshotId": 3402
    },
  • "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."
        }
      }
    ]
}