Update data for a specific transport operation by ID

Request

Path Params

transportOperationId

integer <int64>

required

Unique identifier for the transport operation.

Body Params application/json

Details about the transport operation.

integer <int64>

required

Unique identifier for the transport operation.

>= 1

Example:

123456789

operator

object (Organization)

required

Details about the logistic operator that handles the transport operation.

name

string

required

Name of the organization.

Example:

ABC Logistics

Match pattern:

^[\s\S]{1,20}$

countryCode

string

required

Country code of the organization.

Example:

Match pattern:

^[A-Z]{2,4}$

vat

string

optional

VAT Number of the organization.

Example:

IT1234567890

Match pattern:

^[\s\S]{2,13}$

address

string

optional

Address of the organization.

Example:

123 Main St, City, Country

Match pattern:

^[\s\S]{1,100}$

schedule

object (Schedule)

required

Details about the date and time of transport operation.

departureDateTime

string <date-time>

required

Predefined date and time of departure.

Example:

2023-06-25T10:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

realDepartureDateTime

string <date-time>

optional

Real date and time of departure.

Example:

2023-06-27T10:30:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

estimatedDateTimeOfArrival

string <date-time>

required

Estimated date and time of arrival.

Example:

2023-06-27T17:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

realArrivalDateTime

string <date-time>

optional

Real date and time of arrival.

Example:

2023-06-27T17:20:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

driver

object (Driver)

required

Details about the driver used for the operation phase.

integer <int64>

required

Unique identifier for the driver.

>= 1

Example:

123456789

firstName

string

required

First name of the driver.

Example:

John

Match pattern:

^[\s\S]{1,20}$

lastName

string

required

Last name of the driver.

Example:

Doe

Match pattern:

^[\s\S]{1,20}$

countryCode

string

required

Country code of the driver's registration.

Example:

Match pattern:

^[A-Z]{2,4}$

vat

string

required

VAT number of the driver.

Example:

IT0011228901

Match pattern:

^[\s\S]{2,13}$

license

object (License)

required

Details of the driver's license.

trafficViolation

array[object (TrafficViolation) {10}]

optional

List of drivers's traffic violations.

tachographCard

array[object (TachographCard) {2}]

optional

List of drivers's tachograph cards.

vehicle

object (Vehicle)

required

Details about the vehicle used for the operation phase.

integer <int64>

required

Unique identifier for the vehicle.

>= 1

Example:

123456789

countryCode

string

required

Country code of the vehicle's registration.

Example:

Match pattern:

^[A-Z]{2,4}$

plateNumber

string

required

License plate number of the vehicle.

Example:

AA1232

Match pattern:

^[\s\S]{1,20}$

type

string

optional

Type of the vehicle.

Example:

Truck

Match pattern:

^[\s\S]{1,20}$

model

string

optional

Model of the vehicle.

Example:

XX Model

Match pattern:

^[\s\S]{1,20}$

geolocation

array[object (Geolocation) {2}]

optional

owner

object (Owner)

required

Details of the vehicle owner.

insurance

array[object (Insurance) {7}]

required

List of vehicle's insurances.

revision

array[object (Revision) {6}]

required

List of vehicle's revisions.

phase

array[object (Phase) {5}]

optional

List of the operation phases.

integer <int32>

required

The indicator of the respective operation phase.

>= 1

Example:

location

object (Location)

required

Details about the location.

dateTime

string <date-time>

required

Date and time of the respective operation phase.

Example:

2023-06-25T10:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

state

enum<string>

required

Details about the state of the operation phase.

Allowed values:

PLANNINGIN_PROGRESSARRIVED_AT_PICKUPARRIVED_AT_DESTINATIONLOADINGUNLOADINGIN_TRANSITCOMPLETEDDELAYEDCANCELED

Example:

IN_TRANSIT

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

document

array[object (Document) {8}]

required

List of the international consignment notes used for transport operation.

referenceCode

string

required

Unique identifier assigned to international consignment note used for transport operation.

Example:

DOC-123456789

Match pattern:

^[\s\S]{1,20}$

senderOrganization

object (Organization)

required

Details about the organization that sends the load.

receiverOrganization

object (Organization)

required

Details about the organization that receives the load.

startingPoint

object (Location)

required

Details about the starting point of the transport operation.

endingPoint

object (Location)

required

Details about the ending point of the transport operation.

load

object (Load)

required

Details about the load being transported.

report

string <file>

optional

Proof of transport and delivery terms, along with customs and insurance documentation for cross-border shipments. Must be a PDF file.

Example:

report.pdf

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

Example

{
    "id": 123456789,
    "operator": {
        "name": "ABC Logistics",
        "countryCode": "IT",
        "vat": "IT1234567890",
        "address": "123 Main St, City, Country"
    },
    "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",
                "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": {
                "name": "ABC Logistics",
                "countryCode": "IT",
                "vat": "IT1234567890",
                "address": "123 Main St, City, Country"
            },
            "receiverOrganization": {
                "name": "ABC Logistics",
                "countryCode": "IT",
                "vat": "IT1234567890",
                "address": "123 Main St, City, Country"
            },
            "startingPoint": {
                "id": 123456789,
                "description": "Place X",
                "mode": "GENERIC",
                "coordinates": {
                    "latitude": 34.052235,
                    "longitude": -118.243683
                }
            },
            "endingPoint": {
                "id": 123456789,
                "description": "Place X",
                "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"
            }
        }
    ],
    "payload": {
        "additionInformation": "Information XX"
    }
}

Responses

🟢200OK

