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

EcmrConsignment

{
    "senderInformation": {
        "senderCompanyName": "string",
        "senderPersonName": "string",
        "senderStreet": "string",
        "senderPostcode": "string",
        "senderCity": "string",
        "senderCountryCode": {
            "region": "string",
            "value": "st"
        },
        "senderContactInformation": {
            "email": "string",
            "phone": "string"
        }
    },
    "multiConsigneeShipment": {
        "isMultiConsigneeShipment": true
    },
    "consigneeInformation": {
        "consigneeCompanyName": "string",
        "consigneePersonName": "string",
        "consigneePostcode": "string",
        "consigneeCity": "string",
        "consigneeCountryCode": {
            "region": "string",
            "value": "st"
        },
        "consigneeStreet": "string",
        "consigneeContactInformation": {
            "email": "string",
            "phone": "string"
        }
    },
    "takingOverTheGoods": {
        "takingOverTheGoodsPlace": "string",
        "logisticsTimeOfArrivalDateTime": "2019-08-24T14:15:22Z",
        "logisticsTimeOfDepartureDateTime": "2019-08-24T14:15:22Z"
    },
    "deliveryOfTheGoods": {
        "logisticsLocationCity": "string",
        "logisticsLocationOpeningHours": "string"
    },
    "sendersInstructions": {
        "transportInstructionsDescription": "string"
    },
    "carrierInformation": {
        "carrierCompanyName": "string",
        "carrierDriverName": "string",
        "carrierStreet": "string",
        "carrierPostcode": "string",
        "carrierCity": "string",
        "carrierCountryCode": {
            "region": "string",
            "value": "st"
        },
        "carrierLicensePlate": "string",
        "carrierContactInformation": {
            "email": "string",
            "carrierPhone": "string",
            "driverPhone": "string"
        }
    },
    "successiveCarrierInformation": {
        "successiveCarrierCity": "string",
        "successiveCarrierCountryCode": {
            "region": "string",
            "value": "st"
        },
        "successiveCarrierCompanyName": "string",
        "successiveCarrierDriverName": "string",
        "successiveCarrierPostcode": "string",
        "successiveCarrierStreet": "string",
        "successiveCarrierContactInformation": {
            "email": "string",
            "carrierPhone": "string",
            "driverPhone": "string"
        }
    },
    "carriersReservationsAndObservationsOnTakingOverTheGoods": {
        "carrierReservationsObservations": "string",
        "senderReservationsObservationsSignature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        }
    },
    "documentsHandedToCarrier": {
        "documentsRemarks": "string"
    },
    "itemList": [
        {
            "marksAndNos": {
                "logisticsShippingMarksMarking": "string",
                "logisticsShippingMarksCustomBarcodeList": [
                    {
                        "barcode": "string"
                    }
                ]
            },
            "numberOfPackages": {
                "logisticsPackageItemQuantity": 0
            },
            "methodOfPacking": {
                "logisticsPackageType": "string"
            },
            "natureOfTheGoods": {
                "transportCargoIdentification": "string"
            },
            "grossWeightInKg": {
                "supplyChainConsignmentItemGrossWeight": 0
            },
            "volumeInM3": {
                "supplyChainConsignmentItemGrossVolume": 0
            }
        }
    ],
    "specialAgreementsSenderCarrier": {
        "customSpecialAgreement": "string"
    },
    "toBePaidBy": {
        "customChargeCarriage": {
            "value": 0,
            "currency": "string",
            "payer": "SENDER"
        },
        "customChargeSupplementary": {
            "value": 0,
            "currency": "string",
            "payer": "SENDER"
        },
        "customChargeCustomsDuties": {
            "value": 0,
            "currency": "string",
            "payer": "SENDER"
        },
        "customChargeOther": {
            "value": 0,
            "currency": "string",
            "payer": "SENDER"
        }
    },
    "otherUsefulParticulars": {
        "customParticulars": "string"
    },
    "cashOnDelivery": {
        "customCashOnDelivery": 0
    },
    "established": {
        "customEstablishedDate": "2019-08-24T14:15:22Z",
        "customEstablishedIn": "string"
    },
    "goodsReceived": {
        "confirmedLogisticsLocationName": "string",
        "consigneeReservationsObservations": "string",
        "consigneeSignature": {
            "type": "string",
            "userName": "string",
            "userCompany": "string",
            "userStreet": "string",
            "userPostCode": "string",
            "userCity": "string",
            "userCountry": "string",
            "timestamp": "2019-08-24T14:15:22Z",
            "data": "string"
        },
        "consigneeSignatureDate": "2019-08-24T14:15:22Z",
        "consigneeTimeOfArrival": "2019-08-24T14:15:22Z",
        "consigneeTimeOfDeparture": "2019-08-24T14:15:22Z"
    },
    "nonContractualPartReservedForTheCarrier": {
        "nonContractualCarrierRemarks": "string"
    },
    "referenceIdentificationNumber": {
        "value": "string"
    }
}
Built with