Search products using typeahead

Searches for products using typeahead search, an autosuggest method that predicts search results and gives users suggestions when they enter one or more letters related to their search.

This API searches and retrieves products based on the query parameters that you have passed.You must select the Search-Type query parameter as Product to run this API.For example, to search for products that contain the letter �a�, select the Search-Type query parameter to product, and under the Query parameter, enter the letter �a�. Executing this API displays all the products that have the letter �a� in their Product Name, Description, and Product code.If you do not pass any Query parameters, all the products will be retrieved. The PriceList ID in the header is a mandatory field to execute this API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
string

A keyword to narrow down the search result. The API can match a maximum of 20 characters. If the keyword exceeds 20 characters, the API considers only first 20 characters of the keyword to find match in the record header fields. If the parameter is left blank, all relevant records after the filter is executed are retrieved.

string

The list of fields and sort order. The default sort order is ascending by name of the record.

int32
Defaults to 1

The page number of the resultset to view. Use this parameter with the "limit" parameter to configure pagination.

int32
Defaults to 50

The number of records to display on each page. A maximum of 500 records are displayed on each page. The current page and range index of the result set can be found in the "content-range" header field in the response with the total number of results. This helps paginate the result set.

string
Defaults to ProductSearchConfig

configName

Headers
string

The identifier of the price list to search on.

string

The identifier of the category to search on.

string

A unique identifier of the storefront.

string

Pass a cart id to filter the data relative to a specific cart.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json