| POST | /v1/backorder/vehicleimports |
|---|
"use strict";
export class UpdateBackOrderVehicleImportsResponse {
constructor(init) { Object.assign(this, init) }
}
export class Vehicle {
/** @param {{Vin?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Vin;
}
export class VehicleCriteriaMatch {
/** @param {{Fuel?:boolean,Transmission?:boolean,Colour?:boolean,Upholstery?:boolean,Line?:boolean,Engine?:boolean,BodyStyle?:boolean,Packages?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Fuel;
/** @type {boolean} */
Transmission;
/** @type {boolean} */
Colour;
/** @type {boolean} */
Upholstery;
/** @type {boolean} */
Line;
/** @type {boolean} */
Engine;
/** @type {boolean} */
BodyStyle;
/** @type {boolean} */
Packages;
}
/** @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 VehicleBaseDetail extends Vehicle {
/** @param {{Description?:string,CommissionNumber?:string,PortArrivalDate?:string,OfferExpiryDate?:string,Fuel?:string,Transmission?:string,TransmissionType?:string,Colour?:string,ColourDescription?:string,ImageUrl?:string,Specialist?:boolean,VehicleCriteriaMatch?:VehicleCriteriaMatch,ColourGroup?:string,Model?:string,BodyStyle?:string,Brand?:string,Engine?:string,EngineDescription?:string,Line?:string,Upholstery?:string,UpholsteryDescription?:string,Packages?:string[],P11D?:number,Prices?:Price[],VehicleClass?:string,ProductRange?:string,VehicleType?:string,Emission?:number,Baumuster?:string,IsSellable?:boolean,Bm7NST?:string,ElectricRange?:number,ElectricConsumption?:number,IsDisplayStock?:boolean,DisplayRetailer_Id?:number,DisplayRetailer?:string,DisplayRetailerGssnId?:string,Retailer?:Retailer,Age?:number,ModelYearCode?:string,HalfModelYearCode?:string,FullModelYearCode?:string,ProductionDate?:string,ChassisNumber?:string,EligibleForIntegratedServiceCare?:boolean,Vin?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {string} */
CommissionNumber;
/** @type {string} */
PortArrivalDate;
/** @type {string} */
OfferExpiryDate;
/** @type {string} */
Fuel;
/** @type {string} */
Transmission;
/** @type {string} */
TransmissionType;
/** @type {string} */
Colour;
/** @type {string} */
ColourDescription;
/** @type {string} */
ImageUrl;
/** @type {boolean} */
Specialist;
/** @type {?VehicleCriteriaMatch} */
VehicleCriteriaMatch;
/** @type {string} */
ColourGroup;
/** @type {string} */
Model;
/** @type {string} */
BodyStyle;
/** @type {string} */
Brand;
/** @type {string} */
Engine;
/** @type {string} */
EngineDescription;
/** @type {string} */
Line;
/** @type {string} */
Upholstery;
/** @type {string} */
UpholsteryDescription;
/** @type {string[]} */
Packages = [];
/** @type {number} */
P11D;
/** @type {Price[]} */
Prices = [];
/** @type {string} */
VehicleClass;
/** @type {string} */
ProductRange;
/** @type {string} */
VehicleType;
/** @type {?number} */
Emission;
/** @type {string} */
Baumuster;
/** @type {boolean} */
IsSellable;
/** @type {string} */
Bm7NST;
/** @type {?number} */
ElectricRange;
/** @type {?number} */
ElectricConsumption;
/** @type {boolean} */
IsDisplayStock;
/** @type {?number} */
DisplayRetailer_Id;
/** @type {string} */
DisplayRetailer;
/** @type {string} */
DisplayRetailerGssnId;
/** @type {Retailer} */
Retailer;
/** @type {?number} */
Age;
/** @type {string} */
ModelYearCode;
/** @type {string} */
HalfModelYearCode;
/** @type {string} */
FullModelYearCode;
/** @type {string} */
ProductionDate;
/** @type {?string} */
ChassisNumber;
/** @type {boolean} */
EligibleForIntegratedServiceCare;
}
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 VehicleDetail extends VehicleBaseDetail {
/** @param {{RetailPrice_ExVAT?:string,OTR?:string,ActualPrice?:string,TotalOfferValue?:string,IsHOBackOrderAccountVehicle?:boolean,ConsumptionCombined?:VehicleConsumption,ConsumptionExtraUrban?:VehicleConsumption,ConsumptionUrban?:VehicleConsumption,WltpFuelConsumptionCombined?:VehicleConsumption,WltpFuelConsumptionExtraHigh?:VehicleConsumption,WltpFuelConsumptionHigh?:VehicleConsumption,WltpFuelConsumptionLow?:VehicleConsumption,WltpFuelConsumptionMedium?:VehicleConsumption,EquipmentCategories?:VehicleEquipmentCategory[],VehicleEnergyEfficiencyClass?:VehicleEmissionClass,VehicleData?:VehicleAttribute[],IntegratedProducts?:VehicleIntegratedServiceCareOption[],IspVehicleCustomerDescriptions?:string[],ColourCode?:string,UpholsteryCode?:string,Description?:string,CommissionNumber?:string,PortArrivalDate?:string,OfferExpiryDate?:string,Fuel?:string,Transmission?:string,TransmissionType?:string,Colour?:string,ColourDescription?:string,ImageUrl?:string,Specialist?:boolean,VehicleCriteriaMatch?:VehicleCriteriaMatch,ColourGroup?:string,Model?:string,BodyStyle?:string,Brand?:string,Engine?:string,EngineDescription?:string,Line?:string,Upholstery?:string,UpholsteryDescription?:string,Packages?:string[],P11D?:number,Prices?:Price[],VehicleClass?:string,ProductRange?:string,VehicleType?:string,Emission?:number,Baumuster?:string,IsSellable?:boolean,Bm7NST?:string,ElectricRange?:number,ElectricConsumption?:number,IsDisplayStock?:boolean,DisplayRetailer_Id?:number,DisplayRetailer?:string,DisplayRetailerGssnId?:string,Retailer?:Retailer,Age?:number,ModelYearCode?:string,HalfModelYearCode?:string,FullModelYearCode?:string,ProductionDate?:string,ChassisNumber?:string,EligibleForIntegratedServiceCare?:boolean,Vin?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
RetailPrice_ExVAT;
/** @type {string} */
OTR;
/** @type {string} */
ActualPrice;
/** @type {string} */
TotalOfferValue;
/** @type {boolean} */
IsHOBackOrderAccountVehicle;
/** @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 {?VehicleEquipmentCategory[]} */
EquipmentCategories;
/** @type {?VehicleEmissionClass} */
VehicleEnergyEfficiencyClass;
/** @type {?VehicleAttribute[]} */
VehicleData;
/** @type {VehicleIntegratedServiceCareOption[]} */
IntegratedProducts = [];
/** @type {?string[]} */
IspVehicleCustomerDescriptions;
/** @type {string} */
ColourCode;
/** @type {string} */
UpholsteryCode;
}
export class VehicleImport extends Vehicle {
/** @param {{CommissionNumber?:string,Sellable?:boolean,Vehicle?:VehicleDetail,Vin?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
CommissionNumber;
/** @type {boolean} */
Sellable;
/** @type {VehicleDetail} */
Vehicle;
}
export class UpdateBackOrderVehicleImportsRequest {
/** @param {{VehicleImports?:VehicleImport[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {VehicleImport[]} */
VehicleImports = [];
}
JavaScript UpdateBackOrderVehicleImportsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/backorder/vehicleimports HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
VehicleImports:
[
{
CommissionNumber: String,
Sellable: False,
Vehicle:
{
RetailPrice_ExVAT: String,
OTR: String,
ActualPrice: String,
TotalOfferValue: String,
IsHOBackOrderAccountVehicle: False,
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
},
EquipmentCategories:
[
{
Order: 0,
Code: String,
Description: String,
Equipment:
[
{
Importance: 0,
IsAdditional: False,
Id: 0,
Code: String,
Description: String
}
]
}
],
VehicleEnergyEfficiencyClass:
{
Colour: String,
Rating: String
},
VehicleData:
[
{
Description: String,
Value: String
}
],
IntegratedProducts:
[
{
OptionCode: String,
BM7NST: String,
FullModelYear: String,
IntegratedProductType: String,
CustomerDescription: String,
OneAgentProductType: String
}
],
IspVehicleCustomerDescriptions:
[
String
],
ColourCode: String,
UpholsteryCode: String,
Description: String,
CommissionNumber: String,
PortArrivalDate: String,
OfferExpiryDate: String,
Fuel: String,
Transmission: String,
TransmissionType: String,
Colour: String,
ColourDescription: String,
ImageUrl: String,
Specialist: False,
VehicleCriteriaMatch:
{
Fuel: False,
Transmission: False,
Colour: False,
Upholstery: False,
Line: False,
Engine: False,
BodyStyle: False,
Packages: False
},
ColourGroup: String,
Model: String,
BodyStyle: String,
Brand: String,
Engine: String,
EngineDescription: String,
Line: String,
Upholstery: String,
UpholsteryDescription: String,
Packages:
[
String
],
P11D: 0,
Prices:
[
{
Id: String,
Description: String,
Net: 0,
VAT: 0,
Gross: 0,
Product: LIST_PRICE
}
],
VehicleClass: String,
ProductRange: String,
VehicleType: String,
Emission: 0,
Baumuster: String,
IsSellable: False,
Bm7NST: String,
ElectricRange: 0,
ElectricConsumption: 0,
IsDisplayStock: False,
DisplayRetailer_Id: 0,
DisplayRetailer: String,
DisplayRetailerGssnId: 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
}
]
}
},
Age: 0,
ModelYearCode: String,
HalfModelYearCode: String,
FullModelYearCode: String,
ProductionDate: String,
ChassisNumber: String,
EligibleForIntegratedServiceCare: False,
Vin: String
},
Vin: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
}