Function useSearchSuggestions

  • Provides keyword search functionality for products, categories, and brands suggestions.

    Returns suggested products, suggested categories, and suggested brands for the given search phrase.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              currency?: string;
              expand?: GetSearchSuggestionsExpandEnum[];
              includeEinsteinSuggestedPhrases?: boolean;
              includedCustomProductProperties?: string[];
              limit?: number;
              locale?: string;
              organizationId?: string;
              q?: string;
              siteId?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<SuggestionResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : SuggestionResult>;
      }> = {}

    Returns UseQueryResult<SuggestionResult, unknown>

    A TanStack Query query hook with data from the Shopper Search getSearchSuggestions endpoint.

    Parameter

    apiOptions - Options to pass through to commerce-sdk-isomorphic, with null accepted for unset API parameters.

    Parameter

    queryOptions - TanStack Query query options, with enabled by default set to check that all required API parameters have been set.

    See

Settings

Member Visibility

Theme