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

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

Response

Success

totalCount
integer<int32>
items
object[] | null