| POST | /v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} | Get all available vehicles |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Criteria | body | VehicleSearchV3Criteria | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| VehicleType | form | string | Yes | |
| IncludeBackOrderAccounts | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vin | form | string[] | Yes | |
| Model | form | int[] | Yes | |
| Fuel | form | int[] | Yes | |
| Transmission | form | int[] | Yes | |
| Engine | form | int[] | Yes | |
| Line | form | string[] | Yes | |
| MappedLine | form | int[] | Yes | |
| CommissionNumber | form | string[] | Yes | |
| VehicleType | form | string | Yes | |
| Exclusion | form | CampaignExclusion | Yes | |
| RegNo | form | string | Yes | |
| IncludeOffline | form | bool | No | |
| RegistrationDate | form | RegistrationDate | Yes | |
| Age | form | Age | Yes | |
| PortArrivalDate | form | PortArrivalDate | Yes | |
| IsAvailableOnline | form | bool? | No | |
| IsBackOrdered | form | bool? | No | |
| IsSellable | form | bool? | No | |
| IsUnderOffer | form | bool? | No | |
| MBUKSecured | form | bool? | No | |
| Account | form | string[] | Yes | |
| Baumuster | form | string[] | Yes | |
| Colours | form | int[] | Yes | |
| Upholstery | form | int[] | Yes | |
| Package | form | int[] | Yes | |
| NST | form | string[] | Yes | |
| UsageCode | form | string[] | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Vin | form | string[] | Yes | |
| CommissionNumber | form | string[] | Yes | |
| ModelYearCode | form | string | Yes | |
| EquipmentCode | form | string | Yes | |
| Gssn | form | string[] | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | form | DateTime | No | |
| To | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime | No | |
| Min | form | int | No | |
| Max | form | int | No | |
| IncludePipelineStock | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PipelineStock | form | bool | No | |
| From | form | DateTime | No | |
| To | form | DateTime | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TotalVehicles | form | int | No | |
| Vehicles | form | IEnumerable<BackOrderVehicle> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Vin | form | string | Yes | |
| VehicleType | form | string | Yes | |
| Vid | 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 | |
| SalesDescriptionLong | form | string | Yes | |
| VehicleClass | form | string | Yes | |
| RetailPrice_ExVAT | form | decimal | No | |
| RetailPrice_IncVAT | form | decimal | No | |
| OTR | form | decimal | No | |
| BodyStyle | form | string | Yes | |
| ProductRange | form | string | Yes | |
| Engine | form | string | Yes | |
| IsAMG | form | bool | No | |
| ColourGroup | form | string | Yes | |
| UpholsteryCode | form | string | Yes | |
| NST | form | string | Yes | |
| Bm7NST | 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 | |
| ElectricRange | form | decimal? | No | |
| ElectricConsumption | form | decimal? | No | |
| Emission | form | decimal? | No | |
| EmissionDirective | 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 | |
| ProductionDate | form | DateTime? | No | |
| PortArrivalDate | form | DateTime? | No | |
| CreationDate | form | DateTime | No | |
| LastUpdated | form | DateTime? | No | |
| IsDisplayStock | form | bool | No | |
| DisplayStockAgent | form | string | Yes | |
| IsSpecialistCar | form | bool | No | |
| Location | form | string | Yes | |
| CesarIdShipToParty | form | string | Yes | |
| IsSellable | form | bool | No | |
| UnderOffer | form | bool | No | |
| Baumuster | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CommissionNumber | form | string | Yes | |
| Description | form | string | Yes | |
| Model | form | string | Yes | |
| Colour | form | string | Yes | |
| FuelType | form | string | Yes | |
| Transmission | form | string | Yes | |
| Packages | form | string | Yes | |
| Lines | form | string | Yes | |
| Upholstery | form | string | Yes | |
| EmissionCombined | form | string | Yes | |
| ActualPrice | form | decimal | No | |
| UsageCode | form | string | Yes | |
| Secured | form | bool | No | |
| Account | form | string | Yes | |
| SecuredTime | form | string | No | |
| SecuredReason | form | string | No | |
| SecuredByGasId | form | string | No | |
| SecuredDate | form | DateTime? | No | |
| ConfirmedProductionDate | form | DateTime? | No | |
| ForecastedArrivalDate | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/AllAvailableVehicles/{vehicleType}/{includeBackOrderAccounts} HTTP/1.1
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
criteria:
{
vin:
[
String
],
model:
[
0
],
fuel:
[
0
],
transmission:
[
0
],
engine:
[
0
],
line:
[
String
],
mappedLine:
[
0
],
commissionNumber:
[
String
],
vehicleType: String,
exclusion:
{
vin:
[
String
],
commissionNumber:
[
String
],
modelYearCode: String,
equipmentCode: String,
gssn:
[
String
]
},
regNo: String,
includeOffline: False,
registrationDate:
{
from: 0001-01-01,
to: 0001-01-01
},
age:
{
date: 0001-01-01,
min: 0,
max: 0,
includePipelineStock: False
},
portArrivalDate:
{
pipelineStock: False,
from: 0001-01-01,
to: 0001-01-01
},
isAvailableOnline: False,
isBackOrdered: False,
isSellable: False,
isUnderOffer: False,
mbukSecured: False,
account:
[
String
],
baumuster:
[
String
],
colours:
[
0
],
upholstery:
[
0
],
package:
[
0
],
nst:
[
String
],
usageCode:
[
String
]
},
vehicleType: String,
includeBackOrderAccounts: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
totalVehicles: 0
}