- Overview
- Data Schema
- Paths
- Transport Operation
- Create new transport operation dataPOST
- Get all transport operation dataGET
- Get a specific transport operation data by IDGET
- Update data for a specific transport operation by IDPUT
- Delete specific transport operation data by IDDELETE
- Get schedule data related to a specific transport operation by IDGET
- Update schedule data for a specific transport operation by IDPUT
- Get all phase data related to a specific transport operation by IDGET
- Append phase data for a specific transport operation by IDPATCH
- Get specific phase data by transport operation ID and phase IDGET
- Update specific phase data by transport operation ID and phase IDPUT
- Get all international consignment notes related to a specific transport operation by IDGET
- Append international consignment notes data for a specific transport operation by IDPATCH
- Get specific international consignment notes data by transport operation ID and reference codeGET
- Update specific international consignment notes data by transport operation ID and reference codePUT
- Delete specific international consignment notes data by transport operation ID and reference codeDELETE
- Get ongoing transport operation data by country code and license plate numberGET
- Get details about the schedule of the ongoing transport operation by country code and license plate numberGET
- Get details about all the phases of the ongoing transport operation by country code and license plate numberGET
- Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase IDGET
- Get all international consignment notes related to the ongoing transport operation by country code and license plate numberGET
- Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference codeGET
- Get all locations related to transport operationsGET
- Get all locations related to transport operations by location modeGET
- Create a new eCMRPOST
- Get a specific eCMR by IDGET
- Update an eCMR by IDPUT
- Delete an eCMR by IDDELETE
- Create new transport operation data
- Vehicle
- Create new vehicle data
- Get all vehicle data
- Get vehicle data by country code and license plate number
- Update vehicle data by country code and license plate number
- Delete specific vehicle data by country code and license plate number
- Get details about the geolocation of vehicle by country code and license plate number
- Append new vehicle's geolocation data by country code and license plate number
- Get details about the owner of vehicle by country code and license plate number
- Get details about the insurances of vehicle by country code and license plate number
- Get details about the insurance of vehicle by country code, license plate number and insurance id
- Get details about the revisions of vehicle by country code and license plate number
- Get details about the revision of vehicle by country code, license plate number and revision id
- Driver
- Create new driver data
- Get all driver data
- Get driver data by country code and vat number
- Update driver data by country code and vat number
- Delete specific driver data
- Get details about the driver's license by country code and vat number
- Get details about the driver's traffic violations by country code and vat number
- Get specific driver's traffic violation data by country code, vat number and traffic violation id
- Get details about the driver's tachograph cards data by country code and vat number
- Get specific driver's tachograph card data by country code, vat number and tachograph card id
- Organization
- Transport Operation
Update data for a specific transport operation by ID
PUT
https://api.company-server/v2/transport-operations/{transportOperationId}/
Request
Path Params
Body Params application/jsonRequired
Example
{
"id": 123456789,
"operator": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"schedule": {
"departureDateTime": "2023-06-25T10:00:00Z",
"realDepartureDateTime": "2023-06-27T10:30:00Z",
"estimatedDateTimeOfArrival": "2023-06-27T17:00:00Z",
"realArrivalDateTime": "2023-06-27T17:20:00Z"
},
"driver": {
"id": 123456789,
"firstName": "John",
"lastName": "Doe",
"countryCode": "IT",
"vat": "IT0011228901",
"license": {
"id": "IT1234567890",
"countryCode": "IT",
"category": [
{
"type": "AM",
"description": "Goods Vehicle",
"issueDate": "2020-01-01",
"expiryDate": "2025-12-31",
"status": "VALID",
"code95": "95 (13.02.25)"
}
]
},
"trafficViolation": [
{
"id": 123456789,
"description": "Speeding",
"code": "SV-123",
"countryCode": "IT",
"fine": 150,
"paymentDueDate": "2023-07-15",
"paymentDate": "2023-07-10",
"isPaid": true,
"validityPoints": 1,
"payload": {
"additionInformation": "Information XX"
}
}
],
"tachographCard": [
{
"id": "IT1234567890123456",
"drivingInterval": [
{
"startDateTime": "2023-06-20T08:00:00Z",
"endDateTime": "2023-06-20T18:00:00Z",
"etl": [
{
"type": "Daily driving limit",
"hours": 1,
"minutes": 1,
"seconds": 20
}
]
}
]
}
]
},
"vehicle": {
"id": 123456789,
"countryCode": "IT",
"plateNumber": "AA1232",
"type": "Truck",
"model": "XX Model",
"geolocation": [
{
"dateTime": "2023-06-25T10:00:00Z",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
}
],
"owner": {
"id": 123456789,
"name": "Acme Trucking",
"vat": "IT2345678901",
"payload": {
"additionInformation": "Information XX"
}
},
"insurance": [
{
"id": 123456789,
"name": "AB Insurance",
"number": "KST-123456789",
"isInsured": true,
"activationDate": "2023-01-15",
"expirationDate": "2024-01-14",
"payload": {
"additionInformation": "Information XX"
}
}
],
"revision": [
{
"id": 123456789,
"name": "Revision Comp",
"number": "A-2211",
"executionDate": "2023-01-15",
"expirationDate": "2024-01-14",
"payload": {
"additionInformation": "Information XX"
}
}
]
},
"phase": [
{
"id": 1,
"location": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"dateTime": "2023-06-25T10:00:00Z",
"state": "PLANNING",
"payload": {
"additionInformation": "Information XX"
}
}
],
"document": [
{
"referenceCode": "DOC-123456789",
"senderOrganization": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"receiverOrganization": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"startingPoint": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"endingPoint": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"load": {
"type": "Electronics",
"description": "Laptops, tablets, and smartphones",
"weight": 500,
"umWeight": "kg",
"component": [
{
"type": "Laptop",
"description": "Brand X Laptop",
"width": 30,
"height": 20,
"depth": 5,
"unitary": true,
"um": "cm"
}
]
},
"report": "report.pdf",
"payload": {
"additionInformation": "Information XX"
}
}
],
"ecmr": [
{
"ecmrId": "string",
"ecmrConsignment": {
"senderInformation": {
"senderCompanyName": "string",
"senderPersonName": "string",
"senderStreet": "string",
"senderPostcode": "string",
"senderCity": "string",
"senderCountryCode": {
"region": "string",
"value": "st"
},
"senderContactInformation": {
"email": "string",
"phone": "+49 123 4567890"
}
},
"multiConsigneeShipment": {
"isMultiConsigneeShipment": true
},
"consigneeInformation": {
"consigneeCompanyName": "string",
"consigneePersonName": "string",
"consigneePostcode": "string",
"consigneeCity": "string",
"consigneeCountryCode": {
"region": "string",
"value": "st"
},
"consigneeStreet": "string",
"consigneeContactInformation": {
"email": "string",
"phone": "+49 123 4567890"
}
},
"takingOverTheGoods": {
"takingOverTheGoodsPlace": "string",
"logisticsTimeOfArrivalDateTime": "2019-08-24T14:15:22Z",
"logisticsTimeOfDepartureDateTime": "2019-08-24T14:15:22Z"
},
"deliveryOfTheGoods": {
"logisticsLocationCity": "string",
"logisticsLocationOpeningHours": "string"
},
"sendersInstructions": {
"transportInstructionsDescription": "string"
},
"carrierInformation": {
"carrierCompanyName": "string",
"carrierDriverName": "string",
"carrierStreet": "string",
"carrierPostcode": "string",
"carrierCity": "string",
"carrierCountryCode": {
"region": "string",
"value": "st"
},
"carrierLicensePlate": "string",
"carrierContactInformation": {
"email": "string",
"carrierPhone": "+49 123 4567890",
"driverPhone": "+49 123 4567890"
}
},
"successiveCarrierInformation": {
"successiveCarrierCity": "string",
"successiveCarrierCountryCode": {
"region": "string",
"value": "st"
},
"successiveCarrierCompanyName": "string",
"successiveCarrierDriverName": "string",
"successiveCarrierPostcode": "string",
"successiveCarrierStreet": "string",
"successiveCarrierContactInformation": {
"email": "string",
"carrierPhone": "+49 123 4567890",
"driverPhone": "+49 123 4567890"
}
},
"carriersReservationsAndObservationsOnTakingOverTheGoods": {
"carrierReservationsObservations": "string",
"senderReservationsObservationsSignature": {
"type": "string",
"userName": "string",
"userCompany": "string",
"userStreet": "string",
"userPostCode": "string",
"userCity": "string",
"userCountry": "string",
"timestamp": "2019-08-24T14:15:22Z",
"data": "string"
}
},
"documentsHandedToCarrier": {
"documentsRemarks": "string"
},
"itemList": [
{
"marksAndNos": {
"logisticsShippingMarksMarking": "string",
"logisticsShippingMarksCustomBarcodeList": [
{
"barcode": "string"
}
]
},
"numberOfPackages": {
"logisticsPackageItemQuantity": 0
},
"methodOfPacking": {
"logisticsPackageType": "string"
},
"natureOfTheGoods": {
"transportCargoIdentification": "string"
},
"grossWeightInKg": {
"supplyChainConsignmentItemGrossWeight": 0
},
"volumeInM3": {
"supplyChainConsignmentItemGrossVolume": 0
}
}
],
"specialAgreementsSenderCarrier": {
"customSpecialAgreement": "string"
},
"toBePaidBy": {
"customChargeCarriage": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeSupplementary": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeCustomsDuties": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeOther": {
"value": 0,
"currency": "string",
"payer": "SENDER"
}
},
"otherUsefulParticulars": {
"customParticulars": "string"
},
"cashOnDelivery": {
"customCashOnDelivery": 0
},
"established": {
"customEstablishedDate": "2019-08-24T14:15:22Z",
"customEstablishedIn": "string"
},
"goodsReceived": {
"confirmedLogisticsLocationName": "string",
"consigneeReservationsObservations": "string",
"consigneeSignature": {
"type": "string",
"userName": "string",
"userCompany": "string",
"userStreet": "string",
"userPostCode": "string",
"userCity": "string",
"userCountry": "string",
"timestamp": "2019-08-24T14:15:22Z",
"data": "string"
},
"consigneeSignatureDate": "2019-08-24T14:15:22Z",
"consigneeTimeOfArrival": "2019-08-24T14:15:22Z",
"consigneeTimeOfDeparture": "2019-08-24T14:15:22Z"
},
"nonContractualPartReservedForTheCarrier": {
"nonContractualCarrierRemarks": "string"
},
"referenceIdentificationNumber": {
"value": "string"
}
},
"ecmrStatus": "NEW",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"editedAt": "2019-08-24T14:15:22Z",
"editedBy": "string",
"originUrl": "string"
}
],
"payload": {
"additionInformation": "Information XX"
}
}Responses
🟢200OK
application/json
Body
Example
{
"id": 123456789,
"operator": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"schedule": {
"departureDateTime": "2023-06-25T10:00:00Z",
"realDepartureDateTime": "2023-06-27T10:30:00Z",
"estimatedDateTimeOfArrival": "2023-06-27T17:00:00Z",
"realArrivalDateTime": "2023-06-27T17:20:00Z"
},
"driver": {
"id": 123456789,
"firstName": "John",
"lastName": "Doe",
"countryCode": "IT",
"vat": "IT0011228901",
"license": {
"id": "IT1234567890",
"countryCode": "IT",
"category": [
{
"type": "AM",
"description": "Goods Vehicle",
"issueDate": "2020-01-01",
"expiryDate": "2025-12-31",
"status": "VALID",
"code95": "95 (13.02.25)"
}
]
},
"trafficViolation": [
{
"id": 123456789,
"description": "Speeding",
"code": "SV-123",
"countryCode": "IT",
"fine": 150,
"paymentDueDate": "2023-07-15",
"paymentDate": "2023-07-10",
"isPaid": true,
"validityPoints": 1,
"payload": {
"additionInformation": "Information XX"
}
}
],
"tachographCard": [
{
"id": "IT1234567890123456",
"drivingInterval": [
{
"startDateTime": "2023-06-20T08:00:00Z",
"endDateTime": "2023-06-20T18:00:00Z",
"etl": [
{
"type": "Daily driving limit",
"hours": 1,
"minutes": 1,
"seconds": 20
}
]
}
]
}
]
},
"vehicle": {
"id": 123456789,
"countryCode": "IT",
"plateNumber": "AA1232",
"type": "Truck",
"model": "XX Model",
"geolocation": [
{
"dateTime": "2023-06-25T10:00:00Z",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
}
],
"owner": {
"id": 123456789,
"name": "Acme Trucking",
"vat": "IT2345678901",
"payload": {
"additionInformation": "Information XX"
}
},
"insurance": [
{
"id": 123456789,
"name": "AB Insurance",
"number": "KST-123456789",
"isInsured": true,
"activationDate": "2023-01-15",
"expirationDate": "2024-01-14",
"payload": {
"additionInformation": "Information XX"
}
}
],
"revision": [
{
"id": 123456789,
"name": "Revision Comp",
"number": "A-2211",
"executionDate": "2023-01-15",
"expirationDate": "2024-01-14",
"payload": {
"additionInformation": "Information XX"
}
}
]
},
"phase": [
{
"id": 1,
"location": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"dateTime": "2023-06-25T10:00:00Z",
"state": "PLANNING",
"payload": {
"additionInformation": "Information XX"
}
}
],
"document": [
{
"referenceCode": "DOC-123456789",
"senderOrganization": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"receiverOrganization": {
"id": 123456789,
"name": "ABC Logistics",
"countryCode": "IT",
"vat": "IT1234567890",
"address": "123 Main St, City, Country",
"type": "OPERATOR"
},
"startingPoint": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"endingPoint": {
"id": 123456789,
"description": "Place X",
"countryCode": "IT",
"mode": "GENERIC",
"coordinates": {
"latitude": 34.052235,
"longitude": -118.243683
}
},
"load": {
"type": "Electronics",
"description": "Laptops, tablets, and smartphones",
"weight": 500,
"umWeight": "kg",
"component": [
{
"type": "Laptop",
"description": "Brand X Laptop",
"width": 30,
"height": 20,
"depth": 5,
"unitary": true,
"um": "cm"
}
]
},
"report": "report.pdf",
"payload": {
"additionInformation": "Information XX"
}
}
],
"ecmr": [
{
"ecmrId": "string",
"ecmrConsignment": {
"senderInformation": {
"senderCompanyName": "string",
"senderPersonName": "string",
"senderStreet": "string",
"senderPostcode": "string",
"senderCity": "string",
"senderCountryCode": {
"region": "string",
"value": "st"
},
"senderContactInformation": {
"email": "string",
"phone": "+49 123 4567890"
}
},
"multiConsigneeShipment": {
"isMultiConsigneeShipment": true
},
"consigneeInformation": {
"consigneeCompanyName": "string",
"consigneePersonName": "string",
"consigneePostcode": "string",
"consigneeCity": "string",
"consigneeCountryCode": {
"region": "string",
"value": "st"
},
"consigneeStreet": "string",
"consigneeContactInformation": {
"email": "string",
"phone": "+49 123 4567890"
}
},
"takingOverTheGoods": {
"takingOverTheGoodsPlace": "string",
"logisticsTimeOfArrivalDateTime": "2019-08-24T14:15:22Z",
"logisticsTimeOfDepartureDateTime": "2019-08-24T14:15:22Z"
},
"deliveryOfTheGoods": {
"logisticsLocationCity": "string",
"logisticsLocationOpeningHours": "string"
},
"sendersInstructions": {
"transportInstructionsDescription": "string"
},
"carrierInformation": {
"carrierCompanyName": "string",
"carrierDriverName": "string",
"carrierStreet": "string",
"carrierPostcode": "string",
"carrierCity": "string",
"carrierCountryCode": {
"region": "string",
"value": "st"
},
"carrierLicensePlate": "string",
"carrierContactInformation": {
"email": "string",
"carrierPhone": "+49 123 4567890",
"driverPhone": "+49 123 4567890"
}
},
"successiveCarrierInformation": {
"successiveCarrierCity": "string",
"successiveCarrierCountryCode": {
"region": "string",
"value": "st"
},
"successiveCarrierCompanyName": "string",
"successiveCarrierDriverName": "string",
"successiveCarrierPostcode": "string",
"successiveCarrierStreet": "string",
"successiveCarrierContactInformation": {
"email": "string",
"carrierPhone": "+49 123 4567890",
"driverPhone": "+49 123 4567890"
}
},
"carriersReservationsAndObservationsOnTakingOverTheGoods": {
"carrierReservationsObservations": "string",
"senderReservationsObservationsSignature": {
"type": "string",
"userName": "string",
"userCompany": "string",
"userStreet": "string",
"userPostCode": "string",
"userCity": "string",
"userCountry": "string",
"timestamp": "2019-08-24T14:15:22Z",
"data": "string"
}
},
"documentsHandedToCarrier": {
"documentsRemarks": "string"
},
"itemList": [
{
"marksAndNos": {
"logisticsShippingMarksMarking": "string",
"logisticsShippingMarksCustomBarcodeList": [
{
"barcode": "string"
}
]
},
"numberOfPackages": {
"logisticsPackageItemQuantity": 0
},
"methodOfPacking": {
"logisticsPackageType": "string"
},
"natureOfTheGoods": {
"transportCargoIdentification": "string"
},
"grossWeightInKg": {
"supplyChainConsignmentItemGrossWeight": 0
},
"volumeInM3": {
"supplyChainConsignmentItemGrossVolume": 0
}
}
],
"specialAgreementsSenderCarrier": {
"customSpecialAgreement": "string"
},
"toBePaidBy": {
"customChargeCarriage": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeSupplementary": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeCustomsDuties": {
"value": 0,
"currency": "string",
"payer": "SENDER"
},
"customChargeOther": {
"value": 0,
"currency": "string",
"payer": "SENDER"
}
},
"otherUsefulParticulars": {
"customParticulars": "string"
},
"cashOnDelivery": {
"customCashOnDelivery": 0
},
"established": {
"customEstablishedDate": "2019-08-24T14:15:22Z",
"customEstablishedIn": "string"
},
"goodsReceived": {
"confirmedLogisticsLocationName": "string",
"consigneeReservationsObservations": "string",
"consigneeSignature": {
"type": "string",
"userName": "string",
"userCompany": "string",
"userStreet": "string",
"userPostCode": "string",
"userCity": "string",
"userCountry": "string",
"timestamp": "2019-08-24T14:15:22Z",
"data": "string"
},
"consigneeSignatureDate": "2019-08-24T14:15:22Z",
"consigneeTimeOfArrival": "2019-08-24T14:15:22Z",
"consigneeTimeOfDeparture": "2019-08-24T14:15:22Z"
},
"nonContractualPartReservedForTheCarrier": {
"nonContractualCarrierRemarks": "string"
},
"referenceIdentificationNumber": {
"value": "string"
}
},
"ecmrStatus": "NEW",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"editedAt": "2019-08-24T14:15:22Z",
"editedBy": "string",
"originUrl": "string"
}
],
"payload": {
"additionInformation": "Information XX"
}
}🟠400Bad Request
🟠404Not Found
🔴500Internal Server Error