Skip to main content
POST
/
v2
/
recommend
/
products
/
product
Recommend For Product And User
curl --request POST \
  --url 'https://api.example.com/v2/recommend/products/product?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant": "<string>",
  "market": "<string>",
  "type": "<string>",
  "product_id": "<string>",
  "locale": "<string>",
  "limit": 64,
  "user_id": "<string>",
  "session_id": "<string>",
  "dsid": "<string>",
  "document_referrer": "<string>",
  "metadata": {}
}
'
{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.depict.ai/llms.txt

Use this file to discover all available pages before exploring further.

This page does not apply to installs made in 2025 or later of the Depict Shopify apps

Authorizations

api_key
string
query
required

Headers

referer
string

Body

application/json
tenant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

type
string
required

Type of the recommendation, e.g. cross_sell

product_id
string
required
locale
string | null

Locale identifier

limit
integer | null

Maximum number of recommendations returned.

Required range: 1 <= x <= 128
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

Minimum string length: 1
document_referrer
string | null
metadata
Metadata · object

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

Response

Successful Response

displays
Displays · object[]
required
error
string | null
variant
integer | null
experiment_id
string | null