Vehicle API - Apigee (1.2.0)

Download OpenAPI specification:Download

License: Internal usage only

Vehicle API documentation

Authentication & Authorization

You will need to be identified before calling any endpoints.

In order to be recognized and authorized to access our Vehicle API, we put in place 2 mechanisms:

Authentication mechanism is done with a client id dedicated to you.
Remember that the client id provided should be shared with care.
The client id must be inserted in the header of the request in the appropriate field
Authorization mechanism is done by a well-known authorization flow for REST Web API: Basic auth flow.

Vehicles

Vehicles operation with all operation types

Create a vehicle

This endpoint allows to create a vehicle.

Authorizations:

(OAuth2ApiKeyAuth)

Request Body schema: application/json

partyCode	integer <int64> (PartyCode) Party code of the vehicle
siteCode	integer <int64> (SiteCode) Site code of the vehicle
active	boolean (Active) Default: true true if vehicle is active
customerVehicleReference	string <= 255 characters Customer Vehicle Reference
registrationNumber required	string (RegistrationNumber) <= 255 characters Vehicle registration number
registrationDate	string <date> (RegistrationDate) Vehicle registration date
category	string (CategoryName) <= 255 characters Category name
type	string (Type) <= 255 characters Type of the vehicle
vin	string (VIN) <= 255 characters Vehicle Identification Number
vrn	string (VRN) <= 255 characters Vehicle Registration Number
make	string (Make) <= 255 characters Vehicle make
model	string (Model) <= 255 characters Vehicle model
energy	string (Energy) <= 255 characters Vehicle energy
rimType	string <= 255 characters Rim Type
	Array of objects (AxleDTO) <= 1000 items
state	integer <int32> Link to the last inspection

Responses

Request samples

Payload

Content type

application/json

Create a vehicle with the given information

{"partyCode": 100001,
"siteCode": 100001,
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "DAF",
"model": "",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001
}

Response samples

200
400
401
409
500

Content type

application/json

{"code": 1000003,
"partyCode": 100001,
"siteCode": 100001,
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "DAF",
"model": "",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001,
"lastModifiedDate": "2025-05-16T15:55:06"
}

Get vehicles data

Get vehicles data filtered by parameters

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

pageNumber	integer <int32> (PageNumberParam) [ 1 .. 1000 ] Default: 1 Example: pageNumber=2 The page number
pageSize	integer <int32> (PageSizeParam) [ 1 .. 1000 ] Default: 1000 Example: pageSize=2 The page size
lastModifiedDateFrom	string <date-time> (lastModifiedDateFromParam) Example: lastModifiedDateFrom=2024-05-02T10:00:00 Date from for last update date of data
lastModifiedDateTo	string <date-time> (lastModifiedDateToParam) Example: lastModifiedDateTo=2024-05-02T10:00:00 Date to for last update date of data
registrationNumber	string (RegistrationNumberParam) <= 255 characters Example: registrationNumber=AA-123-AA Registration number, if filled then dates filters will not be taken into account
registrationCountryCode	string (RegistrationCountryCodeParam) <= 255 characters Example: registrationCountryCode=FR Country code of registration, only used to trigger autoidat calls
externalRef	string (ExternalRefQueryParam) <= 255 characters Example: externalRef=1000045 Identifier of the external reference
source	string (SourceQueryParam) <= 255 characters Example: source=GENES Source of the external reference
siteCode	integer <int64> (SiteCodeQueryParam) Example: siteCode=1000365 Site identifier
customerVehicleReference	string (CustomerVehicleReferenceQueryParam) <= 255 characters Example: customerVehicleReference=1024 Customer vehicle identifier
withInactive	boolean (WithInactiveQueryParam) Default: false Example: withInactive=false Add inactive vehicle
withExternalRef	boolean (WithExternalRefQueryParam) Default: false Example: withExternalRef=false Add external references

Responses

Response samples

200
400
500

Content type

application/json

{"pagination": {"next": "/vehicle-erm/v1/vehicles?pageNumber=3&pageSize=50",
"previous": "/vehicle-erm/v1/vehicles?pageNumber=1&pageSize=50",
"pageTotal": "3",
"totalElements": "125"
},
"vehicles": [{"code": "1000001",
"partyCode": 100389,
"siteCode": 1000020,
"ownerCode": "1000365",
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "Peugeot",
"model": "208",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": "108765",
"createdDate": "2024-12-27T12:23:23",
"lastModifiedDate": "2024-12-27T12:23:23",
"lastModifiedBy": "user123",
"references": [{"source": "ES_EQUITY",
"externalRef": "AAA123",
"countryCode": "ES",
"lastModifiedDate": "2024-12-27T12:23:23"
}
]
}
]
}

