Skip to main content
POST
/
commerce
/
catalog
/
admin
/
search
/
searchtuningrules
Error
A valid request URL is required to generate request examples
{
  "siteId": 123,
  "searchTuningRuleCode": "<string>",
  "searchTuningRuleName": "<string>",
  "searchTuningRuleDescription": "<string>",
  "keywords": [
    "<string>"
  ],
  "filters": [
    {
      "field": "<string>",
      "value": "<string>"
    }
  ],
  "active": true,
  "isDefault": true,
  "activeStartDate": "2023-11-07T05:31:56Z",
  "activeEndDate": "2023-11-07T05:31:56Z",
  "boostedProductCodes": [
    "<string>"
  ],
  "blockedProductCodes": [
    "<string>"
  ],
  "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

Body

application/json
siteId
integer<int32>
searchTuningRuleCode
string | null
searchTuningRuleName
string | null
searchTuningRuleDescription
string | null
keywords
string[] | null
filters
object[] | null
active
boolean
isDefault
boolean
activeStartDate
string<date-time> | null
activeEndDate
string<date-time> | null
boostedProductCodes
string[] | null
blockedProductCodes
string[] | null
auditInfo
object

Response

Success

siteId
integer<int32>
searchTuningRuleCode
string | null
searchTuningRuleName
string | null
searchTuningRuleDescription
string | null
keywords
string[] | null
filters
object[] | null
active
boolean
isDefault
boolean
activeStartDate
string<date-time> | null
activeEndDate
string<date-time> | null
boostedProductCodes
string[] | null
blockedProductCodes
string[] | null
auditInfo
object