Documentation
Feedback
Guides
API Reference

Guides
Search
Get banner list for a specific search
Get banner list for a specific search

It is possible to display banners as promotional actions on the customer's search result page. This process is done through an association between the words and facets that represent filters selected when making a search. For more information on how to configure a banner, check the Configuring Banners article.

To retrieve a list of banners for a specific search, use the Get list of banners registered for query endpoint. You can filter the endpoint response by defining the search’s facets and the term's locale and query.

Response body example:


_10
{
_10
"banners": [
_10
{
_10
"id": "summersale",
_10
"name": "Summer Sale",
_10
"area": "1",
_10
"html": "<h1>This is a test</h1>"
_10
}
_10
]
_10
}

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page