Mercedes.Agency.Orchestration.API

<back to all web services

UpdateBackOrderVehicleImportsRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/backorder/vehicleimportsUpdates Vehicle ImportsUpdates Vehicle Imports on back order and sends to One Agent
UpdateBackOrderVehicleImportsRequest Parameters:
NameParameterData TypeRequiredDescription
VehicleImportsbodyList<VehicleImport>Yes
VehicleImport Parameters:
NameParameterData TypeRequiredDescription
CommissionNumberformstringYes
SellableformboolNo
VehicleformVehicleDetailYes
Vehicle Parameters:
NameParameterData TypeRequiredDescription
VinformstringNo
VehicleDetail Parameters:
NameParameterData TypeRequiredDescription
RetailPrice_ExVATformstringYes
OTRformstringYes
ActualPriceformstringYes
TotalOfferValueformstringYes
IsHOBackOrderAccountVehicleformboolNo
ConsumptionCombinedformVehicleConsumptionNo
ConsumptionExtraUrbanformVehicleConsumptionNo
ConsumptionUrbanformVehicleConsumptionNo
WltpFuelConsumptionCombinedformVehicleConsumptionNo
WltpFuelConsumptionExtraHighformVehicleConsumptionNo
WltpFuelConsumptionHighformVehicleConsumptionNo
WltpFuelConsumptionLowformVehicleConsumptionNo
WltpFuelConsumptionMediumformVehicleConsumptionNo
EquipmentCategoriesformList<VehicleEquipmentCategory>No
VehicleEnergyEfficiencyClassformVehicleEmissionClassNo
VehicleDataformList<VehicleAttribute>No
IntegratedProductsformList<VehicleIntegratedServiceCareOption>Yes
IspVehicleCustomerDescriptionsformList<string>No
ColourCodeformstringYes
UpholsteryCodeformstringYes
IsAvailableOnlineformboolNo
SecuredformboolNo
VehicleBaseDetail Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringYes
CommissionNumberformstringYes
PortArrivalDateformstringYes
OfferExpiryDateformstringYes
FuelformstringYes
TransmissionformstringYes
TransmissionTypeformstringYes
ColourformstringYes
ColourDescriptionformstringYes
ImageUrlformstringYes
SpecialistformboolNo
VehicleCriteriaMatchformVehicleCriteriaMatchNo
ColourGroupformstringYes
ModelformstringYes
BodyStyleformstringYes
BrandformstringYes
EngineformstringYes
EngineDescriptionformstringYes
LineformstringYes
UpholsteryformstringYes
UpholsteryDescriptionformstringYes
PackagesformList<string>Yes
P11DformdecimalNo
PricesformList<Price>Yes
VehicleClassformstringYes
ProductRangeformstringYes
VehicleTypeformstringYes
Emissionformdecimal?No
BaumusterformstringYes
IsSellableformboolNo
Bm7NSTformstringYes
ElectricRangeformdecimal?No
ElectricConsumptionformdecimal?No
IsDisplayStockformboolNo
DisplayRetailer_Idformint?No
DisplayRetailerformstringYes
DisplayRetailerGssnIdformstringYes
RetailerformRetailerYes
Ageformint?No
ModelYearCodeformstringYes
HalfModelYearCodeformstringYes
FullModelYearCodeformstringYes
ProductionDateformstringYes
ChassisNumberformstringNo
EligibleForIntegratedServiceCareformboolNo
ConfirmedProductionDateformstringNo
ForecastedArrivalDateformstringNo
VehicleCriteriaMatch Parameters:
NameParameterData TypeRequiredDescription
FuelformboolNo
TransmissionformboolNo
ColourformboolNo
UpholsteryformboolNo
LineformboolNo
EngineformboolNo
BodyStyleformboolNo
PackagesformboolNo
Price Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
DescriptionformstringYes
NetformdecimalNo
VATformdecimalNo
GrossformdecimalNo
ProductformOfferPriceProductTypeNo
OfferPriceProductType Enum:
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
Retailer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
GssnIdformstringYes
DescriptionformstringYes
StreetformstringYes
CityformstringYes
PostcodeformstringYes
GoogleMapPostcodeformstringYes
PhoneformstringYes
FaxformstringYes
EmailformstringYes
WebsiteformstringYes
RetailerGroupIdformstringYes
RetailerGroupNameformstringYes
IsOnlineformboolNo
IsNewCarRetailerformboolNo
IsUsedCarRetailerformboolNo
IsCentralRetailerformboolNo
ChatEnabledformboolNo
TradeInEnabledformboolNo
smartformboolNo
DisplayPhoneNumberNewformstringYes
DisplayPhoneNumberUsedformstringYes
LatitudeformdecimalNo
LongitudeformdecimalNo
smartDescriptionformstringYes
smartWebsiteformstringYes
smartPhoneformstringYes
LegacyIdformstringYes
AgentformboolNo
MarketAreaIdformintNo
DigitalLoungeParentGssnIdformstringNo
SendLeadsToDigitalLoungeParentformboolNo
OpeningTimesformRetailerOpeningTimesNo
RetailerOpeningTimes Parameters:
NameParameterData TypeRequiredDescription
NewformList<RetailerOpeningTime>Yes
UsedformList<RetailerOpeningTime>Yes
RetailerOpeningTime Parameters:
NameParameterData TypeRequiredDescription
DayformstringYes
OpenFromformstringYes
OpenToformstringYes
SpecialformstringYes
VehicleConsumption Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
LkmformdecimalNo
MpgformdecimalNo
VehicleEquipmentCategory Parameters:
NameParameterData TypeRequiredDescription
OrderformintNo
CodeformstringNo
DescriptionformstringNo
EquipmentformList<Equipmentv2>No
Equipmentv2 Parameters:
NameParameterData TypeRequiredDescription
ImportanceformintNo
IsAdditionalformboolNo
Equipment Parameters:
NameParameterData TypeRequiredDescription
Idformint?No
CodeformstringNo
DescriptionformstringNo
VehicleEmissionClass Parameters:
NameParameterData TypeRequiredDescription
ColourformstringNo
RatingformstringNo
VehicleAttribute Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
ValueformstringNo
VehicleIntegratedServiceCareOption Parameters:
NameParameterData TypeRequiredDescription
OptionCodeformstringNo
BM7NSTformstringNo
FullModelYearformstringNo
IntegratedProductTypeformstringNo
CustomerDescriptionformstringNo
OneAgentProductTypeformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
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","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"},"Vin":"String"}]}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{}