| POST | /v1/backorder/active/csv | Calls Agency API and fetches a list of active backorders for the Export Detailed CSV | Filter Active Back Order |
|---|
"use strict";
export class BackOrderCriteria {
/** @param {{Source?:number[],CustomerType?:number[],CommLinkedBy?:number[],VinAllocated?:boolean,VinAllocatedSellable?:boolean,VinAllocatedNotSellable?:boolean,Specialist?:boolean,LinkedOrder?:boolean,AssistanceProviders?:number[],COPConverter?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number[]} */
Source;
/** @type {?number[]} */
CustomerType;
/** @type {?number[]} */
CommLinkedBy;
/** @type {?boolean} */
VinAllocated;
/** @type {?boolean} */
VinAllocatedSellable;
/** @type {?boolean} */
VinAllocatedNotSellable;
/** @type {?boolean} */
Specialist;
/** @type {?boolean} */
LinkedOrder;
/** @type {?number[]} */
AssistanceProviders;
/** @type {?boolean} */
COPConverter;
}
export class CriteriaModel {
/** @param {{Description?:string,Id?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {number} */
Id;
}
export class VehicleCriteria {
/** @param {{Model?:CriteriaModel[],Colour?:string[],FuelType?:string[],Transmission?:string[],Engine?:string[],Line?:string[],Package?:string[],Equipment?:string[],Upholstery?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?CriteriaModel[]} */
Model;
/** @type {?string[]} */
Colour;
/** @type {?string[]} */
FuelType;
/** @type {?string[]} */
Transmission;
/** @type {?string[]} */
Engine;
/** @type {?string[]} */
Line;
/** @type {?string[]} */
Package;
/** @type {?string[]} */
Equipment;
/** @type {?string[]} */
Upholstery;
}
export class DayRange {
/** @param {{Min?:number,Max?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
Min;
/** @type {?number} */
Max;
}
export class CreateUpdate {
/** @param {{Date?:string,Range?:DayRange}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Date;
/** @type {?DayRange} */
Range;
}
export class DateCriteria {
/** @param {{Created?:CreateUpdate,Modified?:CreateUpdate}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?CreateUpdate} */
Created;
/** @type {?CreateUpdate} */
Modified;
}
export class FilterBackOrders {
/** @param {{Historical?:boolean,BackOrderCriteria?:BackOrderCriteria,VehicleCriteria?:VehicleCriteria,DateCriteria?:DateCriteria,GssnIds?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {boolean} */
Historical;
/** @type {?BackOrderCriteria} */
BackOrderCriteria;
/** @type {?VehicleCriteria} */
VehicleCriteria;
/** @type {?DateCriteria} */
DateCriteria;
/** @type {?string[]} */
GssnIds;
}
export class BackOrderHistory {
/** @param {{Status?:number,CommissionNumber?:string,VIN?:string,CustomerCriteria?:string,AgentCriteria?:string,CreationDate?:string,MaintenanceDate?:string,GasId?:string,Sellable?:boolean,AdditionalInformation?:string,Reason?:string,ConfigCode?:string,FleetBaseOrder?:string,AssistanceDetail?:string,AssistanceProvider?:string,LinkedByUserType?:string,MotabilityVTN?:string,MotabilityBackOrderDropDown?:string,MotabilityValidFrom?:string,MotabilityValidTo?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Status;
/** @type {?string} */
CommissionNumber;
/** @type {?string} */
VIN;
/** @type {string} */
CustomerCriteria;
/** @type {string} */
AgentCriteria;
/** @type {string} */
CreationDate;
/** @type {string} */
MaintenanceDate;
/** @type {string} */
GasId;
/** @type {boolean} */
Sellable;
/** @type {string} */
AdditionalInformation;
/** @type {string} */
Reason;
/** @type {string} */
ConfigCode;
/** @type {string} */
FleetBaseOrder;
/** @type {?string} */
AssistanceDetail;
/** @type {?string} */
AssistanceProvider;
/** @type {?string} */
LinkedByUserType;
/** @type {?string} */
MotabilityVTN;
/** @type {?string} */
MotabilityBackOrderDropDown;
/** @type {?string} */
MotabilityValidFrom;
/** @type {?string} */
MotabilityValidTo;
}
export class Order {
/** @param {{Guid?:string,Reference?:string,Status?:number,CustomerId?:string,MulesoftReference?:string,GasId?:string,OrderDate?:string,OfferSnapShot?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Guid;
/** @type {string} */
Reference;
/** @type {number} */
Status;
/** @type {string} */
CustomerId;
/** @type {string} */
MulesoftReference;
/** @type {string} */
GasId;
/** @type {string} */
OrderDate;
/** @type {string} */
OfferSnapShot;
}
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 MotabilityPricingCsv {
/** @param {{Id?:number,CriteriaBM7NST?:string,VTN?:string,BackOrderDropDown?:string,CriteriaFullModelYearCode?:string,CriteriaValidOptionCodes?:string,CriteriaInvalidOptionCodes?:string,PIPNet?:number,PIPVat?:number,PIPGross?:number,WPMSNet?:number,WPMSVat?:number,WPMSGross?:number,DiscountNet?:number,DiscountVat?:number,DiscountGross?:number,ListPriceNet?:number,ListPriceVat?:number,ListPriceGross?:number,DeliveryChargeNet?:number,DeliveryChargeVat?:number,DeliveryChargeGross?:number,FuelChargeNet?:number,FuelChargeVat?:number,FuelChargeGross?:number,NumberPlateFeeNet?:number,NumberPlateFeeVat?:number,NumberPlateFeeGross?:number,FirstRegistrationFeeNet?:number,FirstRegistrationFeeVat?:number,FirstRegistrationFeeGross?:number,RoadFundLicenceNet?:number,RoadFundLicenceVat?:number,RoadFundLicenceGross?:number,ValidFrom?:string,ValidTo?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
CriteriaBM7NST;
/** @type {string} */
VTN;
/** @type {string} */
BackOrderDropDown;
/** @type {string} */
CriteriaFullModelYearCode;
/** @type {?string} */
CriteriaValidOptionCodes;
/** @type {?string} */
CriteriaInvalidOptionCodes;
/** @type {number} */
PIPNet;
/** @type {number} */
PIPVat;
/** @type {number} */
PIPGross;
/** @type {number} */
WPMSNet;
/** @type {number} */
WPMSVat;
/** @type {number} */
WPMSGross;
/** @type {number} */
DiscountNet;
/** @type {number} */
DiscountVat;
/** @type {number} */
DiscountGross;
/** @type {number} */
ListPriceNet;
/** @type {number} */
ListPriceVat;
/** @type {number} */
ListPriceGross;
/** @type {number} */
DeliveryChargeNet;
/** @type {number} */
DeliveryChargeVat;
/** @type {number} */
DeliveryChargeGross;
/** @type {number} */
FuelChargeNet;
/** @type {number} */
FuelChargeVat;
/** @type {number} */
FuelChargeGross;
/** @type {number} */
NumberPlateFeeNet;
/** @type {number} */
NumberPlateFeeVat;
/** @type {number} */
NumberPlateFeeGross;
/** @type {number} */
FirstRegistrationFeeNet;
/** @type {number} */
FirstRegistrationFeeVat;
/** @type {number} */
FirstRegistrationFeeGross;
/** @type {number} */
RoadFundLicenceNet;
/** @type {number} */
RoadFundLicenceVat;
/** @type {number} */
RoadFundLicenceGross;
/** @type {string} */
ValidFrom;
/** @type {string} */
ValidTo;
}
/** @typedef {'Pending'|'Current'|'RecentlyExpired'|'Expired'} */
export var MotabilityPricingStatus;
(function (MotabilityPricingStatus) {
MotabilityPricingStatus["Pending"] = "Pending"
MotabilityPricingStatus["Current"] = "Current"
MotabilityPricingStatus["RecentlyExpired"] = "RecentlyExpired"
MotabilityPricingStatus["Expired"] = "Expired"
})(MotabilityPricingStatus || (MotabilityPricingStatus = {}));
export class MotabilityPricing extends MotabilityPricingCsv {
/** @param {{MotabilityPricingStatus?:MotabilityPricingStatus,Id?:number,CriteriaBM7NST?:string,VTN?:string,BackOrderDropDown?:string,CriteriaFullModelYearCode?:string,CriteriaValidOptionCodes?:string,CriteriaInvalidOptionCodes?:string,PIPNet?:number,PIPVat?:number,PIPGross?:number,WPMSNet?:number,WPMSVat?:number,WPMSGross?:number,DiscountNet?:number,DiscountVat?:number,DiscountGross?:number,ListPriceNet?:number,ListPriceVat?:number,ListPriceGross?:number,DeliveryChargeNet?:number,DeliveryChargeVat?:number,DeliveryChargeGross?:number,FuelChargeNet?:number,FuelChargeVat?:number,FuelChargeGross?:number,NumberPlateFeeNet?:number,NumberPlateFeeVat?:number,NumberPlateFeeGross?:number,FirstRegistrationFeeNet?:number,FirstRegistrationFeeVat?:number,FirstRegistrationFeeGross?:number,RoadFundLicenceNet?:number,RoadFundLicenceVat?:number,RoadFundLicenceGross?:number,ValidFrom?:string,ValidTo?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {MotabilityPricingStatus} */
MotabilityPricingStatus;
}
export class CarConfigurator {
/** @param {{Id?:number,BackOrderId?:number,ConfiguratorCode?:string,GasId?:string,Status?:number,DateOfLastUpdate?:string,LastExceptionMessage?:string,LastException?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?number} */
BackOrderId;
/** @type {string} */
ConfiguratorCode;
/** @type {?string} */
GasId;
/** @type {number} */
Status;
/** @type {string} */
DateOfLastUpdate;
/** @type {?string} */
LastExceptionMessage;
/** @type {?string} */
LastException;
}
export class KeyInformation {
/** @param {{BM7NST?:string,ConfigurationDate?:string,ModelYear?:string,HalfYear?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
BM7NST;
/** @type {?string} */
ConfigurationDate;
/** @type {?string} */
ModelYear;
/** @type {?string} */
HalfYear;
}
export class OrderingOptions {
/** @param {{Interior?:string[],Exterior?:string[],Other?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string[]} */
Interior;
/** @type {?string[]} */
Exterior;
/** @type {?string[]} */
Other;
}
export class CarConfiguratorResponse {
/** @param {{Name?:string,KeyInformation?:KeyInformation,OrderingOptions?:OrderingOptions,ResponseStatus?:ResponseStatus,ConfiguratorCode?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
Name;
/** @type {?KeyInformation} */
KeyInformation;
/** @type {?OrderingOptions} */
OrderingOptions;
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {?string} */
ConfiguratorCode;
}
export class BackOrderBase {
/** @param {{Guid?:string,Status?:number,CustomerId?:string,Id?:number,Reference?:string,Agent?:string,Gssn?:string,CreationDate?:string,MaintenanceDate?:string,CustomerCriteria?:string,AgentCriteria?:string,History?:BackOrderHistory[],IsAllocatedToOrder?:boolean,Vin?:string,CommissionNumber?:string,Order?:Order,Source?:string,Specialist?:boolean,OutrightPurchase?:boolean,Sellable?:boolean,MulesoftReference?:string,AdditionalInformation?:string,ConfigCode?:string,FleetBaseOrder?:string,GasId?:string,OutrightPurchaseCustomerIdentifier?:string,Retailer?:Retailer,CustomerMode?:number,CanEdit?:boolean,DigitalLoungeGssnId?:string,DigitalLounge?:string,Motability?:boolean,MotabilityPricing?:MotabilityPricing,LinkedByUserType?:string,AssistanceProviderId?:number,AssistanceProvider?:string,AssistanceDetail?:string,LastAssistanceMessageDate?:string,LastAssistanceUser?:string,IsCOPConverter?:boolean,IsEligibleCOPConverter?:boolean,CarConfigurator?:CarConfigurator,CarConfiguratorResponse?:CarConfiguratorResponse}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Guid;
/** @type {number} */
Status;
/** @type {string} */
CustomerId;
/** @type {number} */
Id;
/** @type {string} */
Reference;
/** @type {string} */
Agent;
/** @type {string} */
Gssn;
/** @type {string} */
CreationDate;
/** @type {string} */
MaintenanceDate;
/** @type {string} */
CustomerCriteria;
/** @type {?string} */
AgentCriteria;
/** @type {?BackOrderHistory[]} */
History;
/** @type {boolean} */
IsAllocatedToOrder;
/** @type {string} */
Vin;
/** @type {?string} */
CommissionNumber;
/** @type {?Order} */
Order;
/** @type {string} */
Source;
/** @type {boolean} */
Specialist;
/** @type {boolean} */
OutrightPurchase;
/** @type {boolean} */
Sellable;
/** @type {string} */
MulesoftReference;
/** @type {string} */
AdditionalInformation;
/** @type {string} */
ConfigCode;
/** @type {string} */
FleetBaseOrder;
/** @type {string} */
GasId;
/** @type {string} */
OutrightPurchaseCustomerIdentifier;
/** @type {Retailer} */
Retailer;
/** @type {number} */
CustomerMode;
/** @type {boolean} */
CanEdit;
/** @type {?string} */
DigitalLoungeGssnId;
/** @type {?string} */
DigitalLounge;
/** @type {boolean} */
Motability;
/** @type {?MotabilityPricing} */
MotabilityPricing;
/** @type {?string} */
LinkedByUserType;
/** @type {?number} */
AssistanceProviderId;
/** @type {?string} */
AssistanceProvider;
/** @type {?string} */
AssistanceDetail;
/** @type {?string} */
LastAssistanceMessageDate;
/** @type {?string} */
LastAssistanceUser;
/** @type {boolean} */
IsCOPConverter;
/** @type {boolean} */
IsEligibleCOPConverter;
/** @type {?CarConfigurator} */
CarConfigurator;
/** @type {?CarConfiguratorResponse} */
CarConfiguratorResponse;
}
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 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 BackOrder extends BackOrderBase {
/** @param {{Vehicle?:VehicleDetail,Guid?:string,Status?:number,CustomerId?:string,Id?:number,Reference?:string,Agent?:string,Gssn?:string,CreationDate?:string,MaintenanceDate?:string,CustomerCriteria?:string,AgentCriteria?:string,History?:BackOrderHistory[],IsAllocatedToOrder?:boolean,Vin?:string,CommissionNumber?:string,Order?:Order,Source?:string,Specialist?:boolean,OutrightPurchase?:boolean,Sellable?:boolean,MulesoftReference?:string,AdditionalInformation?:string,ConfigCode?:string,FleetBaseOrder?:string,GasId?:string,OutrightPurchaseCustomerIdentifier?:string,Retailer?:Retailer,CustomerMode?:number,CanEdit?:boolean,DigitalLoungeGssnId?:string,DigitalLounge?:string,Motability?:boolean,MotabilityPricing?:MotabilityPricing,LinkedByUserType?:string,AssistanceProviderId?:number,AssistanceProvider?:string,AssistanceDetail?:string,LastAssistanceMessageDate?:string,LastAssistanceUser?:string,IsCOPConverter?:boolean,IsEligibleCOPConverter?:boolean,CarConfigurator?:CarConfigurator,CarConfiguratorResponse?:CarConfiguratorResponse}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {VehicleDetail} */
Vehicle;
}
export class FilterBackOrdersResponse {
/** @param {{BackOrders?:BackOrder[],FilteredGssn?:string,FilteredRetailer?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BackOrder[]} */
BackOrders = [];
/** @type {string} */
FilteredGssn;
/** @type {string} */
FilteredRetailer;
}
export class FilterActiveBackOrdersCsvRequest extends FilterBackOrders {
/** @param {{Historical?:boolean,BackOrderCriteria?:BackOrderCriteria,VehicleCriteria?:VehicleCriteria,DateCriteria?:DateCriteria,GssnIds?:string[]}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
JavaScript FilterActiveBackOrdersCsvRequest 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/backorder/active/csv HTTP/1.1
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"Historical":false,"BackOrderCriteria":{"Source":[0],"CustomerType":[0],"CommLinkedBy":[0],"VinAllocated":false,"VinAllocatedSellable":false,"VinAllocatedNotSellable":false,"Specialist":false,"LinkedOrder":false,"AssistanceProviders":[0],"COPConverter":false},"VehicleCriteria":{"Model":[{"Description":"String","Id":0}],"Colour":["String"],"FuelType":["String"],"Transmission":["String"],"Engine":["String"],"Line":["String"],"Package":["String"],"Equipment":["String"],"Upholstery":["String"]},"DateCriteria":{"Created":{"Date":"\/Date(-62135596800000-0000)\/","Range":{"Min":0,"Max":0}},"Modified":{"Date":"\/Date(-62135596800000-0000)\/","Range":{"Min":0,"Max":0}}},"GssnIds":["String"]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"BackOrders":[{"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"},"Guid":"String","Status":0,"CustomerId":"String","Id":0,"Reference":"String","Agent":"String","Gssn":"String","CreationDate":"\/Date(-62135596800000-0000)\/","MaintenanceDate":"\/Date(-62135596800000-0000)\/","CustomerCriteria":"String","AgentCriteria":"String","History":[{"Status":0,"CommissionNumber":"String","VIN":"String","CustomerCriteria":"String","AgentCriteria":"String","CreationDate":"\/Date(-62135596800000-0000)\/","MaintenanceDate":"\/Date(-62135596800000-0000)\/","GasId":"String","Sellable":false,"AdditionalInformation":"String","Reason":"String","ConfigCode":"String","FleetBaseOrder":"String","AssistanceDetail":"String","AssistanceProvider":"String","LinkedByUserType":"String","MotabilityVTN":"String","MotabilityBackOrderDropDown":"String","MotabilityValidFrom":"\/Date(-62135596800000-0000)\/","MotabilityValidTo":"\/Date(-62135596800000-0000)\/"}],"IsAllocatedToOrder":false,"Vin":"String","CommissionNumber":"String","Order":{"Guid":"00000000000000000000000000000000","Reference":"String","Status":0,"CustomerId":"String","MulesoftReference":"String","GasId":"String","OrderDate":"String","OfferSnapShot":"String"},"Source":"String","Specialist":false,"OutrightPurchase":false,"Sellable":false,"MulesoftReference":"String","AdditionalInformation":"String","ConfigCode":"String","FleetBaseOrder":"String","GasId":"String","OutrightPurchaseCustomerIdentifier":"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"}]}},"CustomerMode":0,"CanEdit":false,"DigitalLoungeGssnId":"String","DigitalLounge":"String","Motability":false,"MotabilityPricing":{"MotabilityPricingStatus":"Pending","Id":0,"CriteriaBM7NST":"String","VTN":"String","BackOrderDropDown":"String","CriteriaFullModelYearCode":"String","CriteriaValidOptionCodes":"String","CriteriaInvalidOptionCodes":"String","PIPNet":0,"PIPVat":0,"PIPGross":0,"WPMSNet":0,"WPMSVat":0,"WPMSGross":0,"DiscountNet":0,"DiscountVat":0,"DiscountGross":0,"ListPriceNet":0,"ListPriceVat":0,"ListPriceGross":0,"DeliveryChargeNet":0,"DeliveryChargeVat":0,"DeliveryChargeGross":0,"FuelChargeNet":0,"FuelChargeVat":0,"FuelChargeGross":0,"NumberPlateFeeNet":0,"NumberPlateFeeVat":0,"NumberPlateFeeGross":0,"FirstRegistrationFeeNet":0,"FirstRegistrationFeeVat":0,"FirstRegistrationFeeGross":0,"RoadFundLicenceNet":0,"RoadFundLicenceVat":0,"RoadFundLicenceGross":0,"ValidFrom":"\/Date(-62135596800000-0000)\/","ValidTo":"\/Date(-62135596800000-0000)\/"},"LinkedByUserType":"String","AssistanceProviderId":0,"AssistanceProvider":"String","AssistanceDetail":"String","LastAssistanceMessageDate":"\/Date(-62135596800000-0000)\/","LastAssistanceUser":"String","IsCOPConverter":false,"IsEligibleCOPConverter":false,"CarConfigurator":{"Id":0,"BackOrderId":0,"ConfiguratorCode":"String","GasId":"String","Status":0,"DateOfLastUpdate":"\/Date(-62135596800000-0000)\/","LastExceptionMessage":"String","LastException":"String"},"CarConfiguratorResponse":{"Name":"String","KeyInformation":{"BM7NST":"String","ConfigurationDate":"String","ModelYear":"String","HalfYear":"String"},"OrderingOptions":{"Interior":["String"],"Exterior":["String"],"Other":["String"]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"ConfiguratorCode":"String"}}],"FilteredGssn":"String","FilteredRetailer":"String"}