Skip to main content
POST
/
commerce
/
catalog
/
admin
/
searchmerchandizingrules
Error
A valid request URL is required to generate request examples
{
  "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

responseFields
string

limits which fields are returned in the response body

Body

application/json

Search Merchandizing Rule

code
string | null

Unique identifier. Will be generated if not provided.

name
string | null
description
string | null
isDisabled
boolean | null
tags
string[] | null
context
object

SearchMerchandizingRule Condition

ruleImpact
object

SearchMerchandizingRule Condition

auditInfo
object

Response

Success

Search Merchandizing Rule

code
string | null

Unique identifier. Will be generated if not provided.

name
string | null
description
string | null
isDisabled
boolean | null
tags
string[] | null
context
object

SearchMerchandizingRule Condition

ruleImpact
object

SearchMerchandizingRule Condition

auditInfo
object