| POST | /v1/vehicle | Get Vehicle by Vin |
|---|
"use strict";
export class GetVehicleRequest {
/** @param {{Vin?:string,IncludeAllocatedToOrder?:boolean,Gssn?:string,IsOneAdmin?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Vin;
/** @type {boolean} */
IncludeAllocatedToOrder;
/** @type {string} */
Gssn;
/** @type {boolean} */
IsOneAdmin;
}
export class Model {
/** @param {{Id?:number,Description?:string,DisplayName?:string,ImageUrlSmall?:string,ImageUrlMedium?:string,ImageUrlLarge?:string,Specialist?:boolean,Priority?:number,ExcludeFromOnlineShowroomFilters?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?string} */
Description;
/** @type {?string} */
DisplayName;
/** @type {?string} */
ImageUrlSmall;
/** @type {?string} */
ImageUrlMedium;
/** @type {?string} */
ImageUrlLarge;
/** @type {boolean} */
Specialist;
/** @type {number} */
Priority;
/** @type {?boolean} */
ExcludeFromOnlineShowroomFilters;
}
export class BodyStyle {
/** @param {{Id?:number,Description?:string,Models?:Model[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?string} */
Description;
/** @type {?Model[]} */
Models;
}
export class Brand {
/** @param {{Id?:number,Description?:string,DisplayName?:string,BodyStyles?:BodyStyle[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?string} */
Description;
/** @type {?string} */
DisplayName;
/** @type {?BodyStyle[]} */
BodyStyles;
}
export class Engine {
/** @param {{Id?:number,Badge?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
Id;
/** @type {string} */
Badge;
}
export class Media {
/** @param {{NoImage?:boolean,MainImageUrl?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
NoImage;
/** @type {string} */
MainImageUrl;
}
/** @typedef {'LIST_PRICE'|'NUMBER_PLATE_FEE'|'DELIVERY_CHARGE'|'FUEL_CHARGE'|'MANUFACTURER_OFFER'|'PERSONALISED_MONEYOFFER'|'PERSONALISED_NONMONEYOFFER'|'PERSONALISED_NONMONEYOFFER_NEG'|'SERVICE'|'SERVICE_NEG'|'GOVERNMENT_GRANT'|'OUTRIGHT_PURCHASE_DISCOUNT'|'VIP_OFFER'|'WALLBOX_OFFER'|'WALLBOX_OFFER_NEG'|'ROAD_FUND_LICENCE'|'FIRST_REGISTRATION_FEE'|'NOT_FOUND'|'ACCESSORY_OFFER'|'ACCESSORY_OFFER_NEG'|'MOTABILITY_DISCOUNT'} */
export var OfferPriceProductType;
(function (OfferPriceProductType) {
OfferPriceProductType["LIST_PRICE"] = "LIST_PRICE"
OfferPriceProductType["NUMBER_PLATE_FEE"] = "NUMBER_PLATE_FEE"
OfferPriceProductType["DELIVERY_CHARGE"] = "DELIVERY_CHARGE"
OfferPriceProductType["FUEL_CHARGE"] = "FUEL_CHARGE"
OfferPriceProductType["MANUFACTURER_OFFER"] = "MANUFACTURER_OFFER"
OfferPriceProductType["PERSONALISED_MONEYOFFER"] = "PERSONALISED_MONEYOFFER"
OfferPriceProductType["PERSONALISED_NONMONEYOFFER"] = "PERSONALISED_NONMONEYOFFER"
OfferPriceProductType["PERSONALISED_NONMONEYOFFER_NEG"] = "PERSONALISED_NONMONEYOFFER_NEG"
OfferPriceProductType["SERVICE"] = "SERVICE"
OfferPriceProductType["SERVICE_NEG"] = "SERVICE_NEG"
OfferPriceProductType["GOVERNMENT_GRANT"] = "GOVERNMENT_GRANT"
OfferPriceProductType["OUTRIGHT_PURCHASE_DISCOUNT"] = "OUTRIGHT_PURCHASE_DISCOUNT"
OfferPriceProductType["VIP_OFFER"] = "VIP_OFFER"
OfferPriceProductType["WALLBOX_OFFER"] = "WALLBOX_OFFER"
OfferPriceProductType["WALLBOX_OFFER_NEG"] = "WALLBOX_OFFER_NEG"
OfferPriceProductType["ROAD_FUND_LICENCE"] = "ROAD_FUND_LICENCE"
OfferPriceProductType["FIRST_REGISTRATION_FEE"] = "FIRST_REGISTRATION_FEE"
OfferPriceProductType["NOT_FOUND"] = "NOT_FOUND"
OfferPriceProductType["ACCESSORY_OFFER"] = "ACCESSORY_OFFER"
OfferPriceProductType["ACCESSORY_OFFER_NEG"] = "ACCESSORY_OFFER_NEG"
OfferPriceProductType["MOTABILITY_DISCOUNT"] = "MOTABILITY_DISCOUNT"
})(OfferPriceProductType || (OfferPriceProductType = {}));
export class Price {
/** @param {{Id?:string,Description?:string,Net?:number,VAT?:number,Gross?:number,Product?:OfferPriceProductType}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Id;
/** @type {string} */
Description;
/** @type {number} */
Net;
/** @type {number} */
VAT;
/** @type {number} */
Gross;
/** @type {OfferPriceProductType} */
Product;
}
export class RetailerOpeningTime {
/** @param {{Day?:string,OpenFrom?:string,OpenTo?:string,Special?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Day;
/** @type {string} */
OpenFrom;
/** @type {string} */
OpenTo;
/** @type {string} */
Special;
}
export class RetailerOpeningTimes {
/** @param {{New?:RetailerOpeningTime[],Used?:RetailerOpeningTime[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {RetailerOpeningTime[]} */
New = [];
/** @type {RetailerOpeningTime[]} */
Used = [];
}
export class Retailer {
/** @param {{Id?:number,GssnId?:string,Description?:string,Street?:string,City?:string,Postcode?:string,GoogleMapPostcode?:string,Phone?:string,Fax?:string,Email?:string,Website?:string,RetailerGroupId?:string,RetailerGroupName?:string,IsOnline?:boolean,IsNewCarRetailer?:boolean,IsUsedCarRetailer?:boolean,IsCentralRetailer?:boolean,ChatEnabled?:boolean,TradeInEnabled?:boolean,smart?:boolean,DisplayPhoneNumberNew?:string,DisplayPhoneNumberUsed?:string,Latitude?:number,Longitude?:number,smartDescription?:string,smartWebsite?:string,smartPhone?:string,LegacyId?:string,Agent?:boolean,MarketAreaId?:number,DigitalLoungeParentGssnId?:string,SendLeadsToDigitalLoungeParent?:boolean,OpeningTimes?:RetailerOpeningTimes}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
GssnId;
/** @type {string} */
Description;
/** @type {string} */
Street;
/** @type {string} */
City;
/** @type {string} */
Postcode;
/** @type {string} */
GoogleMapPostcode;
/** @type {string} */
Phone;
/** @type {string} */
Fax;
/** @type {string} */
Email;
/** @type {string} */
Website;
/** @type {string} */
RetailerGroupId;
/** @type {string} */
RetailerGroupName;
/** @type {boolean} */
IsOnline;
/** @type {boolean} */
IsNewCarRetailer;
/** @type {boolean} */
IsUsedCarRetailer;
/** @type {boolean} */
IsCentralRetailer;
/** @type {boolean} */
ChatEnabled;
/** @type {boolean} */
TradeInEnabled;
/** @type {boolean} */
smart;
/** @type {string} */
DisplayPhoneNumberNew;
/** @type {string} */
DisplayPhoneNumberUsed;
/** @type {number} */
Latitude;
/** @type {number} */
Longitude;
/** @type {string} */
smartDescription;
/** @type {string} */
smartWebsite;
/** @type {string} */
smartPhone;
/** @type {string} */
LegacyId;
/** @type {boolean} */
Agent;
/** @type {number} */
MarketAreaId;
/** @type {?string} */
DigitalLoungeParentGssnId;
/** @type {boolean} */
SendLeadsToDigitalLoungeParent;
/** @type {?RetailerOpeningTimes} */
OpeningTimes;
}
export class VehicleConsumption {
/** @param {{Id?:number,Lkm?:number,Mpg?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {number} */
Lkm;
/** @type {number} */
Mpg;
}
export class Equipment {
/** @param {{Id?:number,Code?:string,Description?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?string} */
Code;
/** @type {?string} */
Description;
}
export class Equipmentv2 extends Equipment {
/** @param {{Importance?:number,IsAdditional?:boolean,Id?:number,Code?:string,Description?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {number} */
Importance;
/** @type {boolean} */
IsAdditional;
}
export class VehicleEquipmentCategory {
/** @param {{Order?:number,Code?:string,Description?:string,Equipment?:Equipmentv2[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Order;
/** @type {?string} */
Code;
/** @type {?string} */
Description;
/** @type {?Equipmentv2[]} */
Equipment;
}
export class VehicleEmissionClass {
/** @param {{Colour?:string,Rating?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Colour;
/** @type {?string} */
Rating;
}
export class VehicleAttribute {
/** @param {{Description?:string,Value?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Description;
/** @type {?string} */
Value;
}
export class VehicleIntegratedServiceCareOption {
/** @param {{OptionCode?:string,BM7NST?:string,FullModelYear?:string,IntegratedProductType?:string,CustomerDescription?:string,OneAgentProductType?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
OptionCode;
/** @type {?string} */
BM7NST;
/** @type {?string} */
FullModelYear;
/** @type {?string} */
IntegratedProductType;
/** @type {?string} */
CustomerDescription;
/** @type {?string} */
OneAgentProductType;
}
export class VehicleDetailDto {
/** @param {{BodyStyle?:string,Vin?:string,Description?:string,Colour?:string,ColourCode?:string,ColourDescription?:string,ColourGroup?:string,Model?:string,CommissionNumber?:string,BrandId?:number,Brand?:Brand,Engine?:Engine,EngineBadge?:string,Media?:Media,Line?:string,UpholsteryCode?:string,UpholsteryType?:string,Upholstery?:string,UpholsteryDescription?:string,AvailablePackages?:string[],Packages?:string[],P11D?:number,PortArrivalDate?:string,Prices?:Price[],TransmissionType?:string,FuelType?:string,VehicleClass?:string,ProductRange?:string,VehicleType?:string,Emission?:number,IsAvailableOnline?:boolean,UnderOffer?:boolean,IsExcluded?:boolean,IsSellable?:boolean,OnHold?:boolean,ElectricConsumption?:number,ElectricRange?:number,ImageUrl?:string,Baumuster?:string,Retailer?:Retailer,Bm7NST?:string,OTR?:number,ActualPrice?:number,IsDisplayStock?:boolean,DisplayRetailerId?:number,DisplayRetailer?:string,DisplayRetailerGssnId?:string,DisplayRetailerMarketAreaId?:string,IsSmartDisplayRetailer?:boolean,IsSpecialistCar?:boolean,Age?:number,Secured?:boolean,IsHOBackOrderAccountVehicle?:boolean,IsAllocatedToBackOrder?:boolean,UsageCode?:string,EmissionCombined?:number,NormalisedEmissionDirective?:string,HasMildHybridEquipmentCode?:boolean,RetailPriceExVat?:number,RetailPrice_IncVAT?:number,RetailPrice_ExVAT?:number,ModelId?:number,VID?:string,ProductionDate?:string,FullModelYearCode?:string,ChassisNumber?:string,EligibleForIntegratedServiceCare?:boolean,AccountType?:string,ConsumptionCombined?:VehicleConsumption,ConsumptionExtraUrban?:VehicleConsumption,ConsumptionUrban?:VehicleConsumption,WltpFuelConsumptionCombined?:VehicleConsumption,WltpFuelConsumptionExtraHigh?:VehicleConsumption,WltpFuelConsumptionHigh?:VehicleConsumption,WltpFuelConsumptionLow?:VehicleConsumption,WltpFuelConsumptionMedium?:VehicleConsumption,Equipment?:Equipmentv2[],EquipmentCategories?:VehicleEquipmentCategory[],EnergyEfficiencyClass?:VehicleEmissionClass,VehicleData?:VehicleAttribute[],IntegratedServiceCareOptions?:VehicleIntegratedServiceCareOption[],IspVehicleCustomerDescriptions?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
BodyStyle;
/** @type {string} */
Vin;
/** @type {string} */
Description;
/** @type {string} */
Colour;
/** @type {string} */
ColourCode;
/** @type {string} */
ColourDescription;
/** @type {string} */
ColourGroup;
/** @type {string} */
Model;
/** @type {string} */
CommissionNumber;
/** @type {?number} */
BrandId;
/** @type {Brand} */
Brand;
/** @type {Engine} */
Engine;
/** @type {string} */
EngineBadge;
/** @type {Media} */
Media;
/** @type {string} */
Line;
/** @type {string} */
UpholsteryCode;
/** @type {string} */
UpholsteryType;
/** @type {string} */
Upholstery;
/** @type {string} */
UpholsteryDescription;
/** @type {string[]} */
AvailablePackages = [];
/** @type {string[]} */
Packages = [];
/** @type {number} */
P11D;
/** @type {?string} */
PortArrivalDate;
/** @type {Price[]} */
Prices = [];
/** @type {string} */
TransmissionType;
/** @type {string} */
FuelType;
/** @type {string} */
VehicleClass;
/** @type {string} */
ProductRange;
/** @type {string} */
VehicleType;
/** @type {?number} */
Emission;
/** @type {boolean} */
IsAvailableOnline;
/** @type {boolean} */
UnderOffer;
/** @type {boolean} */
IsExcluded;
/** @type {boolean} */
IsSellable;
/** @type {boolean} */
OnHold;
/** @type {?number} */
ElectricConsumption;
/** @type {?number} */
ElectricRange;
/** @type {string} */
ImageUrl;
/** @type {string} */
Baumuster;
/** @type {Retailer} */
Retailer;
/** @type {string} */
Bm7NST;
/** @type {number} */
OTR;
/** @type {number} */
ActualPrice;
/** @type {boolean} */
IsDisplayStock;
/** @type {?number} */
DisplayRetailerId;
/** @type {string} */
DisplayRetailer;
/** @type {string} */
DisplayRetailerGssnId;
/** @type {string} */
DisplayRetailerMarketAreaId;
/** @type {boolean} */
IsSmartDisplayRetailer;
/** @type {boolean} */
IsSpecialistCar;
/** @type {?number} */
Age;
/** @type {boolean} */
Secured;
/** @type {boolean} */
IsHOBackOrderAccountVehicle;
/** @type {boolean} */
IsAllocatedToBackOrder;
/** @type {string} */
UsageCode;
/** @type {?number} */
EmissionCombined;
/** @type {?string} */
NormalisedEmissionDirective;
/** @type {boolean} */
HasMildHybridEquipmentCode;
/** @type {number} */
RetailPriceExVat;
/** @type {number} */
RetailPrice_IncVAT;
/** @type {number} */
RetailPrice_ExVAT;
/** @type {number} */
ModelId;
/** @type {?string} */
VID;
/** @type {?string} */
ProductionDate;
/** @type {?string} */
FullModelYearCode;
/** @type {?string} */
ChassisNumber;
/** @type {boolean} */
EligibleForIntegratedServiceCare;
/** @type {?string} */
AccountType;
/** @type {?VehicleConsumption} */
ConsumptionCombined;
/** @type {?VehicleConsumption} */
ConsumptionExtraUrban;
/** @type {?VehicleConsumption} */
ConsumptionUrban;
/** @type {?VehicleConsumption} */
WltpFuelConsumptionCombined;
/** @type {?VehicleConsumption} */
WltpFuelConsumptionExtraHigh;
/** @type {?VehicleConsumption} */
WltpFuelConsumptionHigh;
/** @type {?VehicleConsumption} */
WltpFuelConsumptionLow;
/** @type {?VehicleConsumption} */
WltpFuelConsumptionMedium;
/** @type {?Equipmentv2[]} */
Equipment;
/** @type {?VehicleEquipmentCategory[]} */
EquipmentCategories;
/** @type {?VehicleEmissionClass} */
EnergyEfficiencyClass;
/** @type {?VehicleAttribute[]} */
VehicleData;
/** @type {VehicleIntegratedServiceCareOption[]} */
IntegratedServiceCareOptions = [];
/** @type {?string[]} */
IspVehicleCustomerDescriptions;
}
export class VehicleError {
/** @param {{Field?:string,Message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Field;
/** @type {string} */
Message;
}
export class GetVehicleResponse {
/** @param {{Vehicle?:VehicleDetailDto,Errors?:VehicleError[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {VehicleDetailDto} */
Vehicle;
/** @type {VehicleError[]} */
Errors = [];
}
JavaScript GetVehicleRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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: text/csv
Content-Type: text/csv
Content-Length: length
{"Vin":"String","IncludeAllocatedToOrder":false,"Gssn":"String","IsOneAdmin":false}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Vehicle":{"BodyStyle":"String","Vin":"String","Description":"String","Colour":"String","ColourCode":"String","ColourDescription":"String","ColourGroup":"String","Model":"String","CommissionNumber":"String","BrandId":0,"Brand":{"Id":0,"Description":"String","DisplayName":"String","BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}]},"Engine":{"Id":0,"Badge":"String"},"EngineBadge":"String","Media":{"NoImage":false,"MainImageUrl":"String"},"Line":"String","UpholsteryCode":"String","UpholsteryType":"String","Upholstery":"String","UpholsteryDescription":"String","AvailablePackages":["String"],"Packages":["String"],"P11D":0,"PortArrivalDate":"\/Date(-62135596800000-0000)\/","Prices":[{"Id":"String","Description":"String","Net":0,"VAT":0,"Gross":0,"Product":"LIST_PRICE"}],"TransmissionType":"String","FuelType":"String","VehicleClass":"String","ProductRange":"String","VehicleType":"String","Emission":0,"IsAvailableOnline":false,"UnderOffer":false,"IsExcluded":false,"IsSellable":false,"OnHold":false,"ElectricConsumption":0,"ElectricRange":0,"ImageUrl":"String","Baumuster":"String","Retailer":{"Id":0,"GssnId":"String","Description":"String","Street":"String","City":"String","Postcode":"String","GoogleMapPostcode":"String","Phone":"String","Fax":"String","Email":"String","Website":"String","RetailerGroupId":"String","RetailerGroupName":"String","IsOnline":false,"IsNewCarRetailer":false,"IsUsedCarRetailer":false,"IsCentralRetailer":false,"ChatEnabled":false,"TradeInEnabled":false,"smart":false,"DisplayPhoneNumberNew":"String","DisplayPhoneNumberUsed":"String","Latitude":0,"Longitude":0,"smartDescription":"String","smartWebsite":"String","smartPhone":"String","LegacyId":"String","Agent":false,"MarketAreaId":0,"DigitalLoungeParentGssnId":"String","SendLeadsToDigitalLoungeParent":false,"OpeningTimes":{"New":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}],"Used":[{"Day":"String","OpenFrom":"String","OpenTo":"String","Special":"String"}]}},"Bm7NST":"String","OTR":0,"ActualPrice":0,"IsDisplayStock":false,"DisplayRetailerId":0,"DisplayRetailer":"String","DisplayRetailerGssnId":"String","DisplayRetailerMarketAreaId":"String","IsSmartDisplayRetailer":false,"IsSpecialistCar":false,"Age":0,"Secured":false,"IsHOBackOrderAccountVehicle":false,"IsAllocatedToBackOrder":false,"UsageCode":"String","EmissionCombined":0,"NormalisedEmissionDirective":"String","HasMildHybridEquipmentCode":false,"RetailPriceExVat":0,"RetailPrice_IncVAT":0,"RetailPrice_ExVAT":0,"ModelId":0,"VID":"String","ProductionDate":"String","FullModelYearCode":"String","ChassisNumber":"String","EligibleForIntegratedServiceCare":false,"AccountType":"String","ConsumptionCombined":{"Id":0,"Lkm":0,"Mpg":0},"ConsumptionExtraUrban":{"Id":0,"Lkm":0,"Mpg":0},"ConsumptionUrban":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionCombined":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionExtraHigh":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionHigh":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionLow":{"Id":0,"Lkm":0,"Mpg":0},"WltpFuelConsumptionMedium":{"Id":0,"Lkm":0,"Mpg":0},"Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}],"EquipmentCategories":[{"Order":0,"Code":"String","Description":"String","Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}]}],"EnergyEfficiencyClass":{"Colour":"String","Rating":"String"},"VehicleData":[{"Description":"String","Value":"String"}],"IntegratedServiceCareOptions":[{"OptionCode":"String","BM7NST":"String","FullModelYear":"String","IntegratedProductType":"String","CustomerDescription":"String","OneAgentProductType":"String"}],"IspVehicleCustomerDescriptions":["String"]},"Errors":[{"Field":"String","Message":"String"}]}