@coveo/headless-react
    Preparing search index...

    Interface BaseProduct

    interface BaseProduct {
        additionalFields: Record<string, unknown>;
        children: ChildProduct[];
        clickUri: string;
        ec_brand: string | null;
        ec_category: string[];
        ec_color: string | null;
        ec_description: string | null;
        ec_gender: string | null;
        ec_images: string[];
        ec_in_stock: boolean | null;
        ec_item_group_id: string | null;
        ec_listing: string | null;
        ec_name: string | null;
        ec_price: number | null;
        ec_product_id: string | null;
        ec_promo_price: number | null;
        ec_rating: number | null;
        ec_shortdesc: string | null;
        ec_thumbnails: string[];
        excerpt?: string | null;
        excerptHighlights?: HighlightKeyword[];
        excerptsHighlights?: HighlightKeyword[];
        nameHighlights?: HighlightKeyword[];
        permanentid: string;
        responseId?: string;
        resultType: CHILD_PRODUCT | PRODUCT;
        totalNumberOfChildren: number | null;
    }

    Hierarchy (View Summary)

    Index
    additionalFields children clickUri ec_brand ec_category ec_color ec_description ec_gender ec_images ec_in_stock ec_item_group_id ec_listing ec_name ec_price ec_product_id ec_promo_price ec_rating ec_shortdesc ec_thumbnails excerpt? excerptHighlights? excerptsHighlights? nameHighlights? permanentid responseId? resultType totalNumberOfChildren
    additionalFields: Record<string, unknown>

    The requested additional fields for the product.

    children: ChildProduct[]

    The child products of the product, fetched through product grouping.

    clickUri: string

    The URL of the product.

    ec_brand: string | null

    The brand of the product.

    From the ec_brand field.

    ec_category: string[]

    The category of the product (for example, "Electronics;Electronics|Televisions;Electronics|Televisions|4K Televisions").

    From the ec_category field.

    ec_color: string | null

    The color of the product.

    ec_description: string | null

    The description of the product.

    From the ec_description field.

    ec_gender: string | null

    The gender the product is intended for.

    ec_images: string[]

    The URLs of additional product images.

    From the ec_images field.

    ec_in_stock: boolean | null

    Whether the product is currently in stock.

    From the ec_in_stock field.

    ec_item_group_id: string | null

    The ID used for the purpose of product grouping.

    From the ec_item_group_id field.

    ec_listing: string | null

    The listing that the product belongs to.

    ec_name: string | null

    The name of the product.

    From the ec_name field.

    ec_price: number | null

    The base price of the product.

    From the ec_price field.

    ec_product_id: string | null

    The product ID.

    ec_promo_price: number | null

    The promotional price of the product.

    From the ec_promo_price field.

    ec_rating: number | null

    The product rating, from 0 to 10.

    From the ec_rating field.

    ec_shortdesc: string | null

    A short description of the product.

    From the ec_shortdesc field.

    ec_thumbnails: string[]

    The URLs of the product image thumbnails.

    From the ec_thumbnails field.

    excerpt?: string | null

    The contextual excerpt generated for the product.

    ... This orange sea kayak is perfect for beginner and experienced kayakers ... and want to enjoy the water without having to deal with the hassle of attaching a boat to their kayak.
    excerptHighlights?: HighlightKeyword[]

    The length and offset of each word to highlight in the product excerpt string.

    excerptsHighlights?: HighlightKeyword[]

    Use excerptHighlights instead.

    The length and offset of each word to highlight in the product excerpt string.

    nameHighlights?: HighlightKeyword[]

    The length and offset of each word to highlight in the product name.

    permanentid: string

    The SKU of the product.

    responseId?: string

    The ID of the response that returned the product.

    resultType: CHILD_PRODUCT | PRODUCT

    The result type of the product.

    totalNumberOfChildren: number | null

    The total number of child products fetched through product grouping.

    Settings
    Member Visibility
    In this article
    Properties