Home > widget-integration > SuggestionRequestParams

SuggestionRequestParams interface

Parameters for suggestion API request.

Signature:

export interface SuggestionRequestParams 

Properties

Property

Modifiers

Type

Description

collection_limit?

number

(Optional) Maximum collections to return

page_limit?

number

(Optional) Maximum pages to return

product_limit?

number

(Optional) Maximum products to return

q

string

Search query

skip?

Array<"products" | "suggestions" | "collections" | "pages">

(Optional) Blocks to skip

suggestion_limit?

number

(Optional) Maximum suggestions to return