Public search

post

https://{yourinstance}.makaira.io/search/public

This endpoint acts basically the same as the /search/ endpoint. The only difference is that this the public endpoint does not require requests to be signed with using API-Secret. That means, they are publicly available. Because of that, we limit the fields returned in the responses. To achieve this, customers can define a whitelist of fields that should be returned.

Body Params

isSearch

boolean

required

Set this to true when the request is an actual search request (e.g. autosuggest) and to false when you want to perform a request for products on a category or manufacturer page.

searchPhrase

string

required

The term to search for.

enableAggregations

boolean

required

Set this to true when you want aggregations to be included in the response, otherwhise false.

aggregations

object

required

List of selected values to filter for.

sorting

object

required

count

string

required

Number of products to be returned in the response.

offset

string

required

The offset to start returning products from. In combination with the "count" property this is used for paginating the search results.

constraints

object

required

apiVersion

string

enableHook

boolean

If set to false, the search query hook will be disabled. Default value is true(if not specify)

Headers

X-Makaira-Instance

string

required

Makaira Instance ID

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK