Get list of suggested terms and attributes similar to the search term
Lists the suggested terms and attributes similar to the search term.
For more information, check the Intelligent Search Autocomplete guide.
ℹ️ Migrate to Intelligent Search API v1 for HTTP caching, lower latency, and a simpler URL structure. The new endpoint is: GET Get list of suggested terms and attributes similar to the search term. See the migration guide.
Permissions
This endpoint does not require authentication or permissions.
Query parameters
Search term. It can contain any character.
This parameter is named query in the API. The short form q is an alias for query and has the same semantics.
You can search for products or SKUs using specific ID types by adding search parameters (query) at the end of the store URL, respecting one of the following structures:
- Single item search: ?query=[id type]:[id_1]. Example: ?query=product:98765
- Multiple items search: ?query=[id type]:[id_1];[id_2];[id_3]. Example: ?query=product:98765;98743
⚠️ All searched IDs should be of the same type.
Search by ID
On the Intelligent Search API, search products or SKUs by ID by sending the value in the query or q query parameter on requests such as /product_search/{facets}. The {facets} path must include the required trade-policy facet and any optional filters.
- Product ID: .../product_search/trade-policy/1?query=product:98765 or .../product_search/trade-policy/1?query=product.id:98765.
- SKU ID: .../product_search/trade-policy/1?query=sku.id:12345 or .../product_search/trade-policy/1?query=sku:12345.
Supported ID types
The possible value types for the ID segment are product.id, sku.id, sku.ean, sku.reference, product.link, or id (ProductID, ProductRefID, SKUID, SKURefID, and EAN).
| ID Type | Query format | Example |
|---|---|---|
| Product ID | ?query=product:<id> or ?query=product.id:<id> | ?query=product:98765 |
| SKU ID | ?query=sku:<id> or ?query=sku.id:<id> | ?query=sku.id:12345 |
| Reference ID | ?query=sku.reference:<id> | ?query=sku.reference:REF123 |
| EAN | ?query=sku.ean:<id> | ?query=sku.ean:7891234567890 |
| Slug | ?query=product.link:<link> | ?query=product.link:blue-shirt |
Indicates the target language as a BCP 47 language code. The Intelligent Search must have indexed the account in the target language.
Response
OK