Fleet Remarketing External API (0.0.1)

Download OpenAPI specification:Download

Ana Costa: ana.costa@finn.com URL: https://finn-mobility.slack.com/team/U04PLDDE4AC

The Fleet Remarketing External API it's a set of services to share our data with interested external partners

Cars

Operations related to cars

List car inventory by filter

Lists all car inventory for remarketing that meets the filter criteria. You can use a range of filters on the list returned, including filtering by:

  • Brand name
  • Color
  • Expected return date
  • Model name
  • Vehicle identification number (VIN)
  • Model Year
  • Configuration ID
  • Trim
  • Registration Dates
  • Engine
  • Latest Mileages
  • Fuel
  • Co2 emission
  • Car lifecycle status

You can also apply sorting on the list returned by the following properties:

  • Expected return date
  • Date First Registration
  • Damage Deductible
  • Latest Mileage
  • Brand Name
  • Model Name
  • Vin
  • Location Name
  • Color
  • Trim
  • Engine
  • Latest Mileage
  • Shift
  • Fuel Name
  • Model Year
  • Offer Statuses
SecurityApiKeyAuth and Actor and BearerAuth
Request
query Parameters
brandNames
string

Filter by Brand names

Example: brandNames=Tesla,Audi
modelNames
string

Filter by Model names

Example: modelNames=Grand Cherokee L,C5 Aircross
colorName
string

Filter by Color

Example: colorName=Diamond Black Crystal Pearl Coat
expectedReturnDate
string

Filter by Expected Return Date date range. Can filter by initial or end date, or date range.

Example: expectedReturnDate=\%2023-10-30
vins
Array of strings

Filter by multple VINs, This filter takes the next precedence after finnCarIds.

Example: vins=VXKUPHNKSM4280660,VXKUPHNKSM4280661
trim
string

Filter by Trim

Example: trim=LT
registrationDate
string

Filter by Registration Dates date range. Can filter by initial or end date, or date range.

Example: registrationDate=2023-01-30%2023-10-30
engine
string

Filter by Engine

Example: engine=1.2 Turbo
shift
string

Filter by Gear

Example: shift=Automatic
latestMileage
string

Filter by latest mileages range. Can filter by initial or end mileage, or mileage range.

Example: latestMileage=10000%15000
fuelName
string

Filter by Fuel Type

Example: fuelName=Diesel
modelYear
number

Filter by Model Year

Example: modelYear=2023
co2Emission
string

Filter by co2Emission range. Can filter by initial or end co2Emission, or co2Emission range.

Example: co2Emission=100%150
offerStatuses
string

Filter by offer statuses

Example: offerStatuses=open,lost
sortBy
string

Sort by a property, add (-) in front of the property to sort descending

Enum: "expectedDefleetingDate" "dateFirstRegistration" "damageDeductible" "latestMileage" "brandName" "modelName" "vin" "locationName" "defleetingCompound" "color" "trim" "engine" "signedBy" "shift" "fuelName" "tcoTiresPlanned" "modelYear"
Example: sortBy=-expectedDefleetingDate
currentPage
integer

The current page of the list, for pagination purposes. Defaults to 1

perPage
integer

The amount of items per page, for pagination purposes. Defaults to 25

Responses
200

Inventory

400

Invalid operation params

403

Action on operation denied

500

Internal error

get/cars
Request samples 
Response samples 
application/json
{
  • "inventory": [
    ],
  • "pagination": {
    }
}
Gets all configuration information available for a specific car.
SecurityApiKeyAuth and Actor and BearerAuth 
Request 
path Parameters
finnCarId
required
string
 
 Example:  34nk23on
Responses 
200
CarConfiguration


400
Invalid operation params


403
Action on operation denied


404
Resource not found


500
Internal error


get/cars/{finnCarId}
Request samples 
Response samples 
application/json
{
  • "data": {
    }
}