Create vehicles data

Create vehicles

Authorizations:

(OAuth2ApiKeyAuth)

Request Body schema: application/json

externalRef required	string (ExternalRef) <= 255 characters Vehicle reference code of the source
partyExternalRef	string <= 255 characters Party external Reference
siteExternalRef	string <= 255 characters Site external Reference
ownerExternalRef	string <= 255 characters Owner external Reference
active	boolean (Active) Default: true true if vehicle is active
customerVehicleReference	string <= 255 characters Customer Vehicle Reference
registrationNumber	string (RegistrationNumber) <= 255 characters Vehicle registration number
registrationDate	string <date> (RegistrationDate) Vehicle registration date
category	string (CategoryName) <= 255 characters Category name
type	string (Type) <= 255 characters Type of the vehicle
vin	string (VIN) <= 255 characters Vehicle Identification Number
vrn	string (VRN) <= 255 characters Vehicle Registration Number
make	string (Make) <= 255 characters Vehicle make
model	string (Model) <= 255 characters Vehicle model
energy	string (Energy) <= 255 characters Vehicle energy
rimType	string <= 255 characters Rim Type
	Array of objects (AxleDTO) <= 1000 items
state	integer <int32> Link to the last inspection
mileage	integer (Mileage) Vehicle mileage
mileageUOM	string (MileageUOM) <= 255 characters Vehicle mileage unit of measure
annualMileage	integer (AnnualMileage) Vehicle annual mileage
annualMileageUOM	string (AnnualMileageUOM) <= 255 characters Vehicle annual mileage unit of measure
workingHours	integer <int32> Working hours of the vehicle
nextInspectionDate	string <date> (NextInspectionDate) Vehicle next inspection date

Responses

Request samples

Payload

Content type

application/json

Create a vehicle with the given informations

{"externalRef": "AAA123",
"partyExternalRef": "208389",
"siteExternalRef": "208312",
"ownerExternalRef": "20831238",
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "Peugeot",
"model": "208",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001,
"mileage": 120000,
"mileageUOM": "km",
"annualMileage": 20000,
"annualMileageUOM": "km",
"workingHours": null,
"nextInspectionDate": "2025-09-10"
}

Response samples

200
400
500

Content type

application/json

{"code": "1000293"
}

Get tyre options for a vehicle

Authorizations:

(OAuth2ApiKeyAuth)

path Parameters

vehicleCode

required

integer <int32> (VehicleCodeParam)

Example: 2

The vehicle code

Responses

Response samples

200
404
500

Content type

application/json

{"tyreOptions": [{"axlePosition": 1,
"width": "195",
"aspectRatio": "65",
"constructionType": "R",
"diameter": "19",
"loadIndex": 91,
"speedIndex": "V",
"winter": true,
"summer": false
},
{"axlePosition": 2,
"width": "195",
"aspectRatio": "65",
"constructionType": "R",
"diameter": "19",
"loadIndex": 91,
"speedIndex": "V",
"winter": true,
"summer": false
},
{"axlePosition": 2,
"width": "225",
"aspectRatio": "45",
"constructionType": "R",
"diameter": "19",
"loadIndex": 91,
"speedIndex": "V",
"winter": true,
"summer": false
}
]
}

Get vehicles states

Get vehicles state data filtered by parameters

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

pageNumber	integer <int32> (PageNumberParam) [ 1 .. 1000 ] Default: 1 Example: pageNumber=2 The page number
pageSize	integer <int32> (PageSizeParam) [ 1 .. 1000 ] Default: 1000 Example: pageSize=2 The page size
siteCode	integer <int64> (SiteCodeQueryParam) Example: siteCode=1000365 Site identifier
lastModifiedDateFrom	string <date-time> (lastModifiedDateFromParam) Example: lastModifiedDateFrom=2024-05-02T10:00:00 Date from for last update date of data
lastModifiedDateTo	string <date-time> (lastModifiedDateToParam) Example: lastModifiedDateTo=2024-05-02T10:00:00 Date to for last update date of data

Responses

Response samples

200
400
401
404
500

Content type

application/json

