Mercedes.Agency.Orchestration.API

CarConfiguratorStockRequest

CarConfigurator

The following routes are available for this service:
POST	/v1/CarConfiguratorStock	Validate and save a car configurator code for a vehicle search	This endpoint calls Agency API to validate and save a car configurator code. The code is validated and saved in the database and returns a response from a third party CCS which provides car configuration details. These get saved to open search and used to perform a vehicle search

**CarConfiguratorStockRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ConfiguratorCode	body	string	Yes	The configurator code to search on
IsSellable	body	bool?	No	Whether to return sellable vehicles
ExactMatch	body	bool	No	Whether to only get exact matches
GSSN	body	string	No	Whether to restrict vehicles response to a GSSN

**CarConfiguratorStockResponse** Parameters:
Name	Parameter	Data Type	Required
TotalVehicles	form	int	No
CarConfiguratorResponse	form	CarConfiguratorResponse	Yes
ExactMatches	form	CarConfiguratorStockMatches	Yes
CloseMatches	form	CarConfiguratorStockMatches	Yes

**CarConfiguratorResponse** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
KeyInformation	form	KeyInformation	No
OrderingOptions	form	OrderingOptions	No
ResponseStatus	form	ResponseStatus	Yes
ConfiguratorCode	form	string	No

**KeyInformation** Parameters:
Name	Parameter	Data Type	Required
BM7NST	form	string	No
ConfigurationDate	form	string	No
ModelYear	form	string	No
HalfYear	form	string	No

**OrderingOptions** Parameters:
Name	Parameter	Data Type	Required
Interior	form	List<string>	No
Exterior	form	List<string>	No
Options	form	List<string>	No
WheelOptions	form	List<EquipmentCache>	Yes
TrimOptions	form	List<EquipmentCache>	Yes
OptionCodes	form	List<EquipmentCache>	Yes

**EquipmentCache** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	Yes
Description	form	string	Yes
StandardFlag	form	string	Yes
Price	form	decimal	No
Category	form	string	Yes
Importance	form	string	Yes

**CarConfiguratorStockMatches** Parameters:
Name	Parameter	Data Type	Required	Description
SellableMatches	form	List<CarConfiguratorStockMatch>	Yes
NonSellableMatches	form	List<CarConfiguratorStockMatch>	Yes

**CarConfiguratorStockMatch** Parameters:
Name	Parameter	Data Type	Required
Vehicle	form	CarConfiguratorVehicle	Yes
IsSellable	form	bool	No
VehicleWheels	form	string	No
VehicleTrim	form	string	No
VehicleAdditionalOptionCodes	form	List<string>	Yes
FullModelYearDifferences	form	List<string>	Yes
PaintDifferences	form	List<string>	Yes
UpholsteryDifferences	form	List<string>	Yes
WheelDifferences	form	List<string>	Yes
TrimDifferences	form	List<string>	Yes
EquipmentDifferences	form	List<string>	Yes
Differences	form	List<string>	Yes
ExactMatch	form	bool	No

**CarConfiguratorVehicle** Parameters:
Name	Parameter	Data Type	Required
ModelYearCode	form	string	No
HalfModelYearCode	form	string	No
ActiveOffers	form	List<int>	Yes
EligibleForMotability	form	bool	No
NearestPort	form	bool?	No

**BackOrderVehicleDetailsWithPackages** Parameters:
Name	Parameter	Data Type	Required	Description
Packages	form	ICollection<Package>	Yes
PackageNames	form	string	Yes

