v1

latestOpenAPI 3.0.02026-07-24182211348.4 KB
Searchbanners

searchbanners

Service that returns searchbanners based on a search term.

get/searchbanners/{instancekey}

Path parameters

instancekeystring required

Instance specific key.

Query parameters

tn_qstring required

Search term entered by the user.

tn_cidstring

The category that should contain the filtered results. If you want to provide the entire path, you should include the categories divided by a hyphen (-).

Example: ?tn_cid=100-150

tn_keyboardstring

Specify the keyboard to use for the search algorithms.

All available options are: 'qwerty', 'azerty' or 'qwertz'

Example: ?tn_keyboard=azerty

Headers

TWN-Sourcestring

The source of the request. See the article on the request source for more information.

Response

Response with searchbanners

imageurlstring

The image of the searchbanner

clickurlstring

The url to go to if you click on the banner.

clicktargetstring

Target to go to if banner is clicked (_blank: It opens the link in a new window. _self: It opens the linked document in the same frame.)

typestring

The type where this banner will show: (Desktop | Mobile)

locationstring

Location of the banner: (ContainerTop | ListTop | ProductsTop)

categoryidinteger

The categoryid where this banner is for