KEYSTONE API Standard
  1. Transport Operation
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
  • Paths
    • Transport Operation
      • Create new transport operation data
        POST
      • Get all ongoing 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 ongoing transport operation data by country code and license plate number
        GET
      • Get details about the schedule of the ongoing transport operation by country code and license plate number
        GET
      • Get details about all the phases of the ongoing transport operation by country code and license plate number
        GET
      • Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase ID
        GET
      • Get all international consignment notes related to the ongoing transport operation by country code and license plate number
        GET
      • Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference code
        GET
      • Get all locations related to transport operations
        GET
      • Get all locations related to transport operations by location mode
        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

Append international consignment notes data for a specific transport operation by ID

PATCH
https://api.company-server/v1/transport-operations/{transportOperationId}/documents/

Request

Path Params

Body Params application/json

Example
{
    "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"
    }
}

Responses

🟢200OK
application/json
Document data appended successfully
Body

Example
{
    "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"
    }
}
🟠400Bad Request
🟠404Record Not Found
🔴500Server Error
Previous
Get all international consignment notes related to a specific transport operation by ID
Next
Get specific international consignment notes data by transport operation ID and reference code
Built with