Mercedes.Agency.Orchestration.API

UpdateBackOrderVehicleImportsRequest

BackOrder

The following routes are available for this service:
POST	/v1/backorder/vehicleimports


export class UpdateBackOrderVehicleImportsResponse
{

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

export class Vehicle
{
    public Vin?: string;

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

export class VehicleCriteriaMatch
{
    public Fuel: boolean;
    public Transmission: boolean;
    public Colour: boolean;
    public Upholstery: boolean;
    public Line: boolean;
    public Engine: boolean;
    public BodyStyle: boolean;
    public Packages: boolean;

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

export enum OfferPriceProductType
{
    LIST_PRICE = 'LIST_PRICE',
    NUMBER_PLATE_FEE = 'NUMBER_PLATE_FEE',
    DELIVERY_CHARGE = 'DELIVERY_CHARGE',
    FUEL_CHARGE = 'FUEL_CHARGE',
    MANUFACTURER_OFFER = 'MANUFACTURER_OFFER',
    PERSONALISED_MONEYOFFER = 'PERSONALISED_MONEYOFFER',
    PERSONALISED_NONMONEYOFFER = 'PERSONALISED_NONMONEYOFFER',
    PERSONALISED_NONMONEYOFFER_NEG = 'PERSONALISED_NONMONEYOFFER_NEG',
    SERVICE = 'SERVICE',
    SERVICE_NEG = 'SERVICE_NEG',
    GOVERNMENT_GRANT = 'GOVERNMENT_GRANT',
    OUTRIGHT_PURCHASE_DISCOUNT = 'OUTRIGHT_PURCHASE_DISCOUNT',
    VIP_OFFER = 'VIP_OFFER',
    WALLBOX_OFFER = 'WALLBOX_OFFER',
    WALLBOX_OFFER_NEG = 'WALLBOX_OFFER_NEG',
    ROAD_FUND_LICENCE = 'ROAD_FUND_LICENCE',
    FIRST_REGISTRATION_FEE = 'FIRST_REGISTRATION_FEE',
    NOT_FOUND = 'NOT_FOUND',
    ACCESSORY_OFFER = 'ACCESSORY_OFFER',
    ACCESSORY_OFFER_NEG = 'ACCESSORY_OFFER_NEG',
    MOTABILITY_DISCOUNT = 'MOTABILITY_DISCOUNT',
}

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

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

export class RetailerOpeningTime
{
    public Day: string;
    public OpenFrom: string;
    public OpenTo: string;
    public Special: string;

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

export class RetailerOpeningTimes
{
    public New: RetailerOpeningTime[] = [];
    public Used: RetailerOpeningTime[] = [];

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

export class Retailer
{
    public Id: number;
    public GssnId: string;
    public Description: string;
    public Street: string;
    public City: string;
    public Postcode: string;
    public GoogleMapPostcode: string;
    public Phone: string;
    public Fax: string;
    public Email: string;
    public Website: string;
    public RetailerGroupId: string;
    public RetailerGroupName: string;
    public IsOnline: boolean;
    public IsNewCarRetailer: boolean;
    public IsUsedCarRetailer: boolean;
    public IsCentralRetailer: boolean;
    public ChatEnabled: boolean;
    public TradeInEnabled: boolean;
    public smart: boolean;
    public DisplayPhoneNumberNew: string;
    public DisplayPhoneNumberUsed: string;
    public Latitude: number;
    public Longitude: number;
    public smartDescription: string;
    public smartWebsite: string;
    public smartPhone: string;
    public LegacyId: string;
    public Agent: boolean;
    public MarketAreaId: number;
    public DigitalLoungeParentGssnId?: string;
    public SendLeadsToDigitalLoungeParent: boolean;
    public OpeningTimes?: RetailerOpeningTimes;

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

export class VehicleBaseDetail extends Vehicle implements ICommissionNumber
{
    public Description: string;
    public CommissionNumber: string;
    public PortArrivalDate: string;
    public OfferExpiryDate: string;
    public Fuel: string;
    public Transmission: string;
    public TransmissionType: string;
    public Colour: string;
    public ColourDescription: string;
    public ImageUrl: string;
    public Specialist: boolean;
    public VehicleCriteriaMatch?: VehicleCriteriaMatch;
    public ColourGroup: string;
    public Model: string;
    public BodyStyle: string;
    public Brand: string;
    public Engine: string;
    public EngineDescription: string;
    public Line: string;
    public Upholstery: string;
    public UpholsteryDescription: string;
    public Packages: string[] = [];
    public P11D: number;
    public Prices: Price[] = [];
    public VehicleClass: string;
    public ProductRange: string;
    public VehicleType: string;
    public Emission?: number;
    public Baumuster: string;
    public IsSellable: boolean;
    public Bm7NST: string;
    public ElectricRange?: number;
    public ElectricConsumption?: number;
    public IsDisplayStock: boolean;
    public DisplayRetailer_Id?: number;
    public DisplayRetailer: string;
    public DisplayRetailerGssnId: string;
    public Retailer: Retailer;
    public Age?: number;
    public ModelYearCode: string;
    public HalfModelYearCode: string;
    public FullModelYearCode: string;
    public ProductionDate: string;
    public ChassisNumber?: string;
    public EligibleForIntegratedServiceCare: boolean;

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

export class VehicleConsumption
{
    public Id: number;
    public Lkm: number;
    public Mpg: number;

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

export class Equipment
{
    public Id: number;
    public Code?: string;
    public Description?: string;

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

export class Equipmentv2 extends Equipment
{
    public Importance: number;
    public IsAdditional: boolean;

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

export class VehicleEquipmentCategory
{
    public Order: number;
    public Code?: string;
    public Description?: string;
    public Equipment?: Equipmentv2[];

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

export class VehicleEmissionClass
{
    public Colour?: string;
    public Rating?: string;

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

export class VehicleAttribute
{
    public Description?: string;
    public Value?: string;

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

export class VehicleIntegratedServiceCareOption
{
    public OptionCode?: string;
    public BM7NST?: string;
    public FullModelYear?: string;
    public IntegratedProductType?: string;
    public CustomerDescription?: string;
    public OneAgentProductType?: string;

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

export class VehicleDetail extends VehicleBaseDetail
{
    public RetailPrice_ExVAT: string;
    public OTR: string;
    public ActualPrice: string;
    public TotalOfferValue: string;
    public IsHOBackOrderAccountVehicle: boolean;
    public ConsumptionCombined?: VehicleConsumption;
    public ConsumptionExtraUrban?: VehicleConsumption;
    public ConsumptionUrban?: VehicleConsumption;
    public WltpFuelConsumptionCombined?: VehicleConsumption;
    public WltpFuelConsumptionExtraHigh?: VehicleConsumption;
    public WltpFuelConsumptionHigh?: VehicleConsumption;
    public WltpFuelConsumptionLow?: VehicleConsumption;
    public WltpFuelConsumptionMedium?: VehicleConsumption;
    public EquipmentCategories?: VehicleEquipmentCategory[];
    public VehicleEnergyEfficiencyClass?: VehicleEmissionClass;
    public VehicleData?: VehicleAttribute[];
    public IntegratedProducts: VehicleIntegratedServiceCareOption[] = [];
    public IspVehicleCustomerDescriptions?: string[];
    public ColourCode: string;
    public UpholsteryCode: string;

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

export class VehicleImport extends Vehicle
{
    public CommissionNumber: string;
    public Sellable: boolean;
    public Vehicle: VehicleDetail;

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

// @ApiResponse(Description="Success", StatusCode=200)
// @ApiResponse(Description="BadRequest", StatusCode=400)
export class UpdateBackOrderVehicleImportsRequest implements IPost
{
    public VehicleImports: VehicleImport[] = [];

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

TypeScript UpdateBackOrderVehicleImportsRequest 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/backorder/vehicleimports HTTP/1.1 
Host: prod-api-agency-orch-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBackOrderVehicleImportsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles">
  <VehicleImports xmlns:d2p1="http://schemas.datacontract.org/2004/07/Mercedes.Agency.API.Shared.POCO">
    <d2p1:VehicleImport>
      <d2p1:Vin>String</d2p1:Vin>
      <d2p1:CommissionNumber>String</d2p1:CommissionNumber>
      <d2p1:Sellable>false</d2p1:Sellable>
      <d2p1:Vehicle>
        <d2p1:Vin>String</d2p1:Vin>
        <d2p1:Age>0</d2p1:Age>
        <d2p1:Baumuster>String</d2p1:Baumuster>
        <d2p1:Bm7NST>String</d2p1:Bm7NST>
        <d2p1:BodyStyle>String</d2p1:BodyStyle>
        <d2p1:Brand>String</d2p1:Brand>
        <d2p1:ChassisNumber>String</d2p1:ChassisNumber>
        <d2p1:Colour>String</d2p1:Colour>
        <d2p1:ColourDescription>String</d2p1:ColourDescription>
        <d2p1:ColourGroup>String</d2p1:ColourGroup>
        <d2p1:CommissionNumber>String</d2p1:CommissionNumber>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:DisplayRetailer>String</d2p1:DisplayRetailer>
        <d2p1:DisplayRetailerGssnId>String</d2p1:DisplayRetailerGssnId>
        <d2p1:DisplayRetailer_Id>0</d2p1:DisplayRetailer_Id>
        <d2p1:ElectricConsumption>0</d2p1:ElectricConsumption>
        <d2p1:ElectricRange>0</d2p1:ElectricRange>
        <d2p1:EligibleForIntegratedServiceCare>false</d2p1:EligibleForIntegratedServiceCare>
        <d2p1:Emission>0</d2p1:Emission>
        <d2p1:Engine>String</d2p1:Engine>
        <d2p1:EngineDescription>String</d2p1:EngineDescription>
        <d2p1:Fuel>String</d2p1:Fuel>
        <d2p1:FullModelYearCode>String</d2p1:FullModelYearCode>
        <d2p1:HalfModelYearCode>String</d2p1:HalfModelYearCode>
        <d2p1:ImageUrl>String</d2p1:ImageUrl>
        <d2p1:IsDisplayStock>false</d2p1:IsDisplayStock>
        <d2p1:IsSellable>false</d2p1:IsSellable>
        <d2p1:Line>String</d2p1:Line>
        <d2p1:Model>String</d2p1:Model>
        <d2p1:ModelYearCode>String</d2p1:ModelYearCode>
        <d2p1:OfferExpiryDate>String</d2p1:OfferExpiryDate>
        <d2p1:P11D>0</d2p1:P11D>
        <d2p1:Packages xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:Packages>
        <d2p1:PortArrivalDate>String</d2p1:PortArrivalDate>
        <d2p1:Prices>
          <d2p1:Price>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:Gross>0</d2p1:Gross>
            <d2p1:Id>String</d2p1:Id>
            <d2p1:Net>0</d2p1:Net>
            <d2p1:Product>LIST_PRICE</d2p1:Product>
            <d2p1:VAT>0</d2p1:VAT>
          </d2p1:Price>
        </d2p1:Prices>
        <d2p1:ProductRange>String</d2p1:ProductRange>
        <d2p1:ProductionDate>String</d2p1:ProductionDate>
        <d2p1:Retailer>
          <d2p1:Agent>false</d2p1:Agent>
          <d2p1:ChatEnabled>false</d2p1:ChatEnabled>
          <d2p1:City>String</d2p1:City>
          <d2p1:Description>String</d2p1:Description>
          <d2p1:DigitalLoungeParentGssnId>String</d2p1:DigitalLoungeParentGssnId>
          <d2p1:DisplayPhoneNumberNew>String</d2p1:DisplayPhoneNumberNew>
          <d2p1:DisplayPhoneNumberUsed>String</d2p1:DisplayPhoneNumberUsed>
          <d2p1:Email>String</d2p1:Email>
          <d2p1:Fax>String</d2p1:Fax>
          <d2p1:GoogleMapPostcode>String</d2p1:GoogleMapPostcode>
          <d2p1:GssnId>String</d2p1:GssnId>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:IsCentralRetailer>false</d2p1:IsCentralRetailer>
          <d2p1:IsNewCarRetailer>false</d2p1:IsNewCarRetailer>
          <d2p1:IsOnline>false</d2p1:IsOnline>
          <d2p1:IsUsedCarRetailer>false</d2p1:IsUsedCarRetailer>
          <d2p1:Latitude>0</d2p1:Latitude>
          <d2p1:LegacyId>String</d2p1:LegacyId>
          <d2p1:Longitude>0</d2p1:Longitude>
          <d2p1:MarketAreaId>0</d2p1:MarketAreaId>
          <d2p1:OpeningTimes>
            <d2p1:New>
              <d2p1:RetailerOpeningTime>
                <d2p1:Day>String</d2p1:Day>
                <d2p1:OpenFrom>String</d2p1:OpenFrom>
                <d2p1:OpenTo>String</d2p1:OpenTo>
                <d2p1:Special>String</d2p1:Special>
              </d2p1:RetailerOpeningTime>
            </d2p1:New>
            <d2p1:Used>
              <d2p1:RetailerOpeningTime>
                <d2p1:Day>String</d2p1:Day>
                <d2p1:OpenFrom>String</d2p1:OpenFrom>
                <d2p1:OpenTo>String</d2p1:OpenTo>
                <d2p1:Special>String</d2p1:Special>
              </d2p1:RetailerOpeningTime>
            </d2p1:Used>
          </d2p1:OpeningTimes>
          <d2p1:Phone>String</d2p1:Phone>
          <d2p1:Postcode>String</d2p1:Postcode>
          <d2p1:RetailerGroupId>String</d2p1:RetailerGroupId>
          <d2p1:RetailerGroupName>String</d2p1:RetailerGroupName>
          <d2p1:SendLeadsToDigitalLoungeParent>false</d2p1:SendLeadsToDigitalLoungeParent>
          <d2p1:Street>String</d2p1:Street>
          <d2p1:TradeInEnabled>false</d2p1:TradeInEnabled>
          <d2p1:Website>String</d2p1:Website>
          <d2p1:smart>false</d2p1:smart>
          <d2p1:smartDescription>String</d2p1:smartDescription>
          <d2p1:smartPhone>String</d2p1:smartPhone>
          <d2p1:smartWebsite>String</d2p1:smartWebsite>
        </d2p1:Retailer>
        <d2p1:Specialist>false</d2p1:Specialist>
        <d2p1:Transmission>String</d2p1:Transmission>
        <d2p1:TransmissionType>String</d2p1:TransmissionType>
        <d2p1:Upholstery>String</d2p1:Upholstery>
        <d2p1:UpholsteryDescription>String</d2p1:UpholsteryDescription>
        <d2p1:VehicleClass>String</d2p1:VehicleClass>
        <d2p1:VehicleCriteriaMatch>
          <d2p1:BodyStyle>false</d2p1:BodyStyle>
          <d2p1:Colour>false</d2p1:Colour>
          <d2p1:Engine>false</d2p1:Engine>
          <d2p1:Fuel>false</d2p1:Fuel>
          <d2p1:Line>false</d2p1:Line>
          <d2p1:Packages>false</d2p1:Packages>
          <d2p1:Transmission>false</d2p1:Transmission>
          <d2p1:Upholstery>false</d2p1:Upholstery>
        </d2p1:VehicleCriteriaMatch>
        <d2p1:VehicleType>String</d2p1:VehicleType>
        <d2p1:ActualPrice>String</d2p1:ActualPrice>
        <d2p1:ColourCode>String</d2p1:ColourCode>
        <d2p1:ConsumptionCombined>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:ConsumptionCombined>
        <d2p1:ConsumptionExtraUrban>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:ConsumptionExtraUrban>
        <d2p1:ConsumptionUrban>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:ConsumptionUrban>
        <d2p1:EquipmentCategories>
          <d2p1:VehicleEquipmentCategory>
            <d2p1:Code>String</d2p1:Code>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:Equipment xmlns:d7p1="http://schemas.datacontract.org/2004/07/Mercedes.OS.Vehicle.Shared.POCO">
              <d7p1:Equipmentv2>
                <d7p1:Code>String</d7p1:Code>
                <d7p1:Description>String</d7p1:Description>
                <d7p1:Id>0</d7p1:Id>
                <d7p1:Importance>0</d7p1:Importance>
                <d7p1:IsAdditional>false</d7p1:IsAdditional>
              </d7p1:Equipmentv2>
            </d2p1:Equipment>
            <d2p1:Order>0</d2p1:Order>
          </d2p1:VehicleEquipmentCategory>
        </d2p1:EquipmentCategories>
        <d2p1:IntegratedProducts>
          <d2p1:VehicleIntegratedServiceCareOption>
            <d2p1:BM7NST>String</d2p1:BM7NST>
            <d2p1:CustomerDescription>String</d2p1:CustomerDescription>
            <d2p1:FullModelYear>String</d2p1:FullModelYear>
            <d2p1:IntegratedProductType>String</d2p1:IntegratedProductType>
            <d2p1:OneAgentProductType>String</d2p1:OneAgentProductType>
            <d2p1:OptionCode>String</d2p1:OptionCode>
          </d2p1:VehicleIntegratedServiceCareOption>
        </d2p1:IntegratedProducts>
        <d2p1:IsHOBackOrderAccountVehicle>false</d2p1:IsHOBackOrderAccountVehicle>
        <d2p1:IspVehicleCustomerDescriptions xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>String</d5p1:string>
        </d2p1:IspVehicleCustomerDescriptions>
        <d2p1:OTR>String</d2p1:OTR>
        <d2p1:RetailPrice_ExVAT>String</d2p1:RetailPrice_ExVAT>
        <d2p1:TotalOfferValue>String</d2p1:TotalOfferValue>
        <d2p1:UpholsteryCode>String</d2p1:UpholsteryCode>
        <d2p1:VehicleData>
          <d2p1:VehicleAttribute>
            <d2p1:Description>String</d2p1:Description>
            <d2p1:Value>String</d2p1:Value>
          </d2p1:VehicleAttribute>
        </d2p1:VehicleData>
        <d2p1:VehicleEnergyEfficiencyClass>
          <d2p1:Colour>String</d2p1:Colour>
          <d2p1:Rating>String</d2p1:Rating>
        </d2p1:VehicleEnergyEfficiencyClass>
        <d2p1:WltpFuelConsumptionCombined>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:WltpFuelConsumptionCombined>
        <d2p1:WltpFuelConsumptionExtraHigh>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:WltpFuelConsumptionExtraHigh>
        <d2p1:WltpFuelConsumptionHigh>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:WltpFuelConsumptionHigh>
        <d2p1:WltpFuelConsumptionLow>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:WltpFuelConsumptionLow>
        <d2p1:WltpFuelConsumptionMedium>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:Lkm>0</d2p1:Lkm>
          <d2p1:Mpg>0</d2p1:Mpg>
        </d2p1:WltpFuelConsumptionMedium>
      </d2p1:Vehicle>
    </d2p1:VehicleImport>
  </VehicleImports>
</UpdateBackOrderVehicleImportsRequest>

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

<UpdateBackOrderVehicleImportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.Agency.Orchestration.API.ServiceModel.Vehicles" />