Thankly SDK for JavaScript
    Preparing search index...

    Interface ProductQueryParams

    Filters and paging for a catalog product query.

    interface ProductQueryParams {
        brand?: string;
        category?: string;
        color?: string;
        inStock?: boolean;
        limit?: number;
        maxPrice?: number;
        minPrice?: number;
        offset?: number;
        purchaseContext?: PurchaseContext;
        search?: string;
        signal?: AbortSignal;
    }
    Index
    brand? category? color? inStock? limit? maxPrice? minPrice? offset? purchaseContext? search? signal?
    brand?: string

    Brand name.

    category?: string

    Category the product sits in.

    color?: string

    Colour, as held in the catalog.

    inStock?: boolean

    Whether the product is currently purchasable.

    limit?: number

    Maximum products to return.

    maxPrice?: number

    Highest price to include.

    minPrice?: number

    Lowest price to include.

    offset?: number

    How many products to skip; use with limit to page.

    purchaseContext?: PurchaseContext

    Explicit shopper market and currency choices for this read.

    search?: string

    Free-text query matched against product fields.

    signal?: AbortSignal

    Aborts the in-flight request when triggered.

    Settings
    Member Visibility

    On This Page
    Properties