Mercedes.VehicleManagement.API

VehicleByCommissionNumberRequest

Vehicle

The following routes are available for this service:
GET	/v1/{VehicleType}/Vehicle/{vehicleIdentifier}	Get vehicle data by commission number


export class OfferVehicle
{
    public retailPriceExVAT: string;

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

export class Offer
{
    public id: number;
    public offerType: string;
    public campaignName: string;
    public from: string;
    public to: string;
    public value: string;
    public net?: number;
    public offerVehicle: OfferVehicle;
    public pending: boolean;
    public documentUrl: string;
    public personalised: boolean;
    public isPersonalisedMonetaryOffer: boolean;
    public campaignVIPDiscount: boolean;
    public offerValueNet?: number;

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

export class PersonalisedOffer extends Offer
{
    public category: string;
    public description: string;
    public reference: string;

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

export class Message
{
    public id: number;
    public vin: string;
    public campaignId: number;
    public value: string;
    public campaignDescription: string;
    public from: string;
    public to: string;
    public documentUrl: string;

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

export class OfferHistory
{
    public id: number;
    public auditType: string;
    public offerType: string;
    public source: string;
    public from: string;
    public to: string;
    public personalised: boolean;
    public value: string;
    public net: string;
    public vat: string;
    public description: string;
    public vin: string;
    public gssn: string;
    public creation: string;
    public modified: string;
    public userId: string;
    public user: number;
    public offerId: number;
    public commissionNumber: string;
    public campaignId?: number;
    public campaignDescription: string;
    public creationDate: string;
    public isUsedCarOffer: boolean;

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

export class FinanceOffer
{
    public campaignDescription: string;
    public termsAndConditions: string;
    public label: string;
    public campaignId: number;
    public documentUrl: string;
    public from: string;
    public id: number;
    public to: string;
    public value: string;
    public vin: string;
    public enabled: boolean;
    public pending: boolean;
    public offerType: string;

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

export class VehicleByIdentifierResponse
{
    public campaignOffers: Offer[] = [];
    public campaignPersonalisedOffers: PersonalisedOffer[] = [];
    public campaignOLEVGrantOffers: Offer[] = [];
    public campaignMessages: Message[] = [];
    public offerHistories?: OfferHistory[];
    public financeOffers?: FinanceOffer[];

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

export class VehicleDataBase
{
    public vin: string;
    public description: string;
    public model: string;
    public otr: string;
    public retailPriceExVAT: string;
    public actualPrice: string;
    public fuelType: string;
    public transmission: string;
    public transmissionType: string;
    public colour: string;
    public colourCode: string;
    public colourDescription: string;
    public commissionNumber: string;
    public offerAvailable: boolean;
    public campaignDiscountOfferTotal: number;
    public campaignDiscountOfferTotalCurrent: number;
    public campaignDiscountOfferTotalPending: number;
    public campaignServiceOfferTotal: number;
    public campaignServiceOfferTotalCurrent: number;
    public campaignServiceOfferTotalPending: number;
    public campaignCustomOfferTotal: number;
    public campaignPersonalisedOfferTotalCurrent: number;
    public campaignPersonalisedOfferTotalPending: number;
    public campaignPersonalisedOfferTotal: number;
    public campaignCustomOfferTotalCurrent: number;
    public campaignCustomOfferTotalPending: number;
    public campaignOtherOfferTotal: number;
    public campaignOtherOfferTotalCurrent: number;
    public campaignOtherOfferTotalPending: number;
    public retailerDiscountOfferTotal: number;
    public retailerDiscountOfferTotalCurrent: number;
    public retailerDiscountOfferTotalPending: number;
    public retailerServiceOfferTotal: number;
    public retailerServiceOfferTotalCurrent: number;
    public retailerServiceOfferTotalPending: number;
    public retailerCustomOfferTotal: number;
    public retailerCustomOfferTotalCurrent: number;
    public retailerCustomOfferTotalPending: number;
    public retailerWarrantyOfferTotal: number;
    public retailerWarrantyOfferTotalCurrent: number;
    public retailerWarrantyOfferTotalPending: number;
    public retailerOfferTotal: number;
    public retailerOfferTotalCurrent: number;
    public retailerOfferTotalPending: number;
    public campaignOfferTotal: number;
    public campaignOfferTotalCurrent: number;
    public campaignOfferTotalPending: number;
    public campaignAndOfferTotal: number;
    public campaignAndOfferTotalCurrent: number;
    public campaignAndOfferTotalPending: number;
    public offerTotal: number;
    public offerTotalCurrent: number;
    public offerTotalPending: number;
    public creation: string;
    public modified: string;
    public electricRange: number;
    public electricConsumption: number;
    public portArrivalDate?: string;
    public daysSincePortArrival?: number;
    public retailPriceIncVAT: number;
    public bodyStyle: string;
    public upholstery: string;
    public upholsteryCode: string;
    public upholsteryType: string;
    public packageNames: string[] = [];
    public line: string;
    public currentRetailerOfferPrice: number;
    public retailPrice: string;
    public vatQualifying: boolean;
    public retailerId: number;
    public gssnId: string;
    public noImage: boolean;
    public imageUrl: string;
    public isAvailableOnline: boolean;
    public isBackOrdered: boolean;
    public creationDate: string;
    public maintenanceDate: string;
    public registrationNumber: string;
    public registrationDate?: string;
    public mileage?: number;
    public tradeInDate?: string;
    public source: string;
    public vehicleType: string;
    public offerAmount: string;
    public offerExpiry: string;
    public activeOffers: number[] = [];
    public campaignMessagesTotal: number;
    public underOffer: boolean;
    public isDisplayStock: boolean;
    public displayRetailer: string;
    public displayRetailerGssnId: string;
    public location: string;
    public account: string;
    public accountType: string;
    public usageCode: string;
    public bm7NST: string;
    public isSellable: boolean;
    public secured: boolean;
    public specialist: boolean;
    public isMotabilityRetailer: boolean;
    public upholsteryDescription: string;
    public inBackOrderAccount: boolean;
    public fullModelYearCode?: string;
    public productionDate?: string;
    public baumuster: string;
    public isMotability: boolean;
    public pipAdvanceRentalGross?: number;
    public wpmsAdvanceRentalGross?: number;
    public ispVehicleCustomerDescriptions?: string[];

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

export class VehicleData extends VehicleDataBase
{
    public engine: string;

