Mercedes.Agency.Orchestration.API

<back to all web services

GetVehicleRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/vehicleGet Vehicle by VinGet Vehicle by Vin

export class GetVehicleRequest
{
    public Vin: string;
    public IncludeAllocatedToOrder: boolean;
    public Gssn: string;
    public IsOneAdmin: boolean;

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

export class Model
{
    public Id: number;
    public Description?: string;
    public DisplayName?: string;
    public ImageUrlSmall?: string;
    public ImageUrlMedium?: string;
    public ImageUrlLarge?: string;
    public Specialist: boolean;
    public Priority?: number;
    public ExcludeFromOnlineShowroomFilters?: boolean;

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

export class BodyStyle
{
    public Id: number;
    public Description?: string;
    public Models?: Model[];

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

export class Brand
{
    public Id: number;
    public Description?: string;
    public DisplayName?: string;
    public BodyStyles?: BodyStyle[];

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

export class Engine
{
    public Id?: number;
    public Badge: string;

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

export class Media
{
    public NoImage: boolean;
    public MainImageUrl: string;

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

export enum OfferPriceProductType
{
    LIST_PRICE = 'LIST_PRICE',
    NUMBER_PLATE_FEE = 'NUMBER_PLATE_FEE',
    DELIVERY_CHARGE = 'DELIVERY_CHARGE',
    FUEL_CHARGE = 'FUEL_CHARGE',
    MANUFACTURER_OFFER = 'MANUFACTURER_OFFER',
    PERSONALISED_MONEYOFFER = 'PERSONALISED_MONEYOFFER',
    PERSONALISED_NONMONEYOFFER = 'PERSONALISED_NONMONEYOFFER',
    PERSONALISED_NONMONEYOFFER_NEG = 'PERSONALISED_NONMONEYOFFER_NEG',
    SERVICE = 'SERVICE',
    SERVICE_NEG = 'SERVICE_NEG',
    GOVERNMENT_GRANT = 'GOVERNMENT_GRANT',
    OUTRIGHT_PURCHASE_DISCOUNT = 'OUTRIGHT_PURCHASE_DISCOUNT',
    VIP_OFFER = 'VIP_OFFER',
    WALLBOX_OFFER = 'WALLBOX_OFFER',
    WALLBOX_OFFER_NEG = 'WALLBOX_OFFER_NEG',
    ROAD_FUND_LICENCE = 'ROAD_FUND_LICENCE',
    FIRST_REGISTRATION_FEE = 'FIRST_REGISTRATION_FEE',
    NOT_FOUND = 'NOT_FOUND',
    ACCESSORY_OFFER = 'ACCESSORY_OFFER',
    ACCESSORY_OFFER_NEG = 'ACCESSORY_OFFER_NEG',
    MOTABILITY_DISCOUNT = 'MOTABILITY_DISCOUNT',
}

export class Price
{
    public Id: string;
    public Description: string;
    public Net: number;
    public VAT: number;
    public Gross: number;
    public Product: OfferPriceProductType;

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

export class RetailerOpeningTime
{
    public Day: string;
    public OpenFrom: string;
    public OpenTo: string;
    public Special: string;

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

export class RetailerOpeningTimes
{
    public New: RetailerOpeningTime[] = [];
    public Used: RetailerOpeningTime[] = [];

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

export class Retailer
{
    public Id: number;
    public GssnId: string;
    public Description: string;
    public Street: string;
    public City: string;
    public Postcode: string;
    public GoogleMapPostcode: string;
    public Phone: string;
    public Fax: string;
    public Email: string;
    public Website: string;
    public RetailerGroupId: string;
    public RetailerGroupName: string;
    public IsOnline: boolean;
    public IsNewCarRetailer: boolean;
    public IsUsedCarRetailer: boolean;
    public IsCentralRetailer: boolean;
    public ChatEnabled: boolean;
    public TradeInEnabled: boolean;
    public smart: boolean;
    public DisplayPhoneNumberNew: string;
    public DisplayPhoneNumberUsed: string;
    public Latitude: number;
    public Longitude: number;
    public smartDescription: string;
    public smartWebsite: string;
    public smartPhone: string;
    public LegacyId: string;
    public Agent: boolean;
    public MarketAreaId: number;
    public DigitalLoungeParentGssnId?: string;
    public SendLeadsToDigitalLoungeParent: boolean;
    public OpeningTimes?: RetailerOpeningTimes;

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

export class VehicleConsumption
{
    public Id: number;
    public Lkm: number;
    public Mpg: number;

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

export class Equipment
{
    public Id?: number;
    public Code?: string;
    public Description?: string;

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

export class Equipmentv2 extends Equipment
{
    public Importance: number;
    public IsAdditional: boolean;

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

export class VehicleEquipmentCategory
{
    public Order: number;
    public Code?: string;
    public Description?: string;
    public Equipment?: Equipmentv2[];

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

export class VehicleEmissionClass
{
    public Colour?: string;
    public Rating?: string;

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

export class VehicleAttribute
{
    public Description?: string;
    public Value?: string;

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

export class VehicleIntegratedServiceCareOption
{
    public OptionCode?: string;
    public BM7NST?: string;
    public FullModelYear?: string;
    public IntegratedProductType?: string;
    public CustomerDescription?: string;
    public OneAgentProductType?: string;

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

export class VehicleDetailDto
{
    public BodyStyle: string;
    public Vin: string;
    public Description: string;
    public Colour: string;
    public ColourCode: string;
    public ColourDescription: string;
    public ColourGroup: string;
    public Model: string;
    public CommissionNumber: string;
    public BrandId?: number;
    public Brand: Brand;
    public Engine: Engine;
    public EngineBadge: string;
    public Media: Media;
    public Line: string;
    public UpholsteryCode: string;
    public UpholsteryType: string;
    public Upholstery: string;
    public UpholsteryDescription: string;
    public AvailablePackages: string[] = [];
    public Packages: string[] = [];
    public P11D: number;
    public PortArrivalDate?: string;
    public Prices: Price[] = [];
    public TransmissionType: string;
    public FuelType: string;
    public VehicleClass: string;
    public ProductRange: string;
    public VehicleType: string;
    public Emission?: number;
    public IsAvailableOnline: boolean;
    public UnderOffer: boolean;
    public IsExcluded: boolean;
    public IsSellable: boolean;
    public OnHold: boolean;
    public ElectricConsumption?: number;
    public ElectricRange?: number;
    public ImageUrl: string;
    public Baumuster: string;
    public Retailer: Retailer;
    public Bm7NST: string;
    public OTR: number;
    public ActualPrice: number;
    public IsDisplayStock: boolean;
    public DisplayRetailerId?: number;
    public DisplayRetailer: string;
    public DisplayRetailerGssnId: string;
    public DisplayRetailerMarketAreaId: string;
    public IsSmartDisplayRetailer: boolean;
    public IsSpecialistCar: boolean;
    public Age?: number;
    public Secured: boolean;
    public IsHOBackOrderAccountVehicle: boolean;
    public IsAllocatedToBackOrder: boolean;
    public UsageCode: string;
    public EmissionCombined?: number;
    public NormalisedEmissionDirective?: string;
    public HasMildHybridEquipmentCode: boolean;
    public RetailPriceExVat: number;
    public RetailPrice_IncVAT: number;
    public RetailPrice_ExVAT: number;
    public ModelId: number;
    public VID?: string;
    public ProductionDate?: string;
    public FullModelYearCode?: string;
    public ChassisNumber?: string;
    public EligibleForIntegratedServiceCare: boolean;
    public AccountType?: string;
    public ConsumptionCombined?: VehicleConsumption;
    public ConsumptionExtraUrban?: VehicleConsumption;
    public ConsumptionUrban?: VehicleConsumption;
    public WltpFuelConsumptionCombined?: VehicleConsumption;
    public WltpFuelConsumptionExtraHigh?: VehicleConsumption;
    public WltpFuelConsumptionHigh?: VehicleConsumption;
    public WltpFuelConsumptionLow?: VehicleConsumption;
    public WltpFuelConsumptionMedium?: VehicleConsumption;
    public Equipment?: Equipmentv2[];
    public EquipmentCategories?: VehicleEquipmentCategory[];
    public EnergyEfficiencyClass?: VehicleEmissionClass;
    public VehicleData?: VehicleAttribute[];
    public IntegratedServiceCareOptions: VehicleIntegratedServiceCareOption[] = [];
    public IspVehicleCustomerDescriptions?: string[];
    public ConfirmedProductionDate?: string;
    public ForecastedArrivalDate?: string;

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

export class VehicleError
{
    public Field: string;
    public Message: string;

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

export class GetVehicleResponse
{
    public Vehicle: VehicleDetailDto;
    public Errors?: VehicleError[];

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

TypeScript GetVehicleRequest 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/vehicle HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetVehicleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <Gssn>String</Gssn>
  <IncludeAllocatedToOrder>false</IncludeAllocatedToOrder>
  <IsOneAdmin>false</IsOneAdmin>
  <Vin>String</Vin>
</GetVehicleRequest>

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

<GetVehicleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <Errors>
    <VehicleError>
      <Field>String</Field>
      <Message>String</Message>
    </VehicleError>
  </Errors>
  <Vehicle>
    <AccountType>String</AccountType>
    <ActualPrice>0</ActualPrice>
    <Age>0</Age>
    <AvailablePackages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </AvailablePackages>
    <Baumuster>String</Baumuster>
    <Bm7NST>String</Bm7NST>
    <BodyStyle>String</BodyStyle>
    <Brand xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO.Filters.v2">
      <d3p1:BodyStyles>
        <d3p1:BodyStyle>
          <d3p1:Description>String</d3p1:Description>
          <d3p1:Id>0</d3p1:Id>
          <d3p1:Models>
            <d3p1:Model>
              <d3p1:Description>String</d3p1:Description>
              <d3p1:DisplayName>String</d3p1:DisplayName>
              <d3p1:ExcludeFromOnlineShowroomFilters>false</d3p1:ExcludeFromOnlineShowroomFilters>
              <d3p1:Id>0</d3p1:Id>
              <d3p1:ImageUrlLarge>String</d3p1:ImageUrlLarge>
              <d3p1:ImageUrlMedium>String</d3p1:ImageUrlMedium>
              <d3p1:ImageUrlSmall>String</d3p1:ImageUrlSmall>
              <d3p1:Priority>0</d3p1:Priority>
              <d3p1:Specialist>false</d3p1:Specialist>
            </d3p1:Model>
          </d3p1:Models>
        </d3p1:BodyStyle>
      </d3p1:BodyStyles>
      <d3p1:Description>String</d3p1:Description>
      <d3p1:DisplayName>String</d3p1:DisplayName>
      <d3p1:Id>0</d3p1:Id>
    </Brand>
    <BrandId>0</BrandId>
    <ChassisNumber>String</ChassisNumber>
    <Colour>String</Colour>
    <ColourCode>String</ColourCode>
    <ColourDescription>String</ColourDescription>
    <ColourGroup>String</ColourGroup>
    <CommissionNumber>String</CommissionNumber>
    <ConfirmedProductionDate>String</ConfirmedProductionDate>
    <ConsumptionCombined>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionCombined>
    <ConsumptionExtraUrban>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionExtraUrban>
    <ConsumptionUrban>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </ConsumptionUrban>
    <Description>String</Description>
    <DisplayRetailer>String</DisplayRetailer>
    <DisplayRetailerGssnId>String</DisplayRetailerGssnId>
    <DisplayRetailerId>0</DisplayRetailerId>
    <DisplayRetailerMarketAreaId>String</DisplayRetailerMarketAreaId>
    <ElectricConsumption>0</ElectricConsumption>
    <ElectricRange>0</ElectricRange>
    <EligibleForIntegratedServiceCare>false</EligibleForIntegratedServiceCare>
    <Emission>0</Emission>
    <EmissionCombined>0</EmissionCombined>
    <EnergyEfficiencyClass>
      <Colour>String</Colour>
      <Rating>String</Rating>
    </EnergyEfficiencyClass>
    <Engine>
      <Badge>String</Badge>
      <Id>0</Id>
    </Engine>
    <Equipment xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
      <d3p1:Equipmentv2>
        <d3p1:Code>String</d3p1:Code>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:Importance>0</d3p1:Importance>
        <d3p1:IsAdditional>false</d3p1:IsAdditional>
      </d3p1:Equipmentv2>
    </Equipment>
    <EquipmentCategories>
      <VehicleEquipmentCategory>
        <Code>String</Code>
        <Description>String</Description>
        <Equipment xmlns:d5p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
          <d5p1:Equipmentv2>
            <d5p1:Code>String</d5p1:Code>
            <d5p1:Description>String</d5p1:Description>
            <d5p1:Id>0</d5p1:Id>
            <d5p1:Importance>0</d5p1:Importance>
            <d5p1:IsAdditional>false</d5p1:IsAdditional>
          </d5p1:Equipmentv2>
        </Equipment>
        <Order>0</Order>
      </VehicleEquipmentCategory>
    </EquipmentCategories>
    <ForecastedArrivalDate>String</ForecastedArrivalDate>
    <FuelType>String</FuelType>
    <FullModelYearCode>String</FullModelYearCode>
    <HasMildHybridEquipmentCode>false</HasMildHybridEquipmentCode>
    <IntegratedServiceCareOptions>
      <VehicleIntegratedServiceCareOption>
        <BM7NST>String</BM7NST>
        <CustomerDescription>String</CustomerDescription>
        <FullModelYear>String</FullModelYear>
        <IntegratedProductType>String</IntegratedProductType>
        <OneAgentProductType>String</OneAgentProductType>
        <OptionCode>String</OptionCode>
      </VehicleIntegratedServiceCareOption>
    </IntegratedServiceCareOptions>
    <IsAllocatedToBackOrder>false</IsAllocatedToBackOrder>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsDisplayStock>false</IsDisplayStock>
    <IsExcluded>false</IsExcluded>
    <IsHOBackOrderAccountVehicle>false</IsHOBackOrderAccountVehicle>
    <IsSellable>false</IsSellable>
    <IsSmartDisplayRetailer>false</IsSmartDisplayRetailer>
    <IsSpecialistCar>false</IsSpecialistCar>
    <IspVehicleCustomerDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </IspVehicleCustomerDescriptions>
    <Line>String</Line>
    <Media>
      <MainImageUrl>String</MainImageUrl>
      <NoImage>false</NoImage>
    </Media>
    <Model>String</Model>
    <ModelId>0</ModelId>
    <NormalisedEmissionDirective>String</NormalisedEmissionDirective>
    <OTR>0</OTR>
    <OnHold>false</OnHold>
    <P11D>0</P11D>
    <Packages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Packages>
    <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
    <Prices>
      <Price>
        <Description>String</Description>
        <Gross>0</Gross>
        <Id>String</Id>
        <Net>0</Net>
        <Product>LIST_PRICE</Product>
        <VAT>0</VAT>
      </Price>
    </Prices>
    <ProductRange>String</ProductRange>
    <ProductionDate>String</ProductionDate>
    <RetailPriceExVat>0</RetailPriceExVat>
    <RetailPrice_ExVAT>0</RetailPrice_ExVAT>
    <RetailPrice_IncVAT>0</RetailPrice_IncVAT>
    <Retailer>
      <Agent>false</Agent>
      <ChatEnabled>false</ChatEnabled>
      <City>String</City>
      <Description>String</Description>
      <DigitalLoungeParentGssnId>String</DigitalLoungeParentGssnId>
      <DisplayPhoneNumberNew>String</DisplayPhoneNumberNew>
      <DisplayPhoneNumberUsed>String</DisplayPhoneNumberUsed>
      <Email>String</Email>
      <Fax>String</Fax>
      <GoogleMapPostcode>String</GoogleMapPostcode>
      <GssnId>String</GssnId>
      <Id>0</Id>
      <IsCentralRetailer>false</IsCentralRetailer>
      <IsNewCarRetailer>false</IsNewCarRetailer>
      <IsOnline>false</IsOnline>
      <IsUsedCarRetailer>false</IsUsedCarRetailer>
      <Latitude>0</Latitude>
      <LegacyId>String</LegacyId>
      <Longitude>0</Longitude>
      <MarketAreaId>0</MarketAreaId>
      <OpeningTimes>
        <New>
          <RetailerOpeningTime>
            <Day>String</Day>
            <OpenFrom>String</OpenFrom>
            <OpenTo>String</OpenTo>
            <Special>String</Special>
          </RetailerOpeningTime>
        </New>
        <Used>
          <RetailerOpeningTime>
            <Day>String</Day>
            <OpenFrom>String</OpenFrom>
            <OpenTo>String</OpenTo>
            <Special>String</Special>
          </RetailerOpeningTime>
        </Used>
      </OpeningTimes>
      <Phone>String</Phone>
      <Postcode>String</Postcode>
      <RetailerGroupId>String</RetailerGroupId>
      <RetailerGroupName>String</RetailerGroupName>
      <SendLeadsToDigitalLoungeParent>false</SendLeadsToDigitalLoungeParent>
      <Street>String</Street>
      <TradeInEnabled>false</TradeInEnabled>
      <Website>String</Website>
      <smart>false</smart>
      <smartDescription>String</smartDescription>
      <smartPhone>String</smartPhone>
      <smartWebsite>String</smartWebsite>
    </Retailer>
    <Secured>false</Secured>
    <TransmissionType>String</TransmissionType>
    <UnderOffer>false</UnderOffer>
    <UpholsteryCode>String</UpholsteryCode>
    <UpholsteryDescription>String</UpholsteryDescription>
    <UpholsteryType>String</UpholsteryType>
    <UsageCode>String</UsageCode>
    <VID>String</VID>
    <VehicleClass>String</VehicleClass>
    <VehicleData>
      <VehicleAttribute>
        <Description>String</Description>
        <Value>String</Value>
      </VehicleAttribute>
    </VehicleData>
    <VehicleType>String</VehicleType>
    <Vin>String</Vin>
    <WltpFuelConsumptionCombined>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionCombined>
    <WltpFuelConsumptionExtraHigh>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionExtraHigh>
    <WltpFuelConsumptionHigh>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionHigh>
    <WltpFuelConsumptionLow>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionLow>
    <WltpFuelConsumptionMedium>
      <Id>0</Id>
      <Lkm>0</Lkm>
      <Mpg>0</Mpg>
    </WltpFuelConsumptionMedium>
  </Vehicle>
</GetVehicleResponse>