Query integration¶
Query integration handles requests to Voyado Elevate and renders the responses on the site. Each query targets a specific page or area, retrieving all relevant data in a single request.
All queries, including their request and response schemas, are documented in the Storefront API Specification. Since available data depends on your catalog content, it’s important to align data modeling, ID conventions, and key usage across your integration.
For details on common and noteworthy query parameters, see Query parameters.
Page-centric model¶
Each query in the Storefront API is designed around a page-centric concept, where a single request retrieves all data needed to render a given page or view. For most user-facing pages, this means making one request to Elevate per page, with a few exceptions. This model enables the following benefits:
- Built-in deduplication: prevents overlapping content across areas.
- Consistent data: all related components share the same context.
- Optimized performance: minimizes network overhead.
- Simplified integration: fewer API calls and reduced client-side logic.
Page configurations¶
For more information about queries and page configurations, see the Storefront Overview.
Caching¶
A strong recommendation is to never cache the Elevate response. The response is generated dynamically for every request. Caching this data, for example through full-page or API-layer caching, breaks key mechanisms and leads to incorrect or outdated experiences.
Caching the Elevate response can lead to:
- Loss of personalization and relevance
- Incorrect A/B tests
- Incorrect presentation of sponsored products
- Inaccurate behavioral tracking and attribution
Caching can still be safely applied to static or media assets referenced in the response, such as product images or videos. These assets are not affected by personalization logic or test variations.
In short, cache supporting resources, not the Elevate response itself such as product order, included products, or tickets.