Skip to main content
Four endpoints that populate the search box before and while a shopper types. Each one answers a different question, and a typical search box uses more than one.
None of these run a product search. They return terms and categories to show as suggestions. Once the shopper picks one, call Search Products to fetch the actual results.

​
When to Call Each

Before the shopper types — the search box is empty and you want to fill the dropdown:
  • Popular Terms gives you the catalog’s trending searches. They are precomputed, so there is no query to pass — the same ranked list comes back every time.
  • Recent Searches gives you what this particular shopper searched for before, keyed on user_id.
While the shopper types — you have a partial query and want to complete it:
  • Auto-Suggestions completes the term itself, and can also return “did you mean” alternatives when the query looks misspelled.
  • Categories finds matching categories, so you can offer “jump straight to Men’s Shoes” alongside the term suggestions.

​
Endpoints

All four take catalog_id and support limit and skip. Auto-Suggestions and Categories also take q, which is required on Categories.