Skip to main content
POST
/
commerce
/
catalog
/
admin
/
search
/
settings
Error
A valid request URL is required to generate request examples
{
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "categorySuggestSettings": {
    "crossFieldAdditiveScoreFactor": 123,
    "fieldWeights": [
      {
        "searchFieldName": "<string>",
        "weight": 123
      }
    ],
    "personalizationExperience": "<string>",
    "personalizationFactor": 123,
    "returnFields": [
      "<string>"
    ]
  },
  "collapseSettings": {
    "boostFieldName": "<string>",
    "boostRankListing": true,
    "boostRankSiteSearch": true,
    "collapseFieldName": "<string>",
    "collapseListing": true,
    "collapseSiteSearch": true,
    "useFieldCache": true
  },
  "description": "<string>",
  "isDefault": true,
  "listingSettings": {
    "customBoosts": [
      "<string>"
    ],
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "boost": 123,
              "operator": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    },
    "personalizationExperience": "<string>",
    "personalizationFactor": 123
  },
  "productSuggestSettings": {
    "crossFieldAdditiveScoreFactor": 123,
    "fieldWeights": [
      {
        "searchFieldName": "<string>",
        "weight": 123
      }
    ],
    "personalizationExperience": "<string>",
    "personalizationFactor": 123,
    "returnFields": [
      "<string>"
    ],
    "customBoosts": [
      "<string>"
    ],
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "boost": 123,
              "operator": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    },
    "searchChildProductsByDefault": true
  },
  "settingsName": "<string>",
  "siteSearchSettings": {
    "crossFieldAdditiveScoreFactor": 123,
    "customBoosts": [
      "<string>"
    ],
    "fieldValueBoost": {
      "boostType": "<string>",
      "fields": [
        {
          "fieldName": "<string>",
          "valueExpressions": [
            {
              "boost": 123,
              "operator": "<string>",
              "value": "<string>"
            }
          ]
        }
      ]
    },
    "fieldWeights": [
      {
        "searchFieldName": "<string>",
        "weight": 123,
        "phraseWeight": 123
      }
    ],
    "minimumMatchPercents": [
      123
    ],
    "multiTermSynMinimumMatchPercents": [
      123
    ],
    "personalizationExperience": "<string>",
    "personalizationFactor": 123,
    "phraseSlop": 123,
    "searchChildProductsByDefault": true,
    "searchMode": 123,
    "sowBehavior": 123,
    "spellcheck": {
      "autocorrect": true,
      "didyoumean": true,
      "spellcheckEnabled": true
    },
    "twoWordPhraseBoost": true,
    "typoTolerance": {
      "distance": 123,
      "enabled": true,
      "factor": 123
    },
    "vectorSettings": {
      "applyBoostFunctions": true,
      "filterByThresholdDistance": true,
      "hybridMode": 123,
      "multiplier": 123,
      "thresholdDistance": 123,
      "topK": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kibocommerce.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Query Parameters

​
fromSystemDefault
boolean
default:false
​
copyFromName
string
​
name
string
​
makeDefault
boolean
default:false
​
responseFields
string

limits which fields are returned in the response body

Body

application/json

Settings to control product search and indexing behavior

​
auditInfo
object
​
categorySuggestSettings
object
​
collapseSettings
object

Settings to control product search and indexing behavior

​
description
string | null
​
isDefault
boolean
​
listingSettings
object
​
productSuggestSettings
object
​
settingsName
string | null
​
siteSearchSettings
object

Response

Success

Settings to control product search and indexing behavior

​
auditInfo
object
​
categorySuggestSettings
object
​
collapseSettings
object

Settings to control product search and indexing behavior

​
description
string | null
​
isDefault
boolean
​
listingSettings
object
​
productSuggestSettings
object
​
settingsName
string | null
​
siteSearchSettings
object