Get product of service

GET

/services/{serviceId}/products

const url = 'https://api-uat.flinkey.de/v3/services/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/services/1/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Customer-ID: example' \
  --header 'flinkey-API-Key: <flinkey-API-Key>'

Purpose

Retrieve the product assigned to one specific service in the selected customer context.

A service represents the contract or service relationship associated with a flinkey product.

A product represents a flinkey hardware product assigned to the customer context.

Use this operation for operational lookup, reconciliation and support workflows where the relationship between a service and a product must be inspected.

When to use this operation

Use this operation when the partner backend needs to retrieve the product assigned to a specific service.

Typical situations:

checking which product is assigned to a service,
validating service-to-product assignment,
retrieving product serial number from a known service reference,
retrieving product SAP number from a known service reference,
identifying product type,
supporting operational troubleshooting,
reconciling service and product state with partner or support records.

For standard access flows, the partner backend should usually work with Car, User and Assignment.

Use this operation only where service-level or product-level lookup is required.

Validation notes

The base request returned 200 OK with one product object despite the plural /products path.
The returned product ID matched the productId of the active service; the additional carId matched the prevalidated vehicle relation.
dongleTerminationTimeStamp remained present as a functionally obsolete legacy field with null.
Collection-style OData options returned 400 Bad Request because the resource is not a collection.
When the service had no assigned product, the operation returned 404 Not Found with "No product can be found that is assigned to this serviceId.".

Async behavior

Synchronous.

The product assigned to the service is returned directly in the API response.

Webhook result

No.

This operation does not produce a webhook result.

Security notes

Never log:

flinkey-API-Key,
bearer token,
full request headers.

Service and product identifiers are environment-specific.

Do not mix UAT and PROD service IDs or product IDs.

Use placeholders in documentation, examples, screenshots and AI prompts.

For standard partner integrations, the mobile app must not receive API Manager credentials, backend bearer tokens or the flinkey-API-Key.

Authorizations

apiKey
bearerAuth

Parameters

Path Parameters

serviceId

required

number

Database ID of the service

Header Parameters

Customer-ID

required

string

Customer database ID

Responses

200

Product assigned to the service was retrieved successfully

application/json

object

Product database ID

number

uniqueId

Unique product identifier

string

serialNumber

Product serial number

string

sapNumber

SAP number

string

dongleTerminationTimeStamp

Functionally obsolete legacy field from the former virtual telematics-dongle connection; do not use for integration logic

string | null

type

Product type, for example flinkey Box or flinkey IQ

string

carId

Database ID of the assigned car, or null when no car is assigned

number | null

Example

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

401

Invalid subscription key or missing / invalid access token

Recommended handling: Check flinkey-API-Key, bearer token and environment configuration

404

API Manager, customer context, service or assigned product was not found. The observed missing-relation response was “No product can be found that is assigned to this serviceId.”

Recommended handling: Check credentials, Customer-ID, local serviceId reference and service-to-product assignment

500

Server-side error

Recommended handling: Retry later if appropriate and escalate if persistent