Mercedes.Agency.Orchestration.API

<back to all web services

ValidateOutRightPurchaseRequest

OutrightPurchase
Requires Authentication
The following routes are available for this service:
POST/v1/outrightpurchase/validateValidate Outright Purchase
ValidateOutRightPurchaseResponse Parameters:
NameParameterData TypeRequiredDescription
OutrightPurchaseFleetCustomerformOutrightPurchaseFleetCustomerYes
IsBackOrderformbool?No
OutrightPurchaseFleetCustomer Parameters:
NameParameterData TypeRequiredDescription
CustomerIdentifierformstringYes
CompanyNameformstringYes
TitleformstringYes
FirstNameformstringYes
LastNameformstringYes
EmailformstringYes
PhoneNumberformstringYes
HouseNumberformstringYes
AddressLine2formstringYes
TownformstringYes
CountyformstringYes
PostCodeformstringYes
OutrightPurchaseCustomerDiscountsformList<OutrightPurchaseDiscount>Yes
ImportSucessfulformboolNo
IsEligibleCOPConverterformboolNo
OutrightPurchaseDiscount Parameters:
NameParameterData TypeRequiredDescription
BaumusterNSTformstringYes
DiscountPercentageformdecimalNo

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

{
	Criteria: 
	{
		Reference: String,
		Bm7NST: String,
		IsBackOrder: False
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	OutrightPurchaseFleetCustomer: 
	{
		CustomerIdentifier: String,
		CompanyName: String,
		Title: String,
		FirstName: String,
		LastName: String,
		Email: String,
		PhoneNumber: String,
		HouseNumber: String,
		AddressLine2: String,
		Town: String,
		County: String,
		PostCode: String,
		OutrightPurchaseCustomerDiscounts: 
		[
			{
				BaumusterNST: String,
				DiscountPercentage: 0
			}
		],
		ImportSucessful: False,
		IsEligibleCOPConverter: False
	},
	IsBackOrder: False
}