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 behavior 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 a page to have the included content modified and it can be used as a page configuration. 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. The request is per page and will persist for 2 hours for that specific page. This means that page settings and other content in the Apptus eSales apps that can be altered by a
POST request for that page will not be updated until a new
POST request is sent to that page after the 2 hour period is over.
Pages without modifications can be retrieved through either
GET requests or
POST requests with empty bodies. If a
GET request is to be performed, the target page must already be configured in the Category and Landing pages tab of the Experience app.
All page configurations supplied in a
POST request body can be overridden per page and list in the Category and Landing pages tab of the Experience app. A new
POST request will not change what is overridden in the apps.
- Cart Page
- Category Page and Landing Page
- Content Search Page
- Content Information
- Product Page
- Search Page
- Navigation Tree
For the full HTTP API specification, see Specification.