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.
This API is used to power personalized and contextual product recommendations, track user interactions, and enable advanced analytics for VTEX stores.
Index
Events
POSTRecommendation view: Records when a user views a recommendation.POSTRecommendation click: Records a click on a product within a recommendation shelf.POSTProduct view: Records when a user views a product.
Recommendations
GETFetch recommendations: Retrieves a list of recommended products based on the provided parameters.
Users
POSTStart session: Creates a unique ID for a user to associate with the current session.
Endpoints
Events
| Summary | Method | Path |
|---|---|---|
| Recommendation view | POST | /api/recommend-bff/v2/events/recommendation-view |
| Recommendation click | POST | /api/recommend-bff/v2/events/recommendation-click |
| Product view | POST | /api/recommend-bff/v2/events/product-view |
Recommendations
| Summary | Method | Path |
|---|---|---|
| Fetch recommendations | GET | /api/recommend-bff/v2/recommendations |
Users
| Summary | Method | Path |
|---|---|---|
| Start session | POST | /api/recommend-bff/v2/users/start-session |