Mercedes.Agency.Orchestration.API

<back to all web services

GetVehicleWithOptimalRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/VehicleWithOptimalGet Vehicle by Vin and a more optimal option if available
GetVehicleWithOptimalRequest Parameters:
NameParameterData TypeRequiredDescription
VehicleIdentifierbodystringYes
IncludeAllocatedToBackOrderbodyboolNo
GssnbodystringYes
IsOneAdminbodyboolNo
MotabilityPricingIdbodyint?No
GetVehicleWithOptimalResponse Parameters:
NameParameterData TypeRequiredDescription
OptimumVehicleformVehicleDetailDtoYes
GetVehicleResponse Parameters:
NameParameterData TypeRequiredDescription
VehicleformVehicleDetailDtoYes
ErrorsformList<VehicleError>Yes
VehicleDetailDto Parameters:
NameParameterData TypeRequiredDescription
BodyStyleformstringYes
VinformstringYes
DescriptionformstringYes
ColourformstringYes
ColourCodeformstringYes
ColourDescriptionformstringYes
ColourGroupformstringYes
ModelformstringYes
CommissionNumberformstringYes
BrandIdformint?No
BrandformBrandYes
EngineformEngineYes
EngineBadgeformstringYes
MediaformMediaYes
LineformstringYes
UpholsteryCodeformstringYes
UpholsteryTypeformstringYes
UpholsteryformstringYes
UpholsteryDescriptionformstringYes
AvailablePackagesformList<string>Yes
PackagesformList<string>Yes
P11DformdecimalNo
PortArrivalDateformDateTime?No
PricesformList<Price>Yes
TransmissionTypeformstringYes
FuelTypeformstringYes
VehicleClassformstringYes
ProductRangeformstringYes
VehicleTypeformstringYes
Emissionformdecimal?No
IsAvailableOnlineformboolNo
UnderOfferformboolNo
IsExcludedformboolNo
IsSellableformboolNo
OnHoldformboolNo
ElectricConsumptionformdecimal?No
ElectricRangeformdecimal?No
ImageUrlformstringYes
BaumusterformstringYes
RetailerformRetailerYes
Bm7NSTformstringYes
OTRformdecimalNo
ActualPriceformdecimalNo
IsDisplayStockformboolNo
DisplayRetailerIdformint?No
DisplayRetailerformstringYes
DisplayRetailerGssnIdformstringYes
DisplayRetailerMarketAreaIdformstringYes
IsSmartDisplayRetailerformboolNo
IsSpecialistCarformboolNo
Ageformint?No
SecuredformboolNo
IsHOBackOrderAccountVehicleformboolNo
IsAllocatedToBackOrderformboolNo
UsageCodeformstringYes
EmissionCombinedformdecimal?No
NormalisedEmissionDirectiveformstringNo
HasMildHybridEquipmentCodeformboolNo
RetailPriceExVatformdecimalNo
RetailPrice_IncVATformdecimalNo
RetailPrice_ExVATformdecimalNo
ModelIdformintNo
VIDformstringNo
ProductionDateformstringNo
FullModelYearCodeformstringNo
ChassisNumberformstringNo
EligibleForIntegratedServiceCareformboolNo
AccountTypeformstringNo
ConsumptionCombinedformVehicleConsumptionNo
ConsumptionExtraUrbanformVehicleConsumptionNo
ConsumptionUrbanformVehicleConsumptionNo
WltpFuelConsumptionCombinedformVehicleConsumptionNo
WltpFuelConsumptionExtraHighformVehicleConsumptionNo
WltpFuelConsumptionHighformVehicleConsumptionNo
WltpFuelConsumptionLowformVehicleConsumptionNo
WltpFuelConsumptionMediumformVehicleConsumptionNo
EquipmentformList<Equipmentv2>No
EquipmentCategoriesformList<VehicleEquipmentCategory>No
EnergyEfficiencyClassformVehicleEmissionClassNo
VehicleDataformList<VehicleAttribute>No
IntegratedServiceCareOptionsformList<VehicleIntegratedServiceCareOption>Yes
IspVehicleCustomerDescriptionsformList<string>No
Brand Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
DisplayNameformstringNo
BodyStylesformList<BodyStyle>No
BodyStyle Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
ModelsformList<Model>No
Model Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DescriptionformstringNo
DisplayNameformstringNo
ImageUrlSmallformstringNo
ImageUrlMediumformstringNo
ImageUrlLargeformstringNo
SpecialistformboolNo
PriorityformintNo
ExcludeFromOnlineShowroomFiltersformbool?No
Engine Parameters:
NameParameterData TypeRequiredDescription
Idformint?No
BadgeformstringYes
Media Parameters:
NameParameterData TypeRequiredDescription
NoImageformboolNo
MainImageUrlformstringYes
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
Equipmentv2 Parameters:
NameParameterData TypeRequiredDescription
ImportanceformintNo
IsAdditionalformboolNo
Equipment Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
CodeformstringNo
DescriptionformstringNo
VehicleEquipmentCategory Parameters:
NameParameterData TypeRequiredDescription
OrderformintNo
CodeformstringNo
DescriptionformstringNo
EquipmentformList<Equipmentv2>No
VehicleEmissionClass Parameters:
NameParameterData TypeRequiredDescription
ColourformstringNo
RatingformstringNo
VehicleAttribute Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
ValueformstringNo
VehicleIntegratedServiceCareOption Parameters:
NameParameterData TypeRequiredDescription
OptionCodeformstringNo
BM7NSTformstringNo
FullModelYearformstringNo
IntegratedProductTypeformstringNo
CustomerDescriptionformstringNo
OneAgentProductTypeformstringNo
VehicleError Parameters:
NameParameterData TypeRequiredDescription
FieldformstringYes
MessageformstringYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/VehicleWithOptimal HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"VehicleIdentifier":"String","IncludeAllocatedToBackOrder":false,"Gssn":"String","IsOneAdmin":false,"MotabilityPricingId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"OptimumVehicle":{"BodyStyle":"String","Vin":"String","Description":"String","Colour":"String","ColourCode":"String","ColourDescription":"String","ColourGroup":"String","Model":"String","CommissionNumber":"String","BrandId":0,"Brand":{"Id":0,"Description":"String","DisplayName":"String","BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}]},"Engine":{"Id":0,"Badge":"String"},"EngineBadge":"String","Media":{"NoImage":false,"MainImageUrl":"String"},"Line":"String","UpholsteryCode":"String","UpholsteryType":"String","Upholstery":"String","UpholsteryDescription":"String","AvailablePackages":["String"],"Packages":["String"],"P11D":0,"PortArrivalDate":"\/Date(-62135596800000-0000)\/","Prices":[{"Id":"String","Description":"String","Net":0,"VAT":0,"Gross":0,"Product":"LIST_PRICE"}],"TransmissionType":"String","FuelType":"String","VehicleClass":"String","ProductRange":"String","VehicleType":"String","Emission":0,"IsAvailableOnline":false,"UnderOffer":false,"IsExcluded":false,"IsSellable":false,"OnHold":false,"ElectricConsumption":0,"ElectricRange":0,"ImageUrl":"String","Baumuster":"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"}]}},"Bm7NST":"String","OTR":0,"ActualPrice":0,"IsDisplayStock":false,"DisplayRetailerId":0,"DisplayRetailer":"String","DisplayRetailerGssnId":"String","DisplayRetailerMarketAreaId":"String","IsSmartDisplayRetailer":false,"IsSpecialistCar":false,"Age":0,"Secured":false,"IsHOBackOrderAccountVehicle":false,"IsAllocatedToBackOrder":false,"UsageCode":"String","EmissionCombined":0,"NormalisedEmissionDirective":"String","HasMildHybridEquipmentCode":false,"RetailPriceExVat":0,"RetailPrice_IncVAT":0,"RetailPrice_ExVAT":0,"ModelId":0,"VID":"String","ProductionDate":"String","FullModelYearCode":"String","ChassisNumber":"String","EligibleForIntegratedServiceCare":false,"AccountType":"String","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},"Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}],"EquipmentCategories":[{"Order":0,"Code":"String","Description":"String","Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}]}],"EnergyEfficiencyClass":{"Colour":"String","Rating":"String"},"VehicleData":[{"Description":"String","Value":"String"}],"IntegratedServiceCareOptions":[{"OptionCode":"String","BM7NST":"String","FullModelYear":"String","IntegratedProductType":"String","CustomerDescription":"String","OneAgentProductType":"String"}],"IspVehicleCustomerDescriptions":["String"]},"Vehicle":{"BodyStyle":"String","Vin":"String","Description":"String","Colour":"String","ColourCode":"String","ColourDescription":"String","ColourGroup":"String","Model":"String","CommissionNumber":"String","BrandId":0,"Brand":{"Id":0,"Description":"String","DisplayName":"String","BodyStyles":[{"Id":0,"Description":"String","Models":[{"Id":0,"Description":"String","DisplayName":"String","ImageUrlSmall":"String","ImageUrlMedium":"String","ImageUrlLarge":"String","Specialist":false,"Priority":0,"ExcludeFromOnlineShowroomFilters":false}]}]},"Engine":{"Id":0,"Badge":"String"},"EngineBadge":"String","Media":{"NoImage":false,"MainImageUrl":"String"},"Line":"String","UpholsteryCode":"String","UpholsteryType":"String","Upholstery":"String","UpholsteryDescription":"String","AvailablePackages":["String"],"Packages":["String"],"P11D":0,"PortArrivalDate":"\/Date(-62135596800000-0000)\/","Prices":[{"Id":"String","Description":"String","Net":0,"VAT":0,"Gross":0,"Product":"LIST_PRICE"}],"TransmissionType":"String","FuelType":"String","VehicleClass":"String","ProductRange":"String","VehicleType":"String","Emission":0,"IsAvailableOnline":false,"UnderOffer":false,"IsExcluded":false,"IsSellable":false,"OnHold":false,"ElectricConsumption":0,"ElectricRange":0,"ImageUrl":"String","Baumuster":"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"}]}},"Bm7NST":"String","OTR":0,"ActualPrice":0,"IsDisplayStock":false,"DisplayRetailerId":0,"DisplayRetailer":"String","DisplayRetailerGssnId":"String","DisplayRetailerMarketAreaId":"String","IsSmartDisplayRetailer":false,"IsSpecialistCar":false,"Age":0,"Secured":false,"IsHOBackOrderAccountVehicle":false,"IsAllocatedToBackOrder":false,"UsageCode":"String","EmissionCombined":0,"NormalisedEmissionDirective":"String","HasMildHybridEquipmentCode":false,"RetailPriceExVat":0,"RetailPrice_IncVAT":0,"RetailPrice_ExVAT":0,"ModelId":0,"VID":"String","ProductionDate":"String","FullModelYearCode":"String","ChassisNumber":"String","EligibleForIntegratedServiceCare":false,"AccountType":"String","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},"Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}],"EquipmentCategories":[{"Order":0,"Code":"String","Description":"String","Equipment":[{"Importance":0,"IsAdditional":false,"Id":0,"Code":"String","Description":"String"}]}],"EnergyEfficiencyClass":{"Colour":"String","Rating":"String"},"VehicleData":[{"Description":"String","Value":"String"}],"IntegratedServiceCareOptions":[{"OptionCode":"String","BM7NST":"String","FullModelYear":"String","IntegratedProductType":"String","CustomerDescription":"String","OneAgentProductType":"String"}],"IspVehicleCustomerDescriptions":["String"]},"Errors":[{"Field":"String","Message":"String"}]}