Products

Products and product grouping

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/product-groups

Get the Product groups

Product groups are the first layer in the hiarchy of grouping products.

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
vehicle_model_id
required
integer

ID of the vehicle model to get product groups for

Example: vehicle_model_id=332423
vehicle_model_variant_id
required
integer

ID of the vehicle model variant to get product groups for

Example: vehicle_model_variant_id=332423
Responses
200

Product Groups

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/product-groups
Response samples
application/json
{
  • "result": [
    ],
  • "total": 234,
  • "offset": 200,
  • "limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/product-bundles

Get the Product bundles for a specific product group

Bundle of products that have a similar goal

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
product_group_id
number <int32>

The ID of the product group.

Example: product_group_id=2691
vehicle_model_id
required
integer

ID of the vehicle model to get product bundles for

Example: vehicle_model_id=332423
vehicle_model_variant_id
required
integer

ID of the vehicle model variant to get product bundles for

Example: vehicle_model_variant_id=332423
Responses
200

Product bundles

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/product-bundles
Response samples
application/json
{
  • "result": [
    ],
  • "total": 234,
  • "offset": 200,
  • "limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/products

Get Products

Products are services offered by service providers to execute on a selected vehicle.

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
vehicle_model_id
required
integer

ID of the vehicle model to get products for

Example: vehicle_model_id=332423
vehicle_model_variant_id
required
integer

ID of the vehicle model variant to get products for

Example: vehicle_model_variant_id=332423
product_group_id
number <int32>

The ID of the product group. This parameter cannot be combined with product_bundle_id!

Example: product_group_id=2691
product_bundle_id
string <uuid>

The ID of the product bundle. This parameter cannot be combined with product_group_id!

Example: product_bundle_id=e51c66a6-096b-412c-bd94-8c04ded544d5
boolean or integer
Default: true

Return products with matching favorite flag

Responses
200

Products

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/products
Response samples
application/json
{
  • "result": [
    ],
  • "total": 234,
  • "offset": 200,
  • "limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/favorite-products

Add a product to the list of favorite products

By adding a product to the list of favorite products it is flagged as favorite and becomes available under the Favorites section of the customer portal.

SecurityOAuth2 or JifelineAuthorizer
Request
Request Body schema: application/json
required

The product to add to the list of favorite products.

id
integer

A unique ID of the product

item_number
string

A product's item number (SKU)

name
string

The name of the product

internal_name
string

Universal (internal, English) product name

description
string

The description of the product

is_favorite
boolean

Is product marked as favorite.

is_unattended
boolean

Is product executed by an unattended process.

object

Gross price for this product

object

Nett price for this product

object

Total discount for this product

object or null

Original equipment service fee applicable for this product, null if none applies

object
Deprecated

Product Price

Responses
204

Product has been added to the list of favorite products.

post/v1/favorite-products
Request samples
application/json
{
  • "id": 52351,
  • "item_number": 100022,
  • "name": "Remote Diagnostic Support",
  • "internal_name": "Airbag Module Replacement",
  • "description": "Remote diagnostic support session. Have you met the conditions for submitting this diagnosis ticket? You can find more information on our website.",
  • "is_favorite": true,
  • "is_unattended": true,
  • "gross_price": {
    },
  • "net_price": {
    },
  • "total_discount": {
    },
  • "original_equipment_service_fee": {
    },
  • "price": {
    }
}
Response samples
application/json
null

Options

Enable CORS by returning correct headers

SecurityNone
Request
path Parameters
id
required
string

Product ID

Responses
200

Enable CORS by returning correct headers

options/v1/favorite-products/{id}

Remove product from the list of favorite products

By removing the product from the list of favorite products it is no longer flagged as favorite or available under the Favorites section of the customer portal.

SecurityOAuth2 or JifelineAuthorizer
Request
path Parameters
id
required
string

Product ID

Responses
204

Product has been removed from list of favorite products.

delete/v1/favorite-products/{id}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/product-prerequisites

Get product prerequisites, the prerequisites are selected based on the products and vehicle type

Get product prerequisites

SecurityOAuth2 or JifelineAuthorizer
Request
query Parameters
vehicle_model_variant_id
required
number <int32>

Id of the vehicle model the product selected for.

Example: vehicle_model_variant_id=1480
vehicle_model_id
required
integer

ID of the vehicle model to get products for

Example: vehicle_model_id=332423
product_id
required
Array of integers non-empty

Product ID to get the prerequisites for.

Example: product_id=100593,200593,300593
Responses
200

Product requisites

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/product-prerequisites
Response samples
application/json
{
  • "result": [
    ],
  • "total": 234,
  • "offset": 200,
  • "limit": 20
}