| 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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
Content-Length: length
{"gssns":["String"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"totalVehicles":0,"vehicles":[{"commissionNumber":"String","description":"String","salesDescriptionLong":"String","model":"String","colour":"String","colourGroup":"String","fuelType":"String","transmission":"String","transmissionType":"String","packages":"String","lines":"String","upholstery":"String","upholsteryCode":"String","displayStockAgent":"String","location":"String","vin":"String","vid":"String","vehicleType":"String","vehicleClass":"String","creationDate":"\/Date(-62135596800000-0000)\/","lastUpdated":"\/Date(-62135596800000-0000)\/","productionDate":"\/Date(-62135596800000-0000)\/","portArrivalDate":"\/Date(-62135596800000-0000)\/","combinedGrossOfferValue":0,"currentLocation":"String","notVisibleOnlineShowroom":false,"nvosReason":"String","nvosReasonOneAdminExcluded":false,"nvosReasonLinkedToBackOrder":false,"includedAfterDeduplication":false,"unique":false,"duplicate":false,"duplicateGroup":0,"lowestComm":false,"rule":"String","fin":"String","chassisNumber":"String","modelYear":"String","modelYearCode":"String","halfModelYearCode":"String","fullModelYearCode":"String","bodyStyle":"String","engine":"String","cesarIdShipToParty":"String","vehicleUsageCode":"String","acceleration":0,"bootCapacity":0,"topSpeed":0,"driveConcept":"String","combustionPowerHp":0,"electricPowerKw":0,"electricPowerHp":0,"combinedPowerKw":0,"combinedPowerHP":0,"underOffer":false,"isSellable":false,"mbukSecured":false,"isDisplayStock":false,"isSpecialistCar":false,"account":"String","productRange":"String","isAMG":false,"actualPrice":0,"retailPrice_ExVAT":0,"retailPrice_IncVAT":0,"otr":0,"nst":"String","bm7NST":"String","electricRange":0,"electricConsumption":0,"emission":0,"emissionDirective":"String","emissionCombined":"String","emissionExtraUrban":"String","emissionUrban":"String","energyEfficiencyClass":"String","wltpEmissionCombined":"String","wltpCombined":"String","wltpLow":"String","wltpMedium":"String","wltpHigh":"String","wltpExtraHigh":"String","totalMoneyOffersExclDiscretionary":0,"discretionaryMoneyOffer":0,"totalMoneyOffersInclDiscretionary":0,"nonDiscretionaryNMOCount":0,"nonDiscretionaryMOCount":0,"discretionaryNMOCount":0,"discretionaryMOCount":0,"totalOfferVIPAmount":0,"stockLevelIndicator":"String"}]}