    public constructor(init?: Partial<VehicleData>) { super(init); (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 VehicleIdentifierData extends VehicleData
{
    public retailer: string;
    public hasMotabilityError: boolean;
    public equipment: Equipment[] = [];

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

export class VehicleByCommissionNumberResponse extends VehicleByIdentifierResponse
{
    public vehicle: VehicleIdentifierData;

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

export class VehicleByCommissionNumberRequest implements IGet
{
    public vehicleIdentifier: string;
    public vehicleType: string;

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

TypeScript VehicleByCommissionNumberRequest 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.

GET /v1/{VehicleType}/Vehicle/{vehicleIdentifier} HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: application/xml

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

<VehicleByCommissionNumberResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO">
  <CampaignMessages>
    <Message>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <To>String</To>
      <Value>String</Value>
      <Vin>String</Vin>
    </Message>
  </CampaignMessages>
  <CampaignOLEVGrantOffers>
    <Offer>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
    </Offer>
  </CampaignOLEVGrantOffers>
  <CampaignOffers>
    <Offer>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
    </Offer>
  </CampaignOffers>
  <CampaignPersonalisedOffers>
    <PersonalisedOffer>
      <CampaignName>String</CampaignName>
      <CampaignVIPDiscount>false</CampaignVIPDiscount>
      <DocumentUrl>String</DocumentUrl>
      <From>String</From>
      <Id>0</Id>
      <IsPersonalisedMonetaryOffer>false</IsPersonalisedMonetaryOffer>
      <Net>0</Net>
      <OfferType>String</OfferType>
      <OfferValueNet>0</OfferValueNet>
      <OfferVehicle>
        <RetailPriceExVAT>String</RetailPriceExVAT>
      </OfferVehicle>
      <Pending>false</Pending>
      <Personalised>false</Personalised>
      <To>String</To>
      <Value>String</Value>
      <Category>String</Category>
      <Description>String</Description>
      <Reference>String</Reference>
    </PersonalisedOffer>
  </CampaignPersonalisedOffers>
  <FinanceOffers>
    <FinanceOffer>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <DocumentUrl>String</DocumentUrl>
      <Enabled>false</Enabled>
      <From>String</From>
      <Id>0</Id>
      <Label>String</Label>
      <OfferType>String</OfferType>
      <Pending>false</Pending>
      <TermsAndConditions>String</TermsAndConditions>
      <To>String</To>
      <Value>String</Value>
      <Vin>String</Vin>
    </FinanceOffer>
  </FinanceOffers>
  <OfferHistories>
    <OfferHistory>
      <AuditType>String</AuditType>
      <CampaignDescription>String</CampaignDescription>
      <CampaignId>0</CampaignId>
      <CommissionNumber>String</CommissionNumber>
      <Creation>String</Creation>
      <CreationDate>0001-01-01T00:00:00</CreationDate>
      <Description>String</Description>
      <From>String</From>
      <Gssn>String</Gssn>
      <Id>0</Id>
      <IsUsedCarOffer>false</IsUsedCarOffer>
      <Modified>String</Modified>
      <Net>String</Net>
      <OfferId>0</OfferId>
      <OfferType>String</OfferType>
      <Personalised>false</Personalised>
      <Source>String</Source>
      <To>String</To>
      <User>0</User>
      <UserId>String</UserId>
      <VAT>String</VAT>
      <Value>String</Value>
      <Vin>String</Vin>
    </OfferHistory>
  </OfferHistories>
  <Vehicle>
    <Account>String</Account>
    <AccountType>String</AccountType>
    <ActiveOffers xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </ActiveOffers>
    <ActualPrice>String</ActualPrice>
    <Baumuster>String</Baumuster>
    <Bm7NST>String</Bm7NST>
    <BodyStyle>String</BodyStyle>
    <CampaignAndOfferTotal>0</CampaignAndOfferTotal>
    <CampaignAndOfferTotalCurrent>0</CampaignAndOfferTotalCurrent>
    <CampaignAndOfferTotalPending>0</CampaignAndOfferTotalPending>
    <CampaignCustomOfferTotal>0</CampaignCustomOfferTotal>
    <CampaignCustomOfferTotalCurrent>0</CampaignCustomOfferTotalCurrent>
    <CampaignCustomOfferTotalPending>0</CampaignCustomOfferTotalPending>
    <CampaignDiscountOfferTotal>0</CampaignDiscountOfferTotal>
    <CampaignDiscountOfferTotalCurrent>0</CampaignDiscountOfferTotalCurrent>
    <CampaignDiscountOfferTotalPending>0</CampaignDiscountOfferTotalPending>
    <CampaignMessagesTotal>0</CampaignMessagesTotal>
    <CampaignOfferTotal>0</CampaignOfferTotal>
    <CampaignOfferTotalCurrent>0</CampaignOfferTotalCurrent>
    <CampaignOfferTotalPending>0</CampaignOfferTotalPending>
    <CampaignOtherOfferTotal>0</CampaignOtherOfferTotal>
    <CampaignOtherOfferTotalCurrent>0</CampaignOtherOfferTotalCurrent>
    <CampaignOtherOfferTotalPending>0</CampaignOtherOfferTotalPending>
    <CampaignPersonalisedOfferTotal>0</CampaignPersonalisedOfferTotal>
    <CampaignPersonalisedOfferTotalCurrent>0</CampaignPersonalisedOfferTotalCurrent>
    <CampaignPersonalisedOfferTotalPending>0</CampaignPersonalisedOfferTotalPending>
    <CampaignServiceOfferTotal>0</CampaignServiceOfferTotal>
    <CampaignServiceOfferTotalCurrent>0</CampaignServiceOfferTotalCurrent>
    <CampaignServiceOfferTotalPending>0</CampaignServiceOfferTotalPending>
    <Colour>String</Colour>
    <ColourCode>String</ColourCode>
    <ColourDescription>String</ColourDescription>
    <CommissionNumber>String</CommissionNumber>
    <Creation>String</Creation>
    <CreationDate>String</CreationDate>
    <CurrentRetailerOfferPrice>0</CurrentRetailerOfferPrice>
    <DaysSincePortArrival>0</DaysSincePortArrival>
    <Description>String</Description>
    <DisplayRetailer>String</DisplayRetailer>
    <DisplayRetailerGssnId>String</DisplayRetailerGssnId>
    <ElectricConsumption>0</ElectricConsumption>
    <ElectricRange>0</ElectricRange>
    <FuelType>String</FuelType>
    <FullModelYearCode>String</FullModelYearCode>
    <GssnId>String</GssnId>
    <ImageUrl>String</ImageUrl>
    <InBackOrderAccount>false</InBackOrderAccount>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsBackOrdered>false</IsBackOrdered>
    <IsDisplayStock>false</IsDisplayStock>
    <IsMotability>false</IsMotability>
    <IsMotabilityRetailer>false</IsMotabilityRetailer>
    <IsSellable>false</IsSellable>
    <IspVehicleCustomerDescriptions xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </IspVehicleCustomerDescriptions>
    <Line>String</Line>
    <Location>String</Location>
    <MaintenanceDate>String</MaintenanceDate>
    <Mileage>0</Mileage>
    <Model>String</Model>
    <Modified>String</Modified>
    <NoImage>false</NoImage>
    <OfferAmount>String</OfferAmount>
    <OfferAvailable>false</OfferAvailable>
    <OfferExpiry>String</OfferExpiry>
    <OfferTotal>0</OfferTotal>
    <OfferTotalCurrent>0</OfferTotalCurrent>
    <OfferTotalPending>0</OfferTotalPending>
    <Otr>String</Otr>
    <PackageNames xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </PackageNames>
    <PipAdvanceRentalGross>0</PipAdvanceRentalGross>
    <PortArrivalDate>0001-01-01T00:00:00</PortArrivalDate>
    <ProductionDate>0001-01-01T00:00:00</ProductionDate>
    <RegistrationDate>0001-01-01T00:00:00</RegistrationDate>
    <RegistrationNumber>String</RegistrationNumber>
    <RetailPrice>String</RetailPrice>
    <RetailPriceExVAT>String</RetailPriceExVAT>
    <RetailPriceIncVAT>0</RetailPriceIncVAT>
    <RetailerCustomOfferTotal>0</RetailerCustomOfferTotal>
    <RetailerCustomOfferTotalCurrent>0</RetailerCustomOfferTotalCurrent>
    <RetailerCustomOfferTotalPending>0</RetailerCustomOfferTotalPending>
    <RetailerDiscountOfferTotal>0</RetailerDiscountOfferTotal>
    <RetailerDiscountOfferTotalCurrent>0</RetailerDiscountOfferTotalCurrent>
    <RetailerDiscountOfferTotalPending>0</RetailerDiscountOfferTotalPending>
    <RetailerId>0</RetailerId>
    <RetailerOfferTotal>0</RetailerOfferTotal>
    <RetailerOfferTotalCurrent>0</RetailerOfferTotalCurrent>
    <RetailerOfferTotalPending>0</RetailerOfferTotalPending>
    <RetailerServiceOfferTotal>0</RetailerServiceOfferTotal>
    <RetailerServiceOfferTotalCurrent>0</RetailerServiceOfferTotalCurrent>
    <RetailerServiceOfferTotalPending>0</RetailerServiceOfferTotalPending>
    <RetailerWarrantyOfferTotal>0</RetailerWarrantyOfferTotal>
    <RetailerWarrantyOfferTotalCurrent>0</RetailerWarrantyOfferTotalCurrent>
    <RetailerWarrantyOfferTotalPending>0</RetailerWarrantyOfferTotalPending>
    <Secured>false</Secured>
    <Source>String</Source>
    <Specialist>false</Specialist>
    <TradeInDate>0001-01-01T00:00:00</TradeInDate>
    <Transmission>String</Transmission>
    <TransmissionType>String</TransmissionType>
    <UnderOffer>false</UnderOffer>
    <Upholstery>String</Upholstery>
    <UpholsteryCode>String</UpholsteryCode>
    <UpholsteryDescription>String</UpholsteryDescription>
    <UpholsteryType>String</UpholsteryType>
    <UsageCode>String</UsageCode>
    <VATQualifying>false</VATQualifying>
    <VehicleType>String</VehicleType>
    <Vin>String</Vin>
    <WpmsAdvanceRentalGross>0</WpmsAdvanceRentalGross>
    <Engine>String</Engine>
    <Equipment xmlns:d3p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
      <d3p1:Equipment>
        <d3p1:Code>String</d3p1:Code>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
      </d3p1:Equipment>
    </Equipment>
    <HasMotabilityError>false</HasMotabilityError>
    <Retailer>String</Retailer>
  </Vehicle>
</VehicleByCommissionNumberResponse>