Search Products
curl --request POST \
--url https://api.example.com/api/v1/search{
"hits": [
{}
],
"nbHits": 123,
"page": 123,
"nbPages": 123,
"hitsPerPage": 123,
"facets": {},
"processingTimeMs": 123,
"correctedQuery": "<string>"
}Search Products
Semantically search products with Algolia-compatible response format
POST
/
api
/
v1
/
search
Search Products
curl --request POST \
--url https://api.example.com/api/v1/search{
"hits": [
{}
],
"nbHits": 123,
"page": 123,
"nbPages": 123,
"hitsPerPage": 123,
"facets": {},
"processingTimeMs": 123,
"correctedQuery": "<string>"
}Authentication
All requests must include an API key via theX-API-Key header or api_key query parameter.
curl -X POST https://alana.shopping/api/v1/search \
-H "Content-Type: application/json" \
-H "X-API-Key: ak_your_api_key" \
-d '{"query": "camiseta azul"}'
Rate Limits
| Level | Limit | Window |
|---|---|---|
| Per API key | 1,000 requests | 1 minute |
| Per API key + IP | 100 requests | 1 minute |
429 with a Retry-After header indicating seconds until reset.
Sorting
| Value | Description |
|---|---|
relevance (default) | Semantic similarity ranking |
price_asc | Price low to high |
price_desc | Price high to low |
newest | Most recently added |
optimization_score | AI Commerce Score |
Pagination
page: 0-based page number (default: 0)hitsPerPage: Results per page, max 100 (default: 20)
Response Format
Compatible with Algolia InstantSearch for drop-in frontend integration.Array of matching products. Each hit includes
_highlightResult with matched
query terms wrapped in <em> tags.Total number of matching results across all pages.
Current page number (0-based).
Total number of pages.
Number of results per page.
Facet counts per attribute and value. Only populated when
facets is
specified in the request.{ "brand": { "Nike": 12, "Adidas": 7 }, "availability": { "in_stock": 18 } }
Query processing time in milliseconds.
Spell-corrected query string, present only when different from input.
Última modificação em 12 de março de 2026
⌘I