Page Configurations¶

The content of pages can be modified through supplying a page configuration. The page configuration allows pages to be extended with additional recommendation listings and supports product rules and filtering of primary product listings, such as search results and category pages.

Pages with modified content must be retrieved through POST requests, where the content modification specification is supplied as the body.

Product rules¶

Product rules, productRules, is a configuration that is equal to defining a Product selection in the eSales Apps. The product rules are a form of logical expressions that are used to restrict the data set used in a query. Rules can go from easy, such as to only include a single product using its product key or items that are in stock, to more complex with multiple attributes for the product selection.

An expression may consist of multiple rules where each rule must have at least one restriction. A restriction must include a condition, which in turn consist of an attribute that is either a list of strings, an interval, or a specified newness.

When productRules is used with Category and Landing Pages and product keys are specified equal to Handpicked, this rule must be the first rule and must contain a set of product keys as the only condition.

Examples¶

rule incl product_key { "p1234" "p5678" }

rule incl pattern { "striped" } incl newness default

rule incl brand { "Bosch" "Dewalt" } excl price [ 2000.01, infinity ]

rule incl department { "Kids" } incl newness 3d incl rating [ 3, 5 ]

rule incl custom.category_name { "Kitchen" "Dining" } incl discount [ -infinity, 30 ] incl stock_number [ 1, infinity ]

rule incl product_key { "ABC123" "DEF456" "GHJ789" }
rule incl custom.material { "leather" } excl price [ -infinity, 100.00 ]
rule incl newness 10d
rule incl brand { "Birkenstock" } excl custom.isActive { "false" }

Product filters¶

Product filters can be applied to both primary listings and recommendation listings and are included in the request body for the target listing. Applying a filter will restrict the set of returned products to be included in the actual result set and can be either numeric or value filters.

Listing multiple attributes to filter on will restrict the products to all conditions (logical AND). When listing values within one attribute, products with any of the listed properties apply (logical OR).

{
    "productFilter": {
        "brand": "Calvin Klein",
        "discount": {"min": 1},
        "custom.season": ["Winter", "Spring"],
    }
}

Numeric product filters¶

Numeric filters can be provided as a range, single values, or as lists of values. All ranges are inclusive and may be provided with a one sided limitation, where min defaults to 0 and max defaults to the maximum eligible value.

{
    "price": {"max": 300.0},
    "discount": 70,
    "rating": {"min": 4.0, "max": 5.0},
    "stock_number": [0, 1, 2]
}

Supported numeric filter attributes¶

Value product filters¶

Value filters can be provided as single values or as a list of values.

{
    "brand": "Calvin Klein",
    "custom.season": ["Winter", "Spring"],
}

Supported value filter attributes¶

Primary list¶

Some page types include primary listings such as search and category pages. Primary lists can be configured with filters settings.

{
    "primaryList": {
        "include": true,
        "productFilter": {
            "brand": "Calvin Klein"
        }
    }
}

Recommendation lists¶

Most page types support recommendation lists. To include recommendation lists in a page response, the request body must include the recommendation configuration.

{
  "recommendationLists": [
    {
      "id": "START-PAGE-1",
      "limit": 8,
      "algorithm": "PERSONAL"
    },
    {
      "id": "START-PAGE-2",
      "algorithm": "ALTERNATIVES",
      "params": {
        "productKey": "P1"
      }
    },
    {
      "id": "START-PAGE-3",
      "algorithm": "TOP_PRODUCTS",
      "productFilter": {
          "discount": {"min": 1}
      }
    },
  ]
}

Algorithms¶

Parameters¶

Content filters¶

Content filters can be applied to most content listings and are included in the request body for the target listing. Applying a filter will restrict the set of returned content and can only be string value filters e.g. not numeric.

Listing multiple attributes to filter on will restrict the content to all conditions (logical AND). When listing values within one attribute, content with any of the listed properties apply (logical OR).

{
    "contentFilter": {
        "custom.author": "Pelle",
        "type": ["article", "size-guide"]
    }
}

Value content filters¶

Value filters can be provided as single values or as a list of values.

{
    "type": "article",
    "custom.season": ["Winter", "Spring"]
}

Supported value filter attributes¶

Content lists¶

Search-page, autocomplete and landing-page support content lists. To include content lists in a page response, the request body must include a content list configuration.

{
    "contentLists": [
        {
            "id": "bottom-right-mini-faq",
            "limit": 8,
            "contentFilter": {
                "type": "faq"
            }
        }
    ]
}

Algorithms (Content)¶