Consignment documents
Documents of a consignment (transport document, checklist, package marking and others), their sending by email and frozen documents
Get a document of a consignment
Generates a base 64 encoded transport document, checklist, package marking or, for air consignments, the air waybill data sheet (AirWaybillData) with the dangerous goods statements to be shown on the air waybill. When none of the requested document types applies to the regulation of the consignment, the request is rejected with 400.
Authorizations:
basicAuth or bearerAuth
HTTP: basicAuth
basicHTTP: 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.
bearerpath Parameters
| consignmentId required | integer <int64> Id of the consignment |
query Parameters
| requestGuid required | string Identifier of the request, up to 36 characters, used to trace it. |
Request Body schema: application/jsonrequired
type of document
| documentTypes required | Array of strings (DocumentType) non-empty Items Enum: "TransportDocument" "CheckList" "PackageMarking" "PackageMarkingSmallCustomSize" "AirWaybillData" List of document types to be generated. |
| documentFormat required | string Enum: "PDF" "XLSX" "DOCX" Output file format of the generated document: PDF, XLSX or DOCX. |
| documentSettings | Array of strings (DocumentSetting) >= 0 items Items Enum: "HideRedStripesForIATATransportDocument" "ShowBlueStripesForIMDGTransportDocument" "EnglishCheckList" "SpanishCheckList" "FrenchCheckList" "GermanCheckList" "PortugueseCheckList" "RussianCheckList" "ChineseCheckList" "ItalianCheckList" "DutchCheckList" "TurkishCheckList" "PolishCheckList" "SwedishCheckList" "NorwegianCheckList" "CzechCheckList" "DanishCheckList" "GreekCheckList" "HungarianCheckList" "SlovakCheckList" "RomanianCheckList" "FinnishCheckList" Optional rendering settings to customize the generated document. |
Responses
200 Successful request
Successful request
Response Schema: application/json
object Base 64 encoded representation of the generated document. | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
| 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. | |||||||||||||||||||||||||||||||||||||||
Array [
] | |||||||||||||||||||||||||||||||||||||||
400 Bad request
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| 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
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| requestGuid | string Unique identifier of the request, returned for tracing purposes. |
Array of objects (ApiIssue) The authentication error, with its stable code. | |
403 Forbidden
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| 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 Request not accomplished
Request not accomplished
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| requestGuid | string Unique identifier of the request, returned for tracing purposes. |
Array of objects (ApiIssue) Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry. | |
Array of objects (ApiIssue) Every warning found while processing the request, in detection order. Omitted when there is no warning. | |
post/consignment/{consignmentId}/document
Request samples
{"documentTypes": [
- "TransportDocument"
],- "documentFormat": "PDF",
"documentSettings": [
- "HideRedStripesForIATATransportDocument"
]
}Response samples
{"base64EncodedFile": {
- "base64EncodedContent": "SGVsbG8=",
- "contentType": "text/plain"
},- "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."
}
}
]
}{- "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."
}
}
]
}{- "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."
}
}
]
}{- "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."
}
}
]
}{- "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."
}
}
]
}Send documents of a consignment by email
Generates and sends the requested consignment documents by email to the supplied recipients.
Authorizations:
basicAuth or bearerAuth
HTTP: basicAuth
basicHTTP: 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.
bearerpath Parameters
| consignmentId required | integer <int64> Id of the consignment |
query Parameters
| requestGuid required | string Identifier of the request, up to 36 characters, used to trace it. |
Request Body schema: application/jsonrequired
consignment document to be delivered and email addresses
| documentTypes required | Array of strings (DocumentType) non-empty Items Enum: "TransportDocument" "CheckList" "PackageMarking" "PackageMarkingSmallCustomSize" "AirWaybillData" List of document types to be generated. |
| documentFormat required | string Enum: "PDF" "XLSX" "DOCX" Output file format of the generated document: PDF, XLSX or DOCX. |
| emailTo required | string Primary email recipient address. |
| documentSettings | Array of strings (DocumentSetting) >= 0 items Items Enum: "HideRedStripesForIATATransportDocument" "ShowBlueStripesForIMDGTransportDocument" "EnglishCheckList" "SpanishCheckList" "FrenchCheckList" "GermanCheckList" "PortugueseCheckList" "RussianCheckList" "ChineseCheckList" "ItalianCheckList" "DutchCheckList" "TurkishCheckList" "PolishCheckList" "SwedishCheckList" "NorwegianCheckList" "CzechCheckList" "DanishCheckList" "GreekCheckList" "HungarianCheckList" "SlovakCheckList" "RomanianCheckList" "FinnishCheckList" Optional rendering settings to customize the generated document. |
| emailCC | string Email recipients to receive a carbon copy. |
| emailBCC | string Email recipients to receive a blind carbon copy. |
Responses
200 Successful request
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
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| 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
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| requestGuid | string Unique identifier of the request, returned for tracing purposes. |
Array of objects (ApiIssue) The authentication error, with its stable code. | |
403 Forbidden
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| 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 Request not accomplished
Request not accomplished
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 |
| parameterValue | string Aggregated list of the |
| parameterPosition | string Aggregated list of the |
| requestGuid | string Unique identifier of the request, returned for tracing purposes. |
Array of objects (ApiIssue) Every error that made the request fail, in detection order, each one with its stable code and, when it refers to an element of the request, its parameter, value, position and JSON Pointer. Present on every error response, with at least one entry. | |
Array of objects (ApiIssue) Every warning found while processing the request, in detection order. Omitted when there is no warning. | |
post/consignment/{consignmentId}/documentSendingByEMail
Request samples
{"documentTypes": [
- "TransportDocument"
],- "documentFormat": "PDF",
"documentSettings": [
- "HideRedStripesForIATATransportDocument"
],- "emailTo": "dgmailbox@massivedynamics.com",
- "emailCC": "dgmailboxcc@massivedynamics.com",
- "emailBCC": "dgmailboxbcc@massivedynamics.com"
}Response samples
{- "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."
}
}
]
}{- "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."
}
}
]
}{- "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."
}
}
]
}{- "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."
}
}
]
}{- "success": false,
- "httpStatusCode": 404,
- "message": "Item not found",
- "messageType": "Error",
- "parameter": "productId",
- "parameterValue": "Prod001",
- "parameterPosition": "3",
- "requestGuid": "F8AEC2D1-9515-4013-AA46-10405EB688A2",
"errors": [
{
- "code": "NOT_VALID_VALUE_FOR_PARAMETER",
- "message": "Not valid value for the parameter.",
- "parameter": "onTheFlySimpleProducts.packageId",
- "parameterValue": "48213",
- "parameterPosition": "2",
- "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
- "ruleReference": "IMDG 4.1.4.1 P001",
"segregation": {
- "leftConsignmentId": 48213,
- "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
- "leftEquipmentId": 1207,
- "rightConsignmentId": 48214,
- "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
- "rightEquipmentId": 1208,
- "ruleReference": "SG35",
- "requiredSeparation": "NotRequired",
- "verdict": "Allowed",
- "remarks": "Keep one container space between both containers."
}
}
],"warnings": [
{
- "code": "NOT_VALID_VALUE_FOR_PARAMETER",
- "message": "Not valid value for the parameter.",
- "parameter": "onTheFlySimpleProducts.packageId",
- "parameterValue": "48213",
- "parameterPosition": "2",
- "pointer": "/overpacks/0/onTheFlySimpleProducts/2/packageId",
- "ruleReference": "IMDG 4.1.4.1 P001",
"segregation": {
- "leftConsignmentId": 48213,
- "leftConsignmentItemCode": "ITEM-9515-4013-AA46",
- "leftEquipmentId": 1207,
- "rightConsignmentId": 48214,
- "rightConsignmentItemCode": "ITEM-9515-4013-AA46",
- "rightEquipmentId": 1208,
- "ruleReference": "SG35",
- "requiredSeparation": "NotRequired",
- "verdict": "Allowed",
- "remarks": "Keep one container space between both containers."
}
}
]
}Get a frozen document by its public token
Returns the PDF of a frozen document snapshot. This operation is anonymous by design: the administrative control document of national road transport requires the address encoded in its QR code to produce the download directly, without credentials and without any intermediate page. The only protection of the resource is the unpredictability of the token, together with TLS and the expiry date. An unknown, disabled or expired token returns 404, never 403, so that the response does not reveal whether the document exists. The token can also be the public token of a cargo transport unit, encoded in the QR code of its consolidation label: it returns the latest packing list issued for the unit, in any language, until seven days after the arrival of the voyage of the unit, or seven days after the date of its master consignment when no arrival is known; before the first packing list is issued it returns 404.
path Parameters
| documentToken required | string Public token of the document snapshot, or of the cargo transport unit, as encoded in the QR code of the document or of the consolidation label. 32 hexadecimal characters. |
Responses
200 Successful request
Successful request
Response Schema: application/pdf
The token does not exist, is disabled or is no longer available