KEYSTONE API Standard
  1. Schemas
KEYSTONE API Standard
  • Overview
  • Data Schema
    • Diagram
    • Transport Operation
    • Vehicle
    • Driver
    • Organization
  • Paths
    • Transport Operation
      • Create new transport operation data
      • Get all transport operation data
      • Get a specific transport operation data by ID
      • Update data for a specific transport operation by ID
      • Delete specific transport operation data by ID
      • Get schedule data related to a specific transport operation by ID
      • Update schedule data for a specific transport operation by ID
      • Get all phase data related to a specific transport operation by ID
      • Append phase data for a specific transport operation by ID
      • Get specific phase data by transport operation ID and phase ID
      • Update specific phase data by transport operation ID and phase ID
      • Get all international consignment notes related to a specific transport operation by ID
      • Append international consignment notes data for a specific transport operation by ID
      • Get specific international consignment notes data by transport operation ID and reference code
      • Update specific international consignment notes data by transport operation ID and reference code
      • Delete specific international consignment notes data by transport operation ID and reference code
      • Get ongoing transport operation data by country code and license plate number
      • Get details about the schedule of the ongoing transport operation by country code and license plate number
      • Get details about all the phases of the ongoing transport operation by country code and license plate number
      • Get specific phase data related to the ongoing transport operation by country code, license plate number, and phase ID
      • Get all international consignment notes related to the ongoing transport operation by country code and license plate number
      • Get specific international consignment notes data related to the ongoing transport operation by country code, license plate number, and reference code
      • Get all locations related to transport operations
      • Get all locations related to transport operations by location mode
      • Create a new eCMR
      • Get a specific eCMR by ID
      • Update an eCMR by ID
      • Delete an eCMR by ID
    • 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
  • Schemas
    • Schemas
      • TransportOperation
      • Organization
      • Document
      • OrganizationType
      • Location
      • Coordinates
      • Mode
      • Load
      • Phases
      • Component
      • Status
      • Phase
      • Vehicle
      • Schedule
      • State
      • Geolocation
      • Owner
      • Insurance
      • Revision
      • Driver
      • Licence
      • Category
      • TrafficViolation
      • License
      • TachographCard
      • DrivingInterval
      • e-CMRRequest
      • CarrierContactInformation
      • ExceededTimeLimits
      • Shipping
      • CarrierCountryCode
      • Payload
      • Player
      • PhaseUpdate
      • CarrierInformation
      • CarriersReservationsAndObservationsOnTakingOverTheGoods
      • ConsignorSender
      • CashOnDelivery
      • Seller
      • ConsigneeContactInformation
      • Consignee
      • ConsigneeCountryCode
      • Carrier
      • ConsigneeInformation
      • FreightForwarder
      • OtherUsedTransportEquipment
      • CustomCharge
      • EcmrEquipmentCategory
      • DeliveryOfTheGoods
      • ShippingMandate
      • DocumentsHandedToCarrier
      • Established
      • ContractualCarrierAcceptanceLocation
      • ContractualConsigneeReceiptLocation
      • GoodsReceived
      • GrossWeightInKg
      • EcmrDocument
      • Item
      • IncludedConsignmentItems
      • LogisticsShippingMarksCustomBarcode
      • TransportDetails
      • MarksAndNos
      • HashcodeDetails
      • MethodOfPacking
      • eCMRID
      • MultiConsigneeShipment
      • PostalAddress
      • NatureOfTheGoods
      • User
      • Signature
      • NonContractualPartReservedForTheCarrier
      • Plate
      • NumberOfPackages
      • TransportPackage
      • OtherUsefulParticulars
      • ReferenceIdentificationNumber
      • GeographicalCoordinates
      • e-CMRResponse
      • SenderContactInformation
      • EcmrCarrierUpdate
      • SenderCountryCode
      • EcmrCarrierUpdateShipping
      • SenderInformation
      • SendersInstructions
      • EcmrCarrierUpdateLeg
      • EcmrCarrierUpdateAcceptanceLocation
      • SpecialAgreementsSenderCarrier
      • EcmrExtended
      • EcmrManagement
      • SuccessiveCarrierContactInformation
      • SuccessiveCarrierCountryCode
      • SuccessiveCarrierInformation
      • TakingOverTheGoods
      • ToBePaidBy
      • VolumeInM3
      • EcmrConsignment
      • EcmrModel
  1. Schemas

e-CMRRequest

Body main object

