Skip to content

Dangerous Goods API

Webhooks

Webhook subscriptions of the account, their test and their recent deliveries

Create a webhook subscription

Creates a webhook subscription. Returns the identifier of the subscription in newItemId and the signing secret in secret, in the Standard Webhooks format, shown only once. At most five subscriptions per account; the address must use HTTPS. The notifications posted to the address are described by the WebhookNotification schema. Only the administrators of the account manage its webhook subscriptions; any other user receives 403.

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

endpoint and events to subscribe to

url
required
string <= 500 characters

HTTPS endpoint that receives the notifications; the body posted to it is described by the WebhookNotification schema.

eventTypes
Array of strings (WebhookEventType)
Items Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Events to deliver; every event of the account when empty.

description
string <= 100 characters

Free description of the subscription.

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.

secret
string

Signing secret in the Standard Webhooks format: whsec_ followed by the key in base 64. It is shown only in this response; store it to verify the webhook-signature header (see WebhookNotification).

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.

Callbacks

postReceive a webhook notification

Notification of a subscribed event, signed according to Standard Webhooks as described in WebhookNotification. The endpoint must answer with a 2xx status within 10 seconds.

post{$request.body#/url}

Request Body schema: application/json
required

signed notification of a subscribed event

subjectType
deliveryId
required
integer

Identifier of the delivery, the same value sent in the webhook-id header; the repeated deliveries of a retry keep it.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event that produced the notification.

occurredOn
required
string <date-time>

Date and time at which the event happened, in ISO 8601 format (UTC).

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource, to be used with the operation of its kind.

accountCode
string

Code of the subscriber account.

subjectNumber
string

Number of the resource (request, master consignment, movement or consignment note).

object

Summary of the consolidation request at the time of the event.

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.

deliveryId
required
integer

Identifier of the delivery, the same value sent in the webhook-id header; the repeated deliveries of a retry keep it.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event that produced the notification.

occurredOn
required
string <date-time>

Date and time at which the event happened, in ISO 8601 format (UTC).

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource, to be used with the operation of its kind.

accountCode
string

Code of the subscriber account.

subjectNumber
string

Number of the resource (request, master consignment, movement or consignment note).

object

Summary of the master consignment at the time of the event.

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.

deliveryId
required
integer

Identifier of the delivery, the same value sent in the webhook-id header; the repeated deliveries of a retry keep it.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event that produced the notification.

occurredOn
required
string <date-time>

Date and time at which the event happened, in ISO 8601 format (UTC).

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource, to be used with the operation of its kind.

accountCode
string

Code of the subscriber account.

subjectNumber
string

Number of the resource (request, master consignment, movement or consignment note).

object (WebhookTransportMovementData)

Summary of the transport movement and the documents issued.

movementId
required
integer

Identifier of the transport movement.

callCount
required
integer

Number of calls.

equipmentCount
required
integer

Number of pieces of transport equipment in the movement.

transportMode
string
Enum: "Sea" "Rail" "Road" "Air"

Mode of transport.

movementNumber
string

Voyage, flight or journey number.

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

Regulation of the transport movement.

status
string
Enum: "Planned" "InProgress" "Completed" "Cancelled"

Status of the movement.

vesselName
string

Name of the vessel, for sea movements.

vehicleRegistration
string

Registration plate of the vehicle, for road movements.

originLocationCode
string

Code of the location of origin (UN/LOCODE or code given by the account).

destinationLocationCode
string

Code of the location of destination (UN/LOCODE or code given by the account).

departure
string <date-time>

Planned departure, in ISO 8601 format (UTC).

arrival
string <date-time>

Planned arrival, in ISO 8601 format (UTC).

documentTypes
Array of strings (TransportMovementDocumentType)
Items Enum: "DangerousGoodsManifest" "InterUnitSegregationReport" "LoadThresholdReport" "TripRestrictionSheet" "ConsolidationLoadSheet" "Notoc" "ConsolidatedTransportDocument" "VehicleLoadCheckList"

Types of the documents issued.

deliveryId
required
integer

Identifier of the delivery, the same value sent in the webhook-id header; the repeated deliveries of a retry keep it.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event that produced the notification.

occurredOn
required
string <date-time>

Date and time at which the event happened, in ISO 8601 format (UTC).

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource, to be used with the operation of its kind.

accountCode
string

Code of the subscriber account.

subjectNumber
string

Number of the resource (request, master consignment, movement or consignment note).

object (WebhookConsignmentNoteData)

Summary of the consignment note and the event recorded.

consignmentNoteId
required
integer

Identifier of the consignment note.

consignmentNoteType
required
string
Enum: "InternationalCmr" "National"

International CMR or national note.

status
required
string
Enum: "Draft" "Validated" "Issued" "InProgress" "Delivered" "Cancelled" "Failed"

Status of the note.

consignmentId
required
integer

Identifier of the consignment.

consignmentNumber
required
string or null

Number of the consignment.

hasError
required
boolean

True when the last issue or synchronisation failed; the details are in the issue state of the note.

issueMode
required
string
Enum: "Electronic" "Paper"

Electronic note or paper.

consignmentNoteNumber
string

Number of the note, once assigned.

shipperName
string

Name of the shipper.

consigneeName
string

Name of the consignee.

takingOverText
string

Printed place of taking over.

takingOverOn
string <date-time>

Date of taking over, in ISO 8601 format (UTC).

deliveryText
string

Printed place of delivery.

issuedOn
string <date-time>

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

eventId
integer

Identifier of the event recorded, as listed by the events operation.

relatedEventId
integer

For Accepted and Error events that resolve a change or a cancellation, identifier of that event.

eventType
string
Enum: "Created" "Validated" "Issued" "SentToDriver" "ArrivedAtLoading" "LoadingCompleted" "SignedByShipper" "SignedByCarrier" "InTransit" "ArrivedAtDelivery" "Delivered" "Reservation" "Incident" "PlateChange" "DriverChange" "CarrierTransfer" "Modified" "Cancelled" "Error" "DecaGenerated" "LoadingStarted" "UnloadingCompleted" "DeclinedByCarrier" "DocumentAdded" "Reconsignment" "Shared" "Accepted"

Type of the event recorded.

deliveryId
required
integer

Identifier of the delivery, the same value sent in the webhook-id header; the repeated deliveries of a retry keep it.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event that produced the notification.

occurredOn
required
string <date-time>

Date and time at which the event happened, in ISO 8601 format (UTC).

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource, to be used with the operation of its kind.

accountCode
string

Code of the subscriber account.

subjectNumber
string

Number of the resource (request, master consignment, movement or consignment note).

Callback responses

2XX

Notification accepted

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

Request samples

Content type
application/json
{
  • "url": "https://tms.example.com/dgassistant/webhook",
  • "eventTypes": [
    • "ConsolidationRequestCreated"
    ],
  • "description": "Warehouse management system"
}

Response samples

Content type
application/json
{
  • "newItemId": 23,
  • "newItemIsValid": true,
  • "secret": "string",
  • "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."
        }
      }
    ]
}

