---
title: Autocomplete API handler
slug: configured-commerce/docs/autocomplete-api-handler
docTags: 
createdAt: 2026-08-13T10:46:21.000Z
---

**HTTP Verb** – GET

**URL** –  /api/v1/autocomplete /api/v1/autocomplete/products

**Description** – Query products by partial search criteria

**Base** – HandlerBase\<GetAutocompleteProductCollectionParameter, GetAutocompleteProductCollectionResult>

**Handlers** –

| Order | Handler                                 | Description                                                                                                                                                                                                                                                                                                                                                                                              |
| ----- | --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 500   | GetAutocompleteProductCollectionHandler | Gets product collection for autocomplete. If requester is not signed in and website setting WebSiteNavigation set to 'SignInRequiredToBrowse' then handler return error result. Also if requester restricted from website then handler return error result. **NOTE** – This handler was obsolesced as of version 4.3.1 and subsequent version should use the /api/v1/autocomplete endpoint in its place. |

| Order | Handler                        | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ----- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 500   | GetAutocompleteProductResults  | Retrieves autocomplete product results from Elasticsearch using a query. If any of the following is "true", this handler is skipped.<br />The Autocomplete "Show Products" setting equals "false"<br />The ProductEnabled  property on the parameter object equals "false"<br />The Query  property on the parameter object is blank<br />Uses the  GetProductSettingsHandler handler chain to retrieve product search settings. If the CanSeeProducts  property on the settings object equals "false", an error is returned (the current user cannot search for or see products).<br /><br />The product results are stored in the Products  property on the result object. |
| 600   | GetAutocompleteContentResults  | Retrieves autocomplete content page results from Elasticsearch. If any of the following is "true", this handler is skipped.<br />The Autocomplete "Show Website Pages" setting equals "false"<br />The ContentEnabled  property on the parameter object equals "false"<br />The Query  property on the parameter object is blank<br />The content page results are stored in the Content  property on the result object.                                                                                                                                                                                                                                                     |
| 700   | GetAutocompleteCategoryResults | Retrieves autocomplete category results from Elasticsearch. If any of the following is "true", this handler is skipped.<br />The Autocomplete "Show Categories" setting equals "false"<br />The CategoryEnabled  property on the parameter object equals "false"<br />The Query  property on the parameter object is blank<br />The category results are stored in the Categories  property on the result object.                                                                                                                                                                                                                                                            |
