Mercedes.VehicleManagement.API

<back to all web services

OnlineShowroomStockRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/OnlineShowroom/StockSearch for Online Showroom StockCalls 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
"use strict";
export class StockDataRow {
    /** @param {{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?:string,lastUpdated?:string,productionDate?:string,portArrivalDate?:string,combinedGrossOfferValue?:number,currentLocation?:string,notVisibleOnlineShowroom?:boolean,nvosReason?:string,nvosReasonOneAdminExcluded?:boolean,nvosReasonLinkedToBackOrder?:boolean,includedAfterDeduplication?:boolean,unique?:boolean,duplicate?:boolean,duplicateGroup?:number,lowestComm?:boolean,rule?:string,fin?:string,chassisNumber?:string,modelYear?:string,modelYearCode?:string,halfModelYearCode?:string,fullModelYearCode?:string,bodyStyle?:string,engine?:string,cesarIdShipToParty?:string,vehicleUsageCode?:string,acceleration?:number,bootCapacity?:number,topSpeed?:number,driveConcept?:string,combustionPowerHp?:number,electricPowerKw?:number,electricPowerHp?:number,combinedPowerKw?:number,combinedPowerHP?:number,underOffer?:boolean,isSellable?:boolean,mbukSecured?:boolean,isDisplayStock?:boolean,isSpecialistCar?:boolean,account?:string,productRange?:string,isAMG?:boolean,actualPrice?:number,retailPrice_ExVAT?:number,retailPrice_IncVAT?:number,otr?:number,nst?:string,bm7NST?:string,electricRange?:number,electricConsumption?:number,emission?:number,emissionDirective?:string,emissionCombined?:string,emissionExtraUrban?:string,emissionUrban?:string,energyEfficiencyClass?:string,wltpEmissionCombined?:string,wltpCombined?:string,wltpLow?:string,wltpMedium?:string,wltpHigh?:string,wltpExtraHigh?:string,totalMoneyOffersExclDiscretionary?:number,discretionaryMoneyOffer?:number,totalMoneyOffersInclDiscretionary?:number,nonDiscretionaryNMOCount?:number,nonDiscretionaryMOCount?:number,discretionaryNMOCount?:number,discretionaryMOCount?:number,totalOfferVIPAmount?:number,stockLevelIndicator?:string,confirmedProductionDate?:string,forecastedArrivalDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    commissionNumber;
    /** @type {string} */
    description;
    /** @type {string} */
    salesDescriptionLong;
    /** @type {string} */
    model;
    /** @type {string} */
    colour;
    /** @type {string} */
    colourGroup;
    /** @type {string} */
    fuelType;
    /** @type {string} */
    transmission;
    /** @type {string} */
    transmissionType;
    /** @type {string} */
    packages;
    /** @type {string} */
    lines;
    /** @type {string} */
    upholstery;
    /** @type {string} */
    upholsteryCode;
    /** @type {string} */
    displayStockAgent;
    /** @type {string} */
    location;
    /** @type {string} */
    vin;
    /** @type {string} */
    vid;
    /** @type {string} */
    vehicleType;
    /** @type {string} */
    vehicleClass;
    /** @type {string} */
    creationDate;
    /** @type {?string} */
    lastUpdated;
    /** @type {?string} */
    productionDate;
    /** @type {?string} */
    portArrivalDate;
    /** @type {number} */
    combinedGrossOfferValue;
    /** @type {string} */
    currentLocation;
    /** @type {boolean} */
    notVisibleOnlineShowroom;
    /** @type {string} */
    nvosReason;
    /** @type {boolean} */
    nvosReasonOneAdminExcluded;
    /** @type {boolean} */
    nvosReasonLinkedToBackOrder;
    /** @type {boolean} */
    includedAfterDeduplication;
    /** @type {boolean} */
    unique;
    /** @type {boolean} */
    duplicate;
    /** @type {?number} */
    duplicateGroup;
    /** @type {boolean} */
    lowestComm;
    /** @type {string} */
    rule;
    /** @type {string} */
    fin;
    /** @type {string} */
    chassisNumber;
    /** @type {string} */
    modelYear;
    /** @type {string} */
    modelYearCode;
    /** @type {string} */
    halfModelYearCode;
    /** @type {string} */
    fullModelYearCode;
    /** @type {string} */
    bodyStyle;
    /** @type {string} */
    engine;
    /** @type {string} */
    cesarIdShipToParty;
    /** @type {string} */
    vehicleUsageCode;
    /** @type {?number} */
    acceleration;
    /** @type {?number} */
    bootCapacity;
    /** @type {?number} */
    topSpeed;
    /** @type {string} */
    driveConcept;
    /** @type {?number} */
    combustionPowerHp;
    /** @type {?number} */
    electricPowerKw;
    /** @type {?number} */
    electricPowerHp;
    /** @type {?number} */
    combinedPowerKw;
    /** @type {?number} */
    combinedPowerHP;
    /** @type {boolean} */
    underOffer;
    /** @type {boolean} */
    isSellable;
    /** @type {boolean} */
    mbukSecured;
    /** @type {boolean} */
    isDisplayStock;
    /** @type {boolean} */
    isSpecialistCar;
    /** @type {string} */
    account;
    /** @type {string} */
    productRange;
    /** @type {boolean} */
    isAMG;
    /** @type {number} */
    actualPrice;
    /** @type {number} */
    retailPrice_ExVAT;
    /** @type {number} */
    retailPrice_IncVAT;
    /** @type {number} */
    otr;
    /** @type {string} */
    nst;
    /** @type {string} */
    bm7NST;
    /** @type {?number} */
    electricRange;
    /** @type {?number} */
    electricConsumption;
    /** @type {?number} */
    emission;
    /** @type {string} */
    emissionDirective;
    /** @type {string} */
    emissionCombined;
    /** @type {string} */
    emissionExtraUrban;
    /** @type {string} */
    emissionUrban;
    /** @type {string} */
    energyEfficiencyClass;
    /** @type {string} */
    wltpEmissionCombined;
    /** @type {string} */
    wltpCombined;
    /** @type {string} */
    wltpLow;
    /** @type {string} */
    wltpMedium;
    /** @type {string} */
    wltpHigh;
    /** @type {string} */
    wltpExtraHigh;
    /** @type {number} */
    totalMoneyOffersExclDiscretionary;
    /** @type {number} */
    discretionaryMoneyOffer;
    /** @type {number} */
    totalMoneyOffersInclDiscretionary;
    /** @type {number} */
    nonDiscretionaryNMOCount;
    /** @type {number} */
    nonDiscretionaryMOCount;
    /** @type {number} */
    discretionaryNMOCount;
    /** @type {number} */
    discretionaryMOCount;
    /** @type {number} */
    totalOfferVIPAmount;
    /** @type {?string} */
    stockLevelIndicator;
    /** @type {?string} */
    confirmedProductionDate;
    /** @type {?string} */
    forecastedArrivalDate;
}
export class OnlineShowroomStockResponse {
    /** @param {{totalVehicles?:number,vehicles?:StockDataRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    totalVehicles;
    /** @type {StockDataRow[]} */
    vehicles = [];
}
export class OnlineShowroomStockRequest {
    /** @param {{gssns?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string[]} */
    gssns = [];
}

JavaScript OnlineShowroomStockRequest DTOs

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

HTTP + 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:ConfirmedProductionDate>0001-01-01T00:00:00</d2p1:ConfirmedProductionDate>
      <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:ForecastedArrivalDate>0001-01-01T00:00:00</d2p1:ForecastedArrivalDate>
      <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>