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

export class OrderOffer
{
    public Id: number;
    public OfferTypeId: number;
    public OfferTypeDescription: string;
    public OfferId: string;
    public OfferDescription: string;
    public Net: number;
    public VAT: number;
    public Gross: number;
    public GovernmentGrant: boolean;
    public PromoCode?: string;
    public Expiry?: string;
    public AffectsPrice: boolean;
    public Product?: number;
    public ParentId?: string;
    public CreationDate: string;
    public ProductTypeDescription?: string;
    public ProductTypeNegativeDescription?: string;
    public CertificateRequired?: boolean;

    public constructor(init?: Partial<OrderOffer>) { (Object as any).assign(this, init); }
}

export class OutrightPurchase
{
    public IsOutrightPurchase: boolean;
    public Reference: string;
    public DiscountRate: number;
    public Bm7NST: string;
    public IsBackOrder: boolean;
    public IsCOPConverter: boolean;

    public constructor(init?: Partial<OutrightPurchase>) { (Object as any).assign(this, init); }
}

export class MotabilityAdvancePayment
{
    public AdvancePaymentRentalType: string;
    public AdvancePaymentValueGross: number;
    public AdvancePaymentValueVAT: number;
    public AdvancePaymentValueNet: number;

    public constructor(init?: Partial<MotabilityAdvancePayment>) { (Object as any).assign(this, init); }
}

export class InflightPricingOrder
{
    public Guid: string;
    public Vin: string;
    public AdvanceRentalPaymentType: number;
    public Offer: OrderOffer[] = [];
    public OutrightPurchase?: OutrightPurchase;
    public MotabilityAdvancePayment?: MotabilityAdvancePayment;

    public constructor(init?: Partial<InflightPricingOrder>) { (Object as any).assign(this, init); }
}

export class InflightPricingOrderRequest
{
    public InvalidFormatGuids: string[] = [];
    public OrderNotFoundGuids: string[] = [];
    public InflightPricingOrders: InflightPricingOrder[] = [];
    public IsMotability: boolean;

    public constructor(init?: Partial<InflightPricingOrderRequest>) { (Object as any).assign(this, init); }
}

export class CopInflightPricingOrderRequest extends InflightPricingOrderRequest
{
    public NoCustomerContract: string[] = [];
    public NoVehicleDiscount: string[] = [];

    public constructor(init?: Partial<CopInflightPricingOrderRequest>) { super(init); (Object as any).assign(this, init); }
}

export class SalesforcePrice
{
    public Id: string;
    public Description: string;
    public Net: number;
    public VAT: number;
    public Gross: number;
    public Product: string;

    public constructor(init?: Partial<SalesforcePrice>) { (Object as any).assign(this, init); }
}

export class SalesforceTotalPrice
{
    public Net: number;
    public VAT: number;
    public Gross: number;

    public constructor(init?: Partial<SalesforceTotalPrice>) { (Object as any).assign(this, init); }
}

export class SalesforceOffer
{
    public Id: string;
    public Description: string;
    public Net: number;
    public VAT: number;
    public Gross: number;
    public Expiry?: string;
    public Product: string;
    public RequiresCertification?: boolean;

    public constructor(init?: Partial<SalesforceOffer>) { (Object as any).assign(this, init); }
}

export class SalesforceOffers
{
    public Personalised: SalesforceOffer[] = [];
    public NonDiscretionary: SalesforceOffer[] = [];
    public NonCampaign: SalesforceOffer[] = [];
    public OutrightPurchaseDiscount: SalesforceOffer[] = [];
    public MotabilityDiscount: SalesforceOffer[] = [];
    public IntegratedProducts: SalesforceOffer[] = [];

    public constructor(init?: Partial<SalesforceOffers>) { (Object as any).assign(this, init); }
}

export class SalesforceOutrightPurchase
{
    public IsOutrightPurchase: boolean;
    public Reference: string;
    public DiscountPercentage: number;
    public ModelId: string;

    public constructor(init?: Partial<SalesforceOutrightPurchase>) { (Object as any).assign(this, init); }
}

export class VehicleInflightPrice
{
    public Guid: string;
    public Status: string;
    public Success: boolean;
    public Prices: SalesforcePrice[] = [];
    public TotalOTRFees: SalesforceTotalPrice;
    public TotalOTRPrice: SalesforceTotalPrice;
    public TotalActualPrice: SalesforceTotalPrice;
    public Offers: SalesforceOffers;
    public OutrightPurchase?: SalesforceOutrightPurchase;
    public Motability: MotabilityAdvancePayment;

    public constructor(init?: Partial<VehicleInflightPrice>) { (Object as any).assign(this, init); }
}

export class InflightPricingResponse
{
    public VehiclesInflightPrices: VehicleInflightPrice[] = [];

    public constructor(init?: Partial<InflightPricingResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="In Flight pricing generated", StatusCode=200)
export class CopInflightPricingRequest extends CopInflightPricingOrderRequest implements IPost
{

    public constructor(init?: Partial<CopInflightPricingRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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>