Mercedes.VehicleManagement.API

VehicleByCommissionNumberRequest

Vehicle

The following routes are available for this service:
GET	/v1/{VehicleType}/Vehicle/{vehicleIdentifier}	Get vehicle data by commission number	This endpoint calls Vehicle Data API and returns the data that populates the car details page in OneAdmin

**VehicleByCommissionNumberRequest** Parameters:
Name	Parameter	Data Type	Required	Description
vehicleIdentifier	path	string	Yes
VehicleType	path	string	Yes

**VehicleByCommissionNumberResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Vehicle	form	VehicleIdentifierData	Yes

**VehicleByIdentifierResponse** Parameters:
Name	Parameter	Data Type	Required
CampaignOffers	form	List<Offer>	Yes
CampaignPersonalisedOffers	form	List<PersonalisedOffer>	Yes
CampaignGovernmentGrantOffers	form	List<Offer>	Yes
CampaignMessages	form	List<Message>	Yes
OfferHistories	form	List<OfferHistory>	No
FinanceOffers	form	List<FinanceOffer>	No

**Offer** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
OfferType	form	string	Yes
CampaignName	form	string	Yes
From	form	string	Yes
To	form	string	Yes
Value	form	string	Yes
Net	form	decimal?	No
OfferVehicle	form	OfferVehicle	Yes
Pending	form	bool	No
DocumentUrl	form	string	Yes
Personalised	form	bool	No
IsPersonalisedMonetaryOffer	form	bool	No
CampaignVIPDiscount	form	bool	No
OfferValueNet	form	decimal?	No
CampaignGovernmentGrant	form	bool	No

**OfferVehicle** Parameters:
Name	Parameter	Data Type	Required	Description
RetailPriceExVAT	form	string	Yes

**PersonalisedOffer** Parameters:
Name	Parameter	Data Type	Required
Category	form	string	Yes
Description	form	string	Yes
Reference	form	string	Yes
CampaignId	form	int	No
CertificateRequired	form	bool?	No
AutoSelect	form	bool	No

**Message** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Vin	form	string	Yes
CampaignId	form	int	No
Value	form	string	Yes
CampaignDescription	form	string	Yes
From	form	string	Yes
To	form	string	Yes
DocumentUrl	form	string	Yes

**OfferHistory** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
AuditType	form	string	Yes
OfferType	form	string	Yes
Source	form	string	Yes
From	form	string	Yes
To	form	string	Yes
Personalised	form	bool	No
Value	form	string	Yes
Net	form	string	Yes
VAT	form	string	Yes
Description	form	string	Yes
Vin	form	string	Yes
Gssn	form	string	Yes
Creation	form	string	Yes
Modified	form	string	Yes
UserId	form	string	Yes
User	form	int	No
OfferId	form	int	No
CommissionNumber	form	string	Yes
CampaignId	form	int?	No
CampaignDescription	form	string	Yes
CreationDate	form	DateTime	No
IsUsedCarOffer	form	bool	No

**FinanceOffer** Parameters:
Name	Parameter	Data Type	Required
CampaignDescription	form	string	Yes
TermsAndConditions	form	string	Yes
Label	form	string	Yes
CampaignId	form	int	No
DocumentUrl	form	string	Yes
From	form	string	Yes
Id	form	int	No
To	form	string	Yes
Value	form	string	Yes
Vin	form	string	Yes
Enabled	form	bool	No
Pending	form	bool	No
OfferType	form	string	Yes

**VehicleIdentifierData** Parameters:
Name	Parameter	Data Type	Required
Retailer	form	string	Yes
HasMotabilityError	form	bool	No
Equipment	form	List<Equipment>	Yes

**VehicleData** Parameters:
Name	Parameter	Data Type	Required	Description
Engine	form	string	Yes

