Mercedes.VehicleManagement.API

<back to all web services

MotabilityVehiclesFilterRequest

Vehicle
Requires Authentication
The following routes are available for this service:
POST/v1/{VehicleType}/Vehicle/MotabilityFilter motability vehicle data
const std = @import("std");

pub const VehicleDataBase = struct {
    vin: ?[]const u8 = null,
    description: ?[]const u8 = null,
    model: ?[]const u8 = null,
    otr: ?[]const u8 = null,
    retailPriceExVAT: ?[]const u8 = null,
    actualPrice: ?[]const u8 = null,
    p11D: ?[]const u8 = null,
    fuelType: ?[]const u8 = null,
    transmission: ?[]const u8 = null,
    transmissionType: ?[]const u8 = null,
    colour: ?[]const u8 = null,
    colourCode: ?[]const u8 = null,
    colourDescription: ?[]const u8 = null,
    commissionNumber: ?[]const u8 = null,
    offerAvailable: bool = false,
    campaignDiscountOfferTotal: i32 = 0,
    campaignDiscountOfferTotalCurrent: i32 = 0,
    campaignDiscountOfferTotalPending: i32 = 0,
    campaignServiceOfferTotal: i32 = 0,
    campaignServiceOfferTotalCurrent: i32 = 0,
    campaignServiceOfferTotalPending: i32 = 0,
    campaignCustomOfferTotal: i32 = 0,
    campaignPersonalisedOfferTotalCurrent: i32 = 0,
    campaignPersonalisedOfferTotalPending: i32 = 0,
    campaignPersonalisedOfferTotal: i32 = 0,
    campaignCustomOfferTotalCurrent: i32 = 0,
    campaignCustomOfferTotalPending: i32 = 0,
    campaignOtherOfferTotal: i32 = 0,
    campaignOtherOfferTotalCurrent: i32 = 0,
    campaignOtherOfferTotalPending: i32 = 0,
    retailerDiscountOfferTotal: i32 = 0,
    retailerDiscountOfferTotalCurrent: i32 = 0,
    retailerDiscountOfferTotalPending: i32 = 0,
    retailerServiceOfferTotal: i32 = 0,
    retailerServiceOfferTotalCurrent: i32 = 0,
    retailerServiceOfferTotalPending: i32 = 0,
    retailerCustomOfferTotal: i32 = 0,
    retailerCustomOfferTotalCurrent: i32 = 0,
    retailerCustomOfferTotalPending: i32 = 0,
    retailerWarrantyOfferTotal: i32 = 0,
    retailerWarrantyOfferTotalCurrent: i32 = 0,
    retailerWarrantyOfferTotalPending: i32 = 0,
    retailerOfferTotal: i32 = 0,
    retailerOfferTotalCurrent: i32 = 0,
    retailerOfferTotalPending: i32 = 0,
    campaignOfferTotal: i32 = 0,
    campaignOfferTotalCurrent: i32 = 0,
    campaignOfferTotalPending: i32 = 0,
    campaignAndOfferTotal: i32 = 0,
    campaignAndOfferTotalCurrent: i32 = 0,
    campaignAndOfferTotalPending: i32 = 0,
    offerTotal: i32 = 0,
    offerTotalCurrent: i32 = 0,
    offerTotalPending: i32 = 0,
    creation: ?[]const u8 = null,
    modified: ?[]const u8 = null,
    electricRange: i32 = 0,
    electricConsumption: i32 = 0,
    portArrivalDate: ?[]const u8 = null,
    daysSincePortArrival: ?i32 = null,
    retailPriceIncVAT: f64 = 0,
    bodyStyle: ?[]const u8 = null,
    upholstery: ?[]const u8 = null,
    upholsteryCode: ?[]const u8 = null,
    upholsteryType: ?[]const u8 = null,
    packageNames: [][]const u8 = &.{},
    line: ?[]const u8 = null,
    mappedLine: ?[]const u8 = null,
    currentRetailerOfferPrice: f64 = 0,
    retailPrice: ?[]const u8 = null,
    vatQualifying: bool = false,
    retailerId: i32 = 0,
    gssnId: ?[]const u8 = null,
    noImage: bool = false,
    imageUrl: ?[]const u8 = null,
    isAvailableOnline: bool = false,
    isBackOrdered: bool = false,
    creationDate: ?[]const u8 = null,
    maintenanceDate: ?[]const u8 = null,
    registrationNumber: ?[]const u8 = null,
    registrationDate: ?[]const u8 = null,
    mileage: ?i32 = null,
    tradeInDate: ?[]const u8 = null,
    source: ?[]const u8 = null,
    vehicleType: ?[]const u8 = null,
    offerAmount: ?[]const u8 = null,
    offerExpiry: ?[]const u8 = null,
    activeOffers: []i32 = &.{},
    campaignMessagesTotal: i32 = 0,
    underOffer: bool = false,
    isDisplayStock: bool = false,
    displayRetailer: ?[]const u8 = null,
    displayRetailerGssnId: ?[]const u8 = null,
    location: ?[]const u8 = null,
    account: ?[]const u8 = null,
    accountType: ?[]const u8 = null,
    usageCode: ?[]const u8 = null,
    bm7NST: ?[]const u8 = null,
    isSellable: bool = false,
    secured: bool = false,
    specialist: bool = false,
    isMotabilityRetailer: bool = false,
    upholsteryDescription: ?[]const u8 = null,
    inBackOrderAccount: bool = false,
    fullModelYearCode: ?[]const u8 = null,
    baumuster: ?[]const u8 = null,
    isMotability: bool = false,
    pipAdvanceRentalGross: ?f64 = null,
    wpmsAdvanceRentalGross: ?f64 = null,
    ispVehicleCustomerDescriptions: ?[][]const u8 = null,
    eligibleForMaTransfer: bool = false,
    confirmedProductionDate: ?[]const u8 = null,
    forecastedArrivalDate: ?[]const u8 = null,
};

