| POST | /v1/vehicle | Get Vehicle by Vin | Get Vehicle by Vin |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVehicleRequest:
vin: Optional[str] = None
include_allocated_to_order: bool = False
gssn: Optional[str] = None
is_one_admin: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Model:
id: int = 0
description: Optional[str] = None
display_name: Optional[str] = None
image_url_small: Optional[str] = None
image_url_medium: Optional[str] = None
image_url_large: Optional[str] = None
specialist: bool = False
priority: Optional[int] = None
exclude_from_online_showroom_filters: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BodyStyle:
id: int = 0
description: Optional[str] = None
models: Optional[List[Model]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Brand:
id: int = 0
description: Optional[str] = None
display_name: Optional[str] = None
body_styles: Optional[List[BodyStyle]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Engine:
id: Optional[int] = None
badge: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Media:
no_image: bool = False
main_image_url: Optional[str] = None
class OfferPriceProductType(str, Enum):
LIS_T__P_R_I_C_E = 'LIST_PRICE'
NUMBE_R__P_L_A_T_E__F_E_E = 'NUMBER_PLATE_FEE'
DELIVER_Y__C_H_A_R_G_E = 'DELIVERY_CHARGE'
FUE_L__C_H_A_R_G_E = 'FUEL_CHARGE'
MANUFACTURE_R__O_F_F_E_R = 'MANUFACTURER_OFFER'
PERSONALISE_D__M_O_N_E_Y_O_F_F_E_R = 'PERSONALISED_MONEYOFFER'
PERSONALISE_D__N_O_N_M_O_N_E_Y_O_F_F_E_R = 'PERSONALISED_NONMONEYOFFER'
PERSONALISE_D__N_O_N_M_O_N_E_Y_O_F_F_E_R__N_E_G = 'PERSONALISED_NONMONEYOFFER_NEG'
SERVICE = 'SERVICE'
SERVIC_E__N_E_G = 'SERVICE_NEG'
GOVERNMEN_T__G_R_A_N_T = 'GOVERNMENT_GRANT'
OUTRIGH_T__P_U_R_C_H_A_S_E__D_I_S_C_O_U_N_T = 'OUTRIGHT_PURCHASE_DISCOUNT'
VI_P__O_F_F_E_R = 'VIP_OFFER'
WALLBO_X__O_F_F_E_R = 'WALLBOX_OFFER'
WALLBO_X__O_F_F_E_R__N_E_G = 'WALLBOX_OFFER_NEG'
ROA_D__F_U_N_D__L_I_C_E_N_C_E = 'ROAD_FUND_LICENCE'
FIRS_T__R_E_G_I_S_T_R_A_T_I_O_N__F_E_E = 'FIRST_REGISTRATION_FEE'
NO_T__F_O_U_N_D = 'NOT_FOUND'
ACCESSOR_Y__O_F_F_E_R = 'ACCESSORY_OFFER'
ACCESSOR_Y__O_F_F_E_R__N_E_G = 'ACCESSORY_OFFER_NEG'
MOTABILIT_Y__D_I_S_C_O_U_N_T = 'MOTABILITY_DISCOUNT'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Price:
id: Optional[str] = None
description: Optional[str] = None
net: Decimal = decimal.Decimal(0)
vat: Decimal = decimal.Decimal(0)
gross: Decimal = decimal.Decimal(0)
product: Optional[OfferPriceProductType] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTime:
day: Optional[str] = None
open_from: Optional[str] = None
open_to: Optional[str] = None
special: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RetailerOpeningTimes:
new: List[RetailerOpeningTime] = field(default_factory=list)
used: List[RetailerOpeningTime] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Retailer:
id: int = 0
gssn_id: Optional[str] = None
description: Optional[str] = None
street: Optional[str] = None
city: Optional[str] = None
postcode: Optional[str] = None
google_map_postcode: Optional[str] = None
phone: Optional[str] = None
fax: Optional[str] = None
email: Optional[str] = None
website: Optional[str] = None
retailer_group_id: Optional[str] = None
retailer_group_name: Optional[str] = None
is_online: bool = False
is_new_car_retailer: bool = False
is_used_car_retailer: bool = False
is_central_retailer: bool = False
chat_enabled: bool = False
trade_in_enabled: bool = False
smart: bool = False
display_phone_number_new: Optional[str] = None
display_phone_number_used: Optional[str] = None
latitude: Decimal = decimal.Decimal(0)
longitude: Decimal = decimal.Decimal(0)
smart_description: Optional[str] = None
smart_website: Optional[str] = None
smart_phone: Optional[str] = None
legacy_id: Optional[str] = None
agent: bool = False
market_area_id: int = 0
digital_lounge_parent_gssn_id: Optional[str] = None
send_leads_to_digital_lounge_parent: bool = False
opening_times: Optional[RetailerOpeningTimes] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleConsumption:
id: int = 0
lkm: Decimal = decimal.Decimal(0)
mpg: Decimal = decimal.Decimal(0)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Equipment:
id: Optional[int] = None
code: Optional[str] = None
description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Equipmentv2(Equipment):
importance: int = 0
is_additional: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleEquipmentCategory:
order: int = 0
code: Optional[str] = None
description: Optional[str] = None
equipment: Optional[List[Equipmentv2]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleEmissionClass:
colour: Optional[str] = None
rating: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleAttribute:
description: Optional[str] = None
value: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleIntegratedServiceCareOption:
option_code: Optional[str] = None
b_m7_n_s_t: Optional[str] = None
full_model_year: Optional[str] = None
integrated_product_type: Optional[str] = None
customer_description: Optional[str] = None
one_agent_product_type: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleDetailDto:
body_style: Optional[str] = None
vin: Optional[str] = None
description: Optional[str] = None
colour: Optional[str] = None
colour_code: Optional[str] = None
colour_description: Optional[str] = None
colour_group: Optional[str] = None
model: Optional[str] = None
commission_number: Optional[str] = None
brand_id: Optional[int] = None
brand: Optional[Brand] = None
engine: Optional[Engine] = None
engine_badge: Optional[str] = None
media: Optional[Media] = None
line: Optional[str] = None
upholstery_code: Optional[str] = None
upholstery_type: Optional[str] = None
upholstery: Optional[str] = None
upholstery_description: Optional[str] = None
available_packages: List[str] = field(default_factory=list)
packages: List[str] = field(default_factory=list)
p11_d: Decimal = decimal.Decimal(0)
port_arrival_date: Optional[datetime.datetime] = None
prices: List[Price] = field(default_factory=list)
transmission_type: Optional[str] = None
fuel_type: Optional[str] = None
vehicle_class: Optional[str] = None
product_range: Optional[str] = None
vehicle_type: Optional[str] = None
emission: Optional[Decimal] = None
is_available_online: bool = False
under_offer: bool = False
is_excluded: bool = False
is_sellable: bool = False
on_hold: bool = False
electric_consumption: Optional[Decimal] = None
electric_range: Optional[Decimal] = None
image_url: Optional[str] = None
baumuster: Optional[str] = None
retailer: Optional[Retailer] = None
bm7_n_s_t: Optional[str] = None
otr: Decimal = decimal.Decimal(0)
actual_price: Decimal = decimal.Decimal(0)
is_display_stock: bool = False
display_retailer_id: Optional[int] = None
display_retailer: Optional[str] = None
display_retailer_gssn_id: Optional[str] = None
display_retailer_market_area_id: Optional[str] = None
is_smart_display_retailer: bool = False
is_specialist_car: bool = False
age: Optional[int] = None
secured: bool = False
is_h_o_back_order_account_vehicle: bool = False
is_allocated_to_back_order: bool = False
usage_code: Optional[str] = None
emission_combined: Optional[Decimal] = None
normalised_emission_directive: Optional[str] = None
has_mild_hybrid_equipment_code: bool = False
retail_price_ex_vat: Decimal = decimal.Decimal(0)
retail_price__inc_v_a_t: Decimal = decimal.Decimal(0)
retail_price__ex_v_a_t: Decimal = decimal.Decimal(0)
model_id: int = 0
vid: Optional[str] = None
production_date: Optional[str] = None
full_model_year_code: Optional[str] = None
chassis_number: Optional[str] = None
eligible_for_integrated_service_care: bool = False
account_type: Optional[str] = None
consumption_combined: Optional[VehicleConsumption] = None
consumption_extra_urban: Optional[VehicleConsumption] = None
consumption_urban: Optional[VehicleConsumption] = None
wltp_fuel_consumption_combined: Optional[VehicleConsumption] = None
wltp_fuel_consumption_extra_high: Optional[VehicleConsumption] = None
wltp_fuel_consumption_high: Optional[VehicleConsumption] = None
wltp_fuel_consumption_low: Optional[VehicleConsumption] = None
wltp_fuel_consumption_medium: Optional[VehicleConsumption] = None
equipment: Optional[List[Equipmentv2]] = None
equipment_categories: Optional[List[VehicleEquipmentCategory]] = None
energy_efficiency_class: Optional[VehicleEmissionClass] = None
vehicle_data: Optional[List[VehicleAttribute]] = None
integrated_service_care_options: List[VehicleIntegratedServiceCareOption] = field(default_factory=list)
isp_vehicle_customer_descriptions: Optional[List[str]] = None
confirmed_production_date: Optional[str] = None
forecasted_arrival_date: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleError:
field: Optional[str] = None
message: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetVehicleResponse:
vehicle: Optional[VehicleDetailDto] = None
errors: Optional[List[VehicleError]] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/vehicle HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<GetVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
<Gssn>String</Gssn>
<IncludeAllocatedToOrder>false</IncludeAllocatedToOrder>
<IsOneAdmin>false</IsOneAdmin>
<Vin>String</Vin>
</GetVehicleRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
<Errors>
<VehicleError>
<Field>String</Field>
<Message>String</Message>
</VehicleError>
</Errors>
<Vehicle>
<AccountType>String</AccountType>
<ActualPrice>0</ActualPrice>
<Age>0</Age>
<AvailablePackages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</AvailablePackages>
<Baumuster>String</Baumuster>
<Bm7NST>String</Bm7NST>
<BodyStyle>String</BodyStyle>
<Brand xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO.Filters.v2">
<d3p1:BodyStyles>
<d3p1:BodyStyle>
<d3p1:Description>String</d3p1:Description>
<d3p1:Id>0</d3p1:Id>
<d3p1:Models>
<d3p1:Model>
<d3p1:Description>String</d3p1:Description>
<d3p1:DisplayName>String</d3p1:DisplayName>
<d3p1:ExcludeFromOnlineShowroomFilters>false</d3p1:ExcludeFromOnlineShowroomFilters>
<d3p1:Id>0</d3p1:Id>
<d3p1:ImageUrlLarge>String</d3p1:ImageUrlLarge>
<d3p1:ImageUrlMedium>String</d3p1:ImageUrlMedium>
<d3p1:ImageUrlSmall>String</d3p1:ImageUrlSmall>
<d3p1:Priority>0</d3p1:Priority>
<d3p1:Specialist>false</d3p1:Specialist>
</d3p1:Model>
</d3p1:Models>
</d3p1:BodyStyle>
</d3p1:BodyStyles>
<d3p1:Description>String</d3p1:Description>
<d3p1:DisplayName>String</d3p1:DisplayName>
<d3p1:Id>0</d3p1:Id>
</Brand>
<BrandId>0</BrandId>
<ChassisNumber>String</ChassisNumber>
<Colour>String</Colour>
<ColourCode>String</ColourCode>
<ColourDescription>String</ColourDescription>
<ColourGroup>String</ColourGroup>
<CommissionNumber>String</CommissionNumber>
<ConfirmedProductionDate>String</ConfirmedProductionDate>
<ConsumptionCombined>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</ConsumptionCombined>
<ConsumptionExtraUrban>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</ConsumptionExtraUrban>
<ConsumptionUrban>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</ConsumptionUrban>
<Description>String</Description>
<DisplayRetailer>String</DisplayRetailer>
<DisplayRetailerGssnId>String</DisplayRetailerGssnId>
<DisplayRetailerId>0</DisplayRetailerId>
<DisplayRetailerMarketAreaId>String</DisplayRetailerMarketAreaId>
<ElectricConsumption>0</ElectricConsumption>
<ElectricRange>0</ElectricRange>
<EligibleForIntegratedServiceCare>false</EligibleForIntegratedServiceCare>
<Emission>0</Emission>
<EmissionCombined>0</EmissionCombined>
<EnergyEfficiencyClass>
<Colour>String</Colour>
<Rating>String</Rating>
</EnergyEfficiencyClass>
<Engine>
<Badge>String</Badge>
<Id>0</Id>
</Engine>
<Equipment xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d3p1:Equipmentv2>
<d3p1:Code>String</d3p1:Code>
<d3p1:Description>String</d3p1:Description>
<d3p1:Id>0</d3p1:Id>
<d3p1:Importance>0</d3p1:Importance>
<d3p1:IsAdditional>false</d3p1:IsAdditional>
</d3p1:Equipmentv2>
</Equipment>
<EquipmentCategories>
<VehicleEquipmentCategory>
<Code>String</Code>
<Description>String</Description>
<Equipment xmlns:d5p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
<d5p1:Equipmentv2>
<d5p1:Code>String</d5p1:Code>
<d5p1:Description>String</d5p1:Description>
<d5p1:Id>0</d5p1:Id>
<d5p1:Importance>0</d5p1:Importance>
<d5p1:IsAdditional>false</d5p1:IsAdditional>
</d5p1:Equipmentv2>
</Equipment>
<Order>0</Order>
</VehicleEquipmentCategory>
</EquipmentCategories>
<ForecastedArrivalDate>String</ForecastedArrivalDate>
<FuelType>String</FuelType>
<FullModelYearCode>String</FullModelYearCode>
<HasMildHybridEquipmentCode>false</HasMildHybridEquipmentCode>
<IntegratedServiceCareOptions>
<VehicleIntegratedServiceCareOption>
<BM7NST>String</BM7NST>
<CustomerDescription>String</CustomerDescription>
<FullModelYear>String</FullModelYear>
<IntegratedProductType>String</IntegratedProductType>
<OneAgentProductType>String</OneAgentProductType>
<OptionCode>String</OptionCode>
</VehicleIntegratedServiceCareOption>
</IntegratedServiceCareOptions>
<IsAllocatedToBackOrder>false</IsAllocatedToBackOrder>
<IsAvailableOnline>false</IsAvailableOnline>
<IsDisplayStock>false</IsDisplayStock>
<IsExcluded>false</IsExcluded>
<IsHOBackOrderAccountVehicle>false</IsHOBackOrderAccountVehicle>
<IsSellable>false</IsSellable>
<IsSmartDisplayRetailer>false</IsSmartDisplayRetailer>
<IsSpecialistCar>false</IsSpecialistCar>
<IspVehicleCustomerDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</IspVehicleCustomerDescriptions>
<Line>String</Line>
<Media>
<MainImageUrl>String</MainImageUrl>
<NoImage>false</NoImage>
</Media>
<Model>String</Model>
<ModelId>0</ModelId>
<NormalisedEmissionDirective>String</NormalisedEmissionDirective>
<OTR>0</OTR>
<OnHold>false</OnHold>
<P11D>0</P11D>
<Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:string>String</d3p1:string>
</Packages>
<PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
<Prices>
<Price>
<Description>String</Description>
<Gross>0</Gross>
<Id>String</Id>
<Net>0</Net>
<Product>LIST_PRICE</Product>
<VAT>0</VAT>
</Price>
</Prices>
<ProductRange>String</ProductRange>
<ProductionDate>String</ProductionDate>
<RetailPriceExVat>0</RetailPriceExVat>
<RetailPrice_ExVAT>0</RetailPrice_ExVAT>
<RetailPrice_IncVAT>0</RetailPrice_IncVAT>
<Retailer>
<Agent>false</Agent>
<ChatEnabled>false</ChatEnabled>
<City>String</City>
<Description>String</Description>
<DigitalLoungeParentGssnId>String</DigitalLoungeParentGssnId>
<DisplayPhoneNumberNew>String</DisplayPhoneNumberNew>
<DisplayPhoneNumberUsed>String</DisplayPhoneNumberUsed>
<Email>String</Email>
<Fax>String</Fax>
<GoogleMapPostcode>String</GoogleMapPostcode>
<GssnId>String</GssnId>
<Id>0</Id>
<IsCentralRetailer>false</IsCentralRetailer>
<IsNewCarRetailer>false</IsNewCarRetailer>
<IsOnline>false</IsOnline>
<IsUsedCarRetailer>false</IsUsedCarRetailer>
<Latitude>0</Latitude>
<LegacyId>String</LegacyId>
<Longitude>0</Longitude>
<MarketAreaId>0</MarketAreaId>
<OpeningTimes>
<New>
<RetailerOpeningTime>
<Day>String</Day>
<OpenFrom>String</OpenFrom>
<OpenTo>String</OpenTo>
<Special>String</Special>
</RetailerOpeningTime>
</New>
<Used>
<RetailerOpeningTime>
<Day>String</Day>
<OpenFrom>String</OpenFrom>
<OpenTo>String</OpenTo>
<Special>String</Special>
</RetailerOpeningTime>
</Used>
</OpeningTimes>
<Phone>String</Phone>
<Postcode>String</Postcode>
<RetailerGroupId>String</RetailerGroupId>
<RetailerGroupName>String</RetailerGroupName>
<SendLeadsToDigitalLoungeParent>false</SendLeadsToDigitalLoungeParent>
<Street>String</Street>
<TradeInEnabled>false</TradeInEnabled>
<Website>String</Website>
<smart>false</smart>
<smartDescription>String</smartDescription>
<smartPhone>String</smartPhone>
<smartWebsite>String</smartWebsite>
</Retailer>
<Secured>false</Secured>
<TransmissionType>String</TransmissionType>
<UnderOffer>false</UnderOffer>
<UpholsteryCode>String</UpholsteryCode>
<UpholsteryDescription>String</UpholsteryDescription>
<UpholsteryType>String</UpholsteryType>
<UsageCode>String</UsageCode>
<VID>String</VID>
<VehicleClass>String</VehicleClass>
<VehicleData>
<VehicleAttribute>
<Description>String</Description>
<Value>String</Value>
</VehicleAttribute>
</VehicleData>
<VehicleType>String</VehicleType>
<Vin>String</Vin>
<WltpFuelConsumptionCombined>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</WltpFuelConsumptionCombined>
<WltpFuelConsumptionExtraHigh>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</WltpFuelConsumptionExtraHigh>
<WltpFuelConsumptionHigh>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</WltpFuelConsumptionHigh>
<WltpFuelConsumptionLow>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</WltpFuelConsumptionLow>
<WltpFuelConsumptionMedium>
<Id>0</Id>
<Lkm>0</Lkm>
<Mpg>0</Mpg>
</WltpFuelConsumptionMedium>
</Vehicle>
</GetVehicleResponse>