GetSearchTuningRuleSortFields

Retrieves the details of the specified search tuning rule sort fields. Sort fields allow you to control the product relevance whenver shoppers sort products on a page. For more information about sort relevance, refer to Search Tuning Rules and Sorting.

Request

HTTP Request

GET
 api/commerce/catalog/admin/search/searchtuningrulesortfields%3fresponseFields%3d%7bresponseFields%7d

Parameters

Parameter NameDescription
Parameters
responseFieldstype: string 

Filtering syntax appended to an API call to increase or decrease the amount of data returned inside a JSON object. This parameter should only be used to retrieve data. Attempting to update data using this parameter may cause data loss.

Required Behaviors

  • Read Product Ranking Definition

Request Properties

No request body content

Response Properties

The details of the search tuning rule sort fields.

PropertyDescription
inclusionExclusionType

type: string

Specifies whether you want the product properties in sortFields to be white listed or black listed. When you white list a product property, any search tuning rules that affect that product property will be in effect whenever a shopper sorts by that product property. When you black list a product product, any search tuning rules that affect that product property will never be in effect whenever a shopper sorts by that product property.

Valid values are: "WhiteList" or "BlackList".

For more information about search tuning rule sort fields, refer to Search Tuning Rules.

sortFields

type: list of string

A list of product properties that you want to apply the search tuning rule sort fields to. For example, you can set this field to "popularity" in order to make all search tuning rules that affect product popularity to always be in effect whenever a shopper sorts by popularity.

Response Body