pub const VehicleData = struct {
    vin: ?[]const u8 = null,
    description: ?[]const u8 = null,
    model: ?[]const u8 = null,
    otr: ?[]const u8 = null,
    retailPriceExVAT: ?[]const u8 = null,
    actualPrice: ?[]const u8 = null,
    p11D: ?[]const u8 = null,
    fuelType: ?[]const u8 = null,
    transmission: ?[]const u8 = null,
    transmissionType: ?[]const u8 = null,
    colour: ?[]const u8 = null,
    colourCode: ?[]const u8 = null,
    colourDescription: ?[]const u8 = null,
    commissionNumber: ?[]const u8 = null,
    offerAvailable: bool = false,
    campaignDiscountOfferTotal: i32 = 0,
    campaignDiscountOfferTotalCurrent: i32 = 0,
    campaignDiscountOfferTotalPending: i32 = 0,
    campaignServiceOfferTotal: i32 = 0,
    campaignServiceOfferTotalCurrent: i32 = 0,
    campaignServiceOfferTotalPending: i32 = 0,
    campaignCustomOfferTotal: i32 = 0,
    campaignPersonalisedOfferTotalCurrent: i32 = 0,
    campaignPersonalisedOfferTotalPending: i32 = 0,
    campaignPersonalisedOfferTotal: i32 = 0,
    campaignCustomOfferTotalCurrent: i32 = 0,
    campaignCustomOfferTotalPending: i32 = 0,
    campaignOtherOfferTotal: i32 = 0,
    campaignOtherOfferTotalCurrent: i32 = 0,
    campaignOtherOfferTotalPending: i32 = 0,
    retailerDiscountOfferTotal: i32 = 0,
    retailerDiscountOfferTotalCurrent: i32 = 0,
    retailerDiscountOfferTotalPending: i32 = 0,
    retailerServiceOfferTotal: i32 = 0,
    retailerServiceOfferTotalCurrent: i32 = 0,
    retailerServiceOfferTotalPending: i32 = 0,
    retailerCustomOfferTotal: i32 = 0,
    retailerCustomOfferTotalCurrent: i32 = 0,
    retailerCustomOfferTotalPending: i32 = 0,
    retailerWarrantyOfferTotal: i32 = 0,
    retailerWarrantyOfferTotalCurrent: i32 = 0,
    retailerWarrantyOfferTotalPending: i32 = 0,
    retailerOfferTotal: i32 = 0,
    retailerOfferTotalCurrent: i32 = 0,
    retailerOfferTotalPending: i32 = 0,
    campaignOfferTotal: i32 = 0,
    campaignOfferTotalCurrent: i32 = 0,
    campaignOfferTotalPending: i32 = 0,
    campaignAndOfferTotal: i32 = 0,
    campaignAndOfferTotalCurrent: i32 = 0,
    campaignAndOfferTotalPending: i32 = 0,
    offerTotal: i32 = 0,
    offerTotalCurrent: i32 = 0,
    offerTotalPending: i32 = 0,
    creation: ?[]const u8 = null,
    modified: ?[]const u8 = null,
    electricRange: i32 = 0,
    electricConsumption: i32 = 0,
    portArrivalDate: ?[]const u8 = null,
    daysSincePortArrival: ?i32 = null,
    retailPriceIncVAT: f64 = 0,
    bodyStyle: ?[]const u8 = null,
    upholstery: ?[]const u8 = null,
    upholsteryCode: ?[]const u8 = null,
    upholsteryType: ?[]const u8 = null,
    packageNames: [][]const u8 = &.{},
    line: ?[]const u8 = null,
    mappedLine: ?[]const u8 = null,
    currentRetailerOfferPrice: f64 = 0,
    retailPrice: ?[]const u8 = null,
    vatQualifying: bool = false,
    retailerId: i32 = 0,
    gssnId: ?[]const u8 = null,
    noImage: bool = false,
    imageUrl: ?[]const u8 = null,
    isAvailableOnline: bool = false,
    isBackOrdered: bool = false,
    creationDate: ?[]const u8 = null,
    maintenanceDate: ?[]const u8 = null,
    registrationNumber: ?[]const u8 = null,
    registrationDate: ?[]const u8 = null,
    mileage: ?i32 = null,
    tradeInDate: ?[]const u8 = null,
    source: ?[]const u8 = null,
    vehicleType: ?[]const u8 = null,
    offerAmount: ?[]const u8 = null,
    offerExpiry: ?[]const u8 = null,
    activeOffers: []i32 = &.{},
    campaignMessagesTotal: i32 = 0,
    underOffer: bool = false,
    isDisplayStock: bool = false,
    displayRetailer: ?[]const u8 = null,
    displayRetailerGssnId: ?[]const u8 = null,
    location: ?[]const u8 = null,
    account: ?[]const u8 = null,
    accountType: ?[]const u8 = null,
    usageCode: ?[]const u8 = null,
    bm7NST: ?[]const u8 = null,
    isSellable: bool = false,
    secured: bool = false,
    specialist: bool = false,
    isMotabilityRetailer: bool = false,
    upholsteryDescription: ?[]const u8 = null,
    inBackOrderAccount: bool = false,
    fullModelYearCode: ?[]const u8 = null,
    baumuster: ?[]const u8 = null,
    isMotability: bool = false,
    pipAdvanceRentalGross: ?f64 = null,
    wpmsAdvanceRentalGross: ?f64 = null,
    ispVehicleCustomerDescriptions: ?[][]const u8 = null,
    eligibleForMaTransfer: bool = false,
    confirmedProductionDate: ?[]const u8 = null,
    forecastedArrivalDate: ?[]const u8 = null,
    engine: ?[]const u8 = null,
};

