Search

post

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

The search endpoint is the heart of the Makaira Marketing Suite when it comes to searching for products in a classic shop scenario. It is used for your autosuggest and search results as well as for listing products on category or manufacturer pages.

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

fields

array

List of additional fields to be included in the response. When the value is an empty array, the response will include all available fields for each item.

fields

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