Overview
Use/v1/recommendations/* to retrieve ranked product lists for product detail pages, category pages, destination pages, and search/browse pages.
These routes use the same HoJ authentication as the rest of the Distribution API. Clients send Authorization: Bearer <api key|oauth token> to api.hofj.com; the BFF calls the recommender service server-side with its own upstream secret.
Required scope
Your client must includerecommendations in allowedEntities. The requested brand must resolve to a distribution channel id included in your allowedChannelIds.
Common parameters
| Parameter | Required | Description |
|---|---|---|
brand | Yes unless a server default is configured | Distribution channel name or domain, for example Weebora or weebora.com. |
locale | Yes unless a server default is configured | Page/navigation locale, for example it, en, es, or fr. |
top_n | No | Maximum number of products to return. Limits depend on the endpoint. |
slim | No | When true, returns lightweight recommendation items. |
Examples
Product detail recommendations
Search catalog with filters
Response shape
Responses follow the BFF envelope:meta.cacheLoadedAt when available.