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

Properties

field: string

The searchable Product field to facet on.

fieldType?: SearchFieldType

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

filter?: _SearchQuery

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

includes?: string[]

Specify which bucket keys the facets results should include.

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.

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

limit?: number

Maximum number of buckets to return.

missing?: string

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

name: string

Name of the distinct facet to appear in the ProductSearchFacetResultBucket.

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

Define how the buckets are sorted.