Powered by Redocly

Product prerequisites

Product prerequisites are essential checks or conditions that must be fulfilled before a ticket associated with a specific product can be created. These prerequisites may vary depending on the vehicle.

Product Prerequisite

A product prerequisite is a mandatory condition or requirement that must be fulfilled before a ticket can be created. These prerequisites may vary depending on the specific product and vehicle combination.

id
integer

Identifier of the product prerequisite.

description
string

The description of the product prerequisite.

name
string

The name of the product prerequisite.

question
string

The question of prerequisite check.

required
boolean

True if the answer on the prerequisite is required.

type
string

Type of the prerequisite.

Enum Value Description
boolean

The customer needs to answer with true or false.

checkbox

The customer needs to answer with true or false.

text

The customer can fill in text as the answer.

{
  • "id": 0,
  • "description": "Check for battery",
  • "name": "Battery charger",
  • "question": "Did you secure the vehicle's power supply?",
  • "required": true,
  • "type": "boolean"
}

Retrieve product prerequisites

Retrieve a list of prerequisites for one or more products. Prerequisites may vary depending on the vehicle.

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
required
Array of strings <uuid> non-empty

List of product identifiers to retrieve prerequisites for.

Example: product_id=1af5a685-9f58-4784-b4d9-1b217ae29751,d46b1119-4bc7-488b-9014-e32efecf8281,5f44cdb2-bc21-46cc-a1e5-c5b5c7266ee4
vehicle_model_id
required
integer <int64>

Filter product prerequisites 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.

product_id
Array of strings <uuid> non-empty

The applied value of the product_id query parameter on the resources in result.

vehicle_model_id
integer <int64>

The applied value of the vehicle_model_id query parameter on the resources in result.

property name*
additional property
any
Array of objects (Product Prerequisite) >= 0 items

List of product prerequisites.

Array (>= 0 items)
id
integer

Identifier of the product prerequisite.

description
string

The description of the product prerequisite.

name
string

The name of the product prerequisite.

question
string

The question of prerequisite check.

required
boolean

True if the answer on the prerequisite is required.

type
string

Type of the prerequisite.

Enum Value Description
boolean

The customer needs to answer with true or false.

checkbox

The customer needs to answer with true or false.

text

The customer can fill in text as the answer.

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