{"pagination": {"next": "/vehicle-erm/v1/vehicles/state?page=3&size=50",
"previous": "/vehicle-erm/v1/vehicles/state?page=1&size=50",
"pageTotal": "3",
"totalElements": "125"
},
"vehicles": [{"code": "100001",
"mileage": 120000,
"mileageUOM": "km",
"annualMileage": 20000,
"annualMileageUOM": "km",
"nextInspectionDate": "2028-09-10",
"references": [{"source": "ES_EQUITY",
"externalRef": "AAA123",
"countryCode": "ES",
"lastModifiedDate": "2024-12-27T12:23:23"
}
]
}
]
}

Get site vehicle

Get list of vehicles from site

Authorizations:

(OAuth2ApiKeyAuth)

path Parameters

siteCode

required

integer <int64> (SiteCodeQueryParam)

Example: 1000365

The site code

Responses

Response samples

200
400
401
500

Content type

application/json

{"vehicles": [{"code": "1000001",
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"type": "TRACTOR_UNIT"
},
{"code": "1000037",
"customerVehicleReference": "1020",
"registrationNumber": "AA-123-CC",
"type": "TRACTOR_UNIT"
}
]
}

Quick search vehicles data

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

registrationNumber required	string (RegistrationNumberQueryParam) <= 255 characters Example: registrationNumber=AA-123 The registration number to search for
limit	integer <int32> (LimitQueryParam) [ 1 .. 1000 ] Default: 100 Example: limit=2 The limit size

Responses

Response samples

200
400
401
500

Content type

application/json

[{"code": 1000001,
"partyCode": 1000987,
"siteCode": 1000876,
"customerVehicleReference": "1040",
"registrationNumber": "AB-123-AA",
"type": "TRACTOR_UNIT",
"state": 100001
},
{"code": 1000087,
"partyCode": 1006751,
"siteCode": 1000843,
"customerVehicleReference": "1057",
"registrationNumber": "AB-123-AB",
"type": "TRACTOR_UNIT",
"state": 1000056
}
]

Get a vehicle

Retrieve a vehicle by his code

Authorizations:

(OAuth2ApiKeyAuth)

path Parameters

vehicleCode

required

integer <int32> (VehicleCodeParam)

Example: 2

Targeted vehicle code

Responses

Response samples

200
401
404
500

Content type

application/json

{"code": 1000001,
"partyCode": 100389,
"siteCode": 100001,
"ownerCode": "1000001",
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "1000001",
"vrn": "1000001",
"make": "VOLVO",
"model": "FH16",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001,
"createdDate": "2024-12-27T12:23:23",
"lastModifiedDate": "2024-12-27T12:23:23",
"lastModifiedBy": "user"
}

Update vehicle state by vehicleCode

Update the state of a vehicle using its code

Authorizations:

(OAuth2ApiKeyAuth)

path Parameters

vehicleCode

required

integer <int32> (VehicleCodeParam)

Example: 2

Targeted vehicle code

Request Body schema: application/json

state

required

integer <int32> (StateCode)

Code of the state

Responses

Request samples

Payload

Content type

application/json

{"state": 100002
}

Response samples

200
400
404
500

Content type

application/json

{"state": "100001"
}

Update a vehicle

Update vehicle by vehicleCode

Authorizations:

(OAuth2ApiKeyAuth)

path Parameters

vehicleCode

required

integer <int32> (VehicleCodeParam)

Example: 2

Targeted vehicle code

Request Body schema: application/json

partyCode	integer <int64> (PartyCode) Party code of the vehicle
siteCode	integer <int64> (SiteCode) Site code of the vehicle
active	boolean (Active) Default: true true if vehicle is active
customerVehicleReference	string <= 255 characters Customer Vehicle Reference
registrationNumber required	string (RegistrationNumber) <= 255 characters Vehicle registration number
registrationDate	string <date> (RegistrationDate) Vehicle registration date
category	string (CategoryName) <= 255 characters Category name
type	string (Type) <= 255 characters Type of the vehicle
vin	string (VIN) <= 255 characters Vehicle Identification Number
vrn	string (VRN) <= 255 characters Vehicle Registration Number
make	string (Make) <= 255 characters Vehicle make
model	string (Model) <= 255 characters Vehicle model
energy	string (Energy) <= 255 characters Vehicle energy
rimType	string <= 255 characters Rim Type
	Array of objects (AxleDTO) <= 1000 items
state	integer <int32> Link to the last inspection

Responses

Request samples

Payload

Content type

application/json

Update a vehicle with the given information

{"partyCode": 100001,
"siteCode": 100001,
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "DAF",
"model": "",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001
}

Response samples

200
401
404
409
500

Content type

application/json

