Mercedes.Agency.Orchestration.API

<back to all web services

GetEligibleMotabilityPricingForBackOrderRequest

Motability
Requires Authentication
The following routes are available for this service:
POST/v1/motability/backorder/{BackOrderGuid}Gets the current and available motability pricing information for the provided back order guidGets the current and available motability pricing information for the provided back order guid
"use strict";
export class GetEligibleMotabilityPricingForBackOrderRequest {
    /** @param {{backOrderGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    backOrderGuid;
}
export class MotabilityPricingCsv {
    /** @param {{Id?:number,CriteriaBM7NST?:string,VTN?:string,BackOrderDropDown?:string,CriteriaFullModelYearCode?:string,CriteriaValidOptionCodes?:string,CriteriaInvalidOptionCodes?:string,PIPNet?:number,PIPVat?:number,PIPGross?:number,WPMSNet?:number,WPMSVat?:number,WPMSGross?:number,DiscountNet?:number,DiscountVat?:number,DiscountGross?:number,ListPriceNet?:number,ListPriceVat?:number,ListPriceGross?:number,DeliveryChargeNet?:number,DeliveryChargeVat?:number,DeliveryChargeGross?:number,FuelChargeNet?:number,FuelChargeVat?:number,FuelChargeGross?:number,NumberPlateFeeNet?:number,NumberPlateFeeVat?:number,NumberPlateFeeGross?:number,FirstRegistrationFeeNet?:number,FirstRegistrationFeeVat?:number,FirstRegistrationFeeGross?:number,RoadFundLicenceNet?:number,RoadFundLicenceVat?:number,RoadFundLicenceGross?:number,ValidFrom?:string,ValidTo?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CriteriaBM7NST;
    /** @type {string} */
    VTN;
    /** @type {string} */
    BackOrderDropDown;
    /** @type {string} */
    CriteriaFullModelYearCode;
    /** @type {?string} */
    CriteriaValidOptionCodes;
    /** @type {?string} */
    CriteriaInvalidOptionCodes;
    /** @type {number} */
    PIPNet;
    /** @type {number} */
    PIPVat;
    /** @type {number} */
    PIPGross;
    /** @type {number} */
    WPMSNet;
    /** @type {number} */
    WPMSVat;
    /** @type {number} */
    WPMSGross;
    /** @type {number} */
    DiscountNet;
    /** @type {number} */
    DiscountVat;
    /** @type {number} */
    DiscountGross;
    /** @type {number} */
    ListPriceNet;
    /** @type {number} */
    ListPriceVat;
    /** @type {number} */
    ListPriceGross;
    /** @type {number} */
    DeliveryChargeNet;
    /** @type {number} */
    DeliveryChargeVat;
    /** @type {number} */
    DeliveryChargeGross;
    /** @type {number} */
    FuelChargeNet;
    /** @type {number} */
    FuelChargeVat;
    /** @type {number} */
    FuelChargeGross;
    /** @type {number} */
    NumberPlateFeeNet;
    /** @type {number} */
    NumberPlateFeeVat;
    /** @type {number} */
    NumberPlateFeeGross;
    /** @type {number} */
    FirstRegistrationFeeNet;
    /** @type {number} */
    FirstRegistrationFeeVat;
    /** @type {number} */
    FirstRegistrationFeeGross;
    /** @type {number} */
    RoadFundLicenceNet;
    /** @type {number} */
    RoadFundLicenceVat;
    /** @type {number} */
    RoadFundLicenceGross;
    /** @type {string} */
    ValidFrom;
    /** @type {string} */
    ValidTo;
}
/** @typedef {'Pending'|'Current'|'RecentlyExpired'|'Expired'} */
export var MotabilityPricingStatus;
(function (MotabilityPricingStatus) {
    MotabilityPricingStatus["Pending"] = "Pending"
    MotabilityPricingStatus["Current"] = "Current"
    MotabilityPricingStatus["RecentlyExpired"] = "RecentlyExpired"
    MotabilityPricingStatus["Expired"] = "Expired"
})(MotabilityPricingStatus || (MotabilityPricingStatus = {}));
export class MotabilityPricing extends MotabilityPricingCsv {
    /** @param {{MotabilityPricingStatus?:MotabilityPricingStatus,Id?:number,CriteriaBM7NST?:string,VTN?:string,BackOrderDropDown?:string,CriteriaFullModelYearCode?:string,CriteriaValidOptionCodes?:string,CriteriaInvalidOptionCodes?:string,PIPNet?:number,PIPVat?:number,PIPGross?:number,WPMSNet?:number,WPMSVat?:number,WPMSGross?:number,DiscountNet?:number,DiscountVat?:number,DiscountGross?:number,ListPriceNet?:number,ListPriceVat?:number,ListPriceGross?:number,DeliveryChargeNet?:number,DeliveryChargeVat?:number,DeliveryChargeGross?:number,FuelChargeNet?:number,FuelChargeVat?:number,FuelChargeGross?:number,NumberPlateFeeNet?:number,NumberPlateFeeVat?:number,NumberPlateFeeGross?:number,FirstRegistrationFeeNet?:number,FirstRegistrationFeeVat?:number,FirstRegistrationFeeGross?:number,RoadFundLicenceNet?:number,RoadFundLicenceVat?:number,RoadFundLicenceGross?:number,ValidFrom?:string,ValidTo?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {MotabilityPricingStatus} */
    MotabilityPricingStatus;
}
export class GetEligibleMotabilityPricingForBackOrderResponse {
    /** @param {{CurrentlySelectedMotabilityPricing?:MotabilityPricing,AvailableMotabilityPricing?:MotabilityPricing[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {MotabilityPricing} */
    CurrentlySelectedMotabilityPricing;
    /** @type {MotabilityPricing[]} */
    AvailableMotabilityPricing = [];
}

