Add Search Settings

post https://t{tenantId}-s{siteId}.{env}.mozu.com/api/commerce/catalog/admin/search/settings

Adds the Search Settings for a specific site.

Response

Response body

object

settingsName

string | null

description

string | null

isDefault

boolean

siteSearchSettings

object

sowBehavior

int32 | null

controls sowBehavior (Never=0, Always=1, WhenNoMultiTermSyn=2)
never sow=false, always sow=true, WhenNoMultiTermSyn = (depends on existance of multitermsynonym match in query)

searchMode

int32 | null

vectorSettings

object

fieldWeights

array of objects | null

fieldWeights

object

phraseWeight

int32

weight to apply in phrase boosting

searchFieldName

string | null

field in the index to target

weight

int32

weight to apply to boost field

customBoosts

array of strings | null

customBoosts

fieldValueBoost

object

multiTermSynMinimumMatchPercents

array of int32s | null

if values present is used for mm when sowBehavior.WhenNoMultiTermSyn and multi term sym match found in query
if no values are present or null fallback to MinMatchPercents

multiTermSynMinimumMatchPercents

minimumMatchPercents

array of int32s | null

minimumMatchPercents

phraseSlop

int32

twoWordPhraseBoost

boolean | null

if true, 2 word shingles used for phrase boosting based on fields with phrase weights greater than 0
if false, only full phrase mathing used for phrase boosting

personalizationExperience

string | null

personalizationFactor

double | null

searchChildProductsByDefault

boolean

crossFieldAdditiveScoreFactor

double

typoTolerance

object

spellcheck

object

productSuggestSettings

object

customBoosts

array of strings | null

customBoosts

fieldValueBoost

object

searchChildProductsByDefault

boolean

fieldWeights

array of objects | null

fieldWeights

object

searchFieldName

string | null

field in the index to target

weight

int32

weight to apply to boost field

personalizationExperience

string | null

personalizationFactor

double | null

returnFields

array of strings | null

returnFields

crossFieldAdditiveScoreFactor

double

categorySuggestSettings

object

fieldWeights

array of objects | null

fieldWeights

object

searchFieldName

string | null

field in the index to target

weight

int32

weight to apply to boost field

personalizationExperience

string | null

personalizationFactor

double | null

returnFields

array of strings | null

returnFields

crossFieldAdditiveScoreFactor

double

listingSettings

object

customBoosts

array of strings | null

customBoosts

fieldValueBoost

object

personalizationExperience

string | null

personalizationFactor

double | null

collapseSettings

object

Settings to control product search and indexing behavior

collapseSiteSearch

boolean | null

collapseListing

boolean | null

collapseFieldName

string | null

boostFieldName

string | null

boostRankSiteSearch

boolean | null

boostRankListing

boolean | null

useFieldCache

boolean | null

auditInfo

object

updateDate

date-time | null

createDate

date-time | null

updateBy

string | null

createBy

string | null

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url 'https://t0-s0.sandbox.mozu.com/api/commerce/catalog/admin/search/settings?fromSystemDefault=false&makeDefault=false' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

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

application/json

text/json

text/plain

200Success