ChemPal Documentation - v0.0.13-beta.5
    Preparing search index...

    Interface QueryParams

    Represents the query parameters for a Searchanise search request. Controls search behavior and result formatting.

    const params: QueryParams = {
      api_key: "shop_api_key_123",
      q: "sodium chloride",
      maxResults: 20,
      items: true,
      pages: false,
      output: "json"
    };
    interface QueryParams {
        api_key: string;
        q: string;
        maxResults?: number;
        startIndex?: number;
        items?: boolean;
        pages?: boolean;
        facets?: boolean;
        categories?: boolean;
        suggestions?: boolean;
        vendors?: boolean;
        tags?: boolean;
        pageStartIndex?: number;
        pagesMaxResults?: number;
        categoryStartIndex?: number;
        categoriesMaxResults?: number;
        suggestionsMaxResults?: number;
        vendorsMaxResults?: number;
        tagsMaxResults?: number;
        output?: string;
        _: number;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    api_key q maxResults? startIndex? items? pages? facets? categories? suggestions? vendors? tags? pageStartIndex? pagesMaxResults? categoryStartIndex? categoriesMaxResults? suggestionsMaxResults? vendorsMaxResults? tagsMaxResults? output? _

    Properties

    api_key: string

    API key for authentication. Required for accessing the Searchanise API.

    "shop_api_key_123"
    q: string

    Search query string. Terms to search for in products, categories, and pages.

    "sodium chloride"
    maxResults?: number

    Maximum number of results to return. Limits total result set size.

    20
    startIndex?: number

    Starting index for results. Zero-based index for pagination.

    0
    items?: boolean

    Whether to include items in results. Controls product inclusion in response.

    true
    pages?: boolean

    Whether to include pages in results. Controls static page inclusion in response.

    false
    facets?: boolean

    Whether to include facets in results. Controls faceted navigation data in response.

    true
    categories?: boolean

    Whether to include categories in results. Controls category inclusion in response.

    true
    suggestions?: boolean

    Whether to include suggestions in results. Controls search suggestions in response.

    true
    vendors?: boolean

    Whether to include vendors in results. Controls vendor facet inclusion in response.

    true
    tags?: boolean

    Whether to include tags in results. Controls tag facet inclusion in response.

    true
    pageStartIndex?: number

    Starting index for pages. Zero-based index for page pagination.

    0
    pagesMaxResults?: number

    Maximum number of pages to return. Limits page result set size.

    5
    categoryStartIndex?: number

    Starting index for categories. Zero-based index for category pagination.

    0
    categoriesMaxResults?: number

    Maximum number of categories to return. Limits category result set size.

    10
    suggestionsMaxResults?: number

    Maximum number of suggestions to return. Limits suggestion result set size.

    5
    vendorsMaxResults?: number

    Maximum number of vendors to return. Limits vendor facet result set size.

    20
    tagsMaxResults?: number

    Maximum number of tags to return. Limits tag facet result set size.

    50
    output?: string

    Output format for the response. Controls response serialization format.

    "json"

    _

    _: number

    Timestamp for cache busting. Unix timestamp in milliseconds.

    1625097600000

    Settings

    Member Visibility

    On This Page

    Properties