Mercedes.Agency.Orchestration.API

<back to all web services

InflightPricingRequest

InFlightPricing
Requires Authentication
The following routes are available for this service:
POST/v1/inflightpricingInflight Pricing for supplied Order Guids
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 .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.

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

{"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":"\/Date(-62135596800000-0000)\/","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/csv
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}}]}