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.
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.
Persisting page configurations will be supported in the eSales Apps, allowing merchandisers to manipulate settings such as product filters and recommendation algorithms.
- Autocomplete Query
- Cart Page Query
- Category Page and Landing Page Query
- Content Search Page Query
- Content Information Query
- Product Page Query
- Search Page Query
- Navigation Tree Query