Skip to main content

Visual Discovery Types Reference

tip

Learn more about TypeScript at TypeScript Documentation.

Product​

Product data structure returned by Visual Discovery API.

product.ts
export interface Product {
    id: string;
    url: string;
    title: string;
    price: number;
    imageURL: string;
    imageURL2?: string;
    vra?: VariantData[];
    attributes?: [string, string[]][];
    // ... additional properties
}

export type VariantData = [string, [string, string][]];

Facet Types​

Filter data structures for Visual Discovery filtering system.

filters.ts
export interface Facet {
    name: string;
    values: FacetValue[];
}

export interface FacetValue {
    id: string;
    name: string;
    count: number;
    parentName: string;
    selected: boolean;
    childValues?: FacetValue[];
}

export interface PriceFacet {
    name: string;
    bounds: Bounds;
    range: Bounds;
    values: FacetValue[];
}

export interface Bounds {
    min: number;
    max: number;
}