Powered by Redocly

Applications

The product catalog contains applications which are described here. Only enabled applications are available on a ticket.

Application

An application contains the information for a product on a vehicle within your product catalog.

product_id
string <uuid>

The identifier of the product.

vehicle_model_id
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

updated_at
string or null <date-time>

Date-time on which the application was last updated, if at all.

{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve all applications

Returns a list of your product catalog applications. The applications are returned sorted by their product identifier, in descending order.

SecurityOAuth2
Request
query Parameters
enabled
boolean

Filter applications by enabled status.

insourceable
boolean

Filter applications by insourceable status.

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 applications by operator_only status.

outsource_provider_id
string <uuid>

Filter applications by outsource provider identifier.

outsourceable_to
string <uuid>

Filter applications one those that could be outsourced to the provider with this identifier.

product_id
string <uuid>

Filter applications by product_id.

updated_after
string <date-time>

Return only applications that were updated after this date-time.

vehicle_model_id
integer

Filter applications 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 (Application) >= 0 items

List of product applications.

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

The identifier of the product.

vehicle_model_id
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

updated_at
string or null <date-time>

Date-time on which the application was last updated, if at all.

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

Add an application

Add a product catalog application.

SecurityOAuth2
Request
Request Body schema: application/json
required

The product catalog application you wish to add.

product_id
required
string <uuid>

The identifier of the product.

vehicle_model_id
required
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

The identifier of the product.

vehicle_model_id
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

updated_at
string or null <date-time>

Date-time on which the application was last updated, if at all.

default

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

post/v2/product-catalog/applications
Request samples
application/json
{
  • "product_id": null,
  • "vehicle_model_id": null,
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93"
}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an application

Retrieve a single product catalog application by its identifier.

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

The identifier of the product for which to retrieve the application.

vehicle-model-id
required
integer <int64>

The identifier of the vehicle model for which to retrieve the application.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

The identifier of the product.

vehicle_model_id
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

updated_at
string or null <date-time>

Date-time on which the application was last updated, if at all.

default

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

get/v2/product-catalog/applications/{product-id}/{vehicle-model-id}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update an application

Update a single product catalog application by its identifier.

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

The identifier of the product for which to retrieve the application.

vehicle-model-id
required
integer <int64>

The identifier of the vehicle model for which to retrieve the application.

Request Body schema: application/json
required

The product catalog application you want to update.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

Responses
200

Successful response.

Response Schema: application/json
product_id
string <uuid>

The identifier of the product.

vehicle_model_id
integer

The identifier of the vehicle model.

enabled
required
boolean

Whether the application is enabled.

required
object (Money)

The gross price of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

insourceable
required
boolean

Whether the application is insourceable.

operator_only
required
boolean

Whether the application is only available for an operator.

required
object (Money)

The original equipment service fee of the application.

amount
required
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

outsource_provider_id
string or null <uuid>

Outsource provider identifier, if set and available.

updated_at
string or null <date-time>

Date-time on which the application was last updated, if at all.

default

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

put/v2/product-catalog/applications/{product-id}/{vehicle-model-id}
Request samples
application/json
{
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93"
}
Response samples
application/json
{
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "enabled": true,
  • "gross_price": {
    },
  • "insourceable": true,
  • "operator_only": true,
  • "original_equipment_service_fee": {
    },
  • "outsource_provider_id": "bb1d5cca-3595-41db-afc4-9023f6904f93",
  • "updated_at": "2019-08-24T14:15:22Z"
}
➔ Next to Outsource applications