Interface ProductSearchFacetDistinctValue

interface ProductSearchFacetDistinctValue {
    field: string;
    fieldType?: string;
    filter?: _SearchQuery;
    includes?: string[];
    language?: string;
    level?: string;
    limit?: number;
    missing?: string;
    name: string;
    scope?: string;
    sort?: ProductSearchFacetDistinctBucketSortExpression;
}

Properties

field fieldType? filter? includes? language? level? limit? missing? name scope? sort?

Properties

Readonlyfield

field: string

The searchable Product field to facet on.

Optional ReadonlyfieldType

fieldType?: string

If the field is not standard, this must be the Attribute type.

Optional Readonlyfilter

filter?: _SearchQuery

Additional filtering expression to apply to the search result before calculating the facet.

Optional Readonlyincludes

includes?: string[]

Specify which bucket keys the facets results should include.

Optional Readonlylanguage

language?: string

String value specifying linguistic and regional preferences using the IETF language tag format, as described in BCP 47. The format combines language, script, and region using hyphen-separated subtags. For example: en, en-US, zh-Hans-SG.

Optional Readonlylevel

level?: string

Specify whether to count Products (products) or Product Variants (variants).

Optional Readonlylimit

limit?: number

Maximum number of buckets to return.

Optional Readonlymissing

missing?: string

Default value to use if the specified field is not present on some Products.

Readonlyname

name: string

Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

Optional Readonlyscope

scope?: string

Whether the facet must consider only the Products resulting from the search (query) or all the Products (all).

Optional Readonlysort

sort?: ProductSearchFacetDistinctBucketSortExpression

Define how the buckets are sorted.

Settings

Member Visibility

On This Page

Properties