**BackOrderVehicleDetails** Parameters:
Name	Parameter	Data Type	Required
Vin	form	string	No
CommissionNumber	form	string	No
Description	form	string	No
ShortDescription	form	string	No
ModelId	form	int	No
Model	form	string	No
FullModelYearCode	form	string	No
BrandId	form	int?	No
Brand	form	BackOrderVehicleDetailsBrand	No
RetailerId	form	int	No
ImageUrl	form	string	No
Colour	form	string	No
ColourCode	form	string	No
FuelType	form	string	No
FuelTypeId	form	int	No
Transmission	form	string	No
TransmissionType	form	string	No
Engine	form	Engine	No
EngineBadge	form	string	No
Package	form	string	No
Line	form	string	No
Upholstery	form	string	No
UpholsteryCode	form	string	No
UsageCode	form	string	No
Account	form	string	No
AccountType	form	string	No
NST	form	string	No
Baumuster	form	string	No
ElectricRange	form	decimal?	No
ElectricConsumption	form	decimal?	No
ActualPrice	form	decimal?	No
OTRPrice	form	decimal	No
RetailPriceExVat	form	decimal	No
P11D	form	decimal	No
VehicleType	form	string	No
UpholsteryDescription	form	string	No
UpholsteryType	form	string	No
BodyStyle	form	string	No
BodyStyleStyleCode	form	string	No
BodyStyleStyleCodeElectric	form	string	No
BodyStyleStyleCodeHybrid	form	string	No
AvailablePackages	form	List<string>	No
Mapped_Line	form	int?	No
Secured	form	bool	No
Bm7NST	form	string	No
IsAvailableOnline	form	bool	No
IsSpecialistCar	form	bool	No
IsSellable	form	bool	No
UnderOffer	form	bool	No
VehicleAuditDetails	form	List<VehicleAuditDetails>	No
Retailer	form	Retailer	No
Media	form	Media	No
Emission	form	decimal?	No
ColourGroup	form	string	No
VehicleClass	form	string	No
ProductRange	form	string	No
IsHOBackOrderAccountVehicle	form	bool	No
IsAllocatedToBackOrder	form	bool	No
InBackOrderAccount	form	bool	No
DeliveryCharge	form	decimal	No
DeliveryChargeNet	form	decimal?	No
DeliveryChargeVAT	form	decimal?	No
Plates	form	decimal	No
PlatesNet	form	decimal?	No
PlatesVAT	form	decimal?	No
FuelCharge	form	decimal	No
FuelChargeNet	form	decimal?	No
FuelChargeVAT	form	decimal?	No
RetailPrice_ExVAT	form	decimal	No
RetailPrice_IncVAT	form	decimal	No
VED_Year1	form	decimal	No
VED_Year2	form	decimal	No
FirstRegFee	form	decimal	No
OTR_Value	form	decimal	No
OTR	form	decimal	No
Prices	form	List<Price>	No
ProductionDate	form	string	No
PortArrivalDate	form	DateTime?	No
Location	form	string	No
IsDisplayStock	form	bool	No
DisplayRetailerId	form	int?	No
DisplayRetailer	form	string	No
DisplayRetailerGssnId	form	string	No
DisplayRetailerMarketAreaId	form	int?	No
IsSmartDisplayRetailer	form	bool?	No
ColourDescription	form	string	No
Creation	form	DateTime?	No
Modified	form	DateTime?	No
VATQualifyingNumber	form	int?	No
VATQualifying	form	bool	No
CurrentRetailerOfferPrice	form	decimal	No
GssnId	form	string	No
NoImage	form	bool	No
RegistrationNumber	form	string	No
RegistrationDate	form	DateTime?	No
Mileage	form	int?	No
TradeInDate	form	DateTime?	No
VID	form	string	No
EmissionCombined	form	string	No
EmissionDirective	form	string	No
NormalisedEmissionDirective	form	string	No
HasMildHybridEquipmentCode	form	bool	No
Acceleration	form	decimal?	No
ChassisNumber	form	string	No
NumberOfDoors	form	string	No
NumberOfSeats	form	string	No
SpecialInfo	form	bool	No
EligibleForIntegratedServiceCare	form	bool	No
ConsumptionCombined	form	Consumption	No
ConsumptionExtraUrban	form	Consumption	No
ConsumptionUrban	form	Consumption	No
WltpFuelConsumptionCombined	form	Consumption	No
WltpFuelConsumptionExtraHigh	form	Consumption	No
WltpFuelConsumptionHigh	form	Consumption	No
WltpFuelConsumptionLow	form	Consumption	No
WltpFuelConsumptionMedium	form	Consumption	No
EnergyEfficiencyClass	form	EmissionClass	No
Equipment	form	List<Equipmentv2>	No
EquipmentAdditional	form	List<Equipment>	No
EquipmentCategories	form	List<EquipmentCategoryv2>	No
VehicleData	form	List<VehicleAttribute>	No
IntegratedServiceCareOptions	form	List<IntegratedServiceCareOptions>	No
IspVehicleCustomerDescriptions	form	List<string>	No
MarketingCode	form	string	No
EligibleForMaTransfer	form	bool	No
ConfirmedProductionDate	form	string	No
ForecastedArrivalDate	form	string	No

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

**Engine** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Badge	form	string	No
CubicCapacity	form	int	No
Cyclinders	form	int	No
HorsePower	form	string	No
Kw	form	string	No
Selected	form	bool	No

