Powered by Redocly

Outsource applications

Services can be outsourced to other providers. An operator at a partnered provider will execute the service on the vehicle for you when a service is outsourced. Different outsource applications represent the potential options available at partnered providers and include pricing details.

Outsource application

provider_id
string <uuid>

The identifier of the provider of this outsource application.

product_id
string <uuid>

The identifier of the product of this outsource application.

vehicle_model_id
integer

The identifier of the vehicle model of this outsource application.

object (Money)

The discount that applies to this product for this vehicle model when outsourcing to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The gross price to pay to the provider when outsourcing this product for this vehicle model to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The original equipment service fee to pay to the provider when outsourcing this product for this vehicle model to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

updated_at
string or null <date-time>

Date and time of last update.

{
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "discount": {
    },
  • "gross_price": {
    },
  • "original_equipment_service_fee": {
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}

Retrieve all outsource applications

Retrieve a list of available outsource applications. Provide additional filters to retrieve the possible outsource applications to one or more providers, a product or a vehicle model. Combinations of these filters are also possible.

SecurityApiKey and OAuth2
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 outsource applications by product_id.

provider_id
Array of strings <uuid> non-empty unique

Filter outsource applications by one or more provider's identifiers. The filter will be applied as a logical "OR".

Example: provider_id=0d012afa-f885-4e65-aeca-37e27701e2d1,fe3d49af-4061-436b-ae60-f7044f252a44
updated_after
string <date-time>

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

vehicle_model_id
integer

Filter outsource 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 (Outsource application) >= 0 items

List of outsource applications.

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

The identifier of the provider of this outsource application.

product_id
string <uuid>

The identifier of the product of this outsource application.

vehicle_model_id
integer

The identifier of the vehicle model of this outsource application.

object (Money)

The discount that applies to this product for this vehicle model when outsourcing to this provider.

object (Money)

The gross price to pay to the provider when outsourcing this product for this vehicle model to this provider.

object (Money)

The original equipment service fee to pay to the provider when outsourcing this product for this vehicle model to this provider.

updated_at
string or null <date-time>

Date and time of last update.

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

Retrieve outsource application

Retrieve a single outsource application by its identifier.

SecurityApiKey and OAuth2
Request
path Parameters
provider-id
required
string

The identifier of the provider for which you want to retrieve the outsource application.

product-id
required
string <uuid>

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

vehicle-model-id
required
integer <int64>

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

Responses
200

Successful response.

Response Schema: application/json
provider_id
string <uuid>

The identifier of the provider of this outsource application.

product_id
string <uuid>

The identifier of the product of this outsource application.

vehicle_model_id
integer

The identifier of the vehicle model of this outsource application.

object (Money)

The discount that applies to this product for this vehicle model when outsourcing to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The gross price to pay to the provider when outsourcing this product for this vehicle model to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

object (Money)

The original equipment service fee to pay to the provider when outsourcing this product for this vehicle model to this provider.

amount
number <float> >= 0

The monetary amount.

currency
string <iso-4217>

The currency of the monetary amount.

updated_at
string or null <date-time>

Date and time of last update.

default

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

get/v2/product-catalog/outsource-applications/{provider-id}/{product-id}/{vehicle-model-id}
Response samples
application/json
{
  • "provider_id": "fe3d49af-4061-436b-ae60-f7044f252a44",
  • "product_id": "0d012afa-f885-4e65-aeca-37e27701e2d1",
  • "vehicle_model_id": 0,
  • "discount": {
    },
  • "gross_price": {
    },
  • "original_equipment_service_fee": {
    },
  • "updated_at": "2019-08-24T14:15:22Z"
}
➔ Next to Price list codes