Mercedes.VehicleManagement.API

<back to all web services

VehicleByCommissionNumberRequest

Vehicle
Requires Authentication
The following routes are available for this service:
GET/v1/{VehicleType}/Vehicle/{vehicleIdentifier}Get vehicle data by commission numberThis endpoint calls Vehicle Data API and returns the data that populates the car details page in OneAdmin
VehicleByCommissionNumberRequest Parameters:
NameParameterData TypeRequiredDescription
vehicleIdentifierpathstringYes
VehicleTypepathstringYes
VehicleByCommissionNumberResponse Parameters:
NameParameterData TypeRequiredDescription
VehicleformVehicleIdentifierDataYes
VehicleByIdentifierResponse Parameters:
NameParameterData TypeRequiredDescription
CampaignOffersformList<Offer>Yes
CampaignPersonalisedOffersformList<PersonalisedOffer>Yes
CampaignGovernmentGrantOffersformList<Offer>Yes
CampaignMessagesformList<Message>Yes
OfferHistoriesformList<OfferHistory>No
FinanceOffersformList<FinanceOffer>No
Offer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
OfferTypeformstringYes
CampaignNameformstringYes
FromformstringYes
ToformstringYes
ValueformstringYes
Netformdecimal?No
OfferVehicleformOfferVehicleYes
PendingformboolNo
DocumentUrlformstringYes
PersonalisedformboolNo
IsPersonalisedMonetaryOfferformboolNo
CampaignVIPDiscountformboolNo
OfferValueNetformdecimal?No
CampaignGovernmentGrantformboolNo
OfferVehicle Parameters:
NameParameterData TypeRequiredDescription
RetailPriceExVATformstringYes
PersonalisedOffer Parameters:
NameParameterData TypeRequiredDescription
CategoryformstringYes
DescriptionformstringYes
ReferenceformstringYes
CampaignIdformintNo
CertificateRequiredformbool?No
AutoSelectformboolNo
Message Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
VinformstringYes
CampaignIdformintNo
ValueformstringYes
CampaignDescriptionformstringYes
FromformstringYes
ToformstringYes
DocumentUrlformstringYes
OfferHistory Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
AuditTypeformstringYes
OfferTypeformstringYes
SourceformstringYes
FromformstringYes
ToformstringYes
PersonalisedformboolNo
ValueformstringYes
NetformstringYes
VATformstringYes
DescriptionformstringYes
VinformstringYes
GssnformstringYes
CreationformstringYes
ModifiedformstringYes
UserIdformstringYes
UserformintNo
OfferIdformintNo
CommissionNumberformstringYes
CampaignIdformint?No
CampaignDescriptionformstringYes
CreationDateformDateTimeNo
IsUsedCarOfferformboolNo
FinanceOffer Parameters:
NameParameterData TypeRequiredDescription
CampaignDescriptionformstringYes
TermsAndConditionsformstringYes
LabelformstringYes
CampaignIdformintNo
DocumentUrlformstringYes
FromformstringYes
IdformintNo
ToformstringYes
ValueformstringYes
VinformstringYes
EnabledformboolNo
PendingformboolNo
OfferTypeformstringYes
VehicleIdentifierData Parameters:
NameParameterData TypeRequiredDescription
RetailerformstringYes
HasMotabilityErrorformboolNo
EquipmentformList<Equipment>Yes
VehicleData Parameters:
NameParameterData TypeRequiredDescription
EngineformstringYes
VehicleDataBase Parameters:
NameParameterData TypeRequiredDescription
VinformstringYes
DescriptionformstringYes
ModelformstringYes
OtrformstringYes
RetailPriceExVATformstringYes
ActualPriceformstringYes
P11DformstringYes
FuelTypeformstringYes
TransmissionformstringYes
TransmissionTypeformstringYes
ColourformstringYes
ColourCodeformstringYes
ColourDescriptionformstringYes
CommissionNumberformstringYes
OfferAvailableformboolNo
CampaignDiscountOfferTotalformintNo
CampaignDiscountOfferTotalCurrentformintNo
CampaignDiscountOfferTotalPendingformintNo
CampaignServiceOfferTotalformintNo
CampaignServiceOfferTotalCurrentformintNo
CampaignServiceOfferTotalPendingformintNo
CampaignCustomOfferTotalformintNo
CampaignPersonalisedOfferTotalCurrentformintNo
CampaignPersonalisedOfferTotalPendingformintNo
CampaignPersonalisedOfferTotalformintNo
CampaignCustomOfferTotalCurrentformintNo
CampaignCustomOfferTotalPendingformintNo
CampaignOtherOfferTotalformintNo
CampaignOtherOfferTotalCurrentformintNo
CampaignOtherOfferTotalPendingformintNo
RetailerDiscountOfferTotalformintNo
RetailerDiscountOfferTotalCurrentformintNo
RetailerDiscountOfferTotalPendingformintNo
RetailerServiceOfferTotalformintNo
RetailerServiceOfferTotalCurrentformintNo
RetailerServiceOfferTotalPendingformintNo
RetailerCustomOfferTotalformintNo
RetailerCustomOfferTotalCurrentformintNo
RetailerCustomOfferTotalPendingformintNo
RetailerWarrantyOfferTotalformintNo
RetailerWarrantyOfferTotalCurrentformintNo
RetailerWarrantyOfferTotalPendingformintNo
RetailerOfferTotalformintNo
RetailerOfferTotalCurrentformintNo
RetailerOfferTotalPendingformintNo
CampaignOfferTotalformintNo
CampaignOfferTotalCurrentformintNo
CampaignOfferTotalPendingformintNo
CampaignAndOfferTotalformintNo
CampaignAndOfferTotalCurrentformintNo
CampaignAndOfferTotalPendingformintNo
OfferTotalformintNo
OfferTotalCurrentformintNo
OfferTotalPendingformintNo
CreationformstringYes
ModifiedformstringYes
ElectricRangeformintNo
ElectricConsumptionformintNo
PortArrivalDateformDateTime?No
DaysSincePortArrivalformint?No
RetailPriceIncVATformdecimalNo
BodyStyleformstringYes
UpholsteryformstringYes
UpholsteryCodeformstringYes
UpholsteryTypeformstringYes
PackageNamesformList<string>Yes
LineformstringYes
MappedLineformstringYes
CurrentRetailerOfferPriceformdecimalNo
RetailPriceformstringYes
VATQualifyingformboolNo
RetailerIdformintNo
GssnIdformstringYes
NoImageformboolNo
ImageUrlformstringYes
IsAvailableOnlineformboolNo
IsBackOrderedformboolNo
CreationDateformstringYes
MaintenanceDateformstringYes
RegistrationNumberformstringYes
RegistrationDateformDateTime?No
Mileageformint?No
TradeInDateformDateTime?No
SourceformstringYes
VehicleTypeformstringYes
OfferAmountformstringYes
OfferExpiryformstringYes
ActiveOffersformint[]Yes
CampaignMessagesTotalformintNo
UnderOfferformboolNo
IsDisplayStockformboolNo
DisplayRetailerformstringYes
DisplayRetailerGssnIdformstringYes
LocationformstringYes
AccountformstringYes
AccountTypeformstringYes
UsageCodeformstringYes
Bm7NSTformstringYes
IsSellableformboolNo
SecuredformboolNo
SpecialistformboolNo
IsMotabilityRetailerformboolNo
UpholsteryDescriptionformstringYes
InBackOrderAccountformboolNo
FullModelYearCodeformstringNo
ProductionDateformDateTime?No
BaumusterformstringYes
IsMotabilityformboolNo
PipAdvanceRentalGrossformdecimal?No
WpmsAdvanceRentalGrossformdecimal?No
IspVehicleCustomerDescriptionsformList<string>No
EligibleForMaTransferformboolNo
ConfirmedProductionDateformstringNo
ForecastedArrivalDateformstringNo
Equipment Parameters:
NameParameterData TypeRequiredDescription
Idformint?No
CodeformstringNo
DescriptionformstringNo

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

HTTP + CSV

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/csv

HTTP/1.1 200 OK
Content-Type: text/csv
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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","mileage":0,"tradeInDate":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","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"}]}