KEYSTONE API Standard
  1. Transport Operation
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
    • Organization
  • Paths
    • 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 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
      • Create a new eCMR
        POST
      • Get a specific eCMR by ID
        GET
      • Update an eCMR by ID
        PUT
      • Delete an eCMR by ID
        DELETE
    • 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
    • Organization
      • Create new organization data
      • Get all organization data
      • Get organization data by organization ID
      • Update organization data by organization ID
      • Delete specific organization data by organization ID
  1. Transport Operation

Get all international consignment notes related to a specific transport operation by ID

GET
https://api.company-server/v2/transport-operations/{transportOperationId}/documents/

Request

Path Params

Query Params

Responses

🟢200OK
application/json
Document data retrieved successfully
Body

Example
[
    {
        "referenceCode": "DOC123456",
        "senderOrganization": {
            "id": 111111111,
            "name": "ABC Logistics",
            "countryCode": "IT",
            "vat": "IT1234567890",
            "address": "123 Main St, Milan, Italy",
            "type": "OPERATOR"
        },
        "receiverOrganization": {
            "id": 222222222,
            "name": "XYZ Shipping",
            "countryCode": "DE",
            "vat": "DE9876543210",
            "address": "456 Business Ave, Berlin, Germany",
            "type": "CUSTOMER"
        },
        "startingPoint": {
            "id": 54546546,
            "description": "Warehouse A",
            "countryCode": "IT",
            "coordinates": {
                "latitude": 45.4642,
                "longitude": 9.19
            },
            "mode": "GATE"
        },
        "endingPoint": {
            "id": 22252535,
            "description": "Warehouse B",
            "countryCode": "FR",
            "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": {
            "id": 333333333,
            "name": "Global Transport Co",
            "countryCode": "FR",
            "vat": "FR1122334455",
            "address": "789 Commerce Blvd, Paris, France",
            "type": "OPERATOR"
        },
        "receiverOrganization": {
            "id": 444444444,
            "name": "Express Delivery Ltd",
            "countryCode": "ES",
            "vat": "ES5566778899",
            "address": "321 Industrial St, Madrid, Spain",
            "type": "CUSTOMER"
        },
        "startingPoint": {
            "id": 54546546,
            "description": "Warehouse C",
            "countryCode": "IT",
            "coordinates": {
                "latitude": 40.7128,
                "longitude": -74.006
            },
            "mode": "GATE"
        },
        "endingPoint": {
            "id": 22252535,
            "description": "Warehouse D",
            "countryCode": "IT",
            "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
🟠404Not Found
🔴500Internal Server Error
Previous
Update specific phase data by transport operation ID and phase ID
Next
Append international consignment notes data for a specific transport operation by ID
Built with