pub const Equipment = struct {
    id: ?i32 = null,
    code: ?[]const u8 = null,
    description: ?[]const u8 = null,
};

pub const VehicleIdentifierData = struct {
    vin: ?[]const u8 = null,
    description: ?[]const u8 = null,
    model: ?[]const u8 = null,
    otr: ?[]const u8 = null,
    retailPriceExVAT: ?[]const u8 = null,
    actualPrice: ?[]const u8 = null,
    p11D: ?[]const u8 = null,
    fuelType: ?[]const u8 = null,
    transmission: ?[]const u8 = null,
    transmissionType: ?[]const u8 = null,
    colour: ?[]const u8 = null,
    colourCode: ?[]const u8 = null,
    colourDescription: ?[]const u8 = null,
    commissionNumber: ?[]const u8 = null,
    offerAvailable: bool = false,
    campaignDiscountOfferTotal: i32 = 0,
    campaignDiscountOfferTotalCurrent: i32 = 0,
    campaignDiscountOfferTotalPending: i32 = 0,
    campaignServiceOfferTotal: i32 = 0,
    campaignServiceOfferTotalCurrent: i32 = 0,
    campaignServiceOfferTotalPending: i32 = 0,
    campaignCustomOfferTotal: i32 = 0,
    campaignPersonalisedOfferTotalCurrent: i32 = 0,
    campaignPersonalisedOfferTotalPending: i32 = 0,
    campaignPersonalisedOfferTotal: i32 = 0,
    campaignCustomOfferTotalCurrent: i32 = 0,
    campaignCustomOfferTotalPending: i32 = 0,
    campaignOtherOfferTotal: i32 = 0,
    campaignOtherOfferTotalCurrent: i32 = 0,
    campaignOtherOfferTotalPending: i32 = 0,
    retailerDiscountOfferTotal: i32 = 0,
    retailerDiscountOfferTotalCurrent: i32 = 0,
    retailerDiscountOfferTotalPending: i32 = 0,
    retailerServiceOfferTotal: i32 = 0,
    retailerServiceOfferTotalCurrent: i32 = 0,
    retailerServiceOfferTotalPending: i32 = 0,
    retailerCustomOfferTotal: i32 = 0,
    retailerCustomOfferTotalCurrent: i32 = 0,
    retailerCustomOfferTotalPending: i32 = 0,
    retailerWarrantyOfferTotal: i32 = 0,
    retailerWarrantyOfferTotalCurrent: i32 = 0,
    retailerWarrantyOfferTotalPending: i32 = 0,
    retailerOfferTotal: i32 = 0,
    retailerOfferTotalCurrent: i32 = 0,
    retailerOfferTotalPending: i32 = 0,
    campaignOfferTotal: i32 = 0,
    campaignOfferTotalCurrent: i32 = 0,
    campaignOfferTotalPending: i32 = 0,
    campaignAndOfferTotal: i32 = 0,
    campaignAndOfferTotalCurrent: i32 = 0,
    campaignAndOfferTotalPending: i32 = 0,
    offerTotal: i32 = 0,
    offerTotalCurrent: i32 = 0,
    offerTotalPending: i32 = 0,
    creation: ?[]const u8 = null,
    modified: ?[]const u8 = null,
    electricRange: i32 = 0,
    electricConsumption: i32 = 0,
    portArrivalDate: ?[]const u8 = null,
    daysSincePortArrival: ?i32 = null,
    retailPriceIncVAT: f64 = 0,
    bodyStyle: ?[]const u8 = null,
    upholstery: ?[]const u8 = null,
    upholsteryCode: ?[]const u8 = null,
    upholsteryType: ?[]const u8 = null,
    packageNames: [][]const u8 = &.{},
    line: ?[]const u8 = null,
    mappedLine: ?[]const u8 = null,
    currentRetailerOfferPrice: f64 = 0,
    retailPrice: ?[]const u8 = null,
    vatQualifying: bool = false,
    retailerId: i32 = 0,
    gssnId: ?[]const u8 = null,
    noImage: bool = false,
    imageUrl: ?[]const u8 = null,
    isAvailableOnline: bool = false,
    isBackOrdered: bool = false,
    creationDate: ?[]const u8 = null,
    maintenanceDate: ?[]const u8 = null,
    registrationNumber: ?[]const u8 = null,
    registrationDate: ?[]const u8 = null,
    mileage: ?i32 = null,
    tradeInDate: ?[]const u8 = null,
    source: ?[]const u8 = null,
    vehicleType: ?[]const u8 = null,
    offerAmount: ?[]const u8 = null,
    offerExpiry: ?[]const u8 = null,
    activeOffers: []i32 = &.{},
    campaignMessagesTotal: i32 = 0,
    underOffer: bool = false,
    isDisplayStock: bool = false,
    displayRetailer: ?[]const u8 = null,
    displayRetailerGssnId: ?[]const u8 = null,
    location: ?[]const u8 = null,
    account: ?[]const u8 = null,
    accountType: ?[]const u8 = null,
    usageCode: ?[]const u8 = null,
    bm7NST: ?[]const u8 = null,
    isSellable: bool = false,
    secured: bool = false,
    specialist: bool = false,
    isMotabilityRetailer: bool = false,
    upholsteryDescription: ?[]const u8 = null,
    inBackOrderAccount: bool = false,
    fullModelYearCode: ?[]const u8 = null,
    baumuster: ?[]const u8 = null,
    isMotability: bool = false,
    pipAdvanceRentalGross: ?f64 = null,
    wpmsAdvanceRentalGross: ?f64 = null,
    ispVehicleCustomerDescriptions: ?[][]const u8 = null,
    eligibleForMaTransfer: bool = false,
    confirmedProductionDate: ?[]const u8 = null,
    forecastedArrivalDate: ?[]const u8 = null,
    engine: ?[]const u8 = null,
    retailer: ?[]const u8 = null,
    hasMotabilityError: bool = false,
    equipment: []Equipment = &.{},
    vehicleClass: ?[]const u8 = null,
};

