Mercedes.Agency.Orchestration.API

<back to all web services

UpdateBackOrderVehicleImportsRequest

BackOrder
Requires Authentication
The following routes are available for this service:
POST/v1/backorder/vehicleimports
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="Success", StatusCode=200)
// @ApiResponse(Description="BadRequest", StatusCode=400)
open class UpdateBackOrderVehicleImportsRequest : IPost
{
    open var VehicleImports:ArrayList<VehicleImport> = ArrayList<VehicleImport>()
}

open class VehicleImport : Vehicle()
{
    open var CommissionNumber:String? = null
    open var Sellable:Boolean? = null
    open var Vehicle:VehicleDetail? = null
}

open class Vehicle
{
    open var Vin:String? = null
}

open class VehicleDetail : VehicleBaseDetail()
{
    open var RetailPrice_ExVAT:String? = null
    open var OTR:String? = null
    open var ActualPrice:String? = null
    open var TotalOfferValue:String? = null
    open var IsHOBackOrderAccountVehicle:Boolean? = null
    open var ConsumptionCombined:VehicleConsumption? = null
    open var ConsumptionExtraUrban:VehicleConsumption? = null
    open var ConsumptionUrban:VehicleConsumption? = null
    open var WltpFuelConsumptionCombined:VehicleConsumption? = null
    open var WltpFuelConsumptionExtraHigh:VehicleConsumption? = null
    open var WltpFuelConsumptionHigh:VehicleConsumption? = null
    open var WltpFuelConsumptionLow:VehicleConsumption? = null
    open var WltpFuelConsumptionMedium:VehicleConsumption? = null
    open var EquipmentCategories:ArrayList<VehicleEquipmentCategory>? = null
    open var VehicleEnergyEfficiencyClass:VehicleEmissionClass? = null
    open var VehicleData:ArrayList<VehicleAttribute>? = null
    open var IntegratedProducts:ArrayList<VehicleIntegratedServiceCareOption> = ArrayList<VehicleIntegratedServiceCareOption>()
    open var IspVehicleCustomerDescriptions:ArrayList<String>? = null
    open var ColourCode:String? = null
    open var UpholsteryCode:String? = null
}

open class VehicleBaseDetail : Vehicle(), ICommissionNumber
{
    open var Description:String? = null
    override var CommissionNumber:String? = null
    open var PortArrivalDate:String? = null
    open var OfferExpiryDate:String? = null
    open var Fuel:String? = null
    open var Transmission:String? = null
    open var TransmissionType:String? = null
    open var Colour:String? = null
    open var ColourDescription:String? = null
    open var ImageUrl:String? = null
    open var Specialist:Boolean? = null
    open var VehicleCriteriaMatch:VehicleCriteriaMatch? = null
    open var ColourGroup:String? = null
    open var Model:String? = null
    open var BodyStyle:String? = null
    open var Brand:String? = null
    open var Engine:String? = null
    open var EngineDescription:String? = null
    open var Line:String? = null
    open var Upholstery:String? = null
    open var UpholsteryDescription:String? = null
    open var Packages:ArrayList<String> = ArrayList<String>()
    open var P11D:BigDecimal? = null
    open var Prices:ArrayList<Price> = ArrayList<Price>()
    open var VehicleClass:String? = null
    open var ProductRange:String? = null
    open var VehicleType:String? = null
    open var Emission:BigDecimal? = null
    open var Baumuster:String? = null
    open var IsSellable:Boolean? = null
    open var Bm7NST:String? = null
    open var ElectricRange:BigDecimal? = null
    open var ElectricConsumption:BigDecimal? = null
    open var IsDisplayStock:Boolean? = null
    open var DisplayRetailer_Id:Int? = null
    open var DisplayRetailer:String? = null
    open var DisplayRetailerGssnId:String? = null
    open var Retailer:Retailer? = null
    open var Age:Int? = null
    open var ModelYearCode:String? = null
    open var HalfModelYearCode:String? = null
    open var FullModelYearCode:String? = null
    open var ProductionDate:String? = null
    open var ChassisNumber:String? = null
    open var EligibleForIntegratedServiceCare:Boolean? = null
}

