This online publication is intellectual property of Apptus Technologies. Its contents can be duplicated in part or whole, provided that a copyright label is visibly located on each copy and the copy is used in conjunction with the product described within this document.
All information found in these documents has been compiled with utmost attention to detail. However, this does not guarantee complete accuracy. Neither Apptus Technologies nor the authors shall be held liable for possible errors or the consequences thereof.
Software and hardware descriptions cited in these documents might be registered trademarks. All trade names are subject to copyright restrictions and may be registered trademarks. Apptus Technologies essentially adheres to the manufacturer’s spelling. Names of products and trademarks appearing in this document, with or without specific notation, are likewise subject to trademark and trade protection laws and may thus fall under copyright restrictions.CLOSE
A panel can be described as an area on a page where eSales functionality is used. The main types of panels are result panels and zones. Some panels can be reused on several pages, such as navigation.
Panels are set up in a hierarchy to define the content structure of an e-shop. Requests to panels through the Web API with Panel Queries returns the content based on the panel type, its configuration and what arguments are sent to them.
Panels can only be queried through the Web API when the panel hierarchy for a site has been published. The publishing generates unique paths to the panels and zones based on the panel names. The paths are used for identification with queries and statistics. The name of a panel or zone should reflect its use and position in the site structure.
A panel or zone should not be renamed after its initial publishing. All statistics for panels and zones are connected to their path. As the path is based on the panel and zone name, statistics will be reset when the identifying path is changed.
The core type of panel is a result panel. This type of panel can contain items returned from eSales such as a list of products, a did-you-mean suggestion, or a list of faceted product attributes.
An other type of panel are zones. A zone is a container of other panels that are used to build a specific panel structure. This container most often represent a page or a specific part of a page.
Apptus eSales includes several predefined panels in a panel library. The predefined panels includes functions such as general product listing, autocomplete results, and product recommendations. Support for features such as exposure strategies, personalisation of products, deduplication, promotions, and demotions is panel dependent.
Predefined ads panels¶
|Ad information panel||Yes||No||No||No||Yes|
|Ads by customer panel||Yes||No||No||No||Yes|
|Ads by product panel||Yes||No||No||No||Yes|
|Ads by search panel||Yes||No||No||No||Yes|
|Top ads panel||Yes||No||No||No||Yes|
Predefined customer panels¶
|Abandoned carts panel||Yes||No||No||No||Yes|
|Recent searches panel||Yes||No||No||No||No|
|Recently bought panel||Yes||No||No||No||Yes|
|Recently viewed panel||Yes||No||No||No||Yes|
Predefined navigation panels¶
|Category breadcrumb panel||No||No||No||No||No|
|Category information panel||No||No||No||No||No|
|Category navigation panel||No||No||No||No||No|
|Category overview panel||No||No||No||No||No|
|Product breadcrumb panel||Yes||No||No||No||No|
|Product count panel||No||No||No||No||No|
|Product list panel||Yes||Full||Full||Full||Yes|
|Product list with count zone||Yes||Full||Full||Full||Yes|
|Top searches panel||No||No||No||No||No|
|Top sellers panel||No||No||No||No||Yes|
Predefined product panels¶
|Product information panel||No||No||No||No||No|
|Those who bought also bought panel||No||No||No||No||Yes|
|Those who viewed also viewed panel||No||No||No||No||Yes|
|Those who viewed bought panel||No||No||No||No||Yes|
Predefined recommendation panels¶
|Recommend based on cart panel||No||No||No||No||Yes|
|Recommend based on favourites panel |
|Recommend based on customer panel||Yes||No||No||No||Yes|
|Recommend based on product panel||No||Full||Full||No||Yes|
Predefined search panels¶
|Category search panel||No||No||No||No||No|
|Category suggestions panel||No||No||No||No||No|
|Product suggestions panel||No||Partial||Partial||Partial||Yes|
|Search hit count panel||No||No||No||No||No|
|Search hits panel||Yes||Full||Full||Full||Yes|
|Search hits with count zone||Yes||Full||Full||Full||Yes|
Result panels in a panel hierarchy can accept arguments in addition to any default or required values. Argument values can be defined in a parent zone, in the result panel itself, or left undefined. Arguments that are left undefined at the root of a panel hierarchy must be supplied at the time of the request.
Each part of an eSales panel (including products and ads) have a unique identifying ticket that can be sent into eSales with notifications in the Web API. The more notifications sent into eSales, the more it will learn from the visitor behaviour and provide better content as a result. Categories also have tickets. Most of the times it is not necessary to explicitly notify clicks on categories, but if a valid ticket is present in the result, i.e. not "-" which represents a deprecated ticket, it should be notified. Notifications on deprecated tickets will be ignored.