v1

latestOpenAPI 3.0.02026-07-22122745.8 KB

Recommendations

Get widget recommendations

Retrieves personalized recommendations for a specific widget

post/api/widget/{widget_id}

Path parameters

widget_idstring uuid required

Example:123e4567-e89b-12d3-a456-426614174000

Unique identifier for the widget

Request body

session_idstring nullable

Session identifier (optional)

user_idstring uuid nullable

User identifier (optional)

current_urlstring uri required

Current page URL

languagestring

Language code (optional)

price_namestring

Currency code (optional)

hashidstring

Hash identifier (optional)

category_contextobject[] nullable

Contextual category information (optional)

Example request

{
  "session_id": "b2b89619844f4eb0b5fa19f28a19d679",
  "user_id": "8c80694b-354c-4533-acd1-e4b8e7d74b7b",
  "current_url": "https://shop.example.com/products/wireless-headphones-pro",
  "language": "en",
  "price_name": "EUR",
  "hashid": "de8f052ea612f95b6950d4013dd6ef38",
  "cart_items": [
    {
      "dfid": "123e4567e89b12d3a456426614174000@product@e7b7a6c35b2d4afc94991bfc8100227a"
    }
  ]
}

Response

Successful response with recommendations

titlestring

fallback_actionstring

resultsobject[]

Array of recommendation items

Example response

{
  "title": "Our recommendations",
  "currency": {
    "code": "EUR",
    "label": "Euro",
    "format": "%v %s",
    "symbol": "€",
    "precision": 2,
    "decimal": ",",
    "thousand": "."
  },
  "fallback_action": "disabled"
}