Mercedes.VehicleManagement.API

AllAvailableVehiclesByCriteriaRequest

Vehicle

The following routes are available for this service:
POST	/v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts}	Get all available vehicles


export class BaseAllAvailableVehiclesRequest
{
    public vehicleType: string;
    public includeBackOrderAccounts: boolean;

    public constructor(init?: Partial<BaseAllAvailableVehiclesRequest>) { (Object as any).assign(this, init); }
}

export class BasicBackOrderVehicle
{
    public commissionNumber: string;
    public description: string;
    public model: string;
    public colour: string;
    public fuelType: string;
    public transmission: string;
    public packages: string;
    public lines: string;
    public upholstery: string;
    public emissionCombined: string;
    public actualPrice: number;
    public usageCode: string;
    public secured: boolean;
    public account: string;
    public securedTime?: string;
    public securedReason?: string;
    public securedByGasId?: string;
    public securedDate?: string;

    public constructor(init?: Partial<BasicBackOrderVehicle>) { (Object as any).assign(this, init); }
}

export class BackOrderVehicle extends BasicBackOrderVehicle
{
    public id: number;
    public vin: string;
    public vehicleType: string;
    public vid: string;
    public fin: string;
    public chassisNumber: string;
    public modelYear: string;
    public modelYearCode: string;
    public halfModelYearCode: string;
    public fullModelYearCode: string;
    public salesDescriptionLong: string;
    public vehicleClass: string;
    public retailPrice_ExVAT: number;
    public retailPrice_IncVAT: number;
    public otr: number;
    public bodyStyle: string;
    public productRange: string;
    public engine: string;
    public isAMG: boolean;
    public colourGroup: string;
    public upholsteryCode: string;
    public nst: string;
    public bm7NST: 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 electricRange?: number;
    public electricConsumption?: number;
    public emission?: number;
    public emissionDirective: 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 productionDate?: string;
    public portArrivalDate?: string;
    public creationDate: string;
    public lastUpdated?: string;
    public isDisplayStock: boolean;
    public displayStockAgent: string;
    public isSpecialistCar: boolean;
    public location: string;
    public cesarIdShipToParty: string;
    public isSellable: boolean;
    public underOffer: boolean;
    public baumuster: string;

    public constructor(init?: Partial<BackOrderVehicle>) { super(init); (Object as any).assign(this, init); }
}

export class StockManagementResponse
{
    public totalVehicles: number;
    public vehicles: BackOrderVehicle[];

    public constructor(init?: Partial<StockManagementResponse>) { (Object as any).assign(this, init); }
}

export class CampaignExclusion
{
    public vin: string[] = [];
    public commissionNumber: string[] = [];
    public modelYearCode: string;
    public equipmentCode: string;
    public gssn: string[] = [];

    public constructor(init?: Partial<CampaignExclusion>) { (Object as any).assign(this, init); }
}

export class RegistrationDate
{
    public from: string;
    public to: string;

    public constructor(init?: Partial<RegistrationDate>) { (Object as any).assign(this, init); }
}

export class Age
{
    public date: string;
    public min: number;
    public max: number;
    public includePipelineStock: boolean;

    public constructor(init?: Partial<Age>) { (Object as any).assign(this, init); }
}

export class PortArrivalDate
{
    public pipelineStock: boolean;
    public from: string;
    public to: string;

    public constructor(init?: Partial<PortArrivalDate>) { (Object as any).assign(this, init); }
}

export class VehicleSearchV3Criteria
{
    public vin: string[] = [];
    public model: number[] = [];
    public fuel: number[] = [];
    public transmission: number[] = [];
    public engine: number[] = [];
    public line: string[] = [];
    public mappedLine: number[] = [];
    public commissionNumber: string[] = [];
    public vehicleType: string;
    public exclusion: CampaignExclusion;
    public regNo: string;
    public includeOffline: boolean;
    public registrationDate: RegistrationDate;
    public age: Age;
    public portArrivalDate: PortArrivalDate;
    public isAvailableOnline?: boolean;
    public isBackOrdered?: boolean;
    public isSellable?: boolean;
    public isUnderOffer?: boolean;
    public mbukSecured?: boolean;
    public account: string[] = [];
    public baumuster: string[] = [];
    public colours: number[] = [];
    public upholstery: number[] = [];
    public package: number[] = [];
    public nst: string[] = [];
    public usageCode: string[] = [];

    public constructor(init?: Partial<VehicleSearchV3Criteria>) { (Object as any).assign(this, init); }
}

export class AllAvailableVehiclesByCriteriaRequest extends BaseAllAvailableVehiclesRequest implements IPost
{
    public criteria: VehicleSearchV3Criteria;

    public constructor(init?: Partial<AllAvailableVehiclesByCriteriaRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript AllAvailableVehiclesByCriteriaRequest 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/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AllAvailableVehiclesByCriteriaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3">
  <IncludeBackOrderAccounts>false</IncludeBackOrderAccounts>
  <VehicleType>String</VehicleType>
  <Criteria>
    <Account xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Account>
    <Age>
      <Date>0001-01-01T00:00:00</Date>
      <IncludePipelineStock>false</IncludePipelineStock>
      <Max>0</Max>
      <Min>0</Min>
    </Age>
    <Baumuster xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Baumuster>
    <Colours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Colours>
    <CommissionNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CommissionNumber>
    <Engine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Engine>
    <Exclusion>
      <CommissionNumber xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </CommissionNumber>
      <EquipmentCode>String</EquipmentCode>
      <Gssn xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Gssn>
      <ModelYearCode>String</ModelYearCode>
      <Vin xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Vin>
    </Exclusion>
    <Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Fuel>
    <IncludeOffline>false</IncludeOffline>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsBackOrdered>false</IsBackOrdered>
    <IsSellable>false</IsSellable>
    <IsUnderOffer>false</IsUnderOffer>
    <Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Line>
    <MBUKSecured>false</MBUKSecured>
    <MappedLine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </MappedLine>
    <Model xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Model>
    <NST xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </NST>
    <Package xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Package>
    <PortArrivalDate>
      <From>0001-01-01T00:00:00</From>
      <PipelineStock>false</PipelineStock>
      <To>0001-01-01T00:00:00</To>
    </PortArrivalDate>
    <RegNo>String</RegNo>
    <RegistrationDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </RegistrationDate>
    <Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Transmission>
    <Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Upholstery>
    <UsageCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </UsageCode>
    <VehicleType>String</VehicleType>
    <Vin xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Vin>
  </Criteria>
</AllAvailableVehiclesByCriteriaRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StockManagementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3">
  <TotalVehicles>0</TotalVehicles>
  <Vehicles i:nil="true" />
</StockManagementResponse>