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 the visual way of defining a Product selection in the Elevate Apps. The product rules are a form of logical expressions that are used to restrict the products in a response. Rules can go from easy, such as to only include a single product using its product key or products of a specific brand, to more complex with multiple attributes for the product selection.

Expressions¶

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 has a value that is either a list of strings, an interval, an interval with a unit, or a specified newness. The structure of an expression can be visualized as follows:

"rule incl product_key { \"p1234\" \"p5678\" }"
 [                   Rule                    ]
      [             Restriction              ]
           [            Condition            ]
           [Attribute]
                       [        Value        ]

Rule¶

A rule, rule, must have at least one restriction. Rules are separated with a whitespace, i.e. a space, a tab, or a newline. If more than one rule is used, the rules are to be be considered as using the logical OR operator.

When product keys are specified in a rule (equal to Handpicked in the apps), this rule must be the first rule and must contain a set of product keys (one or more) as its only condition.

Restriction¶

A restriction is either an include, incl, or an exclude, excl, followed by a condition. If more than one restriction is present in a rule, the restrictions can be considered as using the logical AND operator.

Condition¶

A condition must consist of an attribute followed by a value that is either a list of strings, an interval, an interval with a unit, or a specified newness. If more than one value is present within a list of strings, consider the values to be using the logical OR operator.

Attribute¶

The following attributes are allowed in conditions.

Type definitions¶

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 newness 3d incl rating [ 2.5, 4.5 ]

rule incl custom.category_name { "Kitchen" "Dining" } incl discount [ 0, 30 ] incl color { BLACK GRAY }

rule incl volume [ 1, 2 ]l incl custom.length.diameter [10, infinity] cm incl variant.custom.length.package_height [2.5, 2.5]dm

rule incl custom.number.items_in_package [10, infinity]

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

Product filters¶

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

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

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

Primary list¶

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

{
    "primaryList": {
        "include": true,
        "productRules": "rule incl brand { \"Bosch\" \"Dewalt\" }"
        }
    }
}

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",
      "productRules": "rule incl discount [ 0, 30 ]"
      }
    },
  ]
}

Algorithms¶

All recommendation algorithms will utilize provided product rules, productRules, or product filters, productFilter (deprecated).

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)¶