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 all international consignment notes related to a specific transport operation by country code and license plate number

GET
/transport-operations/{countryCode}/{plateNumber}/documents/
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///documents/'

Responses

🟢200OK
application/json
Document data retrieved successfully
Body
array of:
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.
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
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.
id
integer <int64>
required
Unique identifier for the location.
>= 1
Example:
123456789
description
string 
required
Description about the location.
>= 1 characters<= 100 characters
Example:
Place X
mode
enum<string> 
required
Details about the mode of the location.
Allowed values:
GENERICGATETERMINALPORTAIRPORTSTATION
Example:
GENERIC
coordinates
object (Coordinates) 
optional
Details about the coordinates.
endingPoint
object (Location) 
required
Details about the ending point of the transport operation.
load
object (Load) 
required
Details about the load being transported.
type
string 
required
Type of load being transported.
>= 1 characters<= 20 characters
Example:
Electronics
description
string 
optional
Detailed description of the load.
>= 1 characters<= 100 characters
Example:
Laptops, tablets, and smartphones
weight
number <double>
required
Weight of the load in kilograms.
>= 0
Example:
500
umWeight
string 
required
Unit of measurement for the weight of the load.
>= 1 characters<= 20 characters
Example:
kg
component
array[object (Component) {7}] 
required
List of the components of the load.
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"}
Additional properties
integer  | number  | string  | boolean 
optional
Example
[
  {
    "referenceCode": "DOC123456",
    "senderOrganization": "Sender Org",
    "receiverOrganization": "Receiver Org",
    "startingPoint": {
      "id": 54546546,
      "description": "Warehouse A",
      "coordinates": {
        "latitude": 45.4642,
        "longitude": 9.19
      },
      "mode": "GATE"
    },
    "endingPoint": {
      "id": 22252535,
      "description": "Warehouse B",
      "coordinates": {
        "latitude": 48.8566,
        "longitude": 2.3522
      },
      "mode": "TERMINAL"
    },
    "load": {
      "type": "Goods",
      "description": "Electronics",
      "weight": 1000,
      "umWeight": "kg",
      "component": [
        {
          "type": "Box",
          "description": "Electronics Box",
          "width": 50,
          "height": 50,
          "depth": 50,
          "unitary": false,
          "um": "cm"
        },
        {
          "type": "Pallet",
          "description": "Pallet of Electronics",
          "width": 50,
          "height": 50,
          "depth": 50,
          "unitary": false,
          "um": "cm"
        }
      ]
    },
    "report": "report.pdf"
  },
  {
    "referenceCode": "DOC654321",
    "senderOrganization": "Sender Org 2",
    "receiverOrganization": "Receiver Org 2",
    "startingPoint": {
      "id": 45355554,
      "description": "Warehouse C",
      "coordinates": {
        "latitude": 40.7128,
        "longitude": -74.006
      },
      "mode": "GATE"
    },
    "endingPoint": {
      "id": 49252535,
      "description": "Warehouse D",
      "coordinates": {
        "latitude": 34.0522,
        "longitude": -118.2437
      },
      "mode": "TERMINAL"
    },
    "load": {
      "type": "Goods",
      "description": "Furniture",
      "weight": 2000,
      "umWeight": "kg",
      "component": [
        {
          "type": "Box",
          "description": "Furniture Box",
          "width": 100,
          "height": 100,
          "depth": 100,
          "unitary": false,
          "um": "cm"
        }
      ]
    },
    "report": "report_2.pdf"
  }
]
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Get specific phase data by country code, license plate number, and phase ID
Next
Get specific international consignment notes data by country code, license plate number, and reference code
Built with