Mercedes.Agency.Orchestration.API

GetVehicleWithOptimalRequest

Vehicle

The following routes are available for this service:
POST	/v1/VehicleWithOptimal		Get Vehicle by Vin and a more optimal option if available

**GetVehicleWithOptimalRequest** Parameters:
Name	Parameter	Data Type	Required
VehicleIdentifier	body	string	Yes
IncludeAllocatedToBackOrder	body	bool	No
Gssn	body	string	Yes
IsOneAdmin	body	bool	No
MotabilityPricingId	body	int?	No

**GetVehicleWithOptimalResponse** Parameters:
Name	Parameter	Data Type	Required	Description
OptimumVehicle	form	VehicleDetailDto	Yes

**GetVehicleResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Vehicle	form	VehicleDetailDto	Yes
Errors	form	List<VehicleError>	Yes

**VehicleDetailDto** Parameters:
Name	Parameter	Data Type	Required
BodyStyle	form	string	Yes
Vin	form	string	Yes
Description	form	string	Yes
Colour	form	string	Yes
ColourCode	form	string	Yes
ColourDescription	form	string	Yes
ColourGroup	form	string	Yes
Model	form	string	Yes
CommissionNumber	form	string	Yes
BrandId	form	int?	No
Brand	form	Brand	Yes
Engine	form	Engine	Yes
EngineBadge	form	string	Yes
Media	form	Media	Yes
Line	form	string	Yes
UpholsteryCode	form	string	Yes
UpholsteryType	form	string	Yes
Upholstery	form	string	Yes
UpholsteryDescription	form	string	Yes
AvailablePackages	form	List<string>	Yes
Packages	form	List<string>	Yes
P11D	form	decimal	No
PortArrivalDate	form	DateTime?	No
Prices	form	List<Price>	Yes
TransmissionType	form	string	Yes
FuelType	form	string	Yes
VehicleClass	form	string	Yes
ProductRange	form	string	Yes
VehicleType	form	string	Yes
Emission	form	decimal?	No
IsAvailableOnline	form	bool	No
UnderOffer	form	bool	No
IsExcluded	form	bool	No
IsSellable	form	bool	No
OnHold	form	bool	No
ElectricConsumption	form	decimal?	No
ElectricRange	form	decimal?	No
ImageUrl	form	string	Yes
Baumuster	form	string	Yes
Retailer	form	Retailer	Yes
Bm7NST	form	string	Yes
OTR	form	decimal	No
ActualPrice	form	decimal	No
IsDisplayStock	form	bool	No
DisplayRetailerId	form	int?	No
DisplayRetailer	form	string	Yes
DisplayRetailerGssnId	form	string	Yes
DisplayRetailerMarketAreaId	form	string	Yes
IsSmartDisplayRetailer	form	bool	No
IsSpecialistCar	form	bool	No
Age	form	int?	No
Secured	form	bool	No
IsHOBackOrderAccountVehicle	form	bool	No
IsAllocatedToBackOrder	form	bool	No
UsageCode	form	string	Yes
EmissionCombined	form	decimal?	No
NormalisedEmissionDirective	form	string	No
HasMildHybridEquipmentCode	form	bool	No
RetailPriceExVat	form	decimal	No
RetailPrice_IncVAT	form	decimal	No
RetailPrice_ExVAT	form	decimal	No
ModelId	form	int	No
VID	form	string	No
ProductionDate	form	string	No
FullModelYearCode	form	string	No
ChassisNumber	form	string	No
EligibleForIntegratedServiceCare	form	bool	No
AccountType	form	string	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
Equipment	form	List<Equipmentv2>	No
EquipmentCategories	form	List<VehicleEquipmentCategory>	No
EnergyEfficiencyClass	form	VehicleEmissionClass	No
VehicleData	form	List<VehicleAttribute>	No
IntegratedServiceCareOptions	form	List<VehicleIntegratedServiceCareOption>	Yes
IspVehicleCustomerDescriptions	form	List<string>	No

**Brand** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
DisplayName	form	string	No
BodyStyles	form	List<BodyStyle>	No

**BodyStyle** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
Models	form	List<Model>	No

**Model** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
DisplayName	form	string	No
ImageUrlSmall	form	string	No
ImageUrlMedium	form	string	No
ImageUrlLarge	form	string	No
Specialist	form	bool	No
Priority	form	int	No
ExcludeFromOnlineShowroomFilters	form	bool?	No

**Engine** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int?	No
Badge	form	string	Yes

**Media** Parameters:
Name	Parameter	Data Type	Required	Description
NoImage	form	bool	No
MainImageUrl	form	string	Yes

**Price** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
Description	form	string	Yes
Net	form	decimal	No
VAT	form	decimal	No
Gross	form	decimal	No
Product	form	OfferPriceProductType	No

**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:
Name	Parameter	Data Type	Required
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
Email	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

**RetailerOpeningTimes** Parameters:
Name	Parameter	Data Type	Required	Description
New	form	List<RetailerOpeningTime>	Yes
Used	form	List<RetailerOpeningTime>	Yes

**RetailerOpeningTime** Parameters:
Name	Parameter	Data Type	Required
Day	form	string	Yes
OpenFrom	form	string	Yes
OpenTo	form	string	Yes
Special	form	string	Yes

**VehicleConsumption** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Lkm	form	decimal	No
Mpg	form	decimal	No

**Equipmentv2** Parameters:
Name	Parameter	Data Type	Required	Description
Importance	form	int	No
IsAdditional	form	bool	No

**Equipment** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Code	form	string	No
Description	form	string	No

**VehicleEquipmentCategory** Parameters:
Name	Parameter	Data Type	Required
Order	form	int	No
Code	form	string	No
Description	form	string	No
Equipment	form	List<Equipmentv2>	No

**VehicleEmissionClass** Parameters:
Name	Parameter	Data Type	Required	Description
Colour	form	string	No
Rating	form	string	No

**VehicleAttribute** Parameters:
Name	Parameter	Data Type	Required	Description
Description	form	string	No
Value	form	string	No

**VehicleIntegratedServiceCareOption** Parameters:
Name	Parameter	Data Type	Required
OptionCode	form	string	No
BM7NST	form	string	No
FullModelYear	form	string	No
IntegratedProductType	form	string	No
CustomerDescription	form	string	No
OneAgentProductType	form	string	No

**VehicleError** Parameters:
Name	Parameter	Data Type	Required	Description
Field	form	string	Yes
Message	form	string	Yes

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	VehicleIdentifier: String,
	IncludeAllocatedToBackOrder: False,
	Gssn: String,
	IsOneAdmin: False,
	MotabilityPricingId: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
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: 0001-01-01,
		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: 0001-01-01,
		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
		}
	]
}