Bulk Vin Connect

curl --request POST \
  --url https://api.volteras.com/v1/vehicles/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vehicles": [
    {
      "vin": "<string>",
      "make": "BMW",
      "region": "NORTH_AMERICA",
      "registrationPlate": "<string>",
      "model": "<string>",
      "modelYear": 123,
      "batteryCapacity": 123,
      "horsepower": 123,
      "generation": "<string>",
      "wltpRange": 123,
      "countryCode": "<string>",
      "tags": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
'

{
  "id": "<string>",
  "status": "CREATED",
  "createdAt": "2023-11-07T05:31:56Z"
}

POST

vehicles

connect

Bulk Vin Connect

curl --request POST \
  --url https://api.volteras.com/v1/vehicles/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "vehicles": [
    {
      "vin": "<string>",
      "make": "BMW",
      "region": "NORTH_AMERICA",
      "registrationPlate": "<string>",
      "model": "<string>",
      "modelYear": 123,
      "batteryCapacity": 123,
      "horsepower": 123,
      "generation": "<string>",
      "wltpRange": 123,
      "countryCode": "<string>",
      "tags": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
'

{
  "id": "<string>",
  "status": "CREATED",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request model to connect multiple VINs

vehicles

ConnectVehicleRequest · object[]

required

The vehicles to connect

Maximum array length: 100

Show child attributes

vehicles.vin

string

required

Vehicle identification number. Unique identifier for the vehicle.

vehicles.make

enum<string>

required

Manufacturer of the vehicle

Available options:

BMW,

MINI,

HYUNDAI,

KIA,

TESLA,

AUDI,

SEAT,

SKODA,

VOLKSWAGEN,

CUPRA,

VOLVO,

ENPHASE,

MERCEDES,

TESLA ENERGY,

ABARTH,

ALFA ROMEO,

CHRYSLER,

CITROEN,

DODGE,

DS AUTOMOBILES,

FIAT,

JEEP,

LANCIA,

MASERATI,

OPEL,

PEUGEOT,

RAM,

VAUXHALL,

STELLANTIS,

FORD,

NISSAN,

POLESTAR

vehicles.region

enum<string>

required

Defines the geographic region for the vehicle, directly influencing which OEM-specific API endpoint will be used for the connection. For OEMs with distinct APIs across regions, this setting ensures the correct regional API is utilized.

Available options:

NORTH_AMERICA,

EUROPE

vehicles.registrationPlate

string | null

Vehicle registration plate

vehicles.model

string | null

Vehicle model

vehicles.modelYear

integer | null

Vehicle model year (the year the model was released, not the year of manufacture)

vehicles.batteryCapacity

number | null

Nominal (IE when manufactured) battery capacity in kWh of the vehicle

vehicles.horsepower

integer | null

Vehicle horsepower

vehicles.generation

string | null

Vehicle generation

vehicles.wltpRange

number | null

WLTP range of the vehicle in km

vehicles.countryCode

string | null

ISO two-character country code of the vehicle, used for retrieving vehicle specifications data for the vehicle. If not populated, will use the default setting (if set).

vehicles.tags

Tag · object[] | null

Tags to associate with the vehicle, for example IDs you want to associate with it, that will then be returned when you fetch the vehicle and can be used to filter vehicles in the list vehicle endpoint.

Show child attributes

vehicles.tags.key

string

required

Maximum string length: 150

vehicles.tags.value

string

required

Maximum string length: 150

Response

202 - application/json

Successful Response

Response for async bulk vehicle upload endpoint on connect-api

string

required

status

enum<string>

required

Available options:

CREATED,

PROCESSING,

COMPLETED,

FAILED

createdAt

string<date-time>

required

Action Disconnect Bulk Vehicle Connect Group Status

⌘I

Authentication

Accounts

Vehicles

Vehicle Telemetry

Vehicle Charging History

Vehicle Range

Vehicle State of Health

Vehicle Command Executions

Vehicle Alerts

Errors

Vehicle Connection

Vehicle Services

Vehicle Tires

Vehicle Manufacturer Alerts

Vehicle Eligibility

Rate Limit

Vehicle Charging Schedule

Vehicle Listening

Tags

Bulk Vin Connect

Authorizations

Body

Response