Versions Compared

Key

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

Overview

...

The purpose of this guide is to provide the steps required to integrate browse service via REST API and use the returned tagging urls for each event (query, click, add2cart, ...).

Step-by-step guide

Service Name

...

ParameterDescriptionData TypeMandatory
categoryIdThe query for the requestcategory that has been clicked to filter byStringYes
langSet the language of the queryStringYes
startIt is used to paginate results from a queryIntegerYes
rowsIt is used to paginate results from a queryIntegerYes
filterSet query filtersStringNo
boostboosting query in lucene query formatStringNo
facetSet query facetsStringNo
sortSort resultsStringNo
jsonCallbackName of the callback that will be executed after the requestStringNo

...

By default, the service will return one node for the search results (content).

Moreover this JSON includes one node per product with the tagging urls and one additional node with the search tagging url.

Code Block
languagejs
{
    content: {},
	ebTagging: {
    	browseCategory: "URL_EMPATHYBROKER/tagging/v1/track/CLIENT_ID/browseCategory?categoryId=QUERY&scope=default&lang=es&totalHits=10&page=1...."
  	}
}

...