Mercedes.Agency.Orchestration.API

<back to all web services

GetBackOrderCsvMatchAllRequest

BackOrder
Requires Authentication
The following routes are available for this service:
GET/v1/backordercsv/match/allGet Back Order Match All
GET/v1/backordercsv/match/all/{Guid}Get Back Order Match All by Guid
"use strict";
export class GetBackOrderMatchRequest {
    /** @param {{Guid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Guid;
}
export class BackOrderVehicleCsv {
    /** @param {{VehicleType?:string,Vid?:string,Vin?:string,Fin?:string,CommissionNumber?:string,ChassisNumber?:string,Line?:string,Packages?:string[],ModelYear?:string,ModelYearCode?:string,Description?:string,VehicleClass?:string,RetailPrice_ExVAT?:string,RetailPrice_IncVAT?:number,OTR?:string,ActualPrice?:string,BodyStyle?:string,Model?:string,Colour?:string,ColourGroup?:string,Fuel?:string,ProductRange?:string,Engine?:string,IsAMG?:boolean,Transmission?:string,Upholstery?:string,Nst?:string,BM7NST?:string,Acceleration?:number,BootCapacity?:number,TopSpeed?:number,DriveConcept?:string,CombustionPowerHp?:number,ElectricPowerKw?:number,ElectricPowerHp?:number,CombinedPowerKw?:number,CombinedPowerHP?:number,ElectricRange?:number,ElectricConsumption?:number,EmissionCombined?:string,EmissionExtraUrban?:string,EmissionUrban?:string,Emission?:number,EmissionDirective?:string,EnergyEfficiencyClass?:string,WltpCombined?:number,WltpLow?:number,WltpMedium?:number,WltpHigh?:number,WltpExtraHigh?:number,WltpEmissionCombined?:number,PortArrivalDate?:string,CreationDate?:string,LastUpdated?:string,IsDisplayStock?:boolean,DisplayStockAgent?:string,IsSpecialistCar?:boolean,Account?:string,Location?:string,CesarIdShipToParty?:string,VehicleUsageCode?:string,IsSellable?:boolean,UnderOffer?:boolean,MbukSecured?:boolean,HalfModelYearCode?:string,FullModelYearCode?:string,ProductionDate?:string,IsMotability?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    VehicleType;
    /** @type {string} */
    Vid;
    /** @type {string} */
    Vin;
    /** @type {string} */
    Fin;
    /** @type {string} */
    CommissionNumber;
    /** @type {string} */
    ChassisNumber;
    /** @type {string} */
    Line;
    /** @type {string[]} */
    Packages = [];
    /** @type {string} */
    ModelYear;
    /** @type {string} */
    ModelYearCode;
    /** @type {string} */
    Description;
    /** @type {string} */
    VehicleClass;
    /** @type {string} */
    RetailPrice_ExVAT;
    /** @type {?number} */
    RetailPrice_IncVAT;
    /** @type {string} */
    OTR;
    /** @type {string} */
    ActualPrice;
    /** @type {string} */
    BodyStyle;
    /** @type {string} */
    Model;
    /** @type {string} */
    Colour;
    /** @type {string} */
    ColourGroup;
    /** @type {string} */
    Fuel;
    /** @type {string} */
    ProductRange;
    /** @type {string} */
    Engine;
    /** @type {boolean} */
    IsAMG;
    /** @type {string} */
    Transmission;
    /** @type {string} */
    Upholstery;
    /** @type {string} */
    Nst;
    /** @type {string} */
    BM7NST;
    /** @type {?number} */
    Acceleration;
    /** @type {?number} */
    BootCapacity;
    /** @type {?number} */
    TopSpeed;
    /** @type {string} */
    DriveConcept;
    /** @type {?number} */
    CombustionPowerHp;
    /** @type {?number} */
    ElectricPowerKw;
    /** @type {?number} */
    ElectricPowerHp;
    /** @type {?number} */
    CombinedPowerKw;
    /** @type {?number} */
    CombinedPowerHP;
    /** @type {?number} */
    ElectricRange;
    /** @type {?number} */
    ElectricConsumption;
    /** @type {string} */
    EmissionCombined;
    /** @type {string} */
    EmissionExtraUrban;
    /** @type {string} */
    EmissionUrban;
    /** @type {?number} */
    Emission;
    /** @type {string} */
    EmissionDirective;
    /** @type {string} */
    EnergyEfficiencyClass;
    /** @type {?number} */
    WltpCombined;
    /** @type {?number} */
    WltpLow;
    /** @type {?number} */
    WltpMedium;
    /** @type {?number} */
    WltpHigh;
    /** @type {?number} */
    WltpExtraHigh;
    /** @type {?number} */
    WltpEmissionCombined;
    /** @type {string} */
    PortArrivalDate;
    /** @type {?string} */
    CreationDate;
    /** @type {?string} */
    LastUpdated;
    /** @type {boolean} */
    IsDisplayStock;
    /** @type {string} */
    DisplayStockAgent;
    /** @type {boolean} */
    IsSpecialistCar;
    /** @type {string} */
    Account;
    /** @type {string} */
    Location;
    /** @type {string} */
    CesarIdShipToParty;
    /** @type {string} */
    VehicleUsageCode;
    /** @type {boolean} */
    IsSellable;
    /** @type {boolean} */
    UnderOffer;
    /** @type {boolean} */
    MbukSecured;
    /** @type {string} */
    HalfModelYearCode;
    /** @type {string} */
    FullModelYearCode;
    /** @type {string} */
    ProductionDate;
    /** @type {boolean} */
    IsMotability;
}
export class GetBackOrderMatchAllCsvResponse {
    /** @param {{Vehicles?:BackOrderVehicleCsv[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BackOrderVehicleCsv[]} */
    Vehicles = [];
}
export class GetBackOrderCsvMatchAllRequest extends GetBackOrderMatchRequest {
    /** @param {{Guid?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

JavaScript GetBackOrderCsvMatchAllRequest 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.

GET /v1/backordercsv/match/all HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml

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

<GetBackOrderMatchAllCsvResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.BackOrders">
  <Vehicles xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:BackOrderVehicleCsv>
      <d2p1:Acceleration>0</d2p1:Acceleration>
      <d2p1:Account>String</d2p1:Account>
      <d2p1:ActualPrice>String</d2p1:ActualPrice>
      <d2p1:BM7NST>String</d2p1:BM7NST>
      <d2p1:BodyStyle>String</d2p1:BodyStyle>
      <d2p1:BootCapacity>0</d2p1:BootCapacity>
      <d2p1:CesarIdShipToParty>String</d2p1:CesarIdShipToParty>
      <d2p1:ChassisNumber>String</d2p1:ChassisNumber>
      <d2p1:Colour>String</d2p1:Colour>
      <d2p1:ColourGroup>String</d2p1:ColourGroup>
      <d2p1:CombinedPowerHP>0</d2p1:CombinedPowerHP>
      <d2p1:CombinedPowerKw>0</d2p1:CombinedPowerKw>
      <d2p1:CombustionPowerHp>0</d2p1:CombustionPowerHp>
      <d2p1:CommissionNumber>String</d2p1:CommissionNumber>
      <d2p1:CreationDate>0001-01-01T00:00:00</d2p1:CreationDate>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:DisplayStockAgent>String</d2p1:DisplayStockAgent>
      <d2p1:DriveConcept>String</d2p1:DriveConcept>
      <d2p1:ElectricConsumption>0</d2p1:ElectricConsumption>
      <d2p1:ElectricPowerHp>0</d2p1:ElectricPowerHp>
      <d2p1:ElectricPowerKw>0</d2p1:ElectricPowerKw>
      <d2p1:ElectricRange>0</d2p1:ElectricRange>
      <d2p1:Emission>0</d2p1:Emission>
      <d2p1:EmissionCombined>String</d2p1:EmissionCombined>
      <d2p1:EmissionDirective>String</d2p1:EmissionDirective>
      <d2p1:EmissionExtraUrban>String</d2p1:EmissionExtraUrban>
      <d2p1:EmissionUrban>String</d2p1:EmissionUrban>
      <d2p1:EnergyEfficiencyClass>String</d2p1:EnergyEfficiencyClass>
      <d2p1:Engine>String</d2p1:Engine>
      <d2p1:Fin>String</d2p1:Fin>
      <d2p1:Fuel>String</d2p1:Fuel>
      <d2p1:FullModelYearCode>String</d2p1:FullModelYearCode>
      <d2p1:HalfModelYearCode>String</d2p1:HalfModelYearCode>
      <d2p1:IsAMG>false</d2p1:IsAMG>
      <d2p1:IsDisplayStock>false</d2p1:IsDisplayStock>
      <d2p1:IsMotability>false</d2p1:IsMotability>
      <d2p1:IsSellable>false</d2p1:IsSellable>
      <d2p1:IsSpecialistCar>false</d2p1:IsSpecialistCar>
      <d2p1:LastUpdated>0001-01-01T00:00:00</d2p1:LastUpdated>
      <d2p1:Line>String</d2p1:Line>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:MbukSecured>false</d2p1:MbukSecured>
      <d2p1:Model>String</d2p1:Model>
      <d2p1:ModelYear>String</d2p1:ModelYear>
      <d2p1:ModelYearCode>String</d2p1:ModelYearCode>
      <d2p1:Nst>String</d2p1:Nst>
      <d2p1:OTR>String</d2p1:OTR>
      <d2p1:Packages xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Packages>
      <d2p1:PortArrivalDate>String</d2p1:PortArrivalDate>
      <d2p1:ProductRange>String</d2p1:ProductRange>
      <d2p1:ProductionDate>String</d2p1:ProductionDate>
      <d2p1:RetailPrice_ExVAT>String</d2p1:RetailPrice_ExVAT>
      <d2p1:RetailPrice_IncVAT>0</d2p1:RetailPrice_IncVAT>
      <d2p1:TopSpeed>0</d2p1:TopSpeed>
      <d2p1:Transmission>String</d2p1:Transmission>
      <d2p1:UnderOffer>false</d2p1:UnderOffer>
      <d2p1:Upholstery>String</d2p1:Upholstery>
      <d2p1:VehicleClass>String</d2p1:VehicleClass>
      <d2p1:VehicleType>String</d2p1:VehicleType>
      <d2p1:VehicleUsageCode>String</d2p1:VehicleUsageCode>
      <d2p1:Vid>String</d2p1:Vid>
      <d2p1:Vin>String</d2p1:Vin>
      <d2p1:WltpCombined>0</d2p1:WltpCombined>
      <d2p1:WltpEmissionCombined>0</d2p1:WltpEmissionCombined>
      <d2p1:WltpExtraHigh>0</d2p1:WltpExtraHigh>
      <d2p1:WltpHigh>0</d2p1:WltpHigh>
      <d2p1:WltpLow>0</d2p1:WltpLow>
      <d2p1:WltpMedium>0</d2p1:WltpMedium>
    </d2p1:BackOrderVehicleCsv>
  </Vehicles>
</GetBackOrderMatchAllCsvResponse>