**VehicleAuditDetails** Parameters:
Name	Parameter	Data Type	Required
UserId	form	string	No
Status	form	bool	No
Notes	form	string	No
CreationDate	form	string	No

**Retailer** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
GssnId	form	string	No
Description	form	string	No
Street	form	string	No
City	form	string	No
District	form	string	No
Postcode	form	string	No
GoogleMapPostcode	form	string	No
Phone	form	string	No
Fax	form	string	No
Email	form	string	No
Website	form	string	No
Latitude	form	double	No
Longitude	form	double	No
RetailerGroup_Id	form	int?	No
RetailerGroupId	form	string	No
RetailerGroupName	form	string	No
Distance	form	double	No
PaymentServiceGuid	form	string	No
IsOnline	form	bool?	No
IsNewCarRetailer	form	bool?	No
IsUsedCarRetailer	form	bool?	No
IsCentralRetailer	form	bool	No
ChatEnabled	form	bool	No
TradeInEnabled	form	bool	No
DisplayPhoneNumberNew	form	string	No
DisplayPhoneNumberUsed	form	string	No
Services	form	RetailerServices	No
smart	form	bool	No
smartDescription	form	string	No
smartWebsite	form	string	No
smartEmail	form	string	No
smartPhone	form	string	No
AdditionalInformation	form	string	No
LegacyId	form	string	No
DriveTime	form	decimal	No
Agent	form	bool	No
Port	form	int?	No
PortName	form	string	No
MarketAreaId	form	int?	No
MarketAreaName	form	string	No
MaintenanceDate	form	string	No
MaintenanceSource	form	string	No
STPAccountNumbers	form	string	No
CampaignExcluded	form	bool?	No
DigitalLoungeParentGssnId	form	string	No
SendLeadsToDigitalLoungeParent	form	bool	No
IsExcludedFromImport	form	bool	No
OpeningTimes	form	RetailerOpeningTimes	No

**RetailerServices** Parameters:
Name	Parameter	Data Type	Required	Description
New	form	List<RetailerService>	No
Used	form	List<RetailerService>	No

**RetailerService** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Description	form	string	No
Priority	form	bool	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

**Media** Parameters:
Name	Parameter	Data Type	Required
ImageCount	form	int	No
MainImageUrl	form	string	No
MainImageUrlMobile	form	string	No
NoImage	form	bool	No
ThreeSixtyDegreeImageUrls	form	string[]	No
ThreeSixtyDegreeMobileImageUrls	form	string[]	No
VehicleImageUrls	form	string[]	No
VehicleMobileImageUrls	form	string[]	No

**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

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

**EmissionClass** Parameters:
Name	Parameter	Data Type	Required	Description
Colour	form	string	No
Rating	form	string	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

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

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

**IntegratedServiceCareOptions** 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

**Package** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	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.

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

{
	ConfiguratorCode: String,
	IsSellable: False,
	ExactMatch: False,
	GSSN: String
}

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

{
	TotalVehicles: 4,
	CarConfiguratorResponse: 
	{
		Name: String,
		KeyInformation: 
		{
			BM7NST: String,
			ConfigurationDate: String,
			ModelYear: String,
			HalfYear: String
		},
		OrderingOptions: 
		{
			Interior: 
			[
				String
			],
			Exterior: 
			[
				String
			],
			Options: 
			[
				String
			],
			WheelOptions: 
			[
				{
					Code: String,
					Description: String,
					StandardFlag: String,
					Price: 0,
					Category: String,
					Importance: String
				}
			],
			TrimOptions: 
			[
				{
					Code: String,
					Description: String,
					StandardFlag: String,
					Price: 0,
					Category: String,
					Importance: String
				}
			],
			OptionCodes: 
			[
				{
					Code: String,
					Description: String,
					StandardFlag: String,
					Price: 0,
					Category: String,
					Importance: String
				}
			]
		},
		ResponseStatus: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String,
					Meta: 
					{
						String: String
					}
				}
			],
			Meta: 
			{
				String: String
			}
		},
		ConfiguratorCode: String
	},
	ExactMatches: 
	{
		SellableMatches: 
		[
			{
				
			}
		],
		NonSellableMatches: 
		[
			{
				
			}
		]
	},
	CloseMatches: 
	{
		SellableMatches: 
		[
			{
				
			}
		],
		NonSellableMatches: 
		[
			{
				
			}
		]
	}
}