| GET | /v1/backorder/historical | Get historical Back Order | Get historical Back Order |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
open class GetHistoricalBackOrderRequest : IGet
{
}
open class GetHistoricalBackOrderResponse
{
open var BackOrders:ArrayList<BackOrder>? = null
}
open class BackOrder : BackOrderBase()
{
open var Vehicle:VehicleDetail? = null
}
open class BackOrderBase
{
open var Guid:String? = null
open var Status:Int? = null
open var CustomerId:String? = null
open var ProfileId:UUID? = null
open var IsCiam:Boolean? = null
open var Id:Int? = null
open var Reference:String? = null
open var Agent:String? = null
open var Gssn:String? = null
open var CreationDate:Date? = null
open var MaintenanceDate:Date? = null
open var CustomerCriteria:String? = null
open var AgentCriteria:String? = null
open var History:ArrayList<BackOrderHistory>? = null
open var IsAllocatedToOrder:Boolean? = null
open var Vin:String? = null
open var CommissionNumber:String? = null
open var Order:Order? = null
open var Source:String? = null
open var Specialist:Boolean? = null
open var OutrightPurchase:Boolean? = null
open var Sellable:Boolean? = null
open var MulesoftReference:String? = null
open var AdditionalInformation:String? = null
open var ConfigCode:String? = null
open var FleetBaseOrder:String? = null
open var GasId:String? = null
open var OutrightPurchaseCustomerIdentifier:String? = null
open var Retailer:Retailer? = null
open var CustomerMode:Int? = null
open var CanEdit:Boolean? = null
open var DigitalLoungeGssnId:String? = null
open var DigitalLounge:String? = null
open var Motability:Boolean? = null
open var MotabilityPricing:MotabilityPricing? = null
open var LinkedByUserType:String? = null
open var AssistanceProviderId:Int? = null
open var AssistanceProvider:String? = null
open var AssistanceDetail:String? = null
open var LastAssistanceMessageDate:Date? = null
open var LastAssistanceUser:String? = null
open var IsCOPConverter:Boolean? = null
open var IsEligibleCOPConverter:Boolean? = null
open var CarConfigurator:CarConfigurator? = null
open var CarConfiguratorResponse:CarConfiguratorResponse? = null
}
open class BackOrderHistory
{
open var Status:Int? = null
open var CommissionNumber:String? = null
open var VIN:String? = null
open var CustomerCriteria:String? = null
open var AgentCriteria:String? = null
open var CreationDate:Date? = null
open var MaintenanceDate:Date? = null
open var GasId:String? = null
open var Sellable:Boolean? = null
open var AdditionalInformation:String? = null
open var Reason:String? = null
open var ConfigCode:String? = null
open var FleetBaseOrder:String? = null
open var AssistanceDetail:String? = null
open var AssistanceProvider:String? = null
open var LinkedByUserType:String? = null
open var MotabilityVTN:String? = null
open var MotabilityBackOrderDropDown:String? = null
open var MotabilityValidFrom:Date? = null
open var MotabilityValidTo:Date? = null
}
open class Order
{
open var Guid:UUID? = null
open var Reference:String? = null
open var Status:Int? = null
open var CustomerId:String? = null
open var MulesoftReference:String? = null
open var GasId:String? = null
open var OrderDate:String? = null
open var OfferSnapShot:String? = null
}
open class Retailer
{
open var Id:Int? = null
open var GssnId:String? = null
open var Description:String? = null
open var Street:String? = null
open var City:String? = null
open var Postcode:String? = null
open var GoogleMapPostcode:String? = null
open var Phone:String? = null
open var Fax:String? = null
open var Email:String? = null
open var Website:String? = null
open var RetailerGroupId:String? = null
open var RetailerGroupName:String? = null
open var IsOnline:Boolean? = null
open var IsNewCarRetailer:Boolean? = null
open var IsUsedCarRetailer:Boolean? = null
open var IsCentralRetailer:Boolean? = null
open var ChatEnabled:Boolean? = null
open var TradeInEnabled:Boolean? = null
open var smart:Boolean? = null
open var DisplayPhoneNumberNew:String? = null
open var DisplayPhoneNumberUsed:String? = null
open var Latitude:BigDecimal? = null
open var Longitude:BigDecimal? = null
open var smartDescription:String? = null
open var smartWebsite:String? = null
open var smartPhone:String? = null
open var LegacyId:String? = null
open var Agent:Boolean? = null
open var MarketAreaId:Int? = null
open var DigitalLoungeParentGssnId:String? = null
open var SendLeadsToDigitalLoungeParent:Boolean? = null
open var OpeningTimes:RetailerOpeningTimes? = null
}
open class RetailerOpeningTimes
{
open var New:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
open var Used:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
}
open class RetailerOpeningTime
{
open var Day:String? = null
open var OpenFrom:String? = null
open var OpenTo:String? = null
open var Special:String? = null
}
open class MotabilityPricing : MotabilityPricingCsv()
{
open var MotabilityPricingStatus:MotabilityPricingStatus? = null
}
open class MotabilityPricingCsv
{
@DataMember(Order=0)
open var Id:Int? = null
@DataMember(Order=1)
open var CriteriaBM7NST:String? = null
@DataMember(Order=2)
open var VTN:String? = null
@DataMember(Order=3)
open var BackOrderDropDown:String? = null
@DataMember(Order=4)
open var CriteriaFullModelYearCode:String? = null
@DataMember(Order=5)
open var CriteriaValidOptionCodes:String? = null
@DataMember(Order=6)
open var CriteriaInvalidOptionCodes:String? = null
@DataMember(Order=7)
open var PIPNet:BigDecimal? = null
@DataMember(Order=8)
open var PIPVat:BigDecimal? = null
@DataMember(Order=9)
open var PIPGross:BigDecimal? = null
@DataMember(Order=10)
open var WPMSNet:BigDecimal? = null
@DataMember(Order=11)
open var WPMSVat:BigDecimal? = null
@DataMember(Order=12)
open var WPMSGross:BigDecimal? = null
@DataMember(Order=13)
open var DiscountNet:BigDecimal? = null
@DataMember(Order=14)
open var DiscountVat:BigDecimal? = null
@DataMember(Order=15)
open var DiscountGross:BigDecimal? = null
@DataMember(Order=16)
open var ListPriceNet:BigDecimal? = null
@DataMember(Order=17)
open var ListPriceVat:BigDecimal? = null
@DataMember(Order=18)
open var ListPriceGross:BigDecimal? = null
@DataMember(Order=19)
open var DeliveryChargeNet:BigDecimal? = null
@DataMember(Order=20)
open var DeliveryChargeVat:BigDecimal? = null
@DataMember(Order=21)
open var DeliveryChargeGross:BigDecimal? = null
@DataMember(Order=22)
open var FuelChargeNet:BigDecimal? = null
@DataMember(Order=23)
open var FuelChargeVat:BigDecimal? = null
@DataMember(Order=24)
open var FuelChargeGross:BigDecimal? = null
@DataMember(Order=25)
open var NumberPlateFeeNet:BigDecimal? = null
@DataMember(Order=26)
open var NumberPlateFeeVat:BigDecimal? = null
@DataMember(Order=27)
open var NumberPlateFeeGross:BigDecimal? = null
@DataMember(Order=28)
open var FirstRegistrationFeeNet:BigDecimal? = null
@DataMember(Order=29)
open var FirstRegistrationFeeVat:BigDecimal? = null
@DataMember(Order=30)
open var FirstRegistrationFeeGross:BigDecimal? = null
@DataMember(Order=31)
open var RoadFundLicenceNet:BigDecimal? = null
@DataMember(Order=32)
open var RoadFundLicenceVat:BigDecimal? = null
@DataMember(Order=33)
open var RoadFundLicenceGross:BigDecimal? = null
@DataMember(Order=34)
open var ValidFrom:Date? = null
@DataMember(Order=35)
open var ValidTo:Date? = null
@DataMember(Order=36)
open var GovernmentGrantNet:BigDecimal? = null
@DataMember(Order=37)
open var GovernmentGrantVat:BigDecimal? = null
@DataMember(Order=38)
open var GovernmentGrantGross:BigDecimal? = null
}
enum class MotabilityPricingStatus
{
Pending,
Current,
RecentlyExpired,
Expired,
}
open class CarConfigurator
{
open var Id:Int? = null
open var BackOrderId:Int? = null
open var ConfiguratorCode:String? = null
open var GasId:String? = null
open var Status:Int? = null
open var DateOfLastUpdate:Date? = null
open var LastExceptionMessage:String? = null
open var LastException:String? = null
}
open class CarConfiguratorResponse
{
open var Name:String? = null
open var KeyInformation:KeyInformation? = null
open var OrderingOptions:OrderingOptions? = null
open var ResponseStatus:ResponseStatus? = null
open var ConfiguratorCode:String? = null
}
open class KeyInformation
{
open var BM7NST:String? = null
open var ConfigurationDate:String? = null
open var ModelYear:String? = null
open var HalfYear:String? = null
}
open class OrderingOptions
{
open var Interior:ArrayList<String>? = null
open var Exterior:ArrayList<String>? = null
open var Options:ArrayList<String>? = null
}
open class VehicleDetail : VehicleBaseDetail()
{
open var RetailPrice_ExVAT:String? = null
open var OTR:String? = null
open var ActualPrice:String? = null
open var TotalOfferValue:String? = null
open var IsHOBackOrderAccountVehicle:Boolean? = null
open var ConsumptionCombined:VehicleConsumption? = null
open var ConsumptionExtraUrban:VehicleConsumption? = null
open var ConsumptionUrban:VehicleConsumption? = null
open var WltpFuelConsumptionCombined:VehicleConsumption? = null
open var WltpFuelConsumptionExtraHigh:VehicleConsumption? = null
open var WltpFuelConsumptionHigh:VehicleConsumption? = null
open var WltpFuelConsumptionLow:VehicleConsumption? = null
open var WltpFuelConsumptionMedium:VehicleConsumption? = null
open var EquipmentCategories:ArrayList<VehicleEquipmentCategory>? = null
open var VehicleEnergyEfficiencyClass:VehicleEmissionClass? = null
open var VehicleData:ArrayList<VehicleAttribute>? = null
open var IntegratedProducts:ArrayList<VehicleIntegratedServiceCareOption> = ArrayList<VehicleIntegratedServiceCareOption>()
open var IspVehicleCustomerDescriptions:ArrayList<String>? = null
open var ColourCode:String? = null
open var UpholsteryCode:String? = null
open var IsAvailableOnline:Boolean? = null
open var Secured:Boolean? = null
}
open class VehicleBaseDetail : Vehicle(), ICommissionNumber
{
open var Description:String? = null
override var CommissionNumber:String? = null
open var PortArrivalDate:String? = null
open var OfferExpiryDate:String? = null
open var Fuel:String? = null
open var Transmission:String? = null
open var TransmissionType:String? = null
open var Colour:String? = null
open var ColourDescription:String? = null
open var ImageUrl:String? = null
open var Specialist:Boolean? = null
open var VehicleCriteriaMatch:VehicleCriteriaMatch? = null
open var ColourGroup:String? = null
open var Model:String? = null
open var BodyStyle:String? = null
open var Brand:String? = null
open var Engine:String? = null
open var EngineDescription:String? = null
open var Line:String? = null
open var Upholstery:String? = null
open var UpholsteryDescription:String? = null
open var Packages:ArrayList<String> = ArrayList<String>()
open var P11D:BigDecimal? = null
open var Prices:ArrayList<Price> = ArrayList<Price>()
open var VehicleClass:String? = null
open var ProductRange:String? = null
open var VehicleType:String? = null
open var Emission:BigDecimal? = null
open var Baumuster:String? = null
open var IsSellable:Boolean? = null
open var Bm7NST:String? = null
open var ElectricRange:BigDecimal? = null
open var ElectricConsumption:BigDecimal? = null
open var IsDisplayStock:Boolean? = null
open var DisplayRetailer_Id:Int? = null
open var DisplayRetailer:String? = null
open var DisplayRetailerGssnId:String? = null
open var Retailer:Retailer? = null
open var Age:Int? = null
open var ModelYearCode:String? = null
open var HalfModelYearCode:String? = null
open var FullModelYearCode:String? = null
open var ProductionDate:String? = null
open var ChassisNumber:String? = null
open var EligibleForIntegratedServiceCare:Boolean? = null
open var ConfirmedProductionDate:String? = null
open var ForecastedArrivalDate:String? = null
}
open class Vehicle
{
open var Vin:String? = null
}
open class VehicleCriteriaMatch
{
open var Fuel:Boolean? = null
open var Transmission:Boolean? = null
open var Colour:Boolean? = null
open var Upholstery:Boolean? = null
open var Line:Boolean? = null
open var Engine:Boolean? = null
open var BodyStyle:Boolean? = null
open var Packages:Boolean? = null
}
open class Price
{
open var Id:String? = null
open var Description:String? = null
open var Net:BigDecimal? = null
open var VAT:BigDecimal? = null
open var Gross:BigDecimal? = null
open var Product:OfferPriceProductType? = null
}
enum class OfferPriceProductType
{
ListPrice,
NumberPlateFee,
DeliveryCharge,
FuelCharge,
ManufacturerOffer,
PersonalisedMoneyoffer,
PersonalisedNonmoneyoffer,
PersonalisedNonmoneyofferNeg,
Service,
ServiceNeg,
GovernmentGrant,
OutrightPurchaseDiscount,
VipOffer,
WallboxOffer,
WallboxOfferNeg,
RoadFundLicence,
FirstRegistrationFee,
NotFound,
AccessoryOffer,
AccessoryOfferNeg,
MotabilityDiscount,
}
open class VehicleConsumption
{
open var Id:Int? = null
open var Lkm:BigDecimal? = null
open var Mpg:BigDecimal? = null
}
open class VehicleEquipmentCategory
{
open var Order:Int? = null
open var Code:String? = null
open var Description:String? = null
open var Equipment:ArrayList<Equipmentv2>? = null
}
open class Equipmentv2 : Equipment()
{
open var Importance:Int? = null
open var IsAdditional:Boolean? = null
}
open class Equipment
{
open var Id:Int? = null
open var Code:String? = null
open var Description:String? = null
}
open class VehicleEmissionClass
{
open var Colour:String? = null
open var Rating:String? = null
}
open class VehicleAttribute
{
open var Description:String? = null
open var Value:String? = null
}
open class VehicleIntegratedServiceCareOption
{
open var OptionCode:String? = null
open var BM7NST:String? = null
open var FullModelYear:String? = null
open var IntegratedProductType:String? = null
open var CustomerDescription:String? = null
open var OneAgentProductType:String? = null
}
Kotlin GetHistoricalBackOrderRequest 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/historical 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,
IsAvailableOnline: False,
Secured: False,
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,
ConfirmedProductionDate: String,
ForecastedArrivalDate: String,
Vin: String
},
Guid: String,
Status: 0,
CustomerId: String,
ProfileId: 00000000000000000000000000000000,
IsCiam: False,
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,
GovernmentGrantNet: 0,
GovernmentGrantVat: 0,
GovernmentGrantGross: 0
},
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
],
Options:
[
String
]
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
},
ConfiguratorCode: String
}
}
]
}