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 a specific eCMR by ID

GET
https://api.company-server/v2/transport-operations/ecmr/{ecmrId}/

Request

Path Params

Responses

🟢200OK
application/json
The requested eCMR
Body

Example
{
    "ecmrId": "string",
    "ecmrConsignment": {
        "senderInformation": {
            "senderCompanyName": "string",
            "senderPersonName": "string",
            "senderStreet": "string",
            "senderPostcode": "string",
            "senderCity": "string",
            "senderCountryCode": {
                "region": "string",
                "value": "st"
            },
            "senderContactInformation": {
                "email": "string",
                "phone": "+49 123 4567890"
            }
        },
        "multiConsigneeShipment": {
            "isMultiConsigneeShipment": true
        },
        "consigneeInformation": {
            "consigneeCompanyName": "string",
            "consigneePersonName": "string",
            "consigneePostcode": "string",
            "consigneeCity": "string",
            "consigneeCountryCode": {
                "region": "string",
                "value": "st"
            },
            "consigneeStreet": "string",
            "consigneeContactInformation": {
                "email": "string",
                "phone": "+49 123 4567890"
            }
        },
        "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": "+49 123 4567890",
                "driverPhone": "+49 123 4567890"
            }
        },
        "successiveCarrierInformation": {
            "successiveCarrierCity": "string",
            "successiveCarrierCountryCode": {
                "region": "string",
                "value": "st"
            },
            "successiveCarrierCompanyName": "string",
            "successiveCarrierDriverName": "string",
            "successiveCarrierPostcode": "string",
            "successiveCarrierStreet": "string",
            "successiveCarrierContactInformation": {
                "email": "string",
                "carrierPhone": "+49 123 4567890",
                "driverPhone": "+49 123 4567890"
            }
        },
        "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"
        }
    },
    "ecmrStatus": "NEW",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "editedAt": "2019-08-24T14:15:22Z",
    "editedBy": "string",
    "originUrl": "string"
}
🟠404Not Found
🔴500Internal Server Error
Previous
Create a new eCMR
Next
Update an eCMR by ID
Built with