Skip to main content
GET
/
commerce
/
catalog
/
admin
/
searchmerchandizingrules
Error
A valid request URL is required to generate request examples
{
  "startIndex": 123,
  "pageSize": 123,
  "pageCount": 123,
  "totalCount": 123,
  "items": [
    {
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "isDisabled": true,
      "tags": [
        "<string>"
      ],
      "context": {
        "searchType": 1,
        "startDate": "2023-11-07T05:31:56Z",
        "endDate": "2023-11-07T05:31:56Z",
        "condition": {
          "terms": [
            "<string>"
          ],
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ]
        }
      },
      "ruleImpact": {
        "rankedItems": [
          {
            "productCode": "<string>",
            "sliceValue": "<string>",
            "position": 123,
            "isPinned": true
          }
        ],
        "buriedItems": [
          {
            "productCode": "<string>",
            "sliceValue": "<string>",
            "position": 123,
            "isPinned": true
          }
        ],
        "excludedItems": [
          {
            "productCode": "<string>",
            "sliceValue": "<string>",
            "position": 123,
            "isPinned": true
          }
        ],
        "sortFields": [
          {
            "direction": "<string>",
            "propertyName": "<string>"
          }
        ],
        "fieldValueBoost": {
          "boostType": 1,
          "fields": [
            {
              "fieldName": "<string>",
              "valueExpressions": [
                {
                  "value": "<string>",
                  "boostNumber": 123,
                  "operator": "<string>"
                }
              ]
            }
          ]
        },
        "filter": {
          "inclusion": "<string>",
          "exclusion": "<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

startIndex
integer<int32>
default:0
pageSize
integer<int32>
default:0
sortBy
string
filter
string
responseGroups
string
q
string
responseFields
string

limits which fields are returned in the response body

Response

Success

startIndex
integer<int32>
pageSize
integer<int32>
pageCount
integer<int32>
totalCount
integer<int32>
items
object[] | null