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
import Foundation
import ServiceStack

// @ApiResponse(Description="In Flight pricing generated", StatusCode=200)
public class InflightPricingRequest : InflightPricingOrderRequest, IPost
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class InflightPricingOrderRequest : Codable
{
    public var invalidFormatGuids:[String] = []
    public var orderNotFoundGuids:[String] = []
    public var inflightPricingOrders:[InflightPricingOrder] = []
    public var isMotability:Bool

    required public init(){}
}

public class InflightPricingOrder : Codable
{
    public var guid:String
    public var vin:String
    public var advanceRentalPaymentType:Int
    public var offer:[OrderOffer] = []
    public var outrightPurchase:OutrightPurchase
    public var motabilityAdvancePayment:MotabilityAdvancePayment

    required public init(){}
}

public class OrderOffer : Codable
{
    public var id:Int
    public var offerTypeId:Int
    public var offerTypeDescription:String
    public var offerId:String
    public var offerDescription:String
    public var net:Double
    public var vat:Double
    public var gross:Double
    public var governmentGrant:Bool
    public var promoCode:String
    public var expiry:String
    public var affectsPrice:Bool
    public var product:Int?
    public var parentId:String
    public var creationDate:Date
    public var productTypeDescription:String
    public var productTypeNegativeDescription:String
    public var certificateRequired:Bool?

    required public init(){}
}

public class OutrightPurchase : Codable
{
    public var isOutrightPurchase:Bool
    public var reference:String
    public var discountRate:Double
    public var bm7NST:String
    public var isBackOrder:Bool
    public var isCOPConverter:Bool

    required public init(){}
}

public class MotabilityAdvancePayment : Codable
{
    public var advancePaymentRentalType:String
    public var advancePaymentValueGross:Double
    public var advancePaymentValueVAT:Double
    public var advancePaymentValueNet:Double

    required public init(){}
}

public class InflightPricingResponse : Codable
{
    public var vehiclesInflightPrices:[VehicleInflightPrice] = []

    required public init(){}
}

public class VehicleInflightPrice : Codable
{
    public var guid:String
    public var status:String
    public var success:Bool
    public var prices:[SalesforcePrice] = []
    public var totalOTRFees:SalesforceTotalPrice
    public var totalOTRPrice:SalesforceTotalPrice
    public var totalActualPrice:SalesforceTotalPrice
    public var offers:SalesforceOffers
    public var outrightPurchase:SalesforceOutrightPurchase
    public var motability:MotabilityAdvancePayment

    required public init(){}
}

public class SalesforcePrice : Codable
{
    public var id:String
    public var Description:String
    public var net:Double
    public var vat:Double
    public var gross:Double
    public var product:String

    required public init(){}
}

public class SalesforceTotalPrice : Codable
{
    public var net:Double
    public var vat:Double
    public var gross:Double

    required public init(){}
}

public class SalesforceOffers : Codable
{
    public var personalised:[SalesforceOffer] = []
    public var nonDiscretionary:[SalesforceOffer] = []
    public var nonCampaign:[SalesforceOffer] = []
    public var outrightPurchaseDiscount:[SalesforceOffer] = []
    public var motabilityDiscount:[SalesforceOffer] = []
    public var integratedProducts:[SalesforceOffer] = []

    required public init(){}
}

public class SalesforceOffer : Codable
{
    public var id:String
    public var Description:String
    public var net:Double
    public var vat:Double
    public var gross:Double
    public var expiry:String
    public var product:String
    public var requiresCertification:Bool?

    required public init(){}
}

public class SalesforceOutrightPurchase : Codable
{
    public var isOutrightPurchase:Bool
    public var reference:String
    public var discountPercentage:Double
    public var modelId:String

    required public init(){}
}


Swift InflightPricingRequest DTOs

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