Mercedes.Agency.Orchestration.API

<back to all web services

MotabilityInflightPricingRequest

InFlightPricing
Requires Authentication
The following routes are available for this service:
POST/v1/motabilityinflightpricingMotability Pricing Inflight Pricing for supplied Order GuidsThis endpoint is used for fetch motability orders only for inflight pricing. The original request is being made on Agency API and a list of orders from database is passed to agency orch. This is to fetch addditional information such as the vehicles details e.g Prices and Offers data
MotabilityInflightPricingOrderRequest Parameters:
NameParameterData TypeRequiredDescription
OrderVehicleWithNoMotabilityDiscountformList<Guid>Yes
InflightPricingOrderRequest Parameters:
NameParameterData TypeRequiredDescription
InvalidFormatGuidsformList<string>Yes
OrderNotFoundGuidsformList<Guid>Yes
InflightPricingOrdersformList<InflightPricingOrder>Yes
IsMotabilityformboolNo
InflightPricingOrder Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
VinformstringYes
AdvanceRentalPaymentTypeformintNo
OfferformList<OrderOffer>Yes
OutrightPurchaseformOutrightPurchaseNo
MotabilityAdvancePaymentformMotabilityAdvancePaymentNo
OrderOffer Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
OfferTypeIdformintNo
OfferTypeDescriptionformstringYes
OfferIdformstringYes
OfferDescriptionformstringYes
NetformdecimalNo
VATformdecimalNo
GrossformdecimalNo
GovernmentGrantformboolNo
PromoCodeformstringNo
ExpiryformstringNo
AffectsPriceformboolNo
Productformint?No
ParentIdformstringNo
CreationDateformDateTimeNo
ProductTypeDescriptionformstringNo
ProductTypeNegativeDescriptionformstringNo
CertificateRequiredformbool?No
OutrightPurchase Parameters:
NameParameterData TypeRequiredDescription
IsOutrightPurchaseformboolNo
ReferenceformstringYes
DiscountRateformdecimalNo
Bm7NSTformstringYes
IsBackOrderformboolNo
IsCOPConverterformboolNo
MotabilityAdvancePayment Parameters:
NameParameterData TypeRequiredDescription
AdvancePaymentRentalTypeformstringYes
AdvancePaymentValueGrossformdecimalNo
AdvancePaymentValueVATformdecimalNo
AdvancePaymentValueNetformdecimalNo
InflightPricingResponse Parameters:
NameParameterData TypeRequiredDescription
VehiclesInflightPricesformList<VehicleInflightPrice>Yes
VehicleInflightPrice Parameters:
NameParameterData TypeRequiredDescription
GuidformstringYes
StatusformstringYes
SuccessformboolNo
PricesformList<SalesforcePrice>Yes
TotalOTRFeesformSalesforceTotalPriceYes
TotalOTRPriceformSalesforceTotalPriceYes
TotalActualPriceformSalesforceTotalPriceYes
OffersformSalesforceOffersYes
OutrightPurchaseformSalesforceOutrightPurchaseNo
MotabilityformMotabilityAdvancePaymentYes
SalesforcePrice Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
DescriptionformstringYes
NetformdecimalNo
VATformdecimalNo
GrossformdecimalNo
ProductformstringYes
SalesforceTotalPrice Parameters:
NameParameterData TypeRequiredDescription
NetformdecimalNo
VATformdecimalNo
GrossformdecimalNo
SalesforceOffers Parameters:
NameParameterData TypeRequiredDescription
PersonalisedformList<SalesforceOffer>Yes
NonDiscretionaryformList<SalesforceOffer>Yes
NonCampaignformList<SalesforceOffer>Yes
OutrightPurchaseDiscountformList<SalesforceOffer>Yes
MotabilityDiscountformList<SalesforceOffer>Yes
IntegratedProductsformList<SalesforceOffer>Yes
SalesforceOffer Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
DescriptionformstringYes
NetformdecimalNo
VATformdecimalNo
GrossformdecimalNo
ExpiryformstringNo
ProductformstringYes
RequiresCertificationformbool?No
SalesforceOutrightPurchase Parameters:
NameParameterData TypeRequiredDescription
IsOutrightPurchaseformboolNo
ReferenceformstringYes
DiscountPercentageformdecimalNo
ModelIdformstringYes

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

{
	OrderVehicleWithNoMotabilityDiscount: 
	[
		00000000000000000000000000000000
	],
	InvalidFormatGuids: 
	[
		String
	],
	OrderNotFoundGuids: 
	[
		00000000000000000000000000000000
	],
	InflightPricingOrders: 
	[
		{
			Guid: 00000000000000000000000000000000,
			Vin: String,
			AdvanceRentalPaymentType: 0,
			Offer: 
			[
				{
					Id: 0,
					OfferTypeId: 0,
					OfferTypeDescription: String,
					OfferId: String,
					OfferDescription: String,
					Net: 0,
					VAT: 0,
					Gross: 0,
					GovernmentGrant: False,
					PromoCode: String,
					Expiry: String,
					AffectsPrice: False,
					Product: 0,
					ParentId: String,
					CreationDate: 0001-01-01,
					ProductTypeDescription: String,
					ProductTypeNegativeDescription: String,
					CertificateRequired: False
				}
			],
			OutrightPurchase: 
			{
				IsOutrightPurchase: False,
				Reference: String,
				DiscountRate: 0,
				Bm7NST: String,
				IsBackOrder: False,
				IsCOPConverter: False
			},
			MotabilityAdvancePayment: 
			{
				AdvancePaymentRentalType: String,
				AdvancePaymentValueGross: 0,
				AdvancePaymentValueVAT: 0,
				AdvancePaymentValueNet: 0
			}
		}
	],
	IsMotability: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	VehiclesInflightPrices: 
	[
		{
			Guid: String,
			Status: String,
			Success: False,
			Prices: 
			[
				{
					Id: String,
					Description: String,
					Net: 0,
					VAT: 0,
					Gross: 0,
					Product: String
				}
			],
			TotalOTRFees: 
			{
				Net: 0,
				VAT: 0,
				Gross: 0
			},
			TotalOTRPrice: 
			{
				Net: 0,
				VAT: 0,
				Gross: 0
			},
			TotalActualPrice: 
			{
				Net: 0,
				VAT: 0,
				Gross: 0
			},
			Offers: 
			{
				Personalised: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				],
				NonDiscretionary: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				],
				NonCampaign: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				],
				OutrightPurchaseDiscount: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				],
				MotabilityDiscount: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				],
				IntegratedProducts: 
				[
					{
						Id: String,
						Description: String,
						Net: 0,
						VAT: 0,
						Gross: 0,
						Expiry: String,
						Product: String,
						RequiresCertification: False
					}
				]
			},
			OutrightPurchase: 
			{
				IsOutrightPurchase: False,
				Reference: String,
				DiscountPercentage: 0,
				ModelId: String
			},
			Motability: 
			{
				AdvancePaymentRentalType: String,
				AdvancePaymentValueGross: 0,
				AdvancePaymentValueVAT: 0,
				AdvancePaymentValueNet: 0
			}
		}
	]
}