Skip to main content
POST
/
store
/
products
/
search
Search products
curl --request POST \
  --url https://api.example.com/store/products/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "page": 123,
  "hitsPerPage": 123,
  "filters": "<string>",
  "facets": [
    "<string>"
  ],
  "maxValuesPerFacet": 123,
  "currency_code": "<string>",
  "region_id": "<string>",
  "customer_id": "<string>",
  "customer_group_id": [
    "<string>"
  ]
}
'
{
  "products": [
    {}
  ],
  "nbHits": 123,
  "page": 123,
  "nbPages": 123,
  "hitsPerPage": 123,
  "facets": {},
  "processingTimeMS": 123
}

Body

application/json
query
string

The search query string

page
number

The page number (0-indexed)

hitsPerPage
number

Number of results per page

filters
string

Algolia filter string

facets
string[]

Array of facet attributes to retrieve

maxValuesPerFacet
number

Maximum number of facet values to return per facet

currency_code
string

Currency code for price calculation

region_id
string

Region ID for price calculation

customer_id
string

Customer ID for customer-specific price calculation

customer_group_id
string[]

Customer group IDs for group-specific price calculation

Response

200 - application/json

OK

products
object[]
nbHits
number

Total number of matching products

page
number

Current page number

nbPages
number

Total number of pages

hitsPerPage
number

Number of results per page

facets
object

Facet values and counts

processingTimeMS
number

Algolia processing time in milliseconds