VehicleLookupResultViewModel

The result of resolving loose make and model text into exact catalog values.

  • matches
    Type: array object[] | null · VehicleMatchViewModel[]

    Candidate vehicles, best first, up to five. Empty when nothing matched. Use make and model from a match verbatim in a plan search; the raw text you sent will usually be rejected.

    One candidate vehicle from a lookup, with how confident Chaiz is about it.

    • confidence
      Type: string | null

      How the match was made. HIGH is an exact match ignoring case. MEDIUM matched after normalizing punctuation, for example f150 to F-150. LOW is a partial match and should be confirmed by the customer rather than used automatically.

    • make
      Type: string | null

      Exact catalog make. Send this value in a plan search, not the customer's original text.

    • makeId
      Type: integer Format: int32

      Catalog identifier for the make. Use it with the models endpoint to list this make's models.

    • model
      Type: string | null

      Exact catalog model. Send this value in a plan search.

    • modelId
      Type: integer Format: int32

      Catalog identifier for the model.

    • year
      Type: integer | null Format: int32

      The year you asked about, echoed back. Null when you did not supply one.

    • yearsAvailable
      Type: array integer[] | null Format: int32

      Every model year Chaiz carries for this make and model. Check the customer's year appears here before searching; a year outside this list returns no plans.

  • suggestions
    Type: object · VehicleLookupSuggestionsViewModelnullable

    Guidance for when the input was ambiguous or unmatched. Null when the match was unambiguous.

    • alternativeModels
      Type: array string[] | null

      Alternative model names worth trying when the requested model did not match.

    • message
      Type: string | null

      Plain-language explanation of the ambiguity, suitable for showing to a customer.