Get Search Merchandizing Rules

Retrieve a list of all search merchandizing rules. You can filter this query by CategoryCode, which supports an EQ (equals) filter with the syntax /catalog/admin/searchmerchandizingrules/?filter=categorycode eq AAA

GET /commerce/catalog/admin/searchmerchandizingrules

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "code": "<string>",
      "context": {
        "condition": {
          "fields": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "terms": [
            "<string>"
          ]
        },
        "endDate": "2023-11-07T05:31:56Z",
        "startDate": "2023-11-07T05:31:56Z"
      },
      "description": "<string>",
      "isDisabled": true,
      "name": "<string>",
      "ruleImpact": {
        "buriedItems": [
          {
            "isPinned": true,
            "position": 123,
            "productCode": "<string>",
            "sliceValue": "<string>"
          }
        ],
        "excludedItems": [
          {
            "isPinned": true,
            "position": 123,
            "productCode": "<string>",
            "sliceValue": "<string>"
          }
        ],
        "fieldValueBoost": {
          "fields": [
            {
              "fieldName": "<string>",
              "valueExpressions": [
                {
                  "boostNumber": 123,
                  "operator": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ]
        },
        "filter": {
          "exclusion": "<string>",
          "inclusion": "<string>"
        },
        "rankedItems": [
          {
            "isPinned": true,
            "position": 123,
            "productCode": "<string>",
            "sliceValue": "<string>"
          }
        ],
        "sortFields": [
          {
            "direction": "<string>",
            "propertyName": "<string>"
          }
        ]
      },
      "tags": [
        "<string>"
      ]
    }
  ],
  "pageCount": 123,
  "pageSize": 123,
  "startIndex": 123,
  "totalCount": 123
}

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

200

application/json

OK

items · object[] | null

Show child attributes

pageCount · integer<int32>

pageSize · integer<int32>

startIndex · integer<int32>

totalCount · integer<int32>