**VehicleDataBase** Parameters:
Name	Parameter	Data Type	Required
Vin	form	string	Yes
Description	form	string	Yes
Model	form	string	Yes
Otr	form	string	Yes
RetailPriceExVAT	form	string	Yes
ActualPrice	form	string	Yes
P11D	form	string	Yes
FuelType	form	string	Yes
Transmission	form	string	Yes
TransmissionType	form	string	Yes
Colour	form	string	Yes
ColourCode	form	string	Yes
ColourDescription	form	string	Yes
CommissionNumber	form	string	Yes
OfferAvailable	form	bool	No
CampaignDiscountOfferTotal	form	int	No
CampaignDiscountOfferTotalCurrent	form	int	No
CampaignDiscountOfferTotalPending	form	int	No
CampaignServiceOfferTotal	form	int	No
CampaignServiceOfferTotalCurrent	form	int	No
CampaignServiceOfferTotalPending	form	int	No
CampaignCustomOfferTotal	form	int	No
CampaignPersonalisedOfferTotalCurrent	form	int	No
CampaignPersonalisedOfferTotalPending	form	int	No
CampaignPersonalisedOfferTotal	form	int	No
CampaignCustomOfferTotalCurrent	form	int	No
CampaignCustomOfferTotalPending	form	int	No
CampaignOtherOfferTotal	form	int	No
CampaignOtherOfferTotalCurrent	form	int	No
CampaignOtherOfferTotalPending	form	int	No
RetailerDiscountOfferTotal	form	int	No
RetailerDiscountOfferTotalCurrent	form	int	No
RetailerDiscountOfferTotalPending	form	int	No
RetailerServiceOfferTotal	form	int	No
RetailerServiceOfferTotalCurrent	form	int	No
RetailerServiceOfferTotalPending	form	int	No
RetailerCustomOfferTotal	form	int	No
RetailerCustomOfferTotalCurrent	form	int	No
RetailerCustomOfferTotalPending	form	int	No
RetailerWarrantyOfferTotal	form	int	No
RetailerWarrantyOfferTotalCurrent	form	int	No
RetailerWarrantyOfferTotalPending	form	int	No
RetailerOfferTotal	form	int	No
RetailerOfferTotalCurrent	form	int	No
RetailerOfferTotalPending	form	int	No
CampaignOfferTotal	form	int	No
CampaignOfferTotalCurrent	form	int	No
CampaignOfferTotalPending	form	int	No
CampaignAndOfferTotal	form	int	No
CampaignAndOfferTotalCurrent	form	int	No
CampaignAndOfferTotalPending	form	int	No
OfferTotal	form	int	No
OfferTotalCurrent	form	int	No
OfferTotalPending	form	int	No
Creation	form	string	Yes
Modified	form	string	Yes
ElectricRange	form	int	No
ElectricConsumption	form	int	No
PortArrivalDate	form	DateTime?	No
DaysSincePortArrival	form	int?	No
RetailPriceIncVAT	form	decimal	No
BodyStyle	form	string	Yes
Upholstery	form	string	Yes
UpholsteryCode	form	string	Yes
UpholsteryType	form	string	Yes
PackageNames	form	List<string>	Yes
Line	form	string	Yes
MappedLine	form	string	Yes
CurrentRetailerOfferPrice	form	decimal	No
RetailPrice	form	string	Yes
VATQualifying	form	bool	No
RetailerId	form	int	No
GssnId	form	string	Yes
NoImage	form	bool	No
ImageUrl	form	string	Yes
IsAvailableOnline	form	bool	No
IsBackOrdered	form	bool	No
CreationDate	form	string	Yes
MaintenanceDate	form	string	Yes
RegistrationNumber	form	string	Yes
RegistrationDate	form	DateTime?	No
Mileage	form	int?	No
TradeInDate	form	DateTime?	No
Source	form	string	Yes
VehicleType	form	string	Yes
OfferAmount	form	string	Yes
OfferExpiry	form	string	Yes
ActiveOffers	form	int[]	Yes
CampaignMessagesTotal	form	int	No
UnderOffer	form	bool	No
IsDisplayStock	form	bool	No
DisplayRetailer	form	string	Yes
DisplayRetailerGssnId	form	string	Yes
Location	form	string	Yes
Account	form	string	Yes
AccountType	form	string	Yes
UsageCode	form	string	Yes
Bm7NST	form	string	Yes
IsSellable	form	bool	No
Secured	form	bool	No
Specialist	form	bool	No
IsMotabilityRetailer	form	bool	No
UpholsteryDescription	form	string	Yes
InBackOrderAccount	form	bool	No
FullModelYearCode	form	string	No
ProductionDate	form	DateTime?	No
Baumuster	form	string	Yes
IsMotability	form	bool	No
PipAdvanceRentalGross	form	decimal?	No
WpmsAdvanceRentalGross	form	decimal?	No
IspVehicleCustomerDescriptions	form	List<string>	No
EligibleForMaTransfer	form	bool	No
ConfirmedProductionDate	form	string	No
ForecastedArrivalDate	form	string	No

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

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.

