PartnerVinPlanSearchRequestErrorsResponseWrapper

  • errorResponse
    Type: object · ErrorsResponse nullable
    • errors
      Type: array object[] | null · ErrorResponse[]
  • response
    Type: object · PartnerVinPlanSearchRequest nullable

    Search for vehicle protection plans using a Vehicle Identification Number (VIN). The VIN is decoded to retrieve vehicle details (make, model, year) automatically.

    • searchCriteria
      Type: object · VinSearchCriteria
      required

      Search criteria using Vehicle Identification Number (VIN). VIN is decoded to retrieve vehicle details automatically.

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

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

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