application/json

Transport operation data updated successfully

Body

Details about the transport operation.

integer <int64>

required

Unique identifier for the transport operation.

>= 1

Example:

123456789

operator

object (Organization)

required

Details about the logistic operator that handles the transport operation.

name

string

required

Name of the organization.

Example:

ABC Logistics

Match pattern:

^[\s\S]{1,20}$

countryCode

string

required

Country code of the organization.

Example:

Match pattern:

^[A-Z]{2,4}$

vat

string

optional

VAT Number of the organization.

Example:

IT1234567890

Match pattern:

^[\s\S]{2,13}$

address

string

optional

Address of the organization.

Example:

123 Main St, City, Country

Match pattern:

^[\s\S]{1,100}$

schedule

object (Schedule)

required

Details about the date and time of transport operation.

departureDateTime

string <date-time>

required

Predefined date and time of departure.

Example:

2023-06-25T10:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

realDepartureDateTime

string <date-time>

optional

Real date and time of departure.

Example:

2023-06-27T10:30:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

estimatedDateTimeOfArrival

string <date-time>

required

Estimated date and time of arrival.

Example:

2023-06-27T17:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

realArrivalDateTime

string <date-time>

optional

Real date and time of arrival.

Example:

2023-06-27T17:20:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

driver

object (Driver)

required

Details about the driver used for the operation phase.

integer <int64>

required

Unique identifier for the driver.

>= 1

Example:

123456789

firstName

string

required

First name of the driver.

Example:

John

Match pattern:

^[\s\S]{1,20}$

lastName

string

required

Last name of the driver.

Example:

Doe

Match pattern:

^[\s\S]{1,20}$

countryCode

string

required

Country code of the driver's registration.

Example:

Match pattern:

^[A-Z]{2,4}$

vat

string

required

VAT number of the driver.

Example:

IT0011228901

Match pattern:

^[\s\S]{2,13}$

license

object (License)

required

Details of the driver's license.

trafficViolation

array[object (TrafficViolation) {10}]

optional

List of drivers's traffic violations.

tachographCard

array[object (TachographCard) {2}]

optional

List of drivers's tachograph cards.

vehicle

object (Vehicle)

required

Details about the vehicle used for the operation phase.

integer <int64>

required

Unique identifier for the vehicle.

>= 1

Example:

123456789

countryCode

string

required

Country code of the vehicle's registration.

Example:

Match pattern:

^[A-Z]{2,4}$

plateNumber

string

required

License plate number of the vehicle.

Example:

AA1232

Match pattern:

^[\s\S]{1,20}$

type

string

optional

Type of the vehicle.

Example:

Truck

Match pattern:

^[\s\S]{1,20}$

model

string

optional

Model of the vehicle.

Example:

XX Model

Match pattern:

^[\s\S]{1,20}$

geolocation

array[object (Geolocation) {2}]

optional

owner

object (Owner)

required

Details of the vehicle owner.

insurance

array[object (Insurance) {7}]

required

List of vehicle's insurances.

revision

array[object (Revision) {6}]

required

List of vehicle's revisions.

phase

array[object (Phase) {5}]

optional

List of the operation phases.

integer <int32>

required

The indicator of the respective operation phase.

>= 1

Example:

location

object (Location)

required

Details about the location.

dateTime

string <date-time>

required

Date and time of the respective operation phase.

Example:

2023-06-25T10:00:00Z

Match pattern:

^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$

state

enum<string>

required

Details about the state of the operation phase.

Allowed values:

PLANNINGIN_PROGRESSARRIVED_AT_PICKUPARRIVED_AT_DESTINATIONLOADINGUNLOADINGIN_TRANSITCOMPLETEDDELAYEDCANCELED

Example:

IN_TRANSIT

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

document

array[object (Document) {8}]

required

List of the international consignment notes used for transport operation.

referenceCode

string

required

Unique identifier assigned to international consignment note used for transport operation.

Example:

DOC-123456789

Match pattern:

^[\s\S]{1,20}$

senderOrganization

object (Organization)

required

Details about the organization that sends the load.

receiverOrganization

object (Organization)

required

Details about the organization that receives the load.

startingPoint

object (Location)

required

Details about the starting point of the transport operation.

endingPoint

object (Location)

required

Details about the ending point of the transport operation.

load

object (Load)

required

Details about the load being transported.

report

string <file>

optional

Proof of transport and delivery terms, along with customs and insurance documentation for cross-border shipments. Must be a PDF file.

Example:

report.pdf

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

payload

object (Payload)

optional

Additional information.

Example:

{"additionInformation":"Information XX"}

Example

{
    "id": 123456789,
    "operator": {
        "name": "ABC Logistics",
        "countryCode": "IT",
        "vat": "IT1234567890",
        "address": "123 Main St, City, Country"
    },
    "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",
                "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": {
                "name": "ABC Logistics",
                "countryCode": "IT",
                "vat": "IT1234567890",
                "address": "123 Main St, City, Country"
            },
            "receiverOrganization": {
                "name": "ABC Logistics",
                "countryCode": "IT",
                "vat": "IT1234567890",
                "address": "123 Main St, City, Country"
            },
            "startingPoint": {
                "id": 123456789,
                "description": "Place X",
                "mode": "GENERIC",
                "coordinates": {
                    "latitude": 34.052235,
                    "longitude": -118.243683
                }
            },
            "endingPoint": {
                "id": 123456789,
                "description": "Place X",
                "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"
            }
        }
    ],
    "payload": {
        "additionInformation": "Information XX"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error