POST | /v1/OnlineShowroom/Stock | Search for Online Showroom Stock | Calls Vehicle Data API online showroom stock endpoint and searches for vehicles given a list of retailers. The results are used to populate the Online Showroom Stock datatable grid in OneAdmin |
---|
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 StockDataRow:
commission_number: Optional[str] = None
description: Optional[str] = None
sales_description_long: Optional[str] = None
model: Optional[str] = None
colour: Optional[str] = None
colour_group: Optional[str] = None
fuel_type: Optional[str] = None
transmission: Optional[str] = None
transmission_type: Optional[str] = None
packages: Optional[str] = None
lines: Optional[str] = None
upholstery: Optional[str] = None
upholstery_code: Optional[str] = None
display_stock_agent: Optional[str] = None
location: Optional[str] = None
vin: Optional[str] = None
vid: Optional[str] = None
vehicle_type: Optional[str] = None
vehicle_class: Optional[str] = None
creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
last_updated: Optional[datetime.datetime] = None
production_date: Optional[datetime.datetime] = None
port_arrival_date: Optional[datetime.datetime] = None
combined_gross_offer_value: Decimal = decimal.Decimal(0)
current_location: Optional[str] = None
not_visible_online_showroom: bool = False
nvos_reason: Optional[str] = None
nvos_reason_one_admin_excluded: bool = False
nvos_reason_linked_to_back_order: bool = False
included_after_deduplication: bool = False
unique: bool = False
duplicate: bool = False
duplicate_group: Optional[int] = None
lowest_comm: bool = False
rule: Optional[str] = None
fin: Optional[str] = None
chassis_number: Optional[str] = None
model_year: Optional[str] = None
model_year_code: Optional[str] = None
half_model_year_code: Optional[str] = None
full_model_year_code: Optional[str] = None
body_style: Optional[str] = None
engine: Optional[str] = None
cesar_id_ship_to_party: Optional[str] = None
vehicle_usage_code: Optional[str] = None
acceleration: Optional[Decimal] = None
boot_capacity: Optional[int] = None
top_speed: Optional[Decimal] = None
drive_concept: Optional[str] = None
combustion_power_hp: Optional[Decimal] = None
electric_power_kw: Optional[Decimal] = None
electric_power_hp: Optional[Decimal] = None
combined_power_kw: Optional[Decimal] = None
combined_power_h_p: Optional[Decimal] = None
under_offer: bool = False
is_sellable: bool = False
mbuk_secured: bool = False
is_display_stock: bool = False
is_specialist_car: bool = False
account: Optional[str] = None
product_range: Optional[str] = None
is_a_m_g: bool = False
actual_price: Decimal = decimal.Decimal(0)
retail_price__ex_v_a_t: Decimal = decimal.Decimal(0)
retail_price__inc_v_a_t: Decimal = decimal.Decimal(0)
otr: Decimal = decimal.Decimal(0)
nst: Optional[str] = None
bm7_n_s_t: Optional[str] = None
electric_range: Optional[Decimal] = None
electric_consumption: Optional[Decimal] = None
emission: Optional[Decimal] = None
emission_directive: Optional[str] = None
emission_combined: Optional[str] = None
emission_extra_urban: Optional[str] = None
emission_urban: Optional[str] = None
energy_efficiency_class: Optional[str] = None
wltp_emission_combined: Optional[str] = None
wltp_combined: Optional[str] = None
wltp_low: Optional[str] = None
wltp_medium: Optional[str] = None
wltp_high: Optional[str] = None
wltp_extra_high: Optional[str] = None
total_money_offers_excl_discretionary: Decimal = decimal.Decimal(0)
discretionary_money_offer: Decimal = decimal.Decimal(0)
total_money_offers_incl_discretionary: Decimal = decimal.Decimal(0)
non_discretionary_n_m_o_count: int = 0
non_discretionary_m_o_count: int = 0
discretionary_n_m_o_count: int = 0
discretionary_m_o_count: int = 0
total_offer_v_i_p_amount: Decimal = decimal.Decimal(0)
stock_level_indicator: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnlineShowroomStockResponse:
total_vehicles: int = 0
vehicles: List[StockDataRow] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OnlineShowroomStockRequest(IPost):
gssns: List[str] = field(default_factory=list)
Python OnlineShowroomStockRequest DTOs
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/OnlineShowroom/Stock HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<OnlineShowroomStockRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.ServiceModel">
<Gssns xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Gssns>
</OnlineShowroomStockRequest>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <OnlineShowroomStockResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.ServiceModel"> <TotalVehicles>0</TotalVehicles> <Vehicles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3"> <d2p1:StockDataRow> <d2p1:Acceleration>0</d2p1:Acceleration> <d2p1:Account>String</d2p1:Account> <d2p1:ActualPrice>0</d2p1:ActualPrice> <d2p1:Bm7NST>String</d2p1:Bm7NST> <d2p1:BodyStyle>String</d2p1:BodyStyle> <d2p1:BootCapacity>0</d2p1:BootCapacity> <d2p1:CesarIdShipToParty>String</d2p1:CesarIdShipToParty> <d2p1:ChassisNumber>String</d2p1:ChassisNumber> <d2p1:Colour>String</d2p1:Colour> <d2p1:ColourGroup>String</d2p1:ColourGroup> <d2p1:CombinedGrossOfferValue>0</d2p1:CombinedGrossOfferValue> <d2p1:CombinedPowerHP>0</d2p1:CombinedPowerHP> <d2p1:CombinedPowerKw>0</d2p1:CombinedPowerKw> <d2p1:CombustionPowerHp>0</d2p1:CombustionPowerHp> <d2p1:CommissionNumber>String</d2p1:CommissionNumber> <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate> <d2p1:CurrentLocation>String</d2p1:CurrentLocation> <d2p1:Description>String</d2p1:Description> <d2p1:DiscretionaryMOCount>0</d2p1:DiscretionaryMOCount> <d2p1:DiscretionaryMoneyOffer>0</d2p1:DiscretionaryMoneyOffer> <d2p1:DiscretionaryNMOCount>0</d2p1:DiscretionaryNMOCount> <d2p1:DisplayStockAgent>String</d2p1:DisplayStockAgent> <d2p1:DriveConcept>String</d2p1:DriveConcept> <d2p1:Duplicate>false</d2p1:Duplicate> <d2p1:DuplicateGroup>0</d2p1:DuplicateGroup> <d2p1:ElectricConsumption>0</d2p1:ElectricConsumption> <d2p1:ElectricPowerHp>0</d2p1:ElectricPowerHp> <d2p1:ElectricPowerKw>0</d2p1:ElectricPowerKw> <d2p1:ElectricRange>0</d2p1:ElectricRange> <d2p1:Emission>0</d2p1:Emission> <d2p1:EmissionCombined>String</d2p1:EmissionCombined> <d2p1:EmissionDirective>String</d2p1:EmissionDirective> <d2p1:EmissionExtraUrban>String</d2p1:EmissionExtraUrban> <d2p1:EmissionUrban>String</d2p1:EmissionUrban> <d2p1:EnergyEfficiencyClass>String</d2p1:EnergyEfficiencyClass> <d2p1:Engine>String</d2p1:Engine> <d2p1:Fin>String</d2p1:Fin> <d2p1:FuelType>String</d2p1:FuelType> <d2p1:FullModelYearCode>String</d2p1:FullModelYearCode> <d2p1:HalfModelYearCode>String</d2p1:HalfModelYearCode> <d2p1:IncludedAfterDeduplication>false</d2p1:IncludedAfterDeduplication> <d2p1:IsAMG>false</d2p1:IsAMG> <d2p1:IsDisplayStock>false</d2p1:IsDisplayStock> <d2p1:IsSellable>false</d2p1:IsSellable> <d2p1:IsSpecialistCar>false</d2p1:IsSpecialistCar> <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated> <d2p1:Lines>String</d2p1:Lines> <d2p1:Location>String</d2p1:Location> <d2p1:LowestComm>false</d2p1:LowestComm> <d2p1:MBUKSecured>false</d2p1:MBUKSecured> <d2p1:Model>String</d2p1:Model> <d2p1:ModelYear>String</d2p1:ModelYear> <d2p1:ModelYearCode>String</d2p1:ModelYearCode> <d2p1:NST>String</d2p1:NST> <d2p1:NonDiscretionaryMOCount>0</d2p1:NonDiscretionaryMOCount> <d2p1:NonDiscretionaryNMOCount>0</d2p1:NonDiscretionaryNMOCount> <d2p1:NotVisibleOnlineShowroom>false</d2p1:NotVisibleOnlineShowroom> <d2p1:NvosReason>String</d2p1:NvosReason> <d2p1:NvosReasonLinkedToBackOrder>false</d2p1:NvosReasonLinkedToBackOrder> <d2p1:NvosReasonOneAdminExcluded>false</d2p1:NvosReasonOneAdminExcluded> <d2p1:OTR>0</d2p1:OTR> <d2p1:Packages>String</d2p1:Packages> <d2p1:PortArrivalDate>0001-01-01T00:00:00</d2p1:PortArrivalDate> <d2p1:ProductRange>String</d2p1:ProductRange> <d2p1:ProductionDate>0001-01-01T00:00:00</d2p1:ProductionDate> <d2p1:RetailPrice_ExVAT>0</d2p1:RetailPrice_ExVAT> <d2p1:RetailPrice_IncVAT>0</d2p1:RetailPrice_IncVAT> <d2p1:Rule>String</d2p1:Rule> <d2p1:SalesDescriptionLong>String</d2p1:SalesDescriptionLong> <d2p1:StockLevelIndicator>String</d2p1:StockLevelIndicator> <d2p1:TopSpeed>0</d2p1:TopSpeed> <d2p1:TotalMoneyOffersExclDiscretionary>0</d2p1:TotalMoneyOffersExclDiscretionary> <d2p1:TotalMoneyOffersInclDiscretionary>0</d2p1:TotalMoneyOffersInclDiscretionary> <d2p1:TotalOfferVIPAmount>0</d2p1:TotalOfferVIPAmount> <d2p1:Transmission>String</d2p1:Transmission> <d2p1:TransmissionType>String</d2p1:TransmissionType> <d2p1:UnderOffer>false</d2p1:UnderOffer> <d2p1:Unique>false</d2p1:Unique> <d2p1:Upholstery>String</d2p1:Upholstery> <d2p1:UpholsteryCode>String</d2p1:UpholsteryCode> <d2p1:VehicleClass>String</d2p1:VehicleClass> <d2p1:VehicleType>String</d2p1:VehicleType> <d2p1:VehicleUsageCode>String</d2p1:VehicleUsageCode> <d2p1:Vid>String</d2p1:Vid> <d2p1:Vin>String</d2p1:Vin> <d2p1:WLTPCombined>String</d2p1:WLTPCombined> <d2p1:WLTPEmissionCombined>String</d2p1:WLTPEmissionCombined> <d2p1:WLTPExtraHigh>String</d2p1:WLTPExtraHigh> <d2p1:WLTPHigh>String</d2p1:WLTPHigh> <d2p1:WLTPLow>String</d2p1:WLTPLow> <d2p1:WLTPMedium>String</d2p1:WLTPMedium> </d2p1:StockDataRow> </Vehicles> </OnlineShowroomStockResponse>