Mercedes.Agency.Orchestration.API

<back to all web services

CopInflightPricingRequest

InFlightPricing
Requires Authentication
The following routes are available for this service:
POST/v1/copinflightpricingCorporate Outright Pricing Inflight Pricing for supplied Order Guids
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OrderOffer:
    id: int = 0
    offer_type_id: int = 0
    offer_type_description: Optional[str] = None
    offer_id: Optional[str] = None
    offer_description: Optional[str] = None
    net: Decimal = decimal.Decimal(0)
    vat: Decimal = decimal.Decimal(0)
    gross: Decimal = decimal.Decimal(0)
    government_grant: bool = False
    promo_code: Optional[str] = None
    expiry: Optional[str] = None
    affects_price: bool = False
    product: Optional[int] = None
    parent_id: Optional[str] = None
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    product_type_description: Optional[str] = None
    product_type_negative_description: Optional[str] = None
    certificate_required: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class OutrightPurchase:
    is_outright_purchase: bool = False
    reference: Optional[str] = None
    discount_rate: Decimal = decimal.Decimal(0)
    bm7_n_s_t: Optional[str] = None
    is_back_order: bool = False
    is_c_o_p_converter: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class MotabilityAdvancePayment:
    advance_payment_rental_type: Optional[str] = None
    advance_payment_value_gross: Decimal = decimal.Decimal(0)
    advance_payment_value_v_a_t: Decimal = decimal.Decimal(0)
    advance_payment_value_net: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InflightPricingOrder:
    guid: Optional[str] = None
    vin: Optional[str] = None
    advance_rental_payment_type: int = 0
    offer: List[OrderOffer] = field(default_factory=list)
    outright_purchase: Optional[OutrightPurchase] = None
    motability_advance_payment: Optional[MotabilityAdvancePayment] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InflightPricingOrderRequest:
    invalid_format_guids: List[str] = field(default_factory=list)
    order_not_found_guids: List[str] = field(default_factory=list)
    inflight_pricing_orders: List[InflightPricingOrder] = field(default_factory=list)
    is_motability: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CopInflightPricingOrderRequest(InflightPricingOrderRequest):
    no_customer_contract: List[str] = field(default_factory=list)
    no_vehicle_discount: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesforcePrice:
    id: Optional[str] = None
    description: Optional[str] = None
    net: Decimal = decimal.Decimal(0)
    vat: Decimal = decimal.Decimal(0)
    gross: Decimal = decimal.Decimal(0)
    product: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesforceTotalPrice:
    net: Decimal = decimal.Decimal(0)
    vat: Decimal = decimal.Decimal(0)
    gross: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesforceOffer:
    id: Optional[str] = None
    description: Optional[str] = None
    net: Decimal = decimal.Decimal(0)
    vat: Decimal = decimal.Decimal(0)
    gross: Decimal = decimal.Decimal(0)
    expiry: Optional[str] = None
    product: Optional[str] = None
    requires_certification: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesforceOffers:
    personalised: List[SalesforceOffer] = field(default_factory=list)
    non_discretionary: List[SalesforceOffer] = field(default_factory=list)
    non_campaign: List[SalesforceOffer] = field(default_factory=list)
    outright_purchase_discount: List[SalesforceOffer] = field(default_factory=list)
    motability_discount: List[SalesforceOffer] = field(default_factory=list)
    integrated_products: List[SalesforceOffer] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SalesforceOutrightPurchase:
    is_outright_purchase: bool = False
    reference: Optional[str] = None
    discount_percentage: Decimal = decimal.Decimal(0)
    model_id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleInflightPrice:
    guid: Optional[str] = None
    status: Optional[str] = None
    success: bool = False
    prices: List[SalesforcePrice] = field(default_factory=list)
    total_o_t_r_fees: Optional[SalesforceTotalPrice] = None
    total_o_t_r_price: Optional[SalesforceTotalPrice] = None
    total_actual_price: Optional[SalesforceTotalPrice] = None
    offers: Optional[SalesforceOffers] = None
    outright_purchase: Optional[SalesforceOutrightPurchase] = None
    motability: Optional[MotabilityAdvancePayment] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InflightPricingResponse:
    vehicles_inflight_prices: List[VehicleInflightPrice] = field(default_factory=list)


# @ApiResponse(Description="In Flight pricing generated", StatusCode=200)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CopInflightPricingRequest(CopInflightPricingOrderRequest, IPost):
    pass

Python CopInflightPricingRequest DTOs

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

<CopInflightPricingRequest 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>
  <NoCustomerContract 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>
  </NoCustomerContract>
  <NoVehicleDiscount 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>
  </NoVehicleDiscount>
</CopInflightPricingRequest>

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>