Mercedes.VehicleManagement.API

<back to all web services

DisplayStockOverviewRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/DisplayStockOverviewFilter Display Stock vehicle data with usedCode and MBUKSecured
"use strict";
export class VehicleDisplayStock {
    /** @param {{vin?:string,vehicleDescription?:string,commissionNumber?:string,retailer?:string,model?:string,fuelType?:string,transmission?:string,colour?:string,actualPrice?:string,gbDestDate?:string,vehicleUsage?:string,underOffer?:boolean,isSellable?:boolean,vehicleType?:string,vid?:string,fin?:string,chassisNumber?:string,line?:string,modelYear?:string,modelYearCode?:string,vehicleClass?:string,retailPrice_ExVAT?:string,retailPrice_IncVAT?:string,otr?:string,bodyStyle?:string,productRange?:string,engine?:string,isAMG?:boolean,colourGroup?:string,upholstery?:string,packages?:string,nst?:string,bM7NST?:string,acceleration?:string,bootCapacity?:string,topSpeed?:string,driveConcept?:string,combustionPowerHp?:string,electricPowerKw?:string,electricPowerHp?:string,combinedPowerKw?:string,combinedPowerHP?:string,electricRange?:string,electricConsumption?:string,emissionCombined?:string,emissionExtraUrban?:string,emissionUrban?:string,emission?:string,emissionDirective?:string,energyEfficiencyClass?:string,wltpCombined?:string,wltpLow?:string,wltpMedium?:string,wltpHigh?:string,wltpExtraHigh?:string,wltpEmissionCombined?:string,portArrivalDate?:string,creationDate?:string,lastUpdated?:string,isDisplayStock?:boolean,displayStockAgent?:string,isSpecialistCar?:boolean,account?:string,location?:string,cesarIdShipToParty?:string,vehicleUsageCode?:string,mbukSecured?:boolean,isAllocatedToBackOrder?:boolean,backOrderReference?:string,marketAreaName?:string,marketAreaId?:number,daysAtSite?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    vin;
    /** @type {string} */
    vehicleDescription;
    /** @type {string} */
    commissionNumber;
    /** @type {string} */
    retailer;
    /** @type {string} */
    model;
    /** @type {string} */
    fuelType;
    /** @type {string} */
    transmission;
    /** @type {string} */
    colour;
    /** @type {string} */
    actualPrice;
    /** @type {?string} */
    gbDestDate;
    /** @type {string} */
    vehicleUsage;
    /** @type {boolean} */
    underOffer;
    /** @type {boolean} */
    isSellable;
    /** @type {string} */
    vehicleType;
    /** @type {string} */
    vid;
    /** @type {string} */
    fin;
    /** @type {string} */
    chassisNumber;
    /** @type {string} */
    line;
    /** @type {string} */
    modelYear;
    /** @type {string} */
    modelYearCode;
    /** @type {string} */
    vehicleClass;
    /** @type {string} */
    retailPrice_ExVAT;
    /** @type {string} */
    retailPrice_IncVAT;
    /** @type {string} */
    otr;
    /** @type {string} */
    bodyStyle;
    /** @type {string} */
    productRange;
    /** @type {string} */
    engine;
    /** @type {boolean} */
    isAMG;
    /** @type {string} */
    colourGroup;
    /** @type {string} */
    upholstery;
    /** @type {string} */
    packages;
    /** @type {string} */
    nst;
    /** @type {string} */
    bM7NST;
    /** @type {string} */
    acceleration;
    /** @type {string} */
    bootCapacity;
    /** @type {string} */
    topSpeed;
    /** @type {string} */
    driveConcept;
    /** @type {string} */
    combustionPowerHp;
    /** @type {string} */
    electricPowerKw;
    /** @type {string} */
    electricPowerHp;
    /** @type {string} */
    combinedPowerKw;
    /** @type {string} */
    combinedPowerHP;
    /** @type {string} */
    electricRange;
    /** @type {string} */
    electricConsumption;
    /** @type {string} */
    emissionCombined;
    /** @type {string} */
    emissionExtraUrban;
    /** @type {string} */
    emissionUrban;
    /** @type {string} */
    emission;
    /** @type {string} */
    emissionDirective;
    /** @type {string} */
    energyEfficiencyClass;
    /** @type {string} */
    wltpCombined;
    /** @type {string} */
    wltpLow;
    /** @type {string} */
    wltpMedium;
    /** @type {string} */
    wltpHigh;
    /** @type {string} */
    wltpExtraHigh;
    /** @type {string} */
    wltpEmissionCombined;
    /** @type {?string} */
    portArrivalDate;
    /** @type {?string} */
    creationDate;
    /** @type {?string} */
    lastUpdated;
    /** @type {boolean} */
    isDisplayStock;
    /** @type {string} */
    displayStockAgent;
    /** @type {boolean} */
    isSpecialistCar;
    /** @type {string} */
    account;
    /** @type {string} */
    location;
    /** @type {string} */
    cesarIdShipToParty;
    /** @type {string} */
    vehicleUsageCode;
    /** @type {boolean} */
    mbukSecured;
    /** @type {boolean} */
    isAllocatedToBackOrder;
    /** @type {?string} */
    backOrderReference;
    /** @type {?string} */
    marketAreaName;
    /** @type {?number} */
    marketAreaId;
    /** @type {?string} */
    daysAtSite;
}
export class DisplayStockOverviewResponse {
    /** @param {{vehicles?:VehicleDisplayStock[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {VehicleDisplayStock[]} */
    vehicles = [];
}
export class DisplayStockOverviewRequest {
    /** @param {{isSecured?:boolean,usageCode?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {boolean}
     * @description Is vehicle secured */
    isSecured;
    /**
     * @type {string[]}
     * @description Usage codes */
    usageCode = [];
}

