Powered by Redocly

Products

Products represent the services that you can configure within your product catalog.

Product

A product describes the outline of the necessary read and/or write operations within a vehicle's digital systems to provide a desired outcome.

id
string <uuid>

Product identifier.

enabled
boolean

Whether the product is enabled. A disabled product can not be added to a ticket.

name
string [ 1 .. 255 ] characters

Name of product in the requested language.

product_number
string

Product number.

type
string

The type of product.

Enum Value Description
base

Base products are available to all service providers and can be used with in- and outsourcing

custom

Custom products are only available within your portal and cannot be using with in- or outsourcing

voucher

Product with this type is used to provide the discount of a voucher on a ticket

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "name": "Remote Diagnostic Support",
  • "product_number": "0000001",
  • "type": "base"
}

Retrieve products

Retrieve a list of products.

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_number
string

Filter products by product number.

Example: product_number=0000001
type
Array of strings (type) non-empty unique
Default: ["base","custom","voucher"]

Filter products by one or more types.

Items Enum Value Description
base

Base products are available to all service providers and can be used with in- and outsourcing

custom

Custom products are only available within your portal and cannot be using with in- or outsourcing

voucher

Product with this type is used to provide the discount of a voucher on a ticket

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.

type
Array of strings (type) non-empty unique
Default: ["base","custom","voucher"]

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

Items Enum Value Description
base

Base products are available to all service providers and can be used with in- and outsourcing

custom

Custom products are only available within your portal and cannot be using with in- or outsourcing

voucher

Product with this type is used to provide the discount of a voucher on a ticket

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

List of products.

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

Product identifier.

enabled
boolean

Whether the product is enabled. A disabled product can not be added to a ticket.

name
string [ 1 .. 255 ] characters

Name of product in the requested language.

product_number
string

Product number.

type
string

The type of product.

Enum Value Description
base

Base products are available to all service providers and can be used with in- and outsourcing

custom

Custom products are only available within your portal and cannot be using with in- or outsourcing

voucher

Product with this type is used to provide the discount of a voucher on a ticket

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/products
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve single product

Retrieve a single product by its identifier.

SecurityOAuth2
Request
path Parameters
product-id
required
string <uuid>

The identifier of the product you want to operate on.

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
id
string <uuid>

Product identifier.

enabled
boolean

Whether the product is enabled. A disabled product can not be added to a ticket.

name
string [ 1 .. 255 ] characters

Name of product in the requested language.

product_number
string

Product number.

type
string

The type of product.

Enum Value Description
base

Base products are available to all service providers and can be used with in- and outsourcing

custom

Custom products are only available within your portal and cannot be using with in- or outsourcing

voucher

Product with this type is used to provide the discount of a voucher on a ticket

default

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

get/v2/products/products/{product-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "enabled": true,
  • "name": "Remote Diagnostic Support",
  • "product_number": "0000001",
  • "type": "base"
}
➔ Next to Product alternative names