GET /v1/{VehicleType}/Vehicle/{vehicleIdentifier} HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv

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

{
	vehicle: 
	{
		retailer: String,
		hasMotabilityError: False,
		equipment: 
		[
			{
				id: 0,
				code: String,
				description: String
			}
		],
		engine: String,
		vin: String,
		description: String,
		model: String,
		otr: String,
		retailPriceExVAT: String,
		actualPrice: String,
		p11D: String,
		fuelType: String,
		transmission: String,
		transmissionType: String,
		colour: String,
		colourCode: String,
		colourDescription: String,
		commissionNumber: String,
		offerAvailable: False,
		campaignDiscountOfferTotal: 0,
		campaignDiscountOfferTotalCurrent: 0,
		campaignDiscountOfferTotalPending: 0,
		campaignServiceOfferTotal: 0,
		campaignServiceOfferTotalCurrent: 0,
		campaignServiceOfferTotalPending: 0,
		campaignCustomOfferTotal: 0,
		campaignPersonalisedOfferTotalCurrent: 0,
		campaignPersonalisedOfferTotalPending: 0,
		campaignPersonalisedOfferTotal: 0,
		campaignCustomOfferTotalCurrent: 0,
		campaignCustomOfferTotalPending: 0,
		campaignOtherOfferTotal: 0,
		campaignOtherOfferTotalCurrent: 0,
		campaignOtherOfferTotalPending: 0,
		retailerDiscountOfferTotal: 0,
		retailerDiscountOfferTotalCurrent: 0,
		retailerDiscountOfferTotalPending: 0,
		retailerServiceOfferTotal: 0,
		retailerServiceOfferTotalCurrent: 0,
		retailerServiceOfferTotalPending: 0,
		retailerCustomOfferTotal: 0,
		retailerCustomOfferTotalCurrent: 0,
		retailerCustomOfferTotalPending: 0,
		retailerWarrantyOfferTotal: 0,
		retailerWarrantyOfferTotalCurrent: 0,
		retailerWarrantyOfferTotalPending: 0,
		retailerOfferTotal: 0,
		retailerOfferTotalCurrent: 0,
		retailerOfferTotalPending: 0,
		campaignOfferTotal: 0,
		campaignOfferTotalCurrent: 0,
		campaignOfferTotalPending: 0,
		campaignAndOfferTotal: 0,
		campaignAndOfferTotalCurrent: 0,
		campaignAndOfferTotalPending: 0,
		offerTotal: 0,
		offerTotalCurrent: 0,
		offerTotalPending: 0,
		creation: String,
		modified: String,
		electricRange: 0,
		electricConsumption: 0,
		portArrivalDate: 0001-01-01,
		daysSincePortArrival: 0,
		retailPriceIncVAT: 0,
		bodyStyle: String,
		upholstery: String,
		upholsteryCode: String,
		upholsteryType: String,
		packageNames: 
		[
			String
		],
		line: String,
		mappedLine: String,
		currentRetailerOfferPrice: 0,
		retailPrice: String,
		vatQualifying: False,
		retailerId: 0,
		gssnId: String,
		noImage: False,
		imageUrl: String,
		isAvailableOnline: False,
		isBackOrdered: False,
		creationDate: String,
		maintenanceDate: String,
		registrationNumber: String,
		registrationDate: 0001-01-01,
		mileage: 0,
		tradeInDate: 0001-01-01,
		source: String,
		vehicleType: String,
		offerAmount: String,
		offerExpiry: String,
		activeOffers: 
		[
			0
		],
		campaignMessagesTotal: 0,
		underOffer: False,
		isDisplayStock: False,
		displayRetailer: String,
		displayRetailerGssnId: String,
		location: String,
		account: String,
		accountType: String,
		usageCode: String,
		bm7NST: String,
		isSellable: False,
		secured: False,
		specialist: False,
		isMotabilityRetailer: False,
		upholsteryDescription: String,
		inBackOrderAccount: False,
		fullModelYearCode: String,
		productionDate: 0001-01-01,
		baumuster: String,
		isMotability: False,
		pipAdvanceRentalGross: 0,
		wpmsAdvanceRentalGross: 0,
		ispVehicleCustomerDescriptions: 
		[
			String
		],
		eligibleForMaTransfer: False,
		confirmedProductionDate: String,
		forecastedArrivalDate: String
	},
	campaignOffers: 
	[
		{
			id: 0,
			offerType: String,
			campaignName: String,
			from: String,
			to: String,
			value: String,
			net: 0,
			offerVehicle: 
			{
				retailPriceExVAT: String
			},
			pending: False,
			documentUrl: String,
			personalised: False,
			isPersonalisedMonetaryOffer: False,
			campaignVIPDiscount: False,
			offerValueNet: 0,
			campaignGovernmentGrant: False
		}
	],
	campaignPersonalisedOffers: 
	[
		{
			category: String,
			description: String,
			reference: String,
			campaignId: 0,
			certificateRequired: False,
			autoSelect: False,
			id: 0,
			offerType: String,
			campaignName: String,
			from: String,
			to: String,
			value: String,
			net: 0,
			offerVehicle: 
			{
				retailPriceExVAT: String
			},
			pending: False,
			documentUrl: String,
			personalised: False,
			isPersonalisedMonetaryOffer: False,
			campaignVIPDiscount: False,
			offerValueNet: 0,
			campaignGovernmentGrant: False
		}
	],
	campaignGovernmentGrantOffers: 
	[
		{
			id: 0,
			offerType: String,
			campaignName: String,
			from: String,
			to: String,
			value: String,
			net: 0,
			offerVehicle: 
			{
				retailPriceExVAT: String
			},
			pending: False,
			documentUrl: String,
			personalised: False,
			isPersonalisedMonetaryOffer: False,
			campaignVIPDiscount: False,
			offerValueNet: 0,
			campaignGovernmentGrant: False
		}
	],
	campaignMessages: 
	[
		{
			id: 0,
			vin: String,
			campaignId: 0,
			value: String,
			campaignDescription: String,
			from: String,
			to: String,
			documentUrl: String
		}
	],
	offerHistories: 
	[
		{
			id: 0,
			auditType: String,
			offerType: String,
			source: String,
			from: String,
			to: String,
			personalised: False,
			value: String,
			net: String,
			vat: String,
			description: String,
			vin: String,
			gssn: String,
			creation: String,
			modified: String,
			userId: String,
			user: 0,
			offerId: 0,
			commissionNumber: String,
			campaignId: 0,
			campaignDescription: String,
			creationDate: 0001-01-01,
			isUsedCarOffer: False
		}
	],
	financeOffers: 
	[
		{
			campaignDescription: String,
			termsAndConditions: String,
			label: String,
			campaignId: 0,
			documentUrl: String,
			from: String,
			id: 0,
			to: String,
			value: String,
			vin: String,
			enabled: False,
			pending: False,
			offerType: String
		}
	]
}