Skip to content

Modules

Endpoints for managing minor features that are not directly related to the main endpoints.

Available modules:

  • Wishlist - Endpoints for managing wishlists
  • Vehicles - Endpoints for managing vehicles [PREVIEW]
Operations

List Vehicles [PREVIEW]

Request

This method allows the client to search for vehicles by a customer id

Example: B9012E40-1B08-4DC5-84F9-BB8E2653B2A6

The response sample below shows the default response, but depending on your configuration the API may return additional fields in the extendedProperties object.

Security
api_key
Path
customerIdstringrequired

The customer id

curl -i -X GET \
  'https://api.oculos.no/v4/modules/vehicles/customerId/{customerId}' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
Array [
idstring

Id of vehicle

Example:"B4B8DB75-517F-464F-8E0A-E30E969BDA8B"
registrationNumberstring

Registration number of the vehicle

Example:"AB12345"
vinstring

Vehicle Identification Number

Example:"TMBJC9NY3MF017111"
vehicleGroupstring

Group of the vehicle

Example:"PERSONBIL"
brandstring

Brand of the vehicle

Example:"SKODA"
lastInspectionDatestring, (date)

Date of the last inspection

Example:"2023-04-29"
nextInspectionDatestring, (date)

Date of the next inspection

Example:"2025-04-29"
lastOdometerStandnumber

Last recorded odometer stand

Example:null
lastRegistrationDatestring, (date)

Date of the last registration

Example:"2024-03-27"
firstRegistrationDatestring, (date)

Date of the first registration

Example:"2021-04-29"
extendedPropertiesobject

Additional properties depending on configuration

]
Response
[
  {
    "id": "B4B8DB75-517F-464F-8E0A-E30E969BDA8B",
    "registrationNumber": "AB12345",
    "vin": "TMBJC9NY3MF017111",
    "vehicleGroup": "PERSONBIL",
    "brand": "SKODA",
    "lastInspectionDate": "2023-04-29",
    "nextInspectionDate": "2025-04-29",
    "lastOdometerStand": null,
    "lastRegistrationDate": "2024-03-27",
    "firstRegistrationDate": "2021-04-29",
    "extendedProperties": { … }
  }
]