JavaScript DisplayStockOverviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/DisplayStockOverview HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	isSecured: False,
	usageCode: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	vehicles: 
	[
		{
			vin: String,
			vehicleDescription: String,
			commissionNumber: String,
			retailer: String,
			model: String,
			fuelType: String,
			transmission: String,
			colour: String,
			actualPrice: String,
			gbDestDate: 0001-01-01,
			vehicleUsage: String,
			underOffer: False,
			isSellable: False,
			vehicleType: String,
			vid: String,
			fin: String,
			chassisNumber: String,
			line: String,
			modelYear: String,
			modelYearCode: String,
			vehicleClass: String,
			retailPrice_ExVAT: String,
			retailPrice_IncVAT: String,
			otr: String,
			bodyStyle: String,
			productRange: String,
			engine: String,
			isAMG: False,
			colourGroup: String,
			upholstery: String,
			packages: String,
			nst: String,
			bM7NST: String,
			acceleration: String,
			bootCapacity: String,
			topSpeed: String,
			driveConcept: String,
			combustionPowerHp: String,
			electricPowerKw: String,
			electricPowerHp: String,
			combinedPowerKw: String,
			combinedPowerHP: String,
			electricRange: String,
			electricConsumption: String,
			emissionCombined: String,
			emissionExtraUrban: String,
			emissionUrban: String,
			emission: String,
			emissionDirective: String,
			energyEfficiencyClass: String,
			wltpCombined: String,
			wltpLow: String,
			wltpMedium: String,
			wltpHigh: String,
			wltpExtraHigh: String,
			wltpEmissionCombined: String,
			portArrivalDate: 0001-01-01,
			creationDate: 0001-01-01,
			lastUpdated: 0001-01-01,
			isDisplayStock: False,
			displayStockAgent: String,
			isSpecialistCar: False,
			account: String,
			location: String,
			cesarIdShipToParty: String,
			vehicleUsageCode: String,
			mbukSecured: False,
			isAllocatedToBackOrder: False,
			backOrderReference: String,
			marketAreaName: String,
			marketAreaId: 0,
			daysAtSite: String
		}
	]
}