GET | /v1/backorder/active | Get Active Back Order | |
---|---|---|---|
GET | /v1/backorder/active/csv | Get Active Back Order | |
GET | /v1/backorder/active/{GssnId} | Get Active Back Order | |
GET | /v1/backorder/active/csv/{GssnId} | Get Active Back Order |
export class BackOrderHistory
{
public Status: number;
public CommissionNumber?: string;
public VIN?: string;
public CustomerCriteria: string;
public AgentCriteria: string;
public CreationDate: string;
public MaintenanceDate: string;
public GasId: string;
public Sellable: boolean;
public AdditionalInformation: string;
public Reason: string;
public ConfigCode: string;
public FleetBaseOrder: string;
public AssistanceDetail?: string;
public AssistanceProvider?: string;
public LinkedByUserType?: string;
public MotabilityVTN?: string;
public MotabilityBackOrderDropDown?: string;
public MotabilityValidFrom?: string;
public MotabilityValidTo?: string;
public constructor(init?: Partial<BackOrderHistory>) { (Object as any).assign(this, init); }
}
export class Order
{
public Guid: string;
public Reference: string;
public Status: number;
public CustomerId: string;
public MulesoftReference: string;
public GasId: string;
public OrderDate: string;
public OfferSnapShot: string;
public constructor(init?: Partial<Order>) { (Object as any).assign(this, init); }
}
export class RetailerOpeningTime
{
public Day: string;
public OpenFrom: string;
public OpenTo: string;
public Special: string;
public constructor(init?: Partial<RetailerOpeningTime>) { (Object as any).assign(this, init); }
}
export class RetailerOpeningTimes
{
public New: RetailerOpeningTime[] = [];
public Used: RetailerOpeningTime[] = [];
public constructor(init?: Partial<RetailerOpeningTimes>) { (Object as any).assign(this, init); }
}
export class Retailer
{
public Id: number;
public GssnId: string;
public Description: string;
public Street: string;
public City: string;
public Postcode: string;
public GoogleMapPostcode: string;
public Phone: string;
public Fax: string;
public Email: string;
public Website: string;
public RetailerGroupId: string;
public RetailerGroupName: string;
public IsOnline: boolean;
public IsNewCarRetailer: boolean;
public IsUsedCarRetailer: boolean;
public IsCentralRetailer: boolean;
public ChatEnabled: boolean;
public TradeInEnabled: boolean;
public smart: boolean;
public DisplayPhoneNumberNew: string;
public DisplayPhoneNumberUsed: string;
public Latitude: number;
public Longitude: number;
public smartDescription: string;
public smartWebsite: string;
public smartPhone: string;
public LegacyId: string;
public Agent: boolean;
public MarketAreaId: number;
public DigitalLoungeParentGssnId?: string;
public SendLeadsToDigitalLoungeParent: boolean;
public OpeningTimes?: RetailerOpeningTimes;
public constructor(init?: Partial<Retailer>) { (Object as any).assign(this, init); }
}
export class MotabilityPricingCsv
{
// @DataMember(Order=0)
public Id: number;
// @DataMember(Order=1)
public CriteriaBM7NST: string;
// @DataMember(Order=2)
public VTN: string;
// @DataMember(Order=3)
public BackOrderDropDown: string;
// @DataMember(Order=4)
public CriteriaFullModelYearCode: string;
// @DataMember(Order=5)
public CriteriaValidOptionCodes?: string;
// @DataMember(Order=6)
public CriteriaInvalidOptionCodes?: string;
// @DataMember(Order=7)
public PIPNet: number;
// @DataMember(Order=8)
public PIPVat: number;
// @DataMember(Order=9)
public PIPGross: number;
// @DataMember(Order=10)
public WPMSNet: number;
// @DataMember(Order=11)
public WPMSVat: number;
// @DataMember(Order=12)
public WPMSGross: number;
// @DataMember(Order=13)
public DiscountNet: number;
// @DataMember(Order=14)
public DiscountVat: number;
// @DataMember(Order=15)
public DiscountGross: number;
// @DataMember(Order=16)
public ListPriceNet: number;
// @DataMember(Order=17)
public ListPriceVat: number;
// @DataMember(Order=18)
public ListPriceGross: number;
// @DataMember(Order=19)
public DeliveryChargeNet: number;
// @DataMember(Order=20)
public DeliveryChargeVat: number;
// @DataMember(Order=21)
public DeliveryChargeGross: number;
// @DataMember(Order=22)
public FuelChargeNet: number;
// @DataMember(Order=23)
public FuelChargeVat: number;
// @DataMember(Order=24)
public FuelChargeGross: number;
// @DataMember(Order=25)
public NumberPlateFeeNet: number;
// @DataMember(Order=26)
public NumberPlateFeeVat: number;
// @DataMember(Order=27)
public NumberPlateFeeGross: number;
// @DataMember(Order=28)
public FirstRegistrationFeeNet: number;
// @DataMember(Order=29)
public FirstRegistrationFeeVat: number;
// @DataMember(Order=30)
public FirstRegistrationFeeGross: number;
// @DataMember(Order=31)
public RoadFundLicenceNet: number;
// @DataMember(Order=32)
public RoadFundLicenceVat: number;
// @DataMember(Order=33)
public RoadFundLicenceGross: number;
// @DataMember(Order=34)
public ValidFrom: string;
// @DataMember(Order=35)
public ValidTo: string;
public constructor(init?: Partial<MotabilityPricingCsv>) { (Object as any).assign(this, init); }
}
export enum MotabilityPricingStatus
{
Pending = 'Pending',
Current = 'Current',
RecentlyExpired = 'RecentlyExpired',
Expired = 'Expired',
}
export class MotabilityPricing extends MotabilityPricingCsv
{
public MotabilityPricingStatus: MotabilityPricingStatus;
public constructor(init?: Partial<MotabilityPricing>) { super(init); (Object as any).assign(this, init); }
}
export class CarConfigurator
{
public Id: number;
public BackOrderId?: number;
public ConfiguratorCode: string;
public GasId?: string;
public Status: number;
public DateOfLastUpdate: string;
public LastExceptionMessage?: string;
public LastException?: string;
public constructor(init?: Partial<CarConfigurator>) { (Object as any).assign(this, init); }
}
export class KeyInformation
{
public BM7NST?: string;
public ConfigurationDate?: string;
public ModelYear?: string;
public HalfYear?: string;
public constructor(init?: Partial<KeyInformation>) { (Object as any).assign(this, init); }
}
export class OrderingOptions
{
public Interior?: string[];
public Exterior?: string[];
public Other?: string[];
public constructor(init?: Partial<OrderingOptions>) { (Object as any).assign(this, init); }
}
export class CarConfiguratorResponse
{
public Name?: string;
public KeyInformation?: KeyInformation;
public OrderingOptions?: OrderingOptions;
public ResponseStatus: ResponseStatus;
public ConfiguratorCode?: string;
public constructor(init?: Partial<CarConfiguratorResponse>) { (Object as any).assign(this, init); }
}
export class BackOrderBase
{
public Guid: string;
public Status: number;
public CustomerId: string;
public Id: number;
public Reference: string;
public Agent: string;
public Gssn: string;
public CreationDate: string;
public MaintenanceDate: string;
public CustomerCriteria: string;
public AgentCriteria?: string;
public History?: BackOrderHistory[];
public IsAllocatedToOrder: boolean;
public Vin: string;
public CommissionNumber?: string;
public Order?: Order;
public Source: string;
public Specialist: boolean;
public OutrightPurchase: boolean;
public Sellable: boolean;
public MulesoftReference: string;
public AdditionalInformation: string;
public ConfigCode: string;
public FleetBaseOrder: string;
public GasId: string;
public OutrightPurchaseCustomerIdentifier: string;
public Retailer: Retailer;
public CustomerMode: number;
public CanEdit: boolean;
public DigitalLoungeGssnId?: string;
public DigitalLounge?: string;
public Motability: boolean;
public MotabilityPricing?: MotabilityPricing;
public LinkedByUserType?: string;
public AssistanceProviderId?: number;
public AssistanceProvider?: string;
public AssistanceDetail?: string;
public LastAssistanceMessageDate?: string;
public LastAssistanceUser?: string;
public IsCOPConverter: boolean;
public IsEligibleCOPConverter: boolean;
public CarConfigurator?: CarConfigurator;
public CarConfiguratorResponse?: CarConfiguratorResponse;
public constructor(init?: Partial<BackOrderBase>) { (Object as any).assign(this, init); }
}
export class Vehicle
{
public Vin?: string;
public constructor(init?: Partial<Vehicle>) { (Object as any).assign(this, init); }
}
export class VehicleCriteriaMatch
{
public Fuel: boolean;
public Transmission: boolean;
public Colour: boolean;
public Upholstery: boolean;
public Line: boolean;
public Engine: boolean;
public BodyStyle: boolean;
public Packages: boolean;
public constructor(init?: Partial<VehicleCriteriaMatch>) { (Object as any).assign(this, init); }
}
export enum OfferPriceProductType
{
LIST_PRICE = 'LIST_PRICE',
NUMBER_PLATE_FEE = 'NUMBER_PLATE_FEE',
DELIVERY_CHARGE = 'DELIVERY_CHARGE',
FUEL_CHARGE = 'FUEL_CHARGE',
MANUFACTURER_OFFER = 'MANUFACTURER_OFFER',
PERSONALISED_MONEYOFFER = 'PERSONALISED_MONEYOFFER',
PERSONALISED_NONMONEYOFFER = 'PERSONALISED_NONMONEYOFFER',
PERSONALISED_NONMONEYOFFER_NEG = 'PERSONALISED_NONMONEYOFFER_NEG',
SERVICE = 'SERVICE',
SERVICE_NEG = 'SERVICE_NEG',
GOVERNMENT_GRANT = 'GOVERNMENT_GRANT',
OUTRIGHT_PURCHASE_DISCOUNT = 'OUTRIGHT_PURCHASE_DISCOUNT',
VIP_OFFER = 'VIP_OFFER',
WALLBOX_OFFER = 'WALLBOX_OFFER',
WALLBOX_OFFER_NEG = 'WALLBOX_OFFER_NEG',
ROAD_FUND_LICENCE = 'ROAD_FUND_LICENCE',
FIRST_REGISTRATION_FEE = 'FIRST_REGISTRATION_FEE',
NOT_FOUND = 'NOT_FOUND',
ACCESSORY_OFFER = 'ACCESSORY_OFFER',
ACCESSORY_OFFER_NEG = 'ACCESSORY_OFFER_NEG',
MOTABILITY_DISCOUNT = 'MOTABILITY_DISCOUNT',
}
export class Price
{
public Id: string;
public Description: string;
public Net: number;
public VAT: number;
public Gross: number;
public Product: OfferPriceProductType;
public constructor(init?: Partial<Price>) { (Object as any).assign(this, init); }
}
export class VehicleBaseDetail extends Vehicle implements ICommissionNumber
{
public Description: string;
public CommissionNumber: string;
public PortArrivalDate: string;
public OfferExpiryDate: string;
public Fuel: string;
public Transmission: string;
public TransmissionType: string;
public Colour: string;
public ColourDescription: string;
public ImageUrl: string;
public Specialist: boolean;
public VehicleCriteriaMatch?: VehicleCriteriaMatch;
public ColourGroup: string;
public Model: string;
public BodyStyle: string;
public Brand: string;
public Engine: string;
public EngineDescription: string;
public Line: string;
public Upholstery: string;
public UpholsteryDescription: string;
public Packages: string[] = [];
public P11D: number;
public Prices: Price[] = [];
public VehicleClass: string;
public ProductRange: string;
public VehicleType: string;
public Emission?: number;
public Baumuster: string;
public IsSellable: boolean;
public Bm7NST: string;
public ElectricRange?: number;
public ElectricConsumption?: number;
public IsDisplayStock: boolean;
public DisplayRetailer_Id?: number;
public DisplayRetailer: string;
public DisplayRetailerGssnId: string;
public Retailer: Retailer;
public Age?: number;
public ModelYearCode: string;
public HalfModelYearCode: string;
public FullModelYearCode: string;
public ProductionDate: string;
public ChassisNumber?: string;
public EligibleForIntegratedServiceCare: boolean;
public constructor(init?: Partial<VehicleBaseDetail>) { super(init); (Object as any).assign(this, init); }
}
export class VehicleConsumption
{
public Id: number;
public Lkm: number;
public Mpg: number;
public constructor(init?: Partial<VehicleConsumption>) { (Object as any).assign(this, init); }
}
export class Equipment
{
public Id: number;
public Code?: string;
public Description?: string;
public constructor(init?: Partial<Equipment>) { (Object as any).assign(this, init); }
}
export class Equipmentv2 extends Equipment
{
public Importance: number;
public IsAdditional: boolean;
public constructor(init?: Partial<Equipmentv2>) { super(init); (Object as any).assign(this, init); }
}
export class VehicleEquipmentCategory
{
public Order: number;
public Code?: string;
public Description?: string;
public Equipment?: Equipmentv2[];
public constructor(init?: Partial<VehicleEquipmentCategory>) { (Object as any).assign(this, init); }
}
export class VehicleEmissionClass
{
public Colour?: string;
public Rating?: string;
public constructor(init?: Partial<VehicleEmissionClass>) { (Object as any).assign(this, init); }
}
export class VehicleAttribute
{
public Description?: string;
public Value?: string;
public constructor(init?: Partial<VehicleAttribute>) { (Object as any).assign(this, init); }
}
export class VehicleIntegratedServiceCareOption
{
public OptionCode?: string;
public BM7NST?: string;
public FullModelYear?: string;
public IntegratedProductType?: string;
public CustomerDescription?: string;
public OneAgentProductType?: string;
public constructor(init?: Partial<VehicleIntegratedServiceCareOption>) { (Object as any).assign(this, init); }
}
export class VehicleDetail extends VehicleBaseDetail
{
public RetailPrice_ExVAT: string;
public OTR: string;
public ActualPrice: string;
public TotalOfferValue: string;
public IsHOBackOrderAccountVehicle: boolean;
public ConsumptionCombined?: VehicleConsumption;
public ConsumptionExtraUrban?: VehicleConsumption;
public ConsumptionUrban?: VehicleConsumption;
public WltpFuelConsumptionCombined?: VehicleConsumption;
public WltpFuelConsumptionExtraHigh?: VehicleConsumption;
public WltpFuelConsumptionHigh?: VehicleConsumption;
public WltpFuelConsumptionLow?: VehicleConsumption;
public WltpFuelConsumptionMedium?: VehicleConsumption;
public EquipmentCategories?: VehicleEquipmentCategory[];
public VehicleEnergyEfficiencyClass?: VehicleEmissionClass;
public VehicleData?: VehicleAttribute[];
public IntegratedProducts: VehicleIntegratedServiceCareOption[] = [];
public IspVehicleCustomerDescriptions?: string[];
public ColourCode: string;
public UpholsteryCode: string;
public constructor(init?: Partial<VehicleDetail>) { super(init); (Object as any).assign(this, init); }
}
export class BackOrder extends BackOrderBase
{
public Vehicle: VehicleDetail;
public constructor(init?: Partial<BackOrder>) { super(init); (Object as any).assign(this, init); }
}
export class GetActiveBackOrderResponse
{
public BackOrders?: BackOrder[];
public FilteredGssn: string;
public FilteredRetailer: string;
public constructor(init?: Partial<GetActiveBackOrderResponse>) { (Object as any).assign(this, init); }
}
export class GetActiveBackOrderRequest implements IGet
{
public GssnId: string;
public constructor(init?: Partial<GetActiveBackOrderRequest>) { (Object as any).assign(this, init); }
}
export class GetActiveBackOrderCsvRequest extends GetActiveBackOrderRequest
{
public constructor(init?: Partial<GetActiveBackOrderCsvRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript GetActiveBackOrderCsvRequest 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.
GET /v1/backorder/active HTTP/1.1 Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv 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: 0001-01-01, MaintenanceDate: 0001-01-01, CustomerCriteria: String, AgentCriteria: String, History: [ { Status: 0, CommissionNumber: String, VIN: String, CustomerCriteria: String, AgentCriteria: String, CreationDate: 0001-01-01, MaintenanceDate: 0001-01-01, GasId: String, Sellable: False, AdditionalInformation: String, Reason: String, ConfigCode: String, FleetBaseOrder: String, AssistanceDetail: String, AssistanceProvider: String, LinkedByUserType: String, MotabilityVTN: String, MotabilityBackOrderDropDown: String, MotabilityValidFrom: 0001-01-01, MotabilityValidTo: 0001-01-01 } ], 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: 0001-01-01, ValidTo: 0001-01-01 }, LinkedByUserType: String, AssistanceProviderId: 0, AssistanceProvider: String, AssistanceDetail: String, LastAssistanceMessageDate: 0001-01-01, LastAssistanceUser: String, IsCOPConverter: False, IsEligibleCOPConverter: False, CarConfigurator: { Id: 0, BackOrderId: 0, ConfiguratorCode: String, GasId: String, Status: 0, DateOfLastUpdate: 0001-01-01, 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 }