open class VehicleCriteriaMatch
{
    open var Fuel:Boolean? = null
    open var Transmission:Boolean? = null
    open var Colour:Boolean? = null
    open var Upholstery:Boolean? = null
    open var Line:Boolean? = null
    open var Engine:Boolean? = null
    open var BodyStyle:Boolean? = null
    open var Packages:Boolean? = null
}

open class Price
{
    open var Id:String? = null
    open var Description:String? = null
    open var Net:BigDecimal? = null
    open var VAT:BigDecimal? = null
    open var Gross:BigDecimal? = null
    open var Product:OfferPriceProductType? = null
}

enum class OfferPriceProductType
{
    ListPrice,
    NumberPlateFee,
    DeliveryCharge,
    FuelCharge,
    ManufacturerOffer,
    PersonalisedMoneyoffer,
    PersonalisedNonmoneyoffer,
    PersonalisedNonmoneyofferNeg,
    Service,
    ServiceNeg,
    GovernmentGrant,
    OutrightPurchaseDiscount,
    VipOffer,
    WallboxOffer,
    WallboxOfferNeg,
    RoadFundLicence,
    FirstRegistrationFee,
    NotFound,
    AccessoryOffer,
    AccessoryOfferNeg,
    MotabilityDiscount,
}

open class Retailer
{
    open var Id:Int? = null
    open var GssnId:String? = null
    open var Description:String? = null
    open var Street:String? = null
    open var City:String? = null
    open var Postcode:String? = null
    open var GoogleMapPostcode:String? = null
    open var Phone:String? = null
    open var Fax:String? = null
    open var Email:String? = null
    open var Website:String? = null
    open var RetailerGroupId:String? = null
    open var RetailerGroupName:String? = null
    open var IsOnline:Boolean? = null
    open var IsNewCarRetailer:Boolean? = null
    open var IsUsedCarRetailer:Boolean? = null
    open var IsCentralRetailer:Boolean? = null
    open var ChatEnabled:Boolean? = null
    open var TradeInEnabled:Boolean? = null
    open var smart:Boolean? = null
    open var DisplayPhoneNumberNew:String? = null
    open var DisplayPhoneNumberUsed:String? = null
    open var Latitude:BigDecimal? = null
    open var Longitude:BigDecimal? = null
    open var smartDescription:String? = null
    open var smartWebsite:String? = null
    open var smartPhone:String? = null
    open var LegacyId:String? = null
    open var Agent:Boolean? = null
    open var MarketAreaId:Int? = null
    open var DigitalLoungeParentGssnId:String? = null
    open var SendLeadsToDigitalLoungeParent:Boolean? = null
    open var OpeningTimes:RetailerOpeningTimes? = null
}

open class RetailerOpeningTimes
{
    open var New:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
    open var Used:ArrayList<RetailerOpeningTime> = ArrayList<RetailerOpeningTime>()
}

open class RetailerOpeningTime
{
    open var Day:String? = null
    open var OpenFrom:String? = null
    open var OpenTo:String? = null
    open var Special:String? = null
}

open class VehicleConsumption
{
    open var Id:Int? = null
    open var Lkm:BigDecimal? = null
    open var Mpg:BigDecimal? = null
}

open class VehicleEquipmentCategory
{
    open var Order:Int? = null
    open var Code:String? = null
    open var Description:String? = null
    open var Equipment:ArrayList<Equipmentv2>? = null
}

open class Equipmentv2 : Equipment()
{
    open var Importance:Int? = null
    open var IsAdditional:Boolean? = null
}

open class Equipment
{
    open var Id:Int? = null
    open var Code:String? = null
    open var Description:String? = null
}

open class VehicleEmissionClass
{
    open var Colour:String? = null
    open var Rating:String? = null
}

open class VehicleAttribute
{
    open var Description:String? = null
    open var Value:String? = null
}

open class VehicleIntegratedServiceCareOption
{
    open var OptionCode:String? = null
    open var BM7NST:String? = null
    open var FullModelYear:String? = null
    open var IntegratedProductType:String? = null
    open var CustomerDescription:String? = null
    open var OneAgentProductType:String? = null
}

open class UpdateBackOrderVehicleImportsResponse
{
}

Kotlin 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" />