PartnerLicensePlatePlanSearchRequestErrorsResponseWrapper

  • errorResponse
    Type: object · ErrorsResponsenullable

    The problems, when the call failed. null on success.

    Check this before reading response. Note that a 2xx status does not guarantee this is null: order creation returns 200 with this populated when the order was not created.

    • errors
      Type: array object[] | null · ErrorResponse[]

      Every problem found with the request. A single call can report several at once, so read the whole array rather than only the first entry.

      A single problem with a request. Errors arrive as an array under errorResponse.errors.

  • response
    Type: object · PartnerLicensePlatePlanSearchRequestnullable

    The payload, when the call succeeded. null when errorResponse is populated.

    • searchCriteria
      Type: object · LicensePlateSearchCriteria
      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).

    • filters
      Type: object · PlanSearchFiltersnullable

      Optional filters to narrow down search results by provider, coverage type, price, duration, etc. If not provided, 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 · ResponseDetailLevelEnumenumnullable

      Optional. How much detail the response carries. Defaults to Full, which is the response shape documented for the 200 on these endpoints.

      Set to Essential for a much smaller payload aimed at lightweight integrations, LLMs, and agents. Each result then keeps only what you need to compare plans, pick one, and send the customer to checkout:

      searchResultPlanId, planId, totalPrice, downpayment, monthlyPrice, duration, deductible, miles, planName, displayProviderName, coverageType, planChaizRating, planRatingVerdict, planHighlights, resultLabels, recommendationSummary, planSummaryUrl, and planCheckoutUrl.

      Dropped in Essential: the coverage breakdown, per-component scores, add-ons, provider detail, payment-option discounts, and planContractUrl. If you need any of those, stay on Full.

      values
      • Full
      • Essential
    • resultOrder
      Type: string · ResultOrderEnumenumnullable

      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.

      values
      • Recommended
      • Rating
      • None
    • searchId
      Type: string | null Format: 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 · PlanSearchTrackingnullable

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

    • userId
      Type: string | null Format: uuid

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