Skip to content

Queries

The HTTP API has been designed to allow all eSales driven page content to be retrieved through a single request. This enables features such as result deduplication, it minimizes the number of required round trips, as well as allows for other performance optimisations.

Each page is divided by usage area, which affects both visitor statistics, visitor analysis, and the response. For example, did-you-mean results will always be returned on search pages when available, and correct usage of product page and cart page requests enables correct behaviour and product correlation analysis. It is therefore important that the usage of a query aligns with the intended purpose of the query.

Non-intended query purposes

Retailers that need to use queries for a non-intended purpose should append those queries with notify=false, and contact their appointed Apptus Success Manager to follow up on correct usage.

Page requests

Each page type is fetched with a set of query parameters and optionally a request body. The request body allows the page to have the included content modified. For example, a category page will always include the product listing for the requested category in the response, but can be configured to include additional recommendation areas.

Pages with modified content must be retrieved through POST requests, where the content modification specification is supplied as the body. Pages without modifications can be retrieved through either GET requests or POST requests with empty bodies.

Coming soon

Persisting page configurations will be supported in the eSales Apps, allowing merchandisers to manipulate settings such as product filters and recommendation algorithms.

Page specifications

Page requests can be tested by downloading examples for use with the tool Postman. Note that the {cluster-id} in the example queries must be changed to the correct cluster id.

Common specifications


Last update: December 8, 2020
×
Copyright

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