Documentation
Feedback
Guides
API Reference

API Reference
Filter By
Post
Get
Put
Delete
Patch

Recommendations BFF API

The Recommendations BFF API allows VTEX stores, integrators, and partners to fetch product recommendations, record user/product events, and manage recommendation sessions for headless, FastStore, and mobile storefronts.

This API powers personalized and contextual product recommendations, tracks user interactions, and enables advanced analytics. It supports multiple recommendation strategies including best sellers, personalized recommendations, similar products, cross-sell, and visually similar items.

This feature is in beta. For questions about enablement, account configuration, or campaigns, contact VTEX Support.

Integration guides

Event tracking

Web storefronts (headless or FastStore): Recommendation shelf view and click events are automatically captured through Activity Flow when proper data attributes are rendered on shelf elements. Cart and order events are also automatically captured. Product view events must be sent via this API.

Mobile apps: All events (recommendation view, recommendation click, and product view) must be sent via this API. Cart and order events require Activity Flow integration for mobile apps.

Endpoints

Events

SummaryMethodPath
Recommendation viewPOST/api/recommend-bff/v2/events/recommendation-view
Recommendation clickPOST/api/recommend-bff/v2/events/recommendation-click
Product viewPOST/api/recommend-bff/v2/events/product-view

Recommendations

SummaryMethodPath
Fetch recommendationsGET/api/recommend-bff/v2/recommendations

Users

SummaryMethodPath
Start sessionPOST/api/recommend-bff/v2/users/start-session

Loading API specification...