APIs/Connected Vehicle APIVersion 2

Engine

Get engine status

Vehicle’s latest engine status value.

get

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

Scopes

openid
conve:engine_status

Headers

Key	Description
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 for the queried vehicle data.

Field	Description
Field timestamp	Description Timestamp in ISO-8601 format when the value has been last retrieved from the vehicle.
Field engineStatus	Description The latest retrieved engine-status value. Possible values: STOPPED, RUNNING.

Examples

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

Start engine

Only available for classic cars. What we mean are cars without Android-based infotainment system. Google, Android, and other Google trademarks, are property of Google LLC.

Command used to start the engine of the vehicle. To check which vehicles support this function please call List commands.

post

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

Scopes

openid
conve:engine_start_stop

Headers

Key	Description
Key content-type	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.

Request body

The request body data needed to perform the invocation command is runtimeMinutes. This is the time in minutes engine will be running. Is required for engine start and can maximum be set to 15 minutes.

Response body

The response’s data node provides the details for the queried request.

Field	Description
Field vin	Description Vehicle identification number
Field statusCode	Description Response status code.
Field invokeStatus	Description Invoke status of the request sent to the vehicle. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, DELIVERED, CAR_ERROR, NOT_ALLOWED_PRIVACY_ENABLED, NOT_ALLOWED_WRONG_USAGE_MODE.
Field message	Description Extra information from the response.

Examples

curl -X POST 'https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/commands/engine-start' \
  -H 'content-type: application/json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>' \
  -d '{"runtimeMinutes":10}'

Body

{
  "runtimeMinutes": 10
}

Stop engine

Only available for classic cars. What we mean are cars without Android-based infotainment system. Google, Android, and other Google trademarks, are property of Google LLC.

Command used to stop the engine of the vehicle. To check which vehicles support this function please call List commands.

post

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

Scopes

openid
conve:engine_start_stop

Headers

Key	Description
Key content-type	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.

Request body

The request body data needed to perform the invocation command is NONE.

Response body

The response’s data node provides the details for the queried request.

Field	Description
Field vin	Description Vehicle identification number
Field statusCode	Description Response status code.
Field invokeStatus	Description Invoke status of the request sent to the vehicle. Possible values: RUNNING, WAITING, COMPLETED, REJECTED, UNKNOWN, TIMEOUT, CONNECTION_FAILURE, VEHICLE_IN_SLEEP, UNLOCK_TIME_FRAME_PASSED, UNABLE_TO_LOCK_DOOR_OPEN, DELIVERED, DELIVERED, CAR_ERROR, NOT_ALLOWED_PRIVACY_ENABLED, NOT_ALLOWED_WRONG_USAGE_MODE.
Field message	Description Extra information from the response.

Examples

curl -X POST 'https://api.volvocars.com/connected-vehicle/v2/vehicles/{vin}/commands/engine-stop' \
  -H 'content-type: application/json' \
  -H 'authorization: Bearer <your-access-token>' \
  -H 'vcc-api-key: <your-vcc-api-key>'