Getting Started with Toll Vehicle APIs
This section describe endpoints related to implementation and configuration of Toll Vehicles.
Shell eTM toll vehicle API product provides seamless operations like creating and searching vehicles for API consumers.
This API product consists of four endpoints which can be used in order to develop different user journeys.
| API End Point | API Functionality |
|---|---|
| /fleetmanagement/v4/vehicle/create | This endpoint will create the vehicle with all mandatory properties and validations. |
| /fleetmanagement/v2/vehicle/search | This endpoint will get country accesses for specified vehicle including devices, services, country access statuses and vehicle statuses. |
| /fleetmanagement/v1/vehicle/devices | This endpoint will get the devices detail for specified vehicle. |
| /fleetmanagement/v1/vehicle/detail | This endpoint will get the vehicle details for specified vehicle. |
All the APIs are protected with basic authentication method.
Authentication
Shell API’s are secured by basic authentication plus API key. It uses the Base64 encoded Client ID and Client Secret in the Authorization header and apikey header. The end-to-end process is illustrated in the sequence diagram below.
sequenceDiagram
participant Partner Application
participant Shell
alt [Call Functional Endpoint]
Partner Application->>Shell: [1] Initiate request to functional endpoint with the basic authentication (Parsing the Base64 encoded Client ID and Client Secret) plus apikey header
Shell->>Partner Application: [2] Returns a response
end
Key Request Parameters
After receiving the Client ID and Client Secret, the next step is to make an API request using basic authentication. This request contains an apikey header and Authorization header in the form of: Basic (credentials), where the credentials is the Base64 encoding of Client ID and Client Secret.
Following are the key parameters:
- Method: POST
- Authentication Type: Basic authentication (Client ID and Client Secret)
- apikey: Header (Client ID)
Exception Handling
| HTTP Code | Description | Scenarios |
|---|---|---|
| 400 | Bad Request | If invalid parameter value passed |
| 401 | Unauthorized | If invalid parameter value passed |
| 403 | The request is valid and server is refusing action | If invalid parameter value passed |
| 504 | Not Found | If requested item does not exist |
| 500 | Internal Server Error | Fault String |
Sample Exception Structure
{
"fault": {
"faultstring": "Raising fault. Fault name : RaiseFaultAuthorizationCheck",
"detail": {
"errorcode": "steps.raisefault.RaiseFault"
}
}
}
Create
This API allows you to create the vehicle with all mandatory properties and telepass validations.
Key Request Parameters
- Method: POST
- URL: https://host-name/fleetmanagement/v4/vehicle/create
- Authentication Type: Basic authentication (Client ID and Client Secret)
- apikey: Header (Client ID)
Sample cURL Request
curl --location --request POST 'https://api-test.shell.com/test/fleetmanagement/v4/vehicle/create' \
--header 'Content-Type: application/json' \
--header 'authorization: Basic RVd5SXY4THBqeWdVW8wVlpNTjZKS3BxUmM6OU5XdlZMRVM3T3NHR1Mrpkg==' \
--header 'apikey: EWyIv8LpjygW3LlKDDUo0VZMNAd0079k' \
--data-raw '{
"requestId": "974756b7-2110-42c0-8faa-3f18f7051b63",
"countryTypeId": "4aab76e8-dd6a-404d-8195-f88b4621ddcd",
"firstDayOfRegistration": "00001-01-01T12:00:00",
"licensePlate": "IK00799",
"vin": "asdad313123131313",
"vehicleCategoryTypeId": "d222056b-4834-4c6d-b9fc-503810eff4bd",
"vehicleTypeId": "fb7ef715-1f00-49b4-b856-e879f44286db",
"totalVehicleWeight": 12000,
"grossVehicleWeightRating": 18000,
"authorizedGrossVehicleWeight": 45000,
"fuelTypeId": "6cf0e140-36e6-4dc7-844f-20916eba1a2c",
"emissionTypeId": "1818805c-5322-4f60-8075-e8aba63e0754",
"truckTractorAxlesNumber": 2,
"vehicleDocuments": [
{
"vehicleDocumentTypeId": "c3a0fa3b-c4d9-4c59-83a0-44c8c87decd6",
"name": "holiday_calendar_2021.pdf",
"content": "pdf content JVBERi0xLjcNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBl"
}
],
"particulateFilterClass": null,
"firstAxleHeight": null,
"vehicleModelTypeId": "7a423770-838a-4879-b731-1db938919b93",
"trailerAxlesNumber": 7,
"userName": "eTMTestAdmin",
"ColCoId": 14,
"ColCoCode": 14,
"payerNumber": "DE00000008",
"accountNumber": "DE00000008"
}
Sample Response
{
"vehicleModelTypeId": "7a423770-838a-4879-b731-1db938919b93",
"trailerAxlesNumber": 7,
"id": "afa727cf-aa64-41af-8de0-d5f9cac52917",
"countryTypeId": "4aab76e8-dd6a-404d-8195-f88b4621ddcd",
"vehicleCategoryTypeId": "d222056b-4834-4c6d-b9fc-503810eff4bd",
"vehicleTypeId": "fb7ef715-1f00-49b4-b856-e879f44286db",
"fuelTypeId": "6cf0e140-36e6-4dc7-844f-20916eba1a2c",
"emissionTypeId": "1818805c-5322-4f60-8075-e8aba63e0754",
"firstDayOfRegistration": "0001-01-01T12:00:00",
"licensePlate": "IK00799",
"cleanLicensePlate": "IK00799",
"vin": "asdad313123131313",
"totalVehicleWeight": 12000.0,
"grossVehicleWeightRating": 18000.0,
"authorizedGrossVehicleWeight": 45000.0,
"truckTractorAxlesNumber": 2,
"vehicleDocuments": [
{
"name": "IK_Vehicle_Deatails_2022.pdf",
"storageId": "f03f18f0-7868-4696-b3a0-70cb18192d12.pdf",
"contentType": "application/pdf",
"contentLength": 40080,
"vehicleDocumentTypeId": "c3a0fa3b-c4d9-4c59-83a0-44c8c87decd6"
}
],
"requestId": "974756b7-2110-42c0-8faa-3f18f7051b63",
"error": {
"code": "0000",
"description": "Success"
}
}
Search
This API allows you to get country accesses for a specified vehicle including devices, services, country access status, and vehicle status.
Key Request Parameters
- Method: POST
- URL: https://host-name/fleetmanagement/v2/vehicle/search
- Authentication Type: Basic authentication (Client ID and Client Secret)
- apikey: Header (Client ID)
Sample cURL Request
curl --location --request POST 'https://api-test.shell.com/test/fleetmanagement/v2/vehicle/search' \
--header 'content-type: application/json' \
--header 'apikey: EWyIv8LpjygW3LlKDDUo0VZMNAd0079k' \
--header 'Authorization: Basic RVd5SXY4THBqeWdVW8wVlpNTjZKS3BxUmM6OU5XdlZMRVM3T3NHR1rpk==' \
--data-raw '{
"CountryAccess": null,
"PageSize": 1,
"CurrentPage": 2,
"SortOptions": [
{
"Member": "LicensePlate",
"SortType": 1
}
],
"Filters": [],
"Username": "eTMTestAdmin",
"ColCoId": 14,
"ColCoCode": 14,
"PayerNumber": "DE26685519"
}
Sample Response
{
"activeCount": 9,
"accessRestrictedCount": 305,
"emptyCount": 610,
"rowCount": 924,
"currentPage": 2,
"totalPages": 924,
"entities": [
{
"licensePlate": " CDFG2333",
"countryTypeId": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50",
"grossVehicleWeightRating": 8765.0,
"authorizedGrossVehicleWeight": 45677.0,
"totalVehicleWeight": 56789.00,
"truckTractorAxlesNumber": 2,
"emissionTypeId": "5c1ebec5-1af3-4f2e-b85a-95505cab2a07",
"emissionTypeName": "Euro 1",
"emissionTypeClass": "01",
"vehicleCategoryTypeId": "d222056b-4834-4c6d-b9fc-503810eff4bd",
"vehicleCategoryTypeLongName": "Heavy Goods Vehicle N2",
"vehicleTypeId": "fb7ef715-1f00-49b4-b856-e879f44286db",
"vehicleTypeLongName": "LGV",
"firstDayOfRegistration": "2016-02-03T00:00:00",
"accountNumber": "DE26635332",
"eTMCustomerId": "e8f15500-66bf-41a9-88cf-1e2c0d3a85f4",
"status": "Access restricted",
"vin": "23423546457568679",
"hasCompleteData": false,
"devices": [
{
"status": "Pending changes",
"deviceTypeId": "0f8e210b-44d0-4c5e-a350-bf6040515f82",
"services": [
{
"orderId": "5e93972f-f471-eb11-b566-00155da3cbd0",
"status": "Active",
"serviceId": "7ed310eb-805e-47de-a5b1-82dec86781ba",
"serviceName": "Belarus road (BelToll)",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Belarus",
"a1": "BY",
"a2": "BY",
"id": "f5bcae15-abee-4231-a4b7-7a50d483af8e"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "d9ac2f11-42b9-47cd-be57-096618687b65",
"services": [
{
"orderId": "02ccd56c-74f0-eb11-b563-00155da3d962",
"status": "Active",
"serviceId": "940110a6-1117-45a6-a988-58c5a5948c2e",
"serviceName": "FDE Frejus tunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "France",
"a1": "F",
"a2": "FR",
"id": "088de29a-b84e-4753-9d25-174a5ac777da"
},
{
"name": "Italy",
"a1": "I",
"a2": "IT",
"id": "7f50cb6e-aecb-4870-90c4-fcb8799ee539"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "776e37a8-d39f-4c0e-9fcd-256732e03edb",
"services": [
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "5f4aeebd-f042-4e96-9c93-0cd832f0358b",
"serviceName": "Toll4Europe Austria road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Austria",
"a1": "A",
"a2": "AT",
"id": "fb94f920-e80b-460d-8841-bb64adce80ac"
}
]
},
{
"status": "Deactivated",
"serviceId": "ee73e01a-ac25-4d70-b7c0-320748b77f8e",
"serviceName": "Toll4Europe Liefkenshoek tunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Belgium",
"a1": "B",
"a2": "BE",
"id": "2dfb93b4-027e-4ae4-aa03-3e7138af0223"
}
]
},
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "2d39f6dc-7c65-4e39-927b-44580f8d1048",
"serviceName": "Toll4Europe Spain road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Spain",
"a1": "E",
"a2": "ES",
"id": "4ca28ed2-e446-452f-9703-65c3d5f9a165"
}
]
},
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "9bc1f26a-a3c0-4409-9445-582f0fc0174a",
"serviceName": "Toll4Europe Germany road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Germany",
"a1": "D",
"a2": "DE",
"id": "a0e495ce-9c39-42f2-92bb-d9aa3e416821"
}
]
},
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "f43a11ce-069c-4620-98db-628d63320c30",
"serviceName": "Toll4Europe France road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "France",
"a1": "F",
"a2": "FR",
"id": "088de29a-b84e-4753-9d25-174a5ac777da"
}
]
},
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "f1095afa-0802-4c26-b405-6d7b74b85cab",
"serviceName": "Toll4Europe Belgium road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Belgium",
"a1": "B",
"a2": "BE",
"id": "2dfb93b4-027e-4ae4-aa03-3e7138af0223"
}
]
},
{
"status": "Deactivated",
"serviceId": "213b4f43-0581-4472-9a83-9132a2bfe8fd",
"serviceName": "Toll4Europe Herrentunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Germany",
"a1": "D",
"a2": "DE",
"id": "a0e495ce-9c39-42f2-92bb-d9aa3e416821"
}
]
},
{
"orderId": "1851c1a2-74c6-ea11-9b05-281878d329be",
"status": "Active",
"serviceId": "1eb2cfc9-05fa-4473-989c-a5d1dbd9f702",
"serviceName": "Toll4Europe Portugal road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Portugal",
"a1": "P",
"a2": "PT",
"id": "5877d2de-002d-43d4-8478-f779f3e5d9c3"
}
]
},
{
"status": "Deactivated",
"serviceId": "42699d7d-0aaa-419b-a515-d06bcb5ec5ba",
"serviceName": "Toll4Europe Slovenia",
"isSupportedAtSfh": false,
"isSupportedAtSfhForPreRegistration": true,
"countries": [
{
"name": "Slovenia",
"a1": "SLO",
"a2": "SI",
"id": "683f9aa9-5a4f-40f9-a645-ee6bf4eb543e"
}
]
},
{
"status": "Deactivated",
"serviceId": "7aea05a7-adf6-487a-9bab-fcb99bc8dead",
"serviceName": "Toll4Europe Switzerland road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Switzerland",
"a1": "CH",
"a2": "CH",
"id": "ca6801c7-3044-4b90-b92b-20bad6f2e78a"
}
]
},
{
"status": "Deactivated",
"serviceId": "4cccaff4-966f-401d-9798-d4e4645fd90b",
"serviceName": "Toll4Europe Czech Republic",
"isSupportedAtSfh": false,
"isSupportedAtSfhForPreRegistration": true,
"countries": [
{
"name": "Czech Republic",
"a1": "CZ",
"a2": "CZ",
"id": "9f419f5c-0137-46ec-88de-2aa26741c0ba"
}
]
},
{
"status": "Deactivated",
"serviceId": "f6bc645e-1676-4eb3-b22c-0e34d9460de1",
"serviceName": "Toll4Europe Slovakia",
"isSupportedAtSfh": false,
"isSupportedAtSfhForPreRegistration": true,
"countries": [
{
"name": "Slovakia",
"a1": "SK",
"a2": "SK",
"id": "87a8c32d-0da7-4354-9afa-90f48da6741b"
}
]
},
{
"status": "Deactivated",
"serviceId": "edebb8c3-c084-4849-abbd-86534c8751f7",
"serviceName": "Toll4Europe Hungary road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Hungary",
"a1": "H",
"a2": "HU",
"id": "32583340-d639-4a1e-a23a-36e45137c78f"
}
]
},
{
"status": "Deactivated",
"serviceId": "806524fa-3c66-4793-bfa1-d08ef34c954c",
"serviceName": "Toll4Europe Bulgaria road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Bulgaria",
"a1": "BG",
"a2": "BG",
"id": "1574a831-7eb8-433d-8a11-fe4f79e2af90"
}
]
},
{
"status": "Deactivated",
"serviceId": "5a0620b4-81bc-441e-9411-fa0c6dc1761c",
"serviceName": "Toll4Europe Storebaelt/Oresund bridges",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
},
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
}
]
},
{
"status": "Deactivated",
"serviceId": "6b1ae4e7-22fd-4dd5-b313-c0f99b719106",
"serviceName": "Toll4Europe Poland (National highways)",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Poland",
"a1": "PL",
"a2": "PL",
"id": "b345cf2a-6a3f-4d2e-a719-22e2817b3f08"
}
]
},
{
"status": "Deactivated",
"serviceId": "e85f744c-c04d-422e-9d32-f64dcdfea0bb",
"serviceName": "Toll4Europe PosData",
"isSupportedAtSfh": false,
"isSupportedAtSfhForPreRegistration": false,
"countries": []
},
{
"status": "Deactivated",
"serviceId": "927b2f4e-b58d-4989-a4f4-109fb7029f9a",
"serviceName": "Toll4Europe Italy road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Italy",
"a1": "I",
"a2": "IT",
"id": "7f50cb6e-aecb-4870-90c4-fcb8799ee539"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "81148bfd-2381-445d-8fdb-c890f78f1468",
"services": [
{
"orderId": "c8501782-9e21-eb11-9fb4-281878d32faa",
"status": "Active",
"serviceId": "9a963f47-7479-4a10-ae84-846cf45354b1",
"serviceName": "FDE Norway road (Brobizz)",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Norway",
"a1": "N",
"a2": "NO",
"id": "9696ac0b-b78a-4c41-b9d4-358ab439889f"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
},
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
}
]
}
]
}
],
"countryAccess": [
{
"name": "Belarus",
"a1": "BY",
"a2": "BY",
"status": "Active",
"id": "f5bcae15-abee-4231-a4b7-7a50d483af8e"
},
{
"name": "France",
"a1": "F",
"a2": "FR",
"status": "Active",
"id": "088de29a-b84e-4753-9d25-174a5ac777da"
},
{
"name": "Italy",
"a1": "I",
"a2": "IT",
"status": "Active",
"id": "7f50cb6e-aecb-4870-90c4-fcb8799ee539"
},
{
"name": "Austria",
"a1": "A",
"a2": "AT",
"status": "Active",
"id": "fb94f920-e80b-460d-8841-bb64adce80ac"
},
{
"name": "Belgium",
"a1": "B",
"a2": "BE",
"status": "Active",
"id": "2dfb93b4-027e-4ae4-aa03-3e7138af0223"
},
{
"name": "Spain",
"a1": "E",
"a2": "ES",
"status": "Active",
"id": "4ca28ed2-e446-452f-9703-65c3d5f9a165"
},
{
"name": "Germany",
"a1": "D",
"a2": "DE",
"status": "Active",
"id": "a0e495ce-9c39-42f2-92bb-d9aa3e416821"
},
{
"name": "Portugal",
"a1": "P",
"a2": "PT",
"status": "Active",
"id": "5877d2de-002d-43d4-8478-f779f3e5d9c3"
},
{
"name": "Slovenia",
"a1": "SLO",
"a2": "SI",
"status": "Not active",
"id": "683f9aa9-5a4f-40f9-a645-ee6bf4eb543e"
},
{
"name": "Switzerland",
"a1": "CH",
"a2": "CH",
"status": "Not active",
"id": "ca6801c7-3044-4b90-b92b-20bad6f2e78a"
},
{
"name": "Czech Republic",
"a1": "CZ",
"a2": "CZ",
"status": "Not active",
"id": "9f419f5c-0137-46ec-88de-2aa26741c0ba"
},
{
"name": "Slovakia",
"a1": "SK",
"a2": "SK",
"status": "Not active",
"id": "87a8c32d-0da7-4354-9afa-90f48da6741b"
},
{
"name": "Hungary",
"a1": "H",
"a2": "HU",
"status": "Not active",
"id": "32583340-d639-4a1e-a23a-36e45137c78f"
},
{
"name": "Bulgaria",
"a1": "BG",
"a2": "BG",
"status": "Not active",
"id": "1574a831-7eb8-433d-8a11-fe4f79e2af90"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"status": "Active",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
},
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"status": "Active",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
},
{
"name": "Poland",
"a1": "PL",
"a2": "PL",
"status": "Not active",
"id": "b345cf2a-6a3f-4d2e-a719-22e2817b3f08"
},
{
"name": "Norway",
"a1": "N",
"a2": "NO",
"status": "Active",
"id": "9696ac0b-b78a-4c41-b9d4-358ab439889f"
}
],
"vehicleCards": [],
"id": "ff87b27f-7263-ea11-a94c-00155da4024f"
}
],
"requestId": "fcd54072-4d4f-4fd8-e64e-68f45eee5bb4",
"error": {
"code": "0000",
"description": "Success"
}
}
Devices
This API allows you to get the devices detail for a specified vehicle.
Key Request Parameters
- Method: POST
- URL: https://host-name/fleetmanagement/v1/vehicle/devices
- Authentication Type: Basic authentication (Client ID and Client Secret)
- apikey: Header (Client ID)
Sample cURL Request
curl --location --request POST 'https://api-test.shell.com/test/fleetmanagement/v1/vehicle/devices' \
--header 'Content-Type: application/json' \
--header 'apikey: EWyIv8LpjygW3LlKDDUo0VZMNAd0079k' \
--header 'Authorization: Basic RVd5SXY4THBqeWdVW8wVlpNTjZKS3BxUmM6OU5XdlZMRVM3T3NHR1rpkg==' \
--data-raw ' {
"ColcoId": 14,
"ColcoCode": 14,
"PayerNumber": "DE26685565",
"AccountNumber": "DE25800373",
"VehicleId":"cb600ecd-ed50-eb11-b9ed-281878d3a450"
}
Note: You can find the VehicleId in the response of Create vehicle API. The value of the id is VehicleId. For example, "id": "5a9b3c5f-afa0-48c9-a09a-3f003a1c1c2a".
Sample Response
{
"devices": [
{
"status": "Inactive",
"deviceTypeId": "efcd57be-c12e-416e-84f7-2041367b4268",
"obuNumber": "0111202119393200000",
"validFrom": "2021-01-10T00:00:00",
"validTo": "2021-01-25T00:00:00",
"services": [
{
"status": "Deactivated",
"serviceId": "bc5c7ae4-5f59-412a-8fce-20d6b64b170b",
"serviceName": "eVignette",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
},
{
"name": "Netherlands",
"a1": "NL",
"a2": "NL",
"id": "2d77545b-8c14-4d31-8266-ab77cf9da3c7"
},
{
"name": "Luxembourg",
"a1": "L",
"a2": "LU",
"id": "8047d310-2f18-49ff-8490-dae98bd5234c"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
}
]
}
]
},
{
"status": "Inactive",
"deviceTypeId": "efcd57be-c12e-416e-84f7-2041367b4268",
"obuNumber": "4221511882855147217",
"validFrom": "2021-07-27T00:00:00",
"validTo": "2022-03-18T00:00:00",
"services": [
{
"status": "Deactivated",
"serviceId": "bc5c7ae4-5f59-412a-8fce-20d6b64b170b",
"serviceName": "eVignette",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
},
{
"name": "Netherlands",
"a1": "NL",
"a2": "NL",
"id": "2d77545b-8c14-4d31-8266-ab77cf9da3c7"
},
{
"name": "Luxembourg",
"a1": "L",
"a2": "LU",
"id": "8047d310-2f18-49ff-8490-dae98bd5234c"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "efcd57be-c12e-416e-84f7-2041367b4268",
"services": [
{
"orderId": "0c2baa30-3361-eb11-9889-281878d3220e",
"status": "Active",
"serviceId": "bc5c7ae4-5f59-412a-8fce-20d6b64b170b",
"serviceName": "eVignette",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
},
{
"name": "Netherlands",
"a1": "NL",
"a2": "NL",
"id": "2d77545b-8c14-4d31-8266-ab77cf9da3c7"
},
{
"name": "Luxembourg",
"a1": "L",
"a2": "LU",
"id": "8047d310-2f18-49ff-8490-dae98bd5234c"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "efcd57be-c12e-416e-84f7-2041367b4268",
"services": [
{
"orderId": "67a13e53-3e56-eb11-b9ed-281878d3a450",
"status": "Active",
"serviceId": "bc5c7ae4-5f59-412a-8fce-20d6b64b170b",
"serviceName": "eVignette",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
},
{
"name": "Netherlands",
"a1": "NL",
"a2": "NL",
"id": "2d77545b-8c14-4d31-8266-ab77cf9da3c7"
},
{
"name": "Luxembourg",
"a1": "L",
"a2": "LU",
"id": "8047d310-2f18-49ff-8490-dae98bd5234c"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "7bf14abc-e8fc-4d5b-a25d-91e15d5ef96a",
"services": [
{
"status": "Deactivated",
"serviceId": "696e4c81-0338-43e6-9c07-80eea02f7809",
"serviceName": "Axxes Austria road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Austria",
"a1": "A",
"a2": "AT",
"id": "fb94f920-e80b-460d-8841-bb64adce80ac"
}
]
},
{
"status": "Deactivated",
"serviceId": "df89342f-b6c8-4499-a8aa-02fbd5c86203",
"serviceName": "Axxes Italy road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Italy",
"a1": "I",
"a2": "IT",
"id": "7f50cb6e-aecb-4870-90c4-fcb8799ee539"
}
]
},
{
"status": "Deactivated",
"serviceId": "18f0c52d-e04c-404a-b3c2-6116ff5f54a6",
"serviceName": "Axxes Spain road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Spain",
"a1": "E",
"a2": "ES",
"id": "4ca28ed2-e446-452f-9703-65c3d5f9a165"
}
]
},
{
"status": "Deactivated",
"serviceId": "fd64d9b7-a4ef-40a2-8767-b0d9b27e343c",
"serviceName": "Axxes Liefkenshoek tunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Belgium",
"a1": "B",
"a2": "BE",
"id": "2dfb93b4-027e-4ae4-aa03-3e7138af0223"
}
]
},
{
"status": "Deactivated",
"serviceId": "7091bd55-a1ef-415c-aecc-9ac1bc976a31",
"serviceName": "Axxes Portugal road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Portugal",
"a1": "P",
"a2": "PT",
"id": "5877d2de-002d-43d4-8478-f779f3e5d9c3"
}
]
},
{
"orderId": "8ac72533-228b-ec11-a507-c896653aaf57",
"status": "Active",
"serviceId": "253f66f3-231e-42b2-acbd-c9aa8d37f943",
"serviceName": "Axxes Germany road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Germany",
"a1": "D",
"a2": "DE",
"id": "a0e495ce-9c39-42f2-92bb-d9aa3e416821"
}
]
},
{
"orderId": "8ac72533-228b-ec11-a507-c896653aaf57",
"status": "Active",
"serviceId": "67a067b5-951b-445c-9e1f-773bfb0b2230",
"serviceName": "Axxes Herren tunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Germany",
"a1": "D",
"a2": "DE",
"id": "a0e495ce-9c39-42f2-92bb-d9aa3e416821"
}
]
},
{
"status": "Deactivated",
"serviceId": "ab3f7314-9143-4d77-8f13-31a4f39ad355",
"serviceName": "Axxes France road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "France",
"a1": "F",
"a2": "FR",
"id": "088de29a-b84e-4753-9d25-174a5ac777da"
}
]
},
{
"orderId": "8ac72533-228b-ec11-a507-c896653aaf57",
"status": "Active",
"serviceId": "593f2773-c639-4842-9216-849c9cedbe9f",
"serviceName": "Axxes Belgium road",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Belgium",
"a1": "B",
"a2": "BE",
"id": "2dfb93b4-027e-4ae4-aa03-3e7138af0223"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "81148bfd-2381-445d-8fdb-c890f78f1468",
"services": [
{
"orderId": "8ac72533-228b-ec11-a507-c896653aaf57",
"status": "Active",
"serviceId": "9a963f47-7479-4a10-ae84-846cf45354b1",
"serviceName": "FDE Norway road (Brobizz)",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "Norway",
"a1": "N",
"a2": "NO",
"id": "9696ac0b-b78a-4c41-b9d4-358ab439889f"
},
{
"name": "Denmark",
"a1": "DK",
"a2": "DK",
"id": "ef3fc9b0-bb39-46ba-b3d6-5fc98dbf2a50"
},
{
"name": "Sweden",
"a1": "S",
"a2": "SE",
"id": "e5622944-fade-4c75-a14c-9455cb5fd08f"
}
]
}
]
},
{
"status": "Pending changes",
"deviceTypeId": "d9ac2f11-42b9-47cd-be57-096618687b65",
"services": [
{
"orderId": "8ac72533-228b-ec11-a507-c896653aaf57",
"status": "Active",
"serviceId": "940110a6-1117-45a6-a988-58c5a5948c2e",
"serviceName": "FDE Frejus tunnel",
"isSupportedAtSfh": true,
"isSupportedAtSfhForPreRegistration": false,
"countries": [
{
"name": "France",
"a1": "F",
"a2": "FR",
"id": "088de29a-b84e-4753-9d25-174a5ac777da"
},
{
"name": "Italy",
"a1": "I",
"a2": "IT",
"id": "7f50cb6e-aecb-4870-90c4-fcb8799ee539"
}
]
}
]
}
],
"requestId": "31ff261d-6661-4e5a-8ea9-e191fde02ffe",
"error": {
"code": "0000",
"description": "Success"
}
}
Details
This API allows you to get the vehicle details for a specified vehicle.
Key Request Parameters
- Method: POST
- URL: https://host-name/fleetmanagement/v1/vehicle/details
- Authentication Type: Basic authentication (Client ID and Client Secret)
- apikey: Header (client ID)
Sample cURL Request
curl --location --request POST 'https://api-test.shell.com/test/fleetmanagement/v1/vehicle/detail' \
--header 'Content-Type: application/json' \
--header 'authorization: Basic RVd5SXY4THBqeWdVW8wVlpNTjZKS3BxUmM6OU5XdlZMRVM3T3NHRrpkg==' \
--header 'apikey: EWyIv8LpjygW3LlKDDUo0VZMNAd0079k' \
--data-raw '{
"VehicleId": "7b480a65-5c5d-eb11-9889-281878d3220e",
"userName": "eTMTestAdmin",
"ColCoId": 14,
"ColCoCode": 14,
"payerId": 15194
}
Note: You can find the VehicleId in the response of Create vehicle API. The value of the id is VehicleId. For example, "id": "5a9b3c5f-afa0-48c9-a09a-3f003a1c1c2a".
Sample Response
{
"licensePlate": "FEB0613",
"emissionTypeId": "8025565b-b87f-4146-9bdb-b1c871c0177d",
"status": "Access restricted",
"emissionTypeName": "Euro 4",
"emissionTypeClass": "04",
"vehicleCategoryTypeId": "00c7d154-9305-4d79-ad0c-b8bda9acd734",
"vehicleCategoryTypeLongName": "People transportation M3",
"vehicleTypeId": "77307014-a0e1-49fd-8468-128e00f13ce6",
"vehicleTypeLongName": "HGV",
"countryTypeId": "4aab76e8-dd6a-404d-8195-f88b4621ddcd",
"fuelTypeId": "2cf5a560-d580-45b7-887f-d562811c8fd6",
"fuelTypeName": "LPG",
"firstDayOfRegistration": "2016-05-06T00:00:00",
"truckTractorAxlesNumber": 2,
"trailerAxlesNumber": 6,
"grossVehicleWeightRating": 8765.0,
"authorizedGrossVehicleWeight": 9876.0,
"countryTypeA2": "CY",
"countryTypeA1": "CY",
"vin": "1G2HY52K94U181576",
"totalVehicleWeight": 7654.00,
"firstAxleHeight": 3456,
"vehicleModelTypeId": "476af16a-538a-41f8-bd65-1d8c0d35aa10",
"hasCompleteData": false,
"vehicleDocuments": [
{
"vehicleDocumentTypeId": "c3a0fa3b-c4d9-4c59-83a0-44c8c87decd6",
"vehicleDocumentTypeName": "Vehicle Registration document",
"name": "hi.pdf",
"content": "pdf content JVBERi0xLjcNCiW1tbW1DQoL1Byb2R1Y2VyKP7/"
}
],
"requestId": "d9778223-80d1-4462-fcfb-20ff6a385bb0",
"error": {
"code": "0000",
"description": "Success"
}
}
