| 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 |
|---|
export class StockDataRow
{
public commissionNumber: string;
public description: string;
public salesDescriptionLong: string;
public model: string;
public colour: string;
public colourGroup: string;
public fuelType: string;
public transmission: string;
public transmissionType: string;
public packages: string;
public lines: string;
public upholstery: string;
public upholsteryCode: string;
public displayStockAgent: string;
public location: string;
public vin: string;
public vid: string;
public vehicleType: string;
public vehicleClass: string;
public creationDate: string;
public lastUpdated?: string;
public productionDate?: string;
public portArrivalDate?: string;
public combinedGrossOfferValue: number;
public currentLocation: string;
public notVisibleOnlineShowroom: boolean;
public nvosReason: string;
public nvosReasonOneAdminExcluded: boolean;
public nvosReasonLinkedToBackOrder: boolean;
public includedAfterDeduplication: boolean;
public unique: boolean;
public duplicate: boolean;
public duplicateGroup?: number;
public lowestComm: boolean;
public rule: string;
public fin: string;
public chassisNumber: string;
public modelYear: string;
public modelYearCode: string;
public halfModelYearCode: string;
public fullModelYearCode: string;
public bodyStyle: string;
public engine: string;
public cesarIdShipToParty: string;
public vehicleUsageCode: string;
public acceleration?: number;
public bootCapacity?: number;
public topSpeed?: number;
public driveConcept: string;
public combustionPowerHp?: number;
public electricPowerKw?: number;
public electricPowerHp?: number;
public combinedPowerKw?: number;
public combinedPowerHP?: number;
public underOffer: boolean;
public isSellable: boolean;
public mbukSecured: boolean;
public isDisplayStock: boolean;
public isSpecialistCar: boolean;
public account: string;
public productRange: string;
public isAMG: boolean;
public actualPrice: number;
public retailPrice_ExVAT: number;
public retailPrice_IncVAT: number;
public otr: number;
public nst: string;
public bm7NST: string;
public electricRange?: number;
public electricConsumption?: number;
public emission?: number;
public emissionDirective: string;
public emissionCombined: string;
public emissionExtraUrban: string;
public emissionUrban: string;
public energyEfficiencyClass: string;
public wltpEmissionCombined: string;
public wltpCombined: string;
public wltpLow: string;
public wltpMedium: string;
public wltpHigh: string;
public wltpExtraHigh: string;
public totalMoneyOffersExclDiscretionary: number;
public discretionaryMoneyOffer: number;
public totalMoneyOffersInclDiscretionary: number;
public nonDiscretionaryNMOCount: number;
public nonDiscretionaryMOCount: number;
public discretionaryNMOCount: number;
public discretionaryMOCount: number;
public totalOfferVIPAmount: number;
public stockLevelIndicator?: string;
public constructor(init?: Partial<StockDataRow>) { (Object as any).assign(this, init); }
}
export class OnlineShowroomStockResponse
{
public totalVehicles: number;
public vehicles: StockDataRow[] = [];
public constructor(init?: Partial<OnlineShowroomStockResponse>) { (Object as any).assign(this, init); }
}
export class OnlineShowroomStockRequest implements IPost
{
public gssns: string[] = [];
public constructor(init?: Partial<OnlineShowroomStockRequest>) { (Object as any).assign(this, init); }
}
TypeScript OnlineShowroomStockRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
gssns:
[
String
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
lastUpdated: 0001-01-01,
productionDate: 0001-01-01,
portArrivalDate: 0001-01-01,
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
}
]
}