KEYSTONE API Standard
  1. Transport Operation
KEYSTONE API Standard
  • KEYSTONE API Standard
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths & Endpoints
    • Transport Operation
      • Create new transport operation data
        POST
      • Get all transport operation data
        GET
      • Get a specific transport operation data by ID
        GET
      • Update data for a specific transport operation by ID
        PUT
      • Delete specific transport operation data by ID
        DELETE
      • Get schedule data related to a specific transport operation by ID
        GET
      • Update schedule data for a specific transport operation by ID
        PUT
      • Get all phase data related to a specific transport operation by ID
        GET
      • Append phase data for a specific transport operation by ID
        PATCH
      • Get specific phase data by transport operation ID and phase ID
        GET
      • Update specific phase data by transport operation ID and phase ID
        PUT
      • Get all international consignment notes related to a specific transport operation by ID
        GET
      • Append international consignment notes data for a specific transport operation by ID
        PATCH
      • Get specific international consignment notes data by transport operation ID and reference code
        GET
      • Update specific international consignment notes data by transport operation ID and reference code
        PUT
      • Delete specific international consignment notes data by transport operation ID and reference code
        DELETE
      • Get specific transport operation data by country code and license plate number
        GET
      • Get details about the schedule of specific transport operation by country code and license plate number
        GET
      • Get details about all the phases of specific transport operation by country code and license plate number
        GET
      • Get specific phase data by country code, license plate number, and phase ID
        GET
      • Get all international consignment notes related to a specific transport operation by country code and license plate number
        GET
      • Get specific international consignment notes data by country code, license plate number, and reference code
        GET
    • 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
  1. Transport Operation

Get specific transport operation data by country code and license plate number

GET
/transport-operations/{countryCode}/{plateNumber}/
Transport Operation

Request

Path Params
countryCode
string 
required
Country code of the vehicle's registration.
plateNumber
string 
required
License plate number of the vehicle.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.company-server/v1/transport-operations///'

Responses

🟢200OK
application/json
Transport operation data retrieved successfully
Body
Details about the transport operation.
id
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.
>= 1 characters<= 20 characters
Example:
ABC Logistics
countryCode
string 
required
Country code of the organization.
Example:
IT
Match pattern:
^[A-Z]{2,4}$
vat
string 
optional
VAT Number of the organization.
>= 2 characters<= 13 characters
Example:
IT1234567890
address
string 
optional
Address of the organization.
>= 1 characters<= 100 characters
Example:
123 Main St, City, Country
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.
id
integer <int64>
required
Unique identifier for the driver.
>= 1
Example:
123456789
firstName
string 
required
First name of the driver.
>= 1 characters<= 20 characters
Example:
John
lastName
string 
required
Last name of the driver.
>= 1 characters<= 20 characters
Example:
Doe
countryCode
string 
required
Country code of the driver's registration.
Example:
IT
Match pattern:
^[A-Z]{2,4}$
vat
string 
required
VAT number of the driver.
>= 2 characters<= 13 characters
Example:
IT0011228901
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.
id
integer <int64>
required
Unique identifier for the vehicle.
>= 1
Example:
123456789
countryCode
string 
required
Country code of the vehicle's registration.
Example:
IT
Match pattern:
^[A-Z]{2,4}$
plateNumber
string 
required
License plate number of the vehicle.
>= 1 characters<= 20 characters
Example:
AA1232
type
string 
optional
Type of the vehicle.
>= 1 characters<= 20 characters
Example:
Truck
model
string 
optional
Model of the vehicle.
>= 1 characters<= 20 characters
Example:
XX Model
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.
id
integer <int32>
required
The indicator of the respective operation phase.
>= 1
Example:
1
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.
>= 1 characters<= 20 characters
Example:
DOC-123456789
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
Previous
Delete specific international consignment notes data by transport operation ID and reference code
Next
Get details about the schedule of specific transport operation by country code and license plate number
Built with