JavaScript GetEligibleMotabilityPricingForBackOrderRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/motability/backorder/{BackOrderGuid} HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"backOrderGuid":"00000000000000000000000000000000"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"CurrentlySelectedMotabilityPricing":{"MotabilityPricingStatus":"Pending","Id":0,"CriteriaBM7NST":"String","VTN":"String","BackOrderDropDown":"String","CriteriaFullModelYearCode":"String","CriteriaValidOptionCodes":"String","CriteriaInvalidOptionCodes":"String","PIPNet":0,"PIPVat":0,"PIPGross":0,"WPMSNet":0,"WPMSVat":0,"WPMSGross":0,"DiscountNet":0,"DiscountVat":0,"DiscountGross":0,"ListPriceNet":0,"ListPriceVat":0,"ListPriceGross":0,"DeliveryChargeNet":0,"DeliveryChargeVat":0,"DeliveryChargeGross":0,"FuelChargeNet":0,"FuelChargeVat":0,"FuelChargeGross":0,"NumberPlateFeeNet":0,"NumberPlateFeeVat":0,"NumberPlateFeeGross":0,"FirstRegistrationFeeNet":0,"FirstRegistrationFeeVat":0,"FirstRegistrationFeeGross":0,"RoadFundLicenceNet":0,"RoadFundLicenceVat":0,"RoadFundLicenceGross":0,"ValidFrom":"\/Date(-62135596800000-0000)\/","ValidTo":"\/Date(-62135596800000-0000)\/"},"AvailableMotabilityPricing":[{"MotabilityPricingStatus":"Pending","Id":0,"CriteriaBM7NST":"String","VTN":"String","BackOrderDropDown":"String","CriteriaFullModelYearCode":"String","CriteriaValidOptionCodes":"String","CriteriaInvalidOptionCodes":"String","PIPNet":0,"PIPVat":0,"PIPGross":0,"WPMSNet":0,"WPMSVat":0,"WPMSGross":0,"DiscountNet":0,"DiscountVat":0,"DiscountGross":0,"ListPriceNet":0,"ListPriceVat":0,"ListPriceGross":0,"DeliveryChargeNet":0,"DeliveryChargeVat":0,"DeliveryChargeGross":0,"FuelChargeNet":0,"FuelChargeVat":0,"FuelChargeGross":0,"NumberPlateFeeNet":0,"NumberPlateFeeVat":0,"NumberPlateFeeGross":0,"FirstRegistrationFeeNet":0,"FirstRegistrationFeeVat":0,"FirstRegistrationFeeGross":0,"RoadFundLicenceNet":0,"RoadFundLicenceVat":0,"RoadFundLicenceGross":0,"ValidFrom":"\/Date(-62135596800000-0000)\/","ValidTo":"\/Date(-62135596800000-0000)\/"}]}