APIs/Connected Vehicle APIVersion 2
APIs/Connected Vehicle APIVersion 2

Vehicle

List vehicles

Endpoint used to get a list of the vehicles which have active relation to the Volvo-id account for whom the request is executed.

get

https://api.volvocars.com/connected-vehicle/v2/vehicles

Scopes

  • openid

  • conve:vehicle_relation

Headers

KeyDescription

Key

accept

Description

The mediatype of what should be returned. The valid values are: application/json

Key

authorization

Description

The access token issued by Volvo ID identity system.

Key

vcc-api-key

Description

Your application’s VCC API Key.

All these header values are mandatory. They must exist in every request.

Response body

The response’s data node provides a list of the vehicles fitting to the function’s criteria

FieldDescription

Field

vin

Description

17 letter vehicle identification number.

Examples

curl -X GET 'https://api.volvocars.com/connected-vehicle/v2/vehicles' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'

Get vehicle details

Endpoint used to get some generic properties of the vehicle such as model, model year, colour etc. together with one exterior and one interior image url.

get

https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}

Scopes

  • openid

  • conve:vehicle_relation

Headers

KeyDescription

Key

accept

Description

The mediatype of what should be returned. The valid values are: application/json

Key

authorization

Description

The access token issued by Volvo ID identity system.

Key

vcc-api-key

Description

Your application’s VCC API Key.

All these header values are mandatory. They must exist in every request.

Response body

The response’s data node provides the details pre-defined in the endpoint’s specifications.

In this table we talk about Electric Hybrids. What we mean are vehicles with one or more electric motors.

FieldDescription

Field

vin

Description

17 letter vehicle identification number.

Field

modelYear

Description

Vehicle’s model year.

Field

gearbox

Description

Text describing the vehicle’s gearbox. Possible values: AUTOMATIC, MANUAL.

Field

fuelType

Description

Fuel type, possible values: DIESEL, PETROL, PETROL/ELECTRIC, ELECTRIC, NONE.

Field

externalColour

Description

Vehicle’s exterior colour.

Field

batteryCapacityKWH

Description

Vehicle’s battery capacity presented in KiloWattHours. Only available for Electric and Electric Hybrids.

Field

images.exteriorImageUrl

Description

A url which provides a generic image of the vehicle’s exterior view. This url has a validity period. It should not be cached for a further usage.

Field

images.interiorImageUrl

Description

A url which provides a generic image of the vehicle’s interior view. This url has a validity period. It should not be cached for a further usage.

Field

descriptions.model

Description

A short text describing the model name / code.

Field

descriptions.steering

Description

Vehicle’s steering wheel description.

Examples

curl -X GET 'https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}' \
  -H 'accept: application/json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'

/