POST | /v1/backorder/vehicleimports |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
VehicleImports | body | List<VehicleImport> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CommissionNumber | form | string | Yes | |
Sellable | form | bool | No | |
Vehicle | form | VehicleDetail | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Vin | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
RetailPrice_ExVAT | form | string | Yes | |
OTR | form | string | Yes | |
ActualPrice | form | string | Yes | |
TotalOfferValue | form | string | Yes | |
IsHOBackOrderAccountVehicle | form | bool | No | |
ConsumptionCombined | form | VehicleConsumption | No | |
ConsumptionExtraUrban | form | VehicleConsumption | No | |
ConsumptionUrban | form | VehicleConsumption | No | |
WltpFuelConsumptionCombined | form | VehicleConsumption | No | |
WltpFuelConsumptionExtraHigh | form | VehicleConsumption | No | |
WltpFuelConsumptionHigh | form | VehicleConsumption | No | |
WltpFuelConsumptionLow | form | VehicleConsumption | No | |
WltpFuelConsumptionMedium | form | VehicleConsumption | No | |
EquipmentCategories | form | List<VehicleEquipmentCategory> | No | |
VehicleEnergyEfficiencyClass | form | VehicleEmissionClass | No | |
VehicleData | form | List<VehicleAttribute> | No | |
IntegratedProducts | form | List<VehicleIntegratedServiceCareOption> | Yes | |
IspVehicleCustomerDescriptions | form | List<string> | No | |
ColourCode | form | string | Yes | |
UpholsteryCode | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Description | form | string | Yes | |
CommissionNumber | form | string | Yes | |
PortArrivalDate | form | string | Yes | |
OfferExpiryDate | form | string | Yes | |
Fuel | form | string | Yes | |
Transmission | form | string | Yes | |
TransmissionType | form | string | Yes | |
Colour | form | string | Yes | |
ColourDescription | form | string | Yes | |
ImageUrl | form | string | Yes | |
Specialist | form | bool | No | |
VehicleCriteriaMatch | form | VehicleCriteriaMatch | No | |
ColourGroup | form | string | Yes | |
Model | form | string | Yes | |
BodyStyle | form | string | Yes | |
Brand | form | string | Yes | |
Engine | form | string | Yes | |
EngineDescription | form | string | Yes | |
Line | form | string | Yes | |
Upholstery | form | string | Yes | |
UpholsteryDescription | form | string | Yes | |
Packages | form | List<string> | Yes | |
P11D | form | decimal | No | |
Prices | form | List<Price> | Yes | |
VehicleClass | form | string | Yes | |
ProductRange | form | string | Yes | |
VehicleType | form | string | Yes | |
Emission | form | decimal? | No | |
Baumuster | form | string | Yes | |
IsSellable | form | bool | No | |
Bm7NST | form | string | Yes | |
ElectricRange | form | decimal? | No | |
ElectricConsumption | form | decimal? | No | |
IsDisplayStock | form | bool | No | |
DisplayRetailer_Id | form | int? | No | |
DisplayRetailer | form | string | Yes | |
DisplayRetailerGssnId | form | string | Yes | |
Retailer | form | Retailer | Yes | |
Age | form | int? | No | |
ModelYearCode | form | string | Yes | |
HalfModelYearCode | form | string | Yes | |
FullModelYearCode | form | string | Yes | |
ProductionDate | form | string | Yes | |
ChassisNumber | form | string | No | |
EligibleForIntegratedServiceCare | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Fuel | form | bool | No | |
Transmission | form | bool | No | |
Colour | form | bool | No | |
Upholstery | form | bool | No | |
Line | form | bool | No | |
Engine | form | bool | No | |
BodyStyle | form | bool | No | |
Packages | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | Yes | |
Description | form | string | Yes | |
Net | form | decimal | No | |
VAT | form | decimal | No | |
Gross | form | decimal | No | |
Product | form | OfferPriceProductType | No |
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 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
GssnId | form | string | Yes | |
Description | form | string | Yes | |
Street | form | string | Yes | |
City | form | string | Yes | |
Postcode | form | string | Yes | |
GoogleMapPostcode | form | string | Yes | |
Phone | form | string | Yes | |
Fax | form | string | Yes | |
form | string | Yes | ||
Website | form | string | Yes | |
RetailerGroupId | form | string | Yes | |
RetailerGroupName | form | string | Yes | |
IsOnline | form | bool | No | |
IsNewCarRetailer | form | bool | No | |
IsUsedCarRetailer | form | bool | No | |
IsCentralRetailer | form | bool | No | |
ChatEnabled | form | bool | No | |
TradeInEnabled | form | bool | No | |
smart | form | bool | No | |
DisplayPhoneNumberNew | form | string | Yes | |
DisplayPhoneNumberUsed | form | string | Yes | |
Latitude | form | decimal | No | |
Longitude | form | decimal | No | |
smartDescription | form | string | Yes | |
smartWebsite | form | string | Yes | |
smartPhone | form | string | Yes | |
LegacyId | form | string | Yes | |
Agent | form | bool | No | |
MarketAreaId | form | int | No | |
DigitalLoungeParentGssnId | form | string | No | |
SendLeadsToDigitalLoungeParent | form | bool | No | |
OpeningTimes | form | RetailerOpeningTimes | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
New | form | List<RetailerOpeningTime> | Yes | |
Used | form | List<RetailerOpeningTime> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Day | form | string | Yes | |
OpenFrom | form | string | Yes | |
OpenTo | form | string | Yes | |
Special | form | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Lkm | form | decimal | No | |
Mpg | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Order | form | int | No | |
Code | form | string | No | |
Description | form | string | No | |
Equipment | form | List<Equipmentv2> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Importance | form | int | No | |
IsAdditional | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Code | form | string | No | |
Description | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Colour | form | string | No | |
Rating | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Description | form | string | No | |
Value | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
OptionCode | form | string | No | |
BM7NST | form | string | No | |
FullModelYear | form | string | No | |
IntegratedProductType | form | string | No | |
CustomerDescription | form | string | No | |
OneAgentProductType | form | string | No |
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 { }