Get products of car

GET

/cars/{carId}/products

const url = 'https://api-uat.flinkey.de/v3/cars/1/products';
const options = {
  method: 'GET',
  headers: {
    'Customer-ID': 'example',
    'flinkey-API-Key': '<flinkey-API-Key>',
    Authorization: 'Bearer <token>'
  }
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api-uat.flinkey.de/v3/cars/1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Validation notes

The base request returned 200 OK with a direct product array.
$top=0, $skip=1 and a non-matching $filter returned 200 OK with an empty array, proving that those options are effective.
$orderby was accepted. Its visible sorting effect could not be observed with one returned product.
$count=true was accepted but returned neither an OData wrapper nor @odata.count.
A known car without assigned products returned 404 Not Found with "No products are assigned to this car.", not 200 OK with an empty array.

Authorizations

apiKey
bearerAuth

Parameters

Path Parameters

carId

required

integer

Database ID of the car

Header Parameters

Customer-ID

required

string

Responses

200

Installed products returned as a direct JSON array

application/json

Array<object>

object

integer

uniqueId

string

serialNumber

string

sapNumber

string

dongleTerminationTimeStamp

null

type

string

carId

integer

Example

[
  {
    "id": 123,
    "uniqueId": "PU-2024-00001",
    "serialNumber": "SN-100200300",
    "sapNumber": "SAP-400500",
    "dongleTerminationTimeStamp": null,
    "type": "flinkey Box",
    "carId": 456
  }
]

401

Credentials or token are invalid

404

Customer context or car was not found, or the known car has no assigned products. The observed no-product response was “No products are assigned to this car.”

500

Server-side error