Car Inventory Search (Make, Model, Year & ZIP)

{
  "type": "object",
  "required": [
    "zip",
    "make",
    "model"
  ],
  "properties": {
    "zip": {
      "type": "string",
      "description": "5-digit US ZIP code for location-based search."
    },
    "make": {
      "type": "string",
      "description": "Car make niceName slug (e.g. honda, toyota, bmw). Use values from get_makes endpoint."
    },
    "year": {
      "type": "string",
      "description": "Model year (e.g. 2020, 2021)."
    },
    "model": {
      "type": "string",
      "description": "Car model niceName slug (e.g. civic, camry, 3-series)."
    },
    "condition": {
      "type": "string",
      "description": "Vehicle condition: used or new."
    }
  },
  "additionalProperties": false
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "count": {
          "type": "number",
          "description": "Number of listings included in this response -- 21 and 0 observed."
        },
        "total": {
          "type": "number",
          "description": "Total number of listings matching the search criteria, which can exceed `count` (2701 total vs. 21 returned on the Honda Civic fixture) -- this endpoint returns a single page of up to 21 listings, not the full match set."
        },
        "listings": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "vin": {
                "type": "string",
                "description": "The vehicle's VIN."
              },
              "make": {
                "type": "string"
              },
              "trim": {
                "type": "string"
              },
              "type": {
                "type": "string",
                "description": "e.g. 'USED'."
              },
              "year": {
                "type": "number"
              },
              "model": {
                "type": "string"
              },
              "price": {
                "type": "number",
                "description": "Listed price in USD."
              },
              "usage": {
                "type": "string",
                "description": "e.g. 'Personal Use', 'Lease', 'Corporate Fleet', 'Rental Use'."
              },
              "dealer": {
                "type": "object",
                "properties": {
                  "city": {
                    "type": "string"
                  },
                  "name": {
                    "type": "string"
                  },
                  "state": {
                    "type": "string"
                  },
                  "distance": {
                    "type": "number",
                    "description": "Miles from the searched ZIP code."
                  }
                },
                "description": "The selling dealership's own public business listing -- not a private individual.",
                "additionalProperties": true
              },
              "owners": {
                "type": "string",
                "description": "Prior-owner count as a string, e.g. '1', '4'."
              },
              "mileage": {
                "type": "number"
              },
              "bodyType": {
                "type": "string",
                "description": "e.g. 'Sedan', 'Hatchback'."
              },
              "fuelType": {
                "type": "string"
              },
              "accidents": {
                "type": "string",
                "description": "A count as a string, e.g. '0', '1' -- not a numeric type on any real listing observed."
              },
              "cylinders": {
                "type": "number"
              },
              "driveType": {
                "type": "string",
                "description": "e.g. 'front wheel drive'."
              },
              "dealRating": {
                "type": "string",
                "description": "Edmunds' own deal-quality label, e.g. 'Great', 'Good', 'Fair'."
              },
              "engineSize": {
                "type": "number",
                "description": "Liters."
              },
              "stockNumber": {
                "type": "string",
                "description": "The selling dealer's internal stock number."
              },
              "transmission": {
                "type": "string"
              },
              "exteriorColor": {
                "type": [
                  "string",
                  "null"
                ],
                "description": "Observed null on at least one real listing when no color was supplied."
              },
              "interiorColor": {
                "type": "string"
              }
            },
            "additionalProperties": true
          },
          "description": "One entry per matching vehicle, 0 to 21 observed. Empty when nothing currently in dealer inventory matches the search."
        }
      },
      "additionalProperties": true
    },
    "status": {
      "type": "string",
      "description": "'success' on both real calls observed, including the zero-match case."
    }
  },
  "description": "The inventory search result, as returned at routing.responseResultPath ($.output).",
  "additionalProperties": true
}