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
package dtos

import (
	"time"
)

type BasicBackOrderVehicle struct {
	CommissionNumber        string     `json:"commissionNumber"`
	Description             string     `json:"description"`
	Model                   string     `json:"model"`
	Colour                  string     `json:"colour"`
	FuelType                string     `json:"fuelType"`
	Transmission            string     `json:"transmission"`
	Packages                string     `json:"packages"`
	Lines                   string     `json:"lines"`
	Upholstery              string     `json:"upholstery"`
	EmissionCombined        string     `json:"emissionCombined"`
	ActualPrice             float64    `json:"actualPrice,omitempty"`
	UsageCode               string     `json:"usageCode"`
	Secured                 bool       `json:"secured,omitempty"`
	Account                 string     `json:"account"`
	SecuredTime             *string    `json:"securedTime,omitempty"`
	SecuredReason           *string    `json:"securedReason,omitempty"`
	SecuredByGasId          *string    `json:"securedByGasId,omitempty"`
	SecuredDate             *time.Time `json:"securedDate,omitempty"`
	ConfirmedProductionDate *time.Time `json:"confirmedProductionDate,omitempty"`
	ForecastedArrivalDate   *time.Time `json:"forecastedArrivalDate,omitempty"`
}

type BackOrderVehicle struct {
	BasicBackOrderVehicle
	Id                    int        `json:"id,omitempty"`
	Vin                   string     `json:"vin"`
	VehicleType           string     `json:"vehicleType"`
	Vid                   string     `json:"vid"`
	Fin                   string     `json:"fin"`
	ChassisNumber         string     `json:"chassisNumber"`
	ModelYear             string     `json:"modelYear"`
	ModelYearCode         string     `json:"modelYearCode"`
	HalfModelYearCode     string     `json:"halfModelYearCode"`
	FullModelYearCode     string     `json:"fullModelYearCode"`
	SalesDescriptionLong  string     `json:"salesDescriptionLong"`
	VehicleClass          string     `json:"vehicleClass"`
	RetailPriceExVAT      float64    `json:"retailPrice_ExVAT,omitempty"`
	RetailPriceIncVAT     float64    `json:"retailPrice_IncVAT,omitempty"`
	Otr                   float64    `json:"otr,omitempty"`
	BodyStyle             string     `json:"bodyStyle"`
	ProductRange          string     `json:"productRange"`
	Engine                string     `json:"engine"`
	IsAMG                 bool       `json:"isAMG,omitempty"`
	ColourGroup           string     `json:"colourGroup"`
	UpholsteryCode        string     `json:"upholsteryCode"`
	Nst                   string     `json:"nst"`
	Bm7NST                string     `json:"bm7NST"`
	Acceleration          *float64   `json:"acceleration,omitempty"`
	BootCapacity          *int       `json:"bootCapacity,omitempty"`
	TopSpeed              *float64   `json:"topSpeed,omitempty"`
	DriveConcept          string     `json:"driveConcept"`
	CombustionPowerHp     *float64   `json:"combustionPowerHp,omitempty"`
	ElectricPowerKw       *float64   `json:"electricPowerKw,omitempty"`
	ElectricPowerHp       *float64   `json:"electricPowerHp,omitempty"`
	CombinedPowerKw       *float64   `json:"combinedPowerKw,omitempty"`
	CombinedPowerHP       *float64   `json:"combinedPowerHP,omitempty"`
	ElectricRange         *float64   `json:"electricRange,omitempty"`
	ElectricConsumption   *float64   `json:"electricConsumption,omitempty"`
	Emission              *float64   `json:"emission,omitempty"`
	EmissionDirective     string     `json:"emissionDirective"`
	EmissionExtraUrban    string     `json:"emissionExtraUrban"`
	EmissionUrban         string     `json:"emissionUrban"`
	EnergyEfficiencyClass string     `json:"energyEfficiencyClass"`
	WltpEmissionCombined  string     `json:"wltpEmissionCombined"`
	WltpCombined          string     `json:"wltpCombined"`
	WltpLow               string     `json:"wltpLow"`
	WltpMedium            string     `json:"wltpMedium"`
	WltpHigh              string     `json:"wltpHigh"`
	WltpExtraHigh         string     `json:"wltpExtraHigh"`
	PortArrivalDate       *time.Time `json:"portArrivalDate,omitempty"`
	CreationDate          time.Time  `json:"creationDate,omitempty"`
	LastUpdated           *time.Time `json:"lastUpdated,omitempty"`
	IsDisplayStock        bool       `json:"isDisplayStock,omitempty"`
	DisplayStockAgent     string     `json:"displayStockAgent"`
	IsSpecialistCar       bool       `json:"isSpecialistCar,omitempty"`
	Location              string     `json:"location"`
	CesarIdShipToParty    string     `json:"cesarIdShipToParty"`
	IsSellable            bool       `json:"isSellable,omitempty"`
	UnderOffer            bool       `json:"underOffer,omitempty"`
	Baumuster             string     `json:"baumuster"`
}

