Services

Services represent applicable products to specific vehicle models and contain pricing details for specified customer scenarios.

Service

A service represents a product that is applicable to a specific vehicle model and carries pricing information for its execution. Services are only available for selection when they have been configured as enabled in the corresponding product catalog Application.

product_id

string <uuid>

The identifier of the product of this service.

vehicle_model_id

integer

The identifier of the vehicle model of this service.

object (Money)

The discount a customer receives for this application, based on the default price list code of its branding profile or provided price list code.

amount	number <float> >= 0 The monetary amount.
currency	string <iso-4217> The currency of the monetary amount.

object (Money)

The gross price that a customer needs to pay for this application, based on the provided or default branding profile.

amount	number <float> >= 0 The monetary amount.
currency	string <iso-4217> The currency of the monetary amount.

operator_only

boolean

Whether the application is only available for an operator.

object (Money)

The original equipment service fee a customer has to pay for this application.

amount	number <float> >= 0 The monetary amount.
currency	string <iso-4217> The currency of the monetary amount.

{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"vehicle_model_id": 0,
"discount": {"amount": 0,
"currency": "EUR"
},
"gross_price": {"amount": 0,
"currency": "EUR"
},
"operator_only": true,
"original_equipment_service_fee": {"amount": 0,
"currency": "EUR"
}
}

Retrieve all services

Retrieve a list of available services. Provide additional filters to retrieve them for a specific product or a vehicle model. Provide a price list code and/or branding profile to retrieve pricing details for specific customer scenarios.

SecurityOAuth2

Request

query Parameters

branding_profile_id	string <uuid> The branding profile to use for the price calculation. Defaults to the branding profile of the authenticated API client or the default branding profile of the provider.
limit	integer <int32> [ 0 .. 1000 ] Default: 25 Limits the amount of resources in result.
offset	integer <int64> >= 0 Default: 0 Offset of resources in result.
operator_only	boolean Filter services by operator_only status.
price_list_code_id	string <uuid> The price list code to use for the price calculation. Defaults to the price list code of the used branding profile.
product_id	string <uuid> Filter services by product_id.
vehicle_model_id	integer Filter services by vehicle_model_id.

Responses

200

Successful response.

Response Schema: application/json

object >= 0 properties

Applied query parameters, including defaults.

limit	integer <int32> [ 0 .. 1000 ] Default: 25 The applied value of the limit query parameter on the resources in result.
offset	integer <int64> >= 0 Default: 0 The applied value of the offset query parameter on the resources in result.
property name* additional property	any

Array of objects (Service) >= 0 items

List of services.

Array (>= 0 items)

product_id	string <uuid> The identifier of the product of this service.
vehicle_model_id	integer The identifier of the vehicle model of this service.
	object (Money) The discount a customer receives for this application, based on the default price list code of its branding profile or provided price list code.
	object (Money) The gross price that a customer needs to pay for this application, based on the provided or default branding profile.
operator_only	boolean Whether the application is only available for an operator.
	object (Money) The original equipment service fee a customer has to pay for this application.

total

integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/product-catalog/services

Response samples

200
default

application/json

{"query": {"limit": 25
},
"result": [{"product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
"vehicle_model_id": 0,
"discount": {"amount": 0,
"currency": "EUR"
},
"gross_price": {"amount": 0,
"currency": "EUR"
},
"operator_only": true,
"original_equipment_service_fee": {"amount": 0,
"currency": "EUR"
}
}
],
"total": 4
}

➔ Next to Price list codes