POST:suggest/products.json

Description

Perform a product suggest query.

This endpoint is useful for product autocompletion UI widgets and is optimized to work in situations alike.

Permission bit: "products.search"

Topic: Search

Query Parameters

ignore_bundles: Boolean

Ignore bundle variant types

Example: ?ignore_bundles=true

ignore_gift_cards: Boolean

Ignore gift card variant types

Example: ?ignore_gift_cards=true

shop_id: String, required

Unique shop identifier. See also: Unique Identifiers

Example: ?shop_id=sh_EQzGqWoY

type: VariantTypeFilter

Filter output by variant type

Example: ?type=bundle

Request Body

Query

Copy
{
  "query": "fancy shoes"
}

Response Body

ProductExpandableItems

Response Body Type

Loading module