PartnerVinPlanSearchWithUserInfoModelErrorsResponseWrapper

  • errorResponse
    Type: object · ErrorsResponse nullable
    • errors
      Type: array object[] | null · ErrorResponse[]
  • response
    Type: object · PartnerVinPlanSearchWithUserInfoModel nullable
    • searchCriteria
      Type: object · VinSearchCriteriaWithUserInfo
      required

      Vehicle information used to search for available protection plans. Required. The fields within depend on the search type (VIN, Make/Model/Year, or License Plate).

      VIN search criteria with pre-registered user information. Used when customer details have already been collected.

    • userDetails
      Type: object · UserDetailsModel
      required

      Customer billing and contact information for account creation. If the email already exists, the user profile is updated with any new information provided.

    • filters
      Type: object · PlanSearchFilters nullable

      Optional filters to narrow down search results by provider, coverage type, price, duration, etc. If not provided, all matching plans are returned.

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

    • partner
      Type: string | null

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

    • responseDetailLevel
      Type: string · ResponseDetailLevelEnumenum nullable

      Optional. Controls how much detail the response contains. Use "essential" for a lean payload optimized for LLM and agent consumption; omit (or "full") to receive the complete response.

      Possible values: Full (0) - Full, Essential (1) - Essential

      values
      • Full
      • Essential
    • resultOrder
      Type: string · ResultOrderEnumenum nullable

      Optional. Controls how the result list is ordered. "recommended" sorts by Chaiz recommendation score, "rating" by Chaiz plan rating, "none" preserves natural order. When omitted, the existing default ordering is used.

      Possible values: Recommended (0) - Recommended, Rating (1) - Rating, None (2) - None

      values
      • Recommended
      • Rating
      • None
    • 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

      Optional UTM parameters and referrer for tracking purposes. Parameters are appended to checkout and summary URLs.

      UTM parameters and referrer information for tracking partner searches.

    • 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.