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.

This API is used to power personalized and contextual product recommendations, track user interactions, and enable advanced analytics for VTEX stores.

Index

Events

Recommendations

Users

  • POST Start session: Creates a unique ID for a user to associate with the current session.

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...