Callback payload samples

Callback
POST: Receive a webhook notification
Content type
application/json
Example
{
  • "deliveryId": 90412,
  • "eventType": "ConsolidationRequestCreated",
  • "occurredOn": "2026-11-02T10:00:00Z",
  • "accountCode": "CO001",
  • "subjectType": "ConsolidationRequest",
  • "subjectId": 97,
  • "subjectNumber": "MC-2026-0007",
  • "data": {
    • "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
    }
}
{
  • "deliveryId": 90412,
  • "eventType": "ConsolidationRequestCreated",
  • "occurredOn": "2026-11-02T10:00:00Z",
  • "accountCode": "CO001",
  • "subjectType": "MasterConsignment",
  • "subjectId": 97,
  • "subjectNumber": "MC-2026-0007",
  • "data": {
    • "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"
    }
}
{
  • "deliveryId": 90412,
  • "eventType": "ConsolidationRequestCreated",
  • "occurredOn": "2026-11-02T10:00:00Z",
  • "accountCode": "CO001",
  • "subjectType": "TransportMovement",
  • "subjectId": 97,
  • "subjectNumber": "MC-2026-0007",
  • "data": {
    • "movementId": 311,
    • "transportMode": "Sea",
    • "movementNumber": "PT 092S",
    • "regulation": "Adr",
    • "status": "Planned",
    • "vesselName": "MSC ANNA",
    • "vehicleRegistration": "1234 KLM",
    • "originLocationCode": "ESVLC",
    • "destinationLocationCode": "DEHAM",
    • "departure": "2026-11-02T10:00:00Z",
    • "arrival": "2026-11-06T08:00:00Z",
    • "callCount": 3,
    • "equipmentCount": 1,
    • "documentTypes": [
      • "DangerousGoodsManifest"
      ]
    }
}
{
  • "deliveryId": 90412,
  • "eventType": "ConsolidationRequestCreated",
  • "occurredOn": "2026-11-02T10:00:00Z",
  • "accountCode": "CO001",
  • "subjectType": "ConsignmentNote",
  • "subjectId": 97,
  • "subjectNumber": "MC-2026-0007",
  • "data": {
    • "consignmentNoteId": 5120,
    • "consignmentNoteNumber": "CP-2026-0118",
    • "consignmentNoteType": "InternationalCmr",
    • "status": "Draft",
    • "consignmentId": 48213,
    • "consignmentNumber": "445",
    • "shipperName": "Pinturas Levante S.L.",
    • "consigneeName": "Farben Nord GmbH",
    • "takingOverText": "Valencia, Spain",
    • "takingOverOn": "2026-11-02T10:00:00Z",
    • "deliveryText": "Hamburg, Germany",
    • "hasError": true,
    • "issueMode": "Electronic",
    • "issuedOn": "2026-11-02T10:00:00Z",
    • "eventId": 20431,
    • "relatedEventId": 20430,
    • "eventType": "Created"
    }
}
{
  • "deliveryId": 90412,
  • "eventType": "ConsolidationRequestCreated",
  • "occurredOn": "2026-11-02T10:00:00Z",
  • "accountCode": "CO001",
  • "subjectType": "WebhookSubscription",
  • "subjectId": 97,
  • "subjectNumber": "MC-2026-0007"
}

