Powered by Redocly

Product alternative names

Products can be named alternatively for different vehicles.

Product Alternative Name

By default, all product names for each vehicle are the same. If a product name is customized for a specific vehicle, we refer to this as the "alternative product name".

product_id
string <uuid>

Product identifier.

name
string [ 1 .. 255 ] characters

Alternative, vehicle specific, name of product in the requested language.

vehicle_make_id
integer <int64>

Vehicle make identifier.

vehicle_model_group_id
integer <int64>

Vehicle model group identifier.

vehicle_model_id
integer <int64>

Vehicle model identifier.

{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "name": "Remote Diagnostic Support",
  • "vehicle_make_id": 0,
  • "vehicle_model_group_id": 0,
  • "vehicle_model_id": 0
}

Retrieve product alternative names

Retrieve a list of alternative, vehicle specific, names for product.

SecurityOAuth2
Request
query Parameters
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.

product_id
string <uuid>

Filter product alternative names by product identifier.

vehicle_make_id
integer <int64>

Filter product alternative names by vehicle make identifier.

vehicle_model_group_id
integer <int64>

Filter product alternative names by vehicle model group identifier.

vehicle_model_id
integer <int64>

Filter product alternative names by vehicle model identifier.

header Parameters
Accept-Language
string
Default: en

Use this header to indicate the natural language and locale in which you want to receive translatable property values. Multiple preferences can be provided using a weighted qualifier. Properties that support translations will specify so in their description.

Examples:
fr-CH
Request for French (Switzerland) or, if not supported (in preferred order), French, English or German.
fr-CH,fr;q=0.9,en;q=0.8,de;q=0.7
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 (Product Alternative Name) >= 0 items

List of product alternative names.

Array (>= 0 items)
product_id
string <uuid>

Product identifier.

name
string [ 1 .. 255 ] characters

Alternative, vehicle specific, name of product in the requested language.

vehicle_make_id
integer <int64>

Vehicle make identifier.

vehicle_model_group_id
integer <int64>

Vehicle model group identifier.

vehicle_model_id
integer <int64>

Vehicle model identifier.

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/products/product-alternative-names
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}
➔ Next to Providers