{
    "shipping": {
        "eCMRID": "TEST-0001",
        "transactionID": "550e8400-e29b-41d4-a716-446655440000",
        "note": "Some notes",
        "isMasterCMR": false,
        "masterCMRReferenceNumber": "MASTER-0002"
    },
    "consignorSender": {
        "name": "ACCUDIRE srl",
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        },
        "taxRegistration": "04679020232",
        "EORICode": "IT04679020232",
        "users": [
            {
                "firstName": "Abramo",
                "lastName": "Vincenzi",
                "emailAddress": "abramo.vincenzi@accudire.eu",
                "mobileNumber": "+393456696415"
            }
        ],
        "signature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        }
    },
    "seller": {
        "name": "ACCUDIRE srl",
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        },
        "taxRegistration": "04679020232",
        "EORICode": "IT04679020232",
        "users": [
            {
                "firstName": "Abramo",
                "lastName": "Vincenzi",
                "emailAddress": "abramo.vincenzi@accudire.eu",
                "mobileNumber": "+393456696415"
            }
        ],
        "signature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        }
    },
    "consignee": {
        "name": "ACCUDIRE srl",
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        },
        "taxRegistration": "04679020232",
        "EORICode": "IT04679020232",
        "users": [
            {
                "firstName": "Abramo",
                "lastName": "Vincenzi",
                "emailAddress": "abramo.vincenzi@accudire.eu",
                "mobileNumber": "+393456696415"
            }
        ],
        "signature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        }
    },
    "carriers": [
        {
            "name": "ACCUDIRE srl",
            "postalAddress": {
                "streetName": "Via Francia, 21/C",
                "postCode": "37135",
                "cityName": "Verona",
                "countryCode": "IT",
                "countryName": "Italy",
                "countrySubDivisionName": "Verona"
            },
            "taxRegistration": "04679020232",
            "EORICode": "IT04679020232",
            "users": [
                {
                    "firstName": "Abramo",
                    "lastName": "Vincenzi",
                    "emailAddress": "abramo.vincenzi@accudire.eu",
                    "mobileNumber": "+393456696415"
                }
            ],
            "signature": {
                "type": "string",
                "userName": "string",
                "userCompany": "string",
                "userStreet": "string",
                "userPostCode": "string",
                "userCity": "string",
                "userCountry": "string",
                "timestamp": "2019-08-24T14:15:22Z",
                "data": "string"
            },
            "traderRegistration": "string",
            "tractorPlate": "AA123BB",
            "trailerPlate": "AA123BB",
            "tractorPlateRegistrationCountryCode": "st",
            "trailerPlateRegistrationCountryCode": "st",
            "otherUsedTransportEquipment": [
                {
                    "identifier": "BICU1234565",
                    "type": "BODY_TRAILER"
                }
            ]
        }
    ],
    "freightForwarder": {
        "name": "ACCUDIRE srl",
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        },
        "taxRegistration": "04679020232",
        "EORICode": "IT04679020232",
        "users": [
            {
                "firstName": "Abramo",
                "lastName": "Vincenzi",
                "emailAddress": "abramo.vincenzi@accudire.eu",
                "mobileNumber": "+393456696415"
            }
        ],
        "signature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        }
    },
    "consignorProvidedRegulatoryFormalitiesInstructions": "Ref.: xxx xxx xxx Final destination: xxxxxx - Delivery of the goods must be performed respecting the \nexisting legislation on road safety and the driving time directive established in it",
    "shippingMandate": {
        "description": "string",
        "number": "string",
        "startingDate": "2024-05-30T00:00:00.000Z",
        "endingDate": "2025-05-30T00:00:00.000Z",
        "hasShippingMandate": true
    },
    "contractualCarrierAcceptanceLocation": {
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        },
        "date": "2024-05-30T00:00:00.000Z"
    },
    "contractualConsigneeReceiptLocation": {
        "postalAddress": {
            "streetName": "Via Francia, 21/C",
            "postCode": "37135",
            "cityName": "Verona",
            "countryCode": "IT",
            "countryName": "Italy",
            "countrySubDivisionName": "Verona"
        }
    },
    "associatedDocuments": [
        {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "MIMECode": "application/pdf",
            "code": "aGVsbG8sIHdvcmxkIQ"
        }
    ],
    "includedConsignmentItems": {
        "transportPackages": [
            {
                "shippingMarks": "string",
                "itemQuantity": 10,
                "typeCode": "string",
                "commodityCode": "string",
                "grossWeight": 10,
                "grossVolume": 100,
                "customsCode": "string"
            }
        ],
        "totalItemQuantity": 10,
        "totalWeight": 100,
        "totalVolume": 100
    },
    "transportDetails": {
        "cargoType": "FTL",
        "incoterms": "EXW",
        "categoryCode": "string",
        "tractorSeal": "string",
        "trailerSeal": "string",
        "palletTruckSeal": "string",
        "cargoDetails": "sealed",
        "payment": "freight payment",
        "sizeTypeCode": "ABCZ1234567"
    },
    "hashcodeDetails": {
        "json": "eyJoZWxsbyI6IndvcmxkIn0",
        "algorithm": "SHA-256"
    }
}
Built with