POST | /v1/OnlineShowroom/Stock | Search for Online Showroom Stock | Calls Vehicle Data API online showroom stock endpoint and searches for vehicles given a list of retailers. The results are used to populate the Online Showroom Stock datatable grid in OneAdmin |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Gssns | body | List<string> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
TotalVehicles | form | int | No | |
Vehicles | form | List<StockDataRow> | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CommissionNumber | form | string | Yes | |
Description | form | string | Yes | |
SalesDescriptionLong | form | string | Yes | |
Model | form | string | Yes | |
Colour | form | string | Yes | |
ColourGroup | form | string | Yes | |
FuelType | form | string | Yes | |
Transmission | form | string | Yes | |
TransmissionType | form | string | Yes | |
Packages | form | string | Yes | |
Lines | form | string | Yes | |
Upholstery | form | string | Yes | |
UpholsteryCode | form | string | Yes | |
DisplayStockAgent | form | string | Yes | |
Location | form | string | Yes | |
Vin | form | string | Yes | |
Vid | form | string | Yes | |
VehicleType | form | string | Yes | |
VehicleClass | form | string | Yes | |
CreationDate | form | DateTime | No | |
LastUpdated | form | DateTime? | No | |
ProductionDate | form | DateTime? | No | |
PortArrivalDate | form | DateTime? | No | |
CombinedGrossOfferValue | form | decimal | No | |
CurrentLocation | form | string | Yes | |
NotVisibleOnlineShowroom | form | bool | No | |
NvosReason | form | string | Yes | |
NvosReasonOneAdminExcluded | form | bool | No | |
NvosReasonLinkedToBackOrder | form | bool | No | |
IncludedAfterDeduplication | form | bool | No | |
Unique | form | bool | No | |
Duplicate | form | bool | No | |
DuplicateGroup | form | int? | No | |
LowestComm | form | bool | No | |
Rule | form | string | Yes | |
Fin | form | string | Yes | |
ChassisNumber | form | string | Yes | |
ModelYear | form | string | Yes | |
ModelYearCode | form | string | Yes | |
HalfModelYearCode | form | string | Yes | |
FullModelYearCode | form | string | Yes | |
BodyStyle | form | string | Yes | |
Engine | form | string | Yes | |
CesarIdShipToParty | form | string | Yes | |
VehicleUsageCode | form | string | Yes | |
Acceleration | form | decimal? | No | |
BootCapacity | form | int? | No | |
TopSpeed | form | decimal? | No | |
DriveConcept | form | string | Yes | |
CombustionPowerHp | form | decimal? | No | |
ElectricPowerKw | form | decimal? | No | |
ElectricPowerHp | form | decimal? | No | |
CombinedPowerKw | form | decimal? | No | |
CombinedPowerHP | form | decimal? | No | |
UnderOffer | form | bool | No | |
IsSellable | form | bool | No | |
MBUKSecured | form | bool | No | |
IsDisplayStock | form | bool | No | |
IsSpecialistCar | form | bool | No | |
Account | form | string | Yes | |
ProductRange | form | string | Yes | |
IsAMG | form | bool | No | |
ActualPrice | form | decimal | No | |
RetailPrice_ExVAT | form | decimal | No | |
RetailPrice_IncVAT | form | decimal | No | |
OTR | form | decimal | No | |
NST | form | string | Yes | |
Bm7NST | form | string | Yes | |
ElectricRange | form | decimal? | No | |
ElectricConsumption | form | decimal? | No | |
Emission | form | decimal? | No | |
EmissionDirective | form | string | Yes | |
EmissionCombined | form | string | Yes | |
EmissionExtraUrban | form | string | Yes | |
EmissionUrban | form | string | Yes | |
EnergyEfficiencyClass | form | string | Yes | |
WLTPEmissionCombined | form | string | Yes | |
WLTPCombined | form | string | Yes | |
WLTPLow | form | string | Yes | |
WLTPMedium | form | string | Yes | |
WLTPHigh | form | string | Yes | |
WLTPExtraHigh | form | string | Yes | |
TotalMoneyOffersExclDiscretionary | form | decimal | No | |
DiscretionaryMoneyOffer | form | decimal | No | |
TotalMoneyOffersInclDiscretionary | form | decimal | No | |
NonDiscretionaryNMOCount | form | int | No | |
NonDiscretionaryMOCount | form | int | No | |
DiscretionaryNMOCount | form | int | No | |
DiscretionaryMOCount | form | int | No | |
TotalOfferVIPAmount | form | decimal | No | |
StockLevelIndicator | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/OnlineShowroom/Stock HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"gssns":["String"]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"totalVehicles":0,"vehicles":[{"commissionNumber":"String","description":"String","salesDescriptionLong":"String","model":"String","colour":"String","colourGroup":"String","fuelType":"String","transmission":"String","transmissionType":"String","packages":"String","lines":"String","upholstery":"String","upholsteryCode":"String","displayStockAgent":"String","location":"String","vin":"String","vid":"String","vehicleType":"String","vehicleClass":"String","creationDate":"\/Date(-62135596800000-0000)\/","lastUpdated":"\/Date(-62135596800000-0000)\/","productionDate":"\/Date(-62135596800000-0000)\/","portArrivalDate":"\/Date(-62135596800000-0000)\/","combinedGrossOfferValue":0,"currentLocation":"String","notVisibleOnlineShowroom":false,"nvosReason":"String","nvosReasonOneAdminExcluded":false,"nvosReasonLinkedToBackOrder":false,"includedAfterDeduplication":false,"unique":false,"duplicate":false,"duplicateGroup":0,"lowestComm":false,"rule":"String","fin":"String","chassisNumber":"String","modelYear":"String","modelYearCode":"String","halfModelYearCode":"String","fullModelYearCode":"String","bodyStyle":"String","engine":"String","cesarIdShipToParty":"String","vehicleUsageCode":"String","acceleration":0,"bootCapacity":0,"topSpeed":0,"driveConcept":"String","combustionPowerHp":0,"electricPowerKw":0,"electricPowerHp":0,"combinedPowerKw":0,"combinedPowerHP":0,"underOffer":false,"isSellable":false,"mbukSecured":false,"isDisplayStock":false,"isSpecialistCar":false,"account":"String","productRange":"String","isAMG":false,"actualPrice":0,"retailPrice_ExVAT":0,"retailPrice_IncVAT":0,"otr":0,"nst":"String","bm7NST":"String","electricRange":0,"electricConsumption":0,"emission":0,"emissionDirective":"String","emissionCombined":"String","emissionExtraUrban":"String","emissionUrban":"String","energyEfficiencyClass":"String","wltpEmissionCombined":"String","wltpCombined":"String","wltpLow":"String","wltpMedium":"String","wltpHigh":"String","wltpExtraHigh":"String","totalMoneyOffersExclDiscretionary":0,"discretionaryMoneyOffer":0,"totalMoneyOffersInclDiscretionary":0,"nonDiscretionaryNMOCount":0,"nonDiscretionaryMOCount":0,"discretionaryNMOCount":0,"discretionaryMOCount":0,"totalOfferVIPAmount":0,"stockLevelIndicator":"String"}]}