Function usePublicProductListsBySearchTerm

  • Retrieves all public product lists as defined by the given search term (for example, email OR first name and last name).

    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

    Parameters

    • apiOptions: NullableParameters<{
          headers?: {
              [key: string]: string;
          };
          parameters?: {
              email?: string;
              firstName?: string;
              lastName?: string;
              organizationId?: string;
              siteId?: string;
          };
      }>
    • queryOptions: ApiQueryOptions<{
          (options?): Promise<PublicProductListResult>;
          <T>(options?, rawResponse?): Promise<T extends true
              ? Response
              : PublicProductListResult>;
      }> = {}

    Returns UseQueryResult<PublicProductListResult, unknown>

    A TanStack Query query hook with data from the Shopper Customers getPublicProductListsBySearchTerm endpoint.

Settings

Member Visibility

Theme