{"code": 1000003,
"partyCode": "100001",
"siteCode": "100001",
"active": true,
"customerVehicleReference": "1040",
"registrationNumber": "AA-123-AA",
"registrationDate": "2024-01-01",
"category": "TRUCK",
"type": "TRACTOR_UNIT",
"vin": "",
"vrn": "",
"make": "DAF",
"model": "",
"energy": "PETROL",
"rimType": "ALUMINIUM",
"axles": [{"position": 1,
"type": "STEERING",
"wheelOffset": 120,
"defaultTyreDimension": "385/55R22.5",
"recommendedPressure": "9.0",
"recommendedPressureUOM": "Bar",
"wheelNumber": 2
}
],
"state": 100001,
"lastModifiedDate": "2025-05-16T15:55:06"
}

Makes

Makes operation with all operation types

Get makes

Get list of makes

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

typeCode	string (TypeCodeQueryParam) <= 255 characters Example: typeCode=Ford Trucks TypeCode to find corresponding makes
withTypes	boolean (WithTypesQueryParam) Default: false Example: withTypes=false To include associated vehicle types in the results

Responses

Response samples

200
400
401
500

Content type

application/json

[{"code": "FORD_TRUCKS",
"label": "Ford Trucks",
"typeCodes": ["TRACTOR_UNIT",
"RIGID",
"BUS"
]
}
]

Energies

Makes operation with all operation types

Get Energies

Get list of energies

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

language	string (LanguageQueryParam) <= 255 characters Example: language=fr-FR Language using ISO 639 and ISO 3166
typeCode	string (TypeCodeQueryParam) <= 255 characters Example: typeCode=Ford Trucks Filters energies by a specific vehicle type code
withTypes	boolean (WithTypesQueryParam) Default: false Example: withTypes=false To include associated vehicle types in the results

Responses

Response samples

200
400
401
500

Content type

application/json

[{"code": "BEV",
"name": "Electrical vehicle",
"typeCodes": ["TRACTOR_UNIT",
"RIGID",
"BUS"
]
}
]

Types

Types operation with all operation types

Get types

Retrieve vehicle category types

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

categoryCode	string <= 255 characters Example: categoryCode=indus Filters types by a specific vehicle category code
language	string (LanguageQueryParam) <= 255 characters Example: language=fr-FR Language using ISO 639 and ISO 3166
withCategories	boolean (WithCategoriesQueryParam) Default: false Example: withCategories=false To include associated vehicle categories in the results

Responses

Response samples

200
400
401
500

Content type

application/json

[{"code": "TRACTOR_UNIT",
"name": "Tractor Unit",
"categoryCodes": ["TRUCK"
]
}
]

AxleConfigurations

Axle configurations operation with all operation types

Get Axle Configurations

Get list of axle configurations

Authorizations:

(OAuth2ApiKeyAuth)

query Parameters

typeCode	string (TypeCodeQueryParam) <= 255 characters Example: typeCode=Ford Trucks TypeCode to find corresponding axle configurations
withTypes	boolean (WithTypesQueryParam) Default: false Example: withTypes=false To include associated vehicle types in the results

Responses

Response samples

200
400
401
500

Content type

application/json

[{"code": 100000,
"axles": [{"position": 1,
"type": "STEERING",
"wheelNumber": 2
},
{"position": 2,
"type": "CARRY",
"wheelNumber": 4
}
],
"typeCodes": ["TRACTOR_UNIT",
"RIGID",
"BUS"
]
}
]

language	string (LanguageQueryParam) <= 255 characters Example: language=fr-FR Language using ISO 639 and ISO 3166
name	string <= 255 characters Example: name=indus Name to find corresponding categories

Vehicle API - Apigee (1.2.0)

Authentication & Authorization

Vehicles

Create a vehicle

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Get vehicles data

Authorizations:

query Parameters

Responses

Response samples

Create vehicles data

Authorizations:

Request Body schema: application/json

Responses

Request samples

Response samples

Get tyre options for a vehicle

Authorizations:

path Parameters

Responses

Response samples

Get vehicles states

Authorizations:

query Parameters

Responses

Response samples

Get site vehicle

Authorizations:

path Parameters

Responses

Response samples

Quick search vehicles data

Authorizations:

query Parameters

Responses

Response samples

Get a vehicle

Authorizations:

path Parameters

Responses

Response samples

Update vehicle state by vehicleCode

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update a vehicle

Authorizations:

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Makes

Get makes

Authorizations:

query Parameters

Responses

Response samples

Energies

Get Energies

Authorizations:

query Parameters

Responses

Response samples

Categories

Get categories

Authorizations:

query Parameters

Responses

Response samples

Types

Get types

Authorizations: