Versions Compared

Old Version 1

changes.mady.by.user Dana Negrescu

Saved on

compared with

New Version 2

changes.mady.by.user Dana Negrescu

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Property

Required

Description

1

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

2

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)

3

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

4

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

5

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)

6

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)

7

Filters

no


default filters (per integration context) are status and visibility

8

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

9

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 (,)

10

Facets

no

List of custom 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 configured in your integration layer (ex: | )

Practices

For a transparent integration and a consistency across your project, the following practices are recommended:

  1. Creating a Boxalino Sidebar Navigation Landing Page (in Shopping Experiences Layouts)

    1. to be used for navigation widget, as a layout for Category pages (with Navigation CMS element)

    2. to be used for other pages with facets, on which the navigation CMS element is also desired

      Image Added

  2. Creating a Boxalino Layout Landing Page (in Shopping Experiences Layout)

    1. to be used for navigation widget, as a layout for Category pages (without Navigation CMS element)

    2. to be used for other pages, where the Navigation CMS element is not needed

  3. Creating a Boxalino Sidebar Layout Landing Page (in Shopping Experiences)

    1. to be used for sidebar layout contexts

      1. the sidebar content is to be defined in the narrative structure in Boxalino Intelligence Admin

The above elements are contextual.

When used as Layout Assignment in a Category or CMS page, the widget and the other properties can be edited.