pub const VehiclesByRetailerResponse = struct {
    vehicles: []VehicleIdentifierData = &.{},
};

pub const MotabilityVehiclesFilterRequest = struct {
    min: i32 = 0,
    max: i32 = 0,
    noPortArrivalDate: bool = false,
    vehicleType: ?[]const u8 = null,
};

Zig MotabilityVehiclesFilterRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/{VehicleType}/Vehicle/Motability HTTP/1.1 
Host: uat-api-vehicle-mgt-mb-dhc.rapp-customers.co.uk 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"min":0,"max":0,"noPortArrivalDate":false,"vehicleType":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"vehicles":[{"retailer":"String","hasMotabilityError":false,"equipment":[{"id":0,"code":"String","description":"String"}],"vehicleClass":"String","engine":"String","vin":"String","description":"String","model":"String","otr":"String","retailPriceExVAT":"String","actualPrice":"String","p11D":"String","fuelType":"String","transmission":"String","transmissionType":"String","colour":"String","colourCode":"String","colourDescription":"String","commissionNumber":"String","offerAvailable":false,"campaignDiscountOfferTotal":0,"campaignDiscountOfferTotalCurrent":0,"campaignDiscountOfferTotalPending":0,"campaignServiceOfferTotal":0,"campaignServiceOfferTotalCurrent":0,"campaignServiceOfferTotalPending":0,"campaignCustomOfferTotal":0,"campaignPersonalisedOfferTotalCurrent":0,"campaignPersonalisedOfferTotalPending":0,"campaignPersonalisedOfferTotal":0,"campaignCustomOfferTotalCurrent":0,"campaignCustomOfferTotalPending":0,"campaignOtherOfferTotal":0,"campaignOtherOfferTotalCurrent":0,"campaignOtherOfferTotalPending":0,"retailerDiscountOfferTotal":0,"retailerDiscountOfferTotalCurrent":0,"retailerDiscountOfferTotalPending":0,"retailerServiceOfferTotal":0,"retailerServiceOfferTotalCurrent":0,"retailerServiceOfferTotalPending":0,"retailerCustomOfferTotal":0,"retailerCustomOfferTotalCurrent":0,"retailerCustomOfferTotalPending":0,"retailerWarrantyOfferTotal":0,"retailerWarrantyOfferTotalCurrent":0,"retailerWarrantyOfferTotalPending":0,"retailerOfferTotal":0,"retailerOfferTotalCurrent":0,"retailerOfferTotalPending":0,"campaignOfferTotal":0,"campaignOfferTotalCurrent":0,"campaignOfferTotalPending":0,"campaignAndOfferTotal":0,"campaignAndOfferTotalCurrent":0,"campaignAndOfferTotalPending":0,"offerTotal":0,"offerTotalCurrent":0,"offerTotalPending":0,"creation":"String","modified":"String","electricRange":0,"electricConsumption":0,"portArrivalDate":"\/Date(-62135596800000-0000)\/","daysSincePortArrival":0,"retailPriceIncVAT":0,"bodyStyle":"String","upholstery":"String","upholsteryCode":"String","upholsteryType":"String","packageNames":["String"],"line":"String","mappedLine":"String","currentRetailerOfferPrice":0,"retailPrice":"String","vatQualifying":false,"retailerId":0,"gssnId":"String","noImage":false,"imageUrl":"String","isAvailableOnline":false,"isBackOrdered":false,"creationDate":"String","maintenanceDate":"String","registrationNumber":"String","registrationDate":"\/Date(-62135596800000-0000)\/","mileage":0,"tradeInDate":"\/Date(-62135596800000-0000)\/","source":"String","vehicleType":"String","offerAmount":"String","offerExpiry":"String","activeOffers":[0],"campaignMessagesTotal":0,"underOffer":false,"isDisplayStock":false,"displayRetailer":"String","displayRetailerGssnId":"String","location":"String","account":"String","accountType":"String","usageCode":"String","bm7NST":"String","isSellable":false,"secured":false,"specialist":false,"isMotabilityRetailer":false,"upholsteryDescription":"String","inBackOrderAccount":false,"fullModelYearCode":"String","baumuster":"String","isMotability":false,"pipAdvanceRentalGross":0,"wpmsAdvanceRentalGross":0,"ispVehicleCustomerDescriptions":["String"],"eligibleForMaTransfer":false,"confirmedProductionDate":"String","forecastedArrivalDate":"String"}]}