Mercedes.VehicleManagement.API

<back to all web services

StockManagementRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/StockManagementGets vehicles for stock management
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BasicBackOrderVehicle:
    commission_number: Optional[str] = None
    description: Optional[str] = None
    model: Optional[str] = None
    colour: Optional[str] = None
    fuel_type: Optional[str] = None
    transmission: Optional[str] = None
    packages: Optional[str] = None
    lines: Optional[str] = None
    upholstery: Optional[str] = None
    emission_combined: Optional[str] = None
    actual_price: Decimal = decimal.Decimal(0)
    usage_code: Optional[str] = None
    secured: bool = False
    account: Optional[str] = None
    secured_time: Optional[str] = None
    secured_reason: Optional[str] = None
    secured_by_gas_id: Optional[str] = None
    secured_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BackOrderVehicle(BasicBackOrderVehicle):
    id: int = 0
    vin: Optional[str] = None
    vehicle_type: Optional[str] = None
    vid: Optional[str] = None
    fin: Optional[str] = None
    chassis_number: Optional[str] = None
    model_year: Optional[str] = None
    model_year_code: Optional[str] = None
    half_model_year_code: Optional[str] = None
    full_model_year_code: Optional[str] = None
    sales_description_long: Optional[str] = None
    vehicle_class: Optional[str] = None
    retail_price__ex_v_a_t: Decimal = decimal.Decimal(0)
    retail_price__inc_v_a_t: Decimal = decimal.Decimal(0)
    otr: Decimal = decimal.Decimal(0)
    body_style: Optional[str] = None
    product_range: Optional[str] = None
    engine: Optional[str] = None
    is_a_m_g: bool = False
    colour_group: Optional[str] = None
    upholstery_code: Optional[str] = None
    nst: Optional[str] = None
    bm7_n_s_t: Optional[str] = None
    acceleration: Optional[Decimal] = None
    boot_capacity: Optional[int] = None
    top_speed: Optional[Decimal] = None
    drive_concept: Optional[str] = None
    combustion_power_hp: Optional[Decimal] = None
    electric_power_kw: Optional[Decimal] = None
    electric_power_hp: Optional[Decimal] = None
    combined_power_kw: Optional[Decimal] = None
    combined_power_h_p: Optional[Decimal] = None
    electric_range: Optional[Decimal] = None
    electric_consumption: Optional[Decimal] = None
    emission: Optional[Decimal] = None
    emission_directive: Optional[str] = None
    emission_extra_urban: Optional[str] = None
    emission_urban: Optional[str] = None
    energy_efficiency_class: Optional[str] = None
    wltp_emission_combined: Optional[str] = None
    wltp_combined: Optional[str] = None
    wltp_low: Optional[str] = None
    wltp_medium: Optional[str] = None
    wltp_high: Optional[str] = None
    wltp_extra_high: Optional[str] = None
    production_date: Optional[datetime.datetime] = None
    port_arrival_date: Optional[datetime.datetime] = None
    creation_date: datetime.datetime = datetime.datetime(1, 1, 1)
    last_updated: Optional[datetime.datetime] = None
    is_display_stock: bool = False
    display_stock_agent: Optional[str] = None
    is_specialist_car: bool = False
    location: Optional[str] = None
    cesar_id_ship_to_party: Optional[str] = None
    is_sellable: bool = False
    under_offer: bool = False
    baumuster: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StockManagementResponse:
    total_vehicles: int = 0
    vehicles: Optional[List[BackOrderVehicle]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Sort:
    id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Paging:
    results_per_page: int = 0
    page_index: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CampaignExclusion:
    vin: List[str] = field(default_factory=list)
    commission_number: List[str] = field(default_factory=list)
    model_year_code: Optional[str] = None
    equipment_code: Optional[str] = None
    gssn: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RegistrationDate:
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Age:
    date: datetime.datetime = datetime.datetime(1, 1, 1)
    min: int = 0
    max: int = 0
    include_pipeline_stock: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PortArrivalDate:
    pipeline_stock: bool = False
    from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
    to: datetime.datetime = datetime.datetime(1, 1, 1)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VehicleSearchV3Criteria:
    vin: List[str] = field(default_factory=list)
    model: List[int] = field(default_factory=list)
    fuel: List[int] = field(default_factory=list)
    transmission: List[int] = field(default_factory=list)
    engine: List[int] = field(default_factory=list)
    line: List[str] = field(default_factory=list)
    mapped_line: List[int] = field(default_factory=list)
    commission_number: List[str] = field(default_factory=list)
    vehicle_type: Optional[str] = None
    exclusion: Optional[CampaignExclusion] = None
    reg_no: Optional[str] = None
    include_offline: bool = False
    registration_date: Optional[RegistrationDate] = None
    age: Optional[Age] = None
    port_arrival_date: Optional[PortArrivalDate] = None
    is_available_online: Optional[bool] = None
    is_back_ordered: Optional[bool] = None
    is_sellable: Optional[bool] = None
    is_under_offer: Optional[bool] = None
    mbuk_secured: Optional[bool] = None
    account: List[str] = field(default_factory=list)
    baumuster: List[str] = field(default_factory=list)
    colours: List[int] = field(default_factory=list)
    upholstery: List[int] = field(default_factory=list)
    package: List[int] = field(default_factory=list)
    nst: List[str] = field(default_factory=list)
    usage_code: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StockManagementRequest(IPost):
    sort: Optional[Sort] = None
    paging: Optional[Paging] = None
    criteria: Optional[VehicleSearchV3Criteria] = None

Python StockManagementRequest 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/StockManagement HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StockManagementRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3">
  <Criteria>
    <Account xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Account>
    <Age>
      <Date>0001-01-01T00:00:00</Date>
      <IncludePipelineStock>false</IncludePipelineStock>
      <Max>0</Max>
      <Min>0</Min>
    </Age>
    <Baumuster xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Baumuster>
    <Colours xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Colours>
    <CommissionNumber xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </CommissionNumber>
    <Engine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Engine>
    <Exclusion>
      <CommissionNumber xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </CommissionNumber>
      <EquipmentCode>String</EquipmentCode>
      <Gssn xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Gssn>
      <ModelYearCode>String</ModelYearCode>
      <Vin xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Vin>
    </Exclusion>
    <Fuel xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Fuel>
    <IncludeOffline>false</IncludeOffline>
    <IsAvailableOnline>false</IsAvailableOnline>
    <IsBackOrdered>false</IsBackOrdered>
    <IsSellable>false</IsSellable>
    <IsUnderOffer>false</IsUnderOffer>
    <Line xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Line>
    <MBUKSecured>false</MBUKSecured>
    <MappedLine xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </MappedLine>
    <Model xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Model>
    <NST xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </NST>
    <Package xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Package>
    <PortArrivalDate>
      <From>0001-01-01T00:00:00</From>
      <PipelineStock>false</PipelineStock>
      <To>0001-01-01T00:00:00</To>
    </PortArrivalDate>
    <RegNo>String</RegNo>
    <RegistrationDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </RegistrationDate>
    <Transmission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Transmission>
    <Upholstery xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Upholstery>
    <UsageCode xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </UsageCode>
    <VehicleType>String</VehicleType>
    <Vin xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Vin>
  </Criteria>
  <Paging>
    <PageIndex>0</PageIndex>
    <ResultsPerPage>0</ResultsPerPage>
  </Paging>
  <Sort>
    <Id>0</Id>
  </Sort>
</StockManagementRequest>

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

<StockManagementResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mercedes.VehicleManagement.API.Shared.POCO.V3">
  <TotalVehicles>0</TotalVehicles>
  <Vehicles i:nil="true" />
</StockManagementResponse>