PartnerMakeModelYearPlanSearchRequest

Search for vehicle protection plans using Make, Model, and Year. Use this when VIN or license plate is not available.

  • searchCriteria
    Type: object · MakeModelYearSearchCriteria
    required

    Search criteria using vehicle Make, Model, and Year. All three fields (make, model, year) are required together.

    • make
      Type: string
      required

      Vehicle manufacturer (e.g., "Toyota", "Ford", "Honda"). Required.

    • model
      Type: string
      required

      Vehicle model name (e.g., "Camry", "F-150", "Civic"). Required.

    • year
      Type: integerFormat: int32
      min:  
      1999
      max:  
      2030
      required

      Vehicle model year (e.g., 2020). Required. Must be within the last 25 years and not in the future.

    • mileage
      Type: integerFormat: int32

      Current vehicle odometer reading in miles. Required. Must be between 1 and 250,000.

    • stateShortName
      Type: string | null

      Two-letter US state code (e.g., "NY", "CA", "TX"). Required if zip is not provided.

    • zip
      Type: string | null

      5-digit US ZIP code. Required if stateShortName is not provided. ZIP takes precedence over state for location-based pricing.

  • filters
    Type: object · PlanSearchFilters nullable

    Optional filters to narrow down plan search results. All filters are optional - if not specified, all matching plans are returned.

    • categoryTypes
      Type: array string[] | null

      Filter by component coverage categories. Only returns plans that cover specified categories. Values: "Engine", "TurboSuper", "TransferCase", "Steering", "Transmission", "DriveAxle", "Suspension", "AirCon", "Brakes", "Electricals", "Cooling", "Fuel", "Hybrid", "Body", "Consumables", "Exhaust", "General", "Interior", "Services", "Assist"

    • coverageType
      Type: string · CoverageTypeEnumenum nullable

      Possible values: None (0) - None, Powertrain (1) - Powertrain, PowertrainPlus (2) - PowertrainPlus, MostComprehensive (3) - MostComprehensive

      values
      • None
      • Powertrain
      • PowertrainPlus
      • MostComprehensive
    • coverageTypes
      Type: array string[] | null

      Filter by multiple coverage types simultaneously. Values: "basic" (Basic), "basicplus" (Basic Plus), "best" (Best/Exclusionary)

    • duration
      Type: object · Int32Range nullable

      Defines a range filter with lower and upper bounds.

    • excludeProviders
      Type: array string[] | null

      Exclude specific providers from the results. Useful when you want all providers except certain ones.

    • miles
      Type: object · Int32Range nullable

      Defines a range filter with lower and upper bounds.

    • monthlyPrice
      Type: object · DoubleRange nullable

      Defines a range filter with lower and upper bounds.

    • numberOfProviders
      Type: integer | nullFormat: int32

      Limit the number of unique providers in the results. For example, set to 3 to get plans from at most 3 different providers.

    • planChaizRating
      Type: object · DecimalRange nullable

      Defines a range filter with lower and upper bounds.

    • providers
      Type: array string[] | null

      Filter results to only include plans from specific providers. Use provider names like "NAAC", "Omega", "CAPS", "ServiceContract".

    • returnResults
      Type: integerFormat: int32

      Maximum number of plan results to return. Default varies by partner configuration.

    • totalPrice
      Type: object · DoubleRange nullable

      Defines a range filter with lower and upper bounds.

  • partner
    Type: string | null

    Your unique partner identifier provided during onboarding. Must match the partner identity in your authentication token.

  • searchId
    Type: string | nullFormat: uuid

    Optional. Return cached results from a previous search. Useful for pagination or retrieving the same results without re-executing the search.

  • showProviderInfo
    Type: boolean

    When true, includes detailed provider information in the response. Default is false.

  • tracking
    Type: object · PlanSearchTracking nullable

    UTM parameters and referrer information for tracking partner searches.

    • queryParams
      Type: string | null

      UTM parameters to append to partner URLs (e.g., "utm_source=partner&utm_medium=api"). These parameters will be included in checkout and plan summary URLs.

    • referrer
      Type: string | null

      Referrer URL for tracking the source of the search request.

  • userId
    Type: string | nullFormat: uuid

    Optional. Associate this search with a specific user ID for tracking purposes. If provided, the search results will be linked to this user.