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": {}
}
'
import requests

url = "https://api.example.com/v2/recommend/products/product?api_key="

payload = {
"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": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
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: {}
})
};

fetch('https://api.example.com/v2/recommend/products/product?api_key=', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v2/recommend/products/product?api_key=",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/v2/recommend/products/product?api_key="

payload := strings.NewReader("{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"type\": \"<string>\",\n \"product_id\": \"<string>\",\n \"locale\": \"<string>\",\n \"limit\": 64,\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"metadata\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/v2/recommend/products/product?api_key=")
.header("Content-Type", "application/json")
.body("{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"type\": \"<string>\",\n \"product_id\": \"<string>\",\n \"locale\": \"<string>\",\n \"limit\": 64,\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"metadata\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v2/recommend/products/product?api_key=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"tenant\": \"<string>\",\n \"market\": \"<string>\",\n \"type\": \"<string>\",\n \"product_id\": \"<string>\",\n \"locale\": \"<string>\",\n \"limit\": 64,\n \"user_id\": \"<string>\",\n \"session_id\": \"<string>\",\n \"dsid\": \"<string>\",\n \"document_referrer\": \"<string>\",\n \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body
{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}
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 | null

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