List the webhook subscriptions of the account

Returns every webhook subscription of the account with its state and the number of consecutive failed deliveries. Only the administrators of the account manage its webhook subscriptions; any other user receives 403.

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.

Responses

200

Successful request

Response Schema: application/json

Array of objects (WebhookSubscriptionResponseData)

Webhook subscriptions of the account.

Array [
webhookSubscriptionId
required
integer

Identifier of the webhook subscription.

url
required
string or null

HTTPS endpoint that receives the notifications.

eventTypes
required
Array of strings or null (WebhookEventType)
Items Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Subscribed events; every event of the account when empty.

isEnabled
required
boolean

False after 20 consecutive failed deliveries or after the subscription is disabled; a successful test enables it again.

failureCount
required
integer

Number of consecutive failed deliveries.

description
string

Free description of the subscription.

lastDeliveryOn
string <date-time>

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

lastError
string

Last error (HTTP status or exception).

createdOn
string <date-time>

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

]
success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

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

Response samples

Content type
application/json
{
  • "webhookSubscriptions": [
    • {
      • "webhookSubscriptionId": 3,
      • "url": "https://tms.example.com/dgassistant/webhook",
      • "eventTypes": [
        • "ConsolidationRequestCreated"
        ],
      • "description": "Warehouse management system",
      • "isEnabled": true,
      • "failureCount": 0,
      • "lastDeliveryOn": "2026-11-02T10:00:00Z",
      • "lastError": "HTTP 500",
      • "createdOn": "2026-11-02T10:00:00Z"
      }
    ],
  • "success": true,
  • "httpStatusCode": 200,
  • "message": "Operation Completed OK",
  • "messageType": "Information",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 400,
  • "message": "Good not valid",
  • "messageType": "Error",
  • "parameter": "goods",
  • "parameterValue": "GoodX",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 401,
  • "message": "Unauthorized",
  • "messageType": "Error",
  • "parameter": "user",
  • "parameterValue": "Value ABC",
  • "parameterPosition": "3",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}
Content type
application/json
{
  • "success": false,
  • "httpStatusCode": 403,
  • "message": "Licensing Regulations Error",
  • "messageType": "Error",
  • "parameter": "Regulation Licenses",
  • "parameterValue": "string",
  • "parameterPosition": "string",
  • "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
  • "errors": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ],
  • "warnings": [
    • {
      • "code": "NOT_VALID_VALUE_FOR_PARAMETER",
      • "message": "Not valid value for the parameter.",
      • "parameter": "onTheFlySimpleProducts.packageId",
      • "parameterValue": "48213",
      • "parameterPosition": "2",
      • "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
      • "ruleReference": "IMDG 4.1.4.1 P001",
      • "segregation": {
        • "leftConsignmentId": 48213,
        • "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "leftEquipmentId": 1207,
        • "rightConsignmentId": 48214,
        • "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
        • "rightEquipmentId": 1208,
        • "ruleReference": "SG35",
        • "requiredSeparation": "NotRequired",
        • "verdict": "Allowed",
        • "remarks": "Keep one container space between both containers."
        }
      }
    ]
}

Delete a webhook subscription

