Page Comparison

Widget

yes

The widget property on the API Request Schema
https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/8749643/Narrative+API+-+Technical+Reference#Base-parameters

• a narrative must exist in Intelligence Admin linked to the widget

Sidebar Layout

no

If set to yes - the API Request will have a context parameter position:sidebar

• the Context Parameter can be used for the narrative layout (check the navigation or search narrative)

  

Add Store Filterable Properties to API Request

no

When active, will add all the Properties defined in your e-shop that have the filterable flag active to the API request.

Available from tag 3.0.3

Benefits:
Facet configuration in IA becomes optional (except for when custom properties on facets are desired)

Nr of products returned

yes

The hitCount property on the API Request Schema https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/8749643/Narrative+API+-+Technical+Reference#Base-parameters

Group by (field name)

yes (default provided)

The groupBy property on the API Request Schema https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/8749643/Narrative+API+-+Technical+Reference#Typical-parameters

Apply Request Parameters

yes

If set to yes - the API request will read the page URL and set the facets

• recommended for the navigation integration

• not recommended for the CMS sliders (ex: having a “category best-seller” slider on a category which is not integrated with Boxalino)

Returned Fields

no (default provided)

The returnFields property on the API Request Schema https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/8749643/Narrative+API+-+Technical+Reference#Typical-parameters

• divided by comma

• list of fields to be returned from the available data index

• the products_ prefix is required for properties (ex: products_brand)

Filters

no

default filters (per integration context) are status, visibility and the Category Filter configuration

• different filters must be divided by comma (,)

• multiple filter options must be divided by the division character | (pipe)

Category Filter

no (default provided)

Setting a category ID as a filter

• for navigation widget integration, use the Current Category option

• for home widget integration (or landing pages, generic contexts), use the Sales Channel Navigation Category option

• for custom category ids filter, use the Custom category IDs option

Category List for Filters

no

When the “Category Filter” option is set to “Custom category IDs”, add the category IDs (HEX) divided by a comma (,)

Facets

no

List of custom selected facet filters on the CMS element (ex: products_brand=Killing Inc|Mann Inc,products_size=37 ):

• different facets must be divided by comma (,)

• multiple facet options must be divided by the division character | (pipe)
  

• )
  

Sort

no

The sort option key (for pre-selected sorting in the request)

• set the key from the available sorting collectiondefined in Integration Layer (

• available since tag 3.0.2

Context Parameters

no

Available from tag 2.4.1

List of custom parameters to be added to the API Request properties (key-value) (ex: campaign=christmas-bestsellers):

• different parameters must be divided by comma (,)

• multiple parameter values must be divided by the division character | (pipe)