POST
/
v2
/
recommend
/
products
/
general
{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<string>"
}

Authorizations

api_key
string
queryrequired

Headers

referer
string

Body

application/json
tenant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

locale
string | null

Locale identifier

type
string
required

Type of the recommendation, e.g. cross_sell

limit
integer | null

Maximum number of recommendations returned.

user_id
string | null

Customer identifier

session_id
string | null

Session identifier

dsid
string | null

Populated for integrations performed by Depict.ai only. Depict.ai Session Id

document_referrer
string | null
metadata
object | null

Metadata that can be used to modify the behaviour of the recommendation system

Response

200 - application/json
displays
object[]
required
error
string | null
variant
integer | null
experiment_id
string | null