Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

This should follow the immutable DTO pattern

campaignSettings
object
fieldList
string[] | null
mid
string | null
pageSize
integer<int32> | null
query
string | null
searchSettings
string | null
searchType
string | null
startIndex
integer<int32> | null

Response

OK

Products and search information returned for search preview query.

facets
object[] | null
items
object[] | null
nextCursorMark
string | null
pageCount
integer<int32>
pageSize
integer<int32>
searchEngine
string | null
searchRedirect
string | null
solrDebugInfo
object
spellcheck
object

Spellcheck related results

startIndex
integer<int32>
totalCount
integer<int32>