Transport Operation
TransportOperation
Details about the transport operation.
id
integer <int64>
required
>= 1
Example:
123456789
operator
object (Organization)
required
name
string
required
>= 1 characters<= 20 characters
Example:
ABC Logistics
countryCode
string
required
Example:
IT
Match pattern:
^[A-Z]{2,4}$
vat
string
optional
>= 2 characters<= 13 characters
Example:
IT1234567890
address
string
optional
>= 1 characters<= 100 characters
Example:
123 Main St, City, Country
schedule
object (Schedule)
required
departureDateTime
string <date-time>
required
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
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
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
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
id
integer <int64>
required
>= 1
Example:
123456789
firstName
string
required
>= 1 characters<= 20 characters
Example:
John
lastName
string
required
>= 1 characters<= 20 characters
Example:
Doe
countryCode
string
required
Example:
IT
Match pattern:
^[A-Z]{2,4}$
vat
string
required
>= 2 characters<= 13 characters
Example:
IT0011228901
license
object (License)
required
trafficViolation
array[object (TrafficViolation) {10}]
optional
tachographCard
array[object (TachographCard) {2}]
optional
vehicle
object (Vehicle)
required
id
integer <int64>
required
>= 1
Example:
123456789
countryCode
string
required
Example:
IT
Match pattern:
^[A-Z]{2,4}$
plateNumber
string
required
>= 1 characters<= 20 characters
Example:
AA1232
type
string
optional
>= 1 characters<= 20 characters
Example:
Truck
model
string
optional
>= 1 characters<= 20 characters
Example:
XX Model
geolocation
array[object (Geolocation) {2}]
optional
owner
object (Owner)
required
insurance
array[object (Insurance) {7}]
required
revision
array[object (Revision) {6}]
required
phase
array[object (Phase) {5}]
optional
id
integer <int32>
required
>= 1
Example:
1
location
object (Location)
required
dateTime
string <date-time>
required
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
Allowed values:
PLANNINGIN_PROGRESSARRIVED_AT_PICKUPARRIVED_AT_DESTINATIONLOADINGUNLOADINGIN_TRANSITCOMPLETEDDELAYEDCANCELED
Example:
IN_TRANSIT
payload
object (Payload)
optional
Example:
{"additionInformation":"Information XX"}
document
array[object (Document) {8}]
required
referenceCode
string
required
>= 1 characters<= 20 characters
Example:
DOC-123456789
senderOrganization
object (Organization)
required
receiverOrganization
object (Organization)
required
startingPoint
object (Location)
required
endingPoint
object (Location)
required
load
object (Load)
required
report
string <file>
optional
Example:
report.pdf
payload
object (Payload)
optional
Example:
{"additionInformation":"Information XX"}
payload
object (Payload)
optional
Example:
{"additionInformation":"Information XX"}