Mercedes.Agency.Orchestration.API

<back to all web services

GetPricingDetailsRequest

Pricing
The following routes are available for this service:
POST/v1/pricingdetailsCreates a detailed pricing of a vehicle
CreateOrderBase Parameters:
NameParameterData TypeRequiredDescription
SourceformSourceNo
GssnIdformstringYes
AdditionalInformationformstringYes
CashformboolNo
FinanceformboolNo
CustomerformCustomerYes
VehicleformVehicleYes
FinanceCriteriaformFinanceCriteriaYes
BackOrderGuidformGuid?No
TagUrlformstringNo
OutrightPurchaseformOutrightPurchaseNo
MotabilityformboolNo
MotabilityPricingIdformint?No
FinanceApplicationReferenceformstringYes
SpecialistformboolNo
GasIdformstringYes
PersonalisedItemOfferIdsformint[]No
SuggestedVinformstringNo
NonOptimumReasonformstringNo
MotabilityTypeformMotabilityTypeNo
EstimatedHandoverDateformstringYes
Source Enum:
NameValue
OnlineShowroom1
OneAdmin2
Customer Parameters:
NameParameterData TypeRequiredDescription
ProfileIdformGuid?No
PreferencesformPreferencesNo
SalesforceCustomer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdformstringYes
IsCiamformboolNo
CompanyNameformstringYes
TitleformstringYes
FirstnameformstringYes
SurnameformstringYes
EmailAddressformstringYes
TelephoneformstringYes
AddressformAddressYes
ModeformCustomerModeNo
Address Parameters:
NameParameterData TypeRequiredDescription
PropertyformstringYes
StreetformstringYes
TownformstringYes
CountyformstringYes
LocalityformstringYes
PostcodeformstringYes
CustomerMode Enum:
NameValue
Private1
Business2
Motability3
Preferences Parameters:
NameParameterData TypeRequiredDescription
OptinEmailformboolNo
OptinPostformboolNo
OptinSMSformboolNo
OptinTelephoneformboolNo
Vehicle Parameters:
NameParameterData TypeRequiredDescription
VinformstringNo
FinanceCriteria Parameters:
NameParameterData TypeRequiredDescription
KeyformstringYes
NameformstringYes
TypeformstringYes
IsDefaultformboolNo
TermformTermYes
DepositformDepositYes
MileageformMileageYes
AdvanceRentalsformAdvanceRentalsYes
IsPersonalisedformboolNo
RegularPaymentformstringYes
PartExchangeformstringYes
SettlementformstringYes
CustomerTypeformstringYes
VehicleTypeformVehicleTypeNo
Term Parameters:
NameParameterData TypeRequiredDescription
OptionsformList<Option>Yes
Option Parameters:
NameParameterData TypeRequiredDescription
IsDefaultformboolNo
ValueformintNo
Deposit Parameters:
NameParameterData TypeRequiredDescription
DefaultformstringYes
Mileage Parameters:
NameParameterData TypeRequiredDescription
OptionsformList<Option>Yes
AdvanceRentals Parameters:
NameParameterData TypeRequiredDescription
OptionsformList<Option>Yes
VehicleType Enum:
UNASSIGNED
NEW
USED
OutrightPurchase Parameters:
NameParameterData TypeRequiredDescription
IsOutrightPurchaseformboolNo
ReferenceformstringYes
DiscountRateformdecimalNo
Bm7NSTformstringYes
IsBackOrderformboolNo
IsCOPConverterformboolNo
MotabilityType Enum:
NameValue
PIP1
WPMS2
UNASSIGNED3
GetPricingDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
PriceformPriceYes
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

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/pricingdetails HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Source: OnlineShowroom,
	GssnId: String,
	AdditionalInformation: String,
	Cash: False,
	Finance: False,
	Customer: 
	{
		ProfileId: 00000000000000000000000000000000,
		Preferences: 
		{
			OptinEmail: False,
			OptinPost: False,
			OptinSMS: False,
			OptinTelephone: False
		},
		CustomerId: String,
		IsCiam: False,
		CompanyName: String,
		Title: String,
		Firstname: String,
		Surname: String,
		EmailAddress: String,
		Telephone: String,
		Address: 
		{
			Property: String,
			Street: String,
			Town: String,
			County: String,
			Locality: String,
			Postcode: String
		},
		Mode: Private
	},
	Vehicle: 
	{
		Vin: String
	},
	FinanceCriteria: 
	{
		Key: String,
		Name: String,
		Type: String,
		IsDefault: False,
		Term: 
		{
			Options: 
			[
				{
					IsDefault: False,
					Value: 0
				}
			]
		},
		Deposit: 
		{
			Default: String
		},
		Mileage: 
		{
			Options: 
			[
				{
					IsDefault: False,
					Value: 0
				}
			]
		},
		AdvanceRentals: 
		{
			Options: 
			[
				{
					IsDefault: False,
					Value: 0
				}
			]
		},
		IsPersonalised: False,
		RegularPayment: String,
		PartExchange: String,
		Settlement: String,
		CustomerType: String,
		VehicleType: UNASSIGNED
	},
	BackOrderGuid: 00000000000000000000000000000000,
	TagUrl: String,
	OutrightPurchase: 
	{
		IsOutrightPurchase: False,
		Reference: String,
		DiscountRate: 0,
		Bm7NST: String,
		IsBackOrder: False,
		IsCOPConverter: False
	},
	Motability: False,
	MotabilityPricingId: 0,
	FinanceApplicationReference: String,
	Specialist: False,
	GasId: String,
	PersonalisedItemOfferIds: 
	[
		0
	],
	SuggestedVin: String,
	NonOptimumReason: String,
	MotabilityType: PIP,
	EstimatedHandoverDate: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Price: 
	{
		Id: String,
		Description: String,
		Net: 0,
		VAT: 0,
		Gross: 0,
		Product: LIST_PRICE
	}
}