type StockManagementResponse struct {
	TotalVehicles int                `json:"totalVehicles,omitempty"`
	Vehicles      []BackOrderVehicle `json:"vehicles"`
}

type Sort struct {
	Id int `json:"id,omitempty"`
}

type Paging struct {
	ResultsPerPage int `json:"resultsPerPage,omitempty"`
	PageIndex      int `json:"pageIndex,omitempty"`
}

type CampaignExclusion struct {
	Vin              []string `json:"vin"`
	CommissionNumber []string `json:"commissionNumber"`
	ModelYearCode    string   `json:"modelYearCode"`
	EquipmentCode    string   `json:"equipmentCode"`
	Gssn             []string `json:"gssn"`
}

type RegistrationDate struct {
	From time.Time `json:"from,omitempty"`
	To   time.Time `json:"to,omitempty"`
}

type Age struct {
	Date                 time.Time `json:"date,omitempty"`
	Min                  int       `json:"min,omitempty"`
	Max                  int       `json:"max,omitempty"`
	IncludePipelineStock bool      `json:"includePipelineStock,omitempty"`
}

type PortArrivalDate struct {
	PipelineStock bool      `json:"pipelineStock,omitempty"`
	From          time.Time `json:"from,omitempty"`
	To            time.Time `json:"to,omitempty"`
}

type VehicleSearchV3Criteria struct {
	Vin               []string          `json:"vin"`
	Model             []int             `json:"model"`
	Fuel              []int             `json:"fuel"`
	Transmission      []int             `json:"transmission"`
	Engine            []int             `json:"engine"`
	Line              []string          `json:"line"`
	MappedLine        []int             `json:"mappedLine"`
	CommissionNumber  []string          `json:"commissionNumber"`
	VehicleType       string            `json:"vehicleType"`
	Exclusion         CampaignExclusion `json:"exclusion"`
	RegNo             string            `json:"regNo"`
	IncludeOffline    bool              `json:"includeOffline,omitempty"`
	RegistrationDate  RegistrationDate  `json:"registrationDate"`
	Age               Age               `json:"age"`
	PortArrivalDate   PortArrivalDate   `json:"portArrivalDate"`
	IsAvailableOnline *bool             `json:"isAvailableOnline,omitempty"`
	IsBackOrdered     *bool             `json:"isBackOrdered,omitempty"`
	IsSellable        *bool             `json:"isSellable,omitempty"`
	IsUnderOffer      *bool             `json:"isUnderOffer,omitempty"`
	MbukSecured       *bool             `json:"mbukSecured,omitempty"`
	Account           []string          `json:"account"`
	Baumuster         []string          `json:"baumuster"`
	Colours           []int             `json:"colours"`
	Upholstery        []int             `json:"upholstery"`
	Package           []int             `json:"package"`
	Nst               []string          `json:"nst"`
	UsageCode         []string          `json:"usageCode"`
}

type StockManagementRequest struct {
	Sort     Sort                    `json:"sort"`
	Paging   Paging                  `json:"paging"`
	Criteria VehicleSearchV3Criteria `json:"criteria"`
}

Go 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>