# 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

Endpoint: GET /cars
Version: 0.0.1
Security: ApiKeyAuth, Actor, BearerAuth

## Query parameters:

  - `brandNames` (string)
    Filter by Brand names
    Example: "Tesla,Audi"

  - `modelNames` (string)
    Filter by Model names
    Example: "Grand Cherokee L,C5 Aircross"

  - `colorName` (string)
    Filter by Color
    Example: "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: "\\%2023-10-30"

  - `vins` (array)
    Filter by multple VINs, This filter takes the next precedence after finnCarIds.
    Example: "VXKUPHNKSM4280660,VXKUPHNKSM4280661"

  - `trim` (string)
    Filter by Trim
    Example: "LT"

  - `registrationDate` (string)
    Filter by Registration Dates date range. Can filter by initial or end date, or date range.
    Example: "2023-01-30%2023-10-30"

  - `engine` (string)
    Filter by Engine
    Example: "1.2 Turbo"

  - `shift` (string)
    Filter by Gear
    Example: "Automatic"

  - `latestMileage` (string)
    Filter by latest mileages range. Can filter by initial or end mileage, or mileage range.
    Example: "10000%15000"

  - `fuelName` (string)
    Filter by Fuel Type
    Example: "Diesel"

  - `modelYear` (number)
    Filter by Model Year
    Example: 2023

  - `co2Emission` (string)
    Filter by co2Emission range. Can filter by initial or end co2Emission, or co2Emission range.
    Example: "100%150"

  - `offerStatuses` (string)
    Filter by offer statuses
    Example: "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"

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

## Response 200 fields (application/json):

  - `inventory` (array)

  - `inventory.finn_car_id` (string, required)
    Example: "abc123"

  - `inventory.config_id` (integer, required)
    Example: 100

  - `inventory.brand_name` (string, required)
    Example: "Jeep"

  - `inventory.model_name` (string, required)
    Example: "Grand Cherokee L"

  - `inventory.vin` (string, required)
    Example: "ABC123456789"

  - `inventory.model_year` (integer,null)
    Example: 2022

  - `inventory.location_name` (integer,null)
    Location where the car is
    Example: "compound_glovis_philadelphia"

  - `inventory.color` (string,null)
    Example: "Diamond Black Crystal Pearl Coat"

  - `inventory.trim` (string,null)
    Example: "Laredo"

  - `inventory.engine` (string,null)
    Example: "3.6L V6"

  - `inventory.car_lifecycle_status` (string,null)
    Enum: "ordered", "produced", "arrived_from_supplier", "in_technical_preparations", "ready_to_deliver", "in_subscription", "returned", "in_repossession_process", "in_defleeting_preparations", "ready_to_defleet", "defleeted", "cancelled"

  - `inventory.msrp_incl_options_net` (number,null)
    Example: 46675

  - `inventory.date_first_registration` (string,null)
    Example: "2022-10-10"

  - `inventory.latest_mileage` (integer,null)

  - `inventory.shift` (string,null)
    Example: "A"

  - `inventory.fuel_name` (string,null)
    Example: "Elektro"

  - `inventory.power` (integer,null)
    Example: 378

  - `inventory.has_hitch` (boolean,null)
    Example: true

  - `inventory.tco_tires_planned` (string,null)
    Example: "all-season"

  - `inventory.expected_defleeting_date` (string,null)
    Example: "2022-10-10"

  - `inventory.tco_purchase_price_final_incl_bafa_net` (number,null)
    Example: 16197.4

  - `inventory.model_body_type` (string,null)
    Example: "SUV"

  - `inventory.deregistration_date` (string)
    Example: "2022-12-19"

  - `inventory.offers` (array)
    Array of offers for this car

  - `inventory.offers.offer_id` (integer)
    Example: 1

  - `inventory.offers.offer_status` (string)
    Enum: "open", "agreed", "signed", "lost", "invalid"

  - `inventory.offers.partner_name` (string)
    Example: "Walser"

  - `inventory.offers.clearing_sales_amount` (number,null)
    Example: 899.99

  - `inventory.offers.start_datetime` (string,null)
    Example: "2022-10-10"

  - `inventory.offers.end_datetime` (string,null)
    Example: "2022-10-10"

  - `inventory.end_location` (string,null)
    Example: "AKB Dortmund"

  - `inventory.damage_deductible` (number)
    Example: 5000

  - `inventory.expected_return_mileage` (integer,null)
    Example: 8500

  - `inventory.drive` (string)
    Example: "four_wheel_drive"

  - `inventory.co2_emission` (number,null)
    Example: 62

  - `pagination` (object)

  - `pagination.current_page` (integer, required)
    Example: 1

  - `pagination.last_page` (integer, required)
    Example: 2

  - `pagination.per_page` (integer, required)
    Example: 25

  - `pagination.total` (integer, required)
    Example: 26

## Response 400 fields (application/json):

  - `message` (string, required)
    Example: "bad request"

## Response 403 fields (application/json):

  - `message` (string, required)
    Example: "Forbidden to continue"

## Response 500 fields (application/json):

  - `message` (string, required)
    Example: "internal error"