Function useProductSearch

  • Provides keyword and refinement search functionality for products.

    Only returns the product ID, link, and name in the product search hit. The search result contains only products that are online and assigned to site catalog.

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              allImages?: boolean;
              allVariationProperties?: boolean;
              currency?: string;
              expand?: ProductSearchExpandEnum[];
              includedCustomVariationProperties?: string[];
              limit?: number;
              locale?: string;
              offset?: number;
              organizationId?: string;
              perPricebook?: boolean;
              q?: string;
              refine?: string;
              select?: string;
              siteId?: string;
              sort?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<ProductSearchResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : ProductSearchResult>;
      }> = {}

    Returns UseQueryResult<ProductSearchResult, unknown>

    A TanStack Query query hook with data from the Shopper Search productSearch 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