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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<MotabilityInflightPricingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.InflightPricing">
  <InflightPricingOrders xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <InflightPricingOrder>
      <AdvanceRentalPaymentType>0</AdvanceRentalPaymentType>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <MotabilityAdvancePayment>
        <AdvancePaymentRentalType>String</AdvancePaymentRentalType>
        <AdvancePaymentValueGross>0</AdvancePaymentValueGross>
        <AdvancePaymentValueNet>0</AdvancePaymentValueNet>
        <AdvancePaymentValueVAT>0</AdvancePaymentValueVAT>
      </MotabilityAdvancePayment>
      <Offer>
        <OrderOffer>
          <AffectsPrice>false</AffectsPrice>
          <CertificateRequired>false</CertificateRequired>
          <CreationDate>0001-01-01T00:00:00</CreationDate>
          <Expiry>String</Expiry>
          <GovernmentGrant>false</GovernmentGrant>
          <Gross>0</Gross>
          <Id>0</Id>
          <Net>0</Net>
          <OfferDescription>String</OfferDescription>
          <OfferId>String</OfferId>
          <OfferTypeDescription>String</OfferTypeDescription>
          <OfferTypeId>0</OfferTypeId>
          <ParentId>String</ParentId>
          <Product>0</Product>
          <ProductTypeDescription>String</ProductTypeDescription>
          <ProductTypeNegativeDescription>String</ProductTypeNegativeDescription>
          <PromoCode>String</PromoCode>
          <VAT>0</VAT>
        </OrderOffer>
      </Offer>
      <OutrightPurchase>
        <Bm7NST>String</Bm7NST>
        <DiscountRate>0</DiscountRate>
        <IsBackOrder>false</IsBackOrder>
        <IsCOPConverter>false</IsCOPConverter>
        <IsOutrightPurchase>false</IsOutrightPurchase>
        <Reference>String</Reference>
      </OutrightPurchase>
      <Vin>String</Vin>
    </InflightPricingOrder>
  </InflightPricingOrders>
  <InvalidFormatGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:string>String</d2p1:string>
  </InvalidFormatGuids>
  <IsMotability xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">false</IsMotability>
  <OrderNotFoundGuids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </OrderNotFoundGuids>
  <OrderVehicleWithNoMotabilityDiscount xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </OrderVehicleWithNoMotabilityDiscount>
</MotabilityInflightPricingRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InflightPricingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
  <VehiclesInflightPrices>
    <VehicleInflightPrice>
      <Guid>String</Guid>
      <Motability>
        <AdvancePaymentRentalType>String</AdvancePaymentRentalType>
        <AdvancePaymentValueGross>0</AdvancePaymentValueGross>
        <AdvancePaymentValueNet>0</AdvancePaymentValueNet>
        <AdvancePaymentValueVAT>0</AdvancePaymentValueVAT>
      </Motability>
      <Offers>
        <IntegratedProducts>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </IntegratedProducts>
        <MotabilityDiscount>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </MotabilityDiscount>
        <NonCampaign>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </NonCampaign>
        <NonDiscretionary>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </NonDiscretionary>
        <OutrightPurchaseDiscount>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </OutrightPurchaseDiscount>
        <Personalised>
          <SalesforceOffer>
            <Description>String</Description>
            <Expiry>String</Expiry>
            <Gross>0</Gross>
            <Id>String</Id>
            <Net>0</Net>
            <Product>String</Product>
            <RequiresCertification>false</RequiresCertification>
            <VAT>0</VAT>
          </SalesforceOffer>
        </Personalised>
      </Offers>
      <OutrightPurchase>
        <DiscountPercentage>0</DiscountPercentage>
        <IsOutrightPurchase>false</IsOutrightPurchase>
        <ModelId>String</ModelId>
        <Reference>String</Reference>
      </OutrightPurchase>
      <Prices>
        <SalesforcePrice>
          <Description>String</Description>
          <Gross>0</Gross>
          <Id>String</Id>
          <Net>0</Net>
          <Product>String</Product>
          <VAT>0</VAT>
        </SalesforcePrice>
      </Prices>
      <Status>String</Status>
      <Success>false</Success>
      <TotalActualPrice>
        <Gross>0</Gross>
        <Net>0</Net>
        <VAT>0</VAT>
      </TotalActualPrice>
      <TotalOTRFees>
        <Gross>0</Gross>
        <Net>0</Net>
        <VAT>0</VAT>
      </TotalOTRFees>
      <TotalOTRPrice>
        <Gross>0</Gross>
        <Net>0</Net>
        <VAT>0</VAT>
      </TotalOTRPrice>
    </VehicleInflightPrice>
  </VehiclesInflightPrices>
</InflightPricingResponse>