Deletes the webhook subscription; its pending deliveries are discarded. Only the administrators of the account manage its webhook subscriptions; any other user receives 403.

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

webhookSubscriptionId
required
integer <int64>
Example: 3

Identifier of the webhook subscription of the account.

query Parameters

requestGuid
required
string

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

Responses

200

Successful request

Response Schema: application/json

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

404

Webhook subscription not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

delete/webhookSubscription/{webhookSubscriptionId}
https://emea.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}
https://amer.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}
https://apac.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}

Response samples

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

Test a webhook subscription

Delivers a Ping notification synchronously and reports the result: 200 when the endpoint answers with a 2xx status, and 400 with the status or the error otherwise. A successful test enables again a subscription that was disabled after failed deliveries. Only the administrators of the account manage its webhook subscriptions; any other user receives 403.

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

webhookSubscriptionId
required
integer <int64>
Example: 3

Identifier of the webhook subscription of the account.

query Parameters

requestGuid
required
string

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

Responses

200

Successful request

Response Schema: application/json

success
boolean

Indicates whether the operation completed successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the operation result.

messageType
string
Enum: "Information" "Warning"

Severity classification of the message.

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

400

Bad request

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the validation error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

401

Unauthorized

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the authorization error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

The authentication error, with its stable code.

403

Forbidden

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing why the request is forbidden.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

404

Webhook subscription not found

Response Schema: application/json

success
boolean

Indicates that the operation did not complete successfully.

httpStatusCode
integer <int32>

HTTP status code returned by the operation.

message
string

Human-readable message describing the not-found error.

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

Severity classification of the message.

parameter
string

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

parameterValue
string

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

parameterPosition
string

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

requestGuid
string

Unique identifier of the request, returned for tracing purposes.

Array of objects (ApiIssue)

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

Array of objects (ApiIssue)

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

post/webhookSubscription/{webhookSubscriptionId}/test
https://emea.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/test
https://amer.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/test
https://apac.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/test

Response samples

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

List the recent deliveries of a webhook subscription

Returns the last 200 deliveries of the subscription, newest first, with their attempts and the last response. Only the administrators of the account manage its webhook subscriptions; any other user receives 403.

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

webhookSubscriptionId
required
integer <int64>
Example: 3

Identifier of the webhook subscription of the account.

query Parameters

requestGuid
required
string

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

Responses

200

Successful request

Response Schema: application/json

Array of objects (WebhookDelivery)

Most recent deliveries, newest first (the last 200).

Array [
deliveryId
required
integer

Identifier of the delivery.

eventType
required
string
Enum: "ConsolidationRequestCreated" "ConsolidationRequestAccepted" "ConsolidationRequestRejected" "ConsolidationRequestWithdrawn" "MasterConsignmentStatusChanged" "MovementDocumentIssued" "ConsignmentNoteEventRecorded" "Ping"

Event notified by the delivery.

subjectType
required
string
Enum: "ConsolidationRequest" "MasterConsignment" "TransportMovement" "ConsignmentNote" "WebhookSubscription"

Kind of resource to which the notification refers.

subjectId
required
integer

Identifier of the resource to which the notification refers.

status
required
string
Enum: "Pending" "Delivered" "Failed" "Discarded"

State of the delivery.

attemptCount
required
integer

Attempts made, six at most.

createdOn
required
string <date-time>

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

nextAttemptOn
string <date-time>

Date and time of the next attempt, while pending, in ISO 8601 format (UTC).

deliveredOn
string <date-time>

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

lastHttpStatusCode
integer

Last HTTP status code received from the endpoint.

lastError
string

Last error of the delivery (HTTP status or exception).

]
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

Webhook subscription 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/webhookSubscription/{webhookSubscriptionId}/delivery
https://emea.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/delivery
https://amer.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/delivery
https://apac.dgassistant.com/api/v2/rest/webhookSubscription/{webhookSubscriptionId}/delivery

Response samples

Content type
application/json
{
  • "webhookDeliveries": [
    • {
      • "deliveryId": 90412,
      • "eventType": "ConsolidationRequestCreated",
      • "subjectType": "ConsolidationRequest",
      • "subjectId": 97,
      • "status": "Pending",
      • "attemptCount": 1,
      • "createdOn": "2026-11-02T10:00:00Z",
      • "nextAttemptOn": "2026-11-02T10:05:00Z",
      • "deliveredOn": "2026-11-02T10:00:01Z",
      • "lastHttpStatusCode": 200,
      • "lastError": "HTTP 500"
      }
    ],
  • "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."
        }
      }
    ]
}