Search products

A search query is group of keywords that a customer enters to satisfy their information needs. This endpoint enables the customer to enter a phrase or a keyword combination to find a product list of interest.

TIP

The search products endpoint has been implemented in the Search Web Component, and It's all setup to save developer's time and effort.

Payload

SearchProductsPayload

Response

Success

Error

products.searchProducts.success

Usage

To perform the action of searching for products using a query string, the developer may call the method products() as follows;

Events

This endpoint may trigger two events, the onSearchResults and onSearchFailed events.

onSearchResults

This event is triggered when searching for products using a query string is done without having any errors coming back from the backend.

onSearchFailed

This event is triggered when searching for products using a query string is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onSearchResults#

onSearchFailed#

Payload

Response

Usage

Events

onSearchResults

onSearchFailed