| POST | /v1/inflightpricing | 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 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 InflightPricingRequest extends InflightPricingOrderRequest implements IPost
{
public constructor(init?: Partial<InflightPricingRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript InflightPricingRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
]
}