Skip to main content
POST
/
v3
/
recommend
/
products
Recommendations
curl --request POST \
  --url 'https://api.example.com/v3/recommend/products?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "merchant": "<string>",
  "market": "<string>",
  "locale": "<string>",
  "type": "<string>",
  "product_ids": [],
  "limit": 64,
  "session_id": "<string>"
}
'
import requests

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

payload = {
    "merchant": "<string>",
    "market": "<string>",
    "locale": "<string>",
    "type": "<string>",
    "product_ids": [],
    "limit": 64,
    "session_id": "<string>"
}
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({
    merchant: '<string>',
    market: '<string>',
    locale: '<string>',
    type: '<string>',
    product_ids: [],
    limit: 64,
    session_id: '<string>'
  })
};

fetch('https://api.example.com/v3/recommend/products?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/v3/recommend/products?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([
    'merchant' => '<string>',
    'market' => '<string>',
    'locale' => '<string>',
    'type' => '<string>',
    'product_ids' => [
        
    ],
    'limit' => 64,
    'session_id' => '<string>'
  ]),
  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/v3/recommend/products?api_key="

	payload := strings.NewReader("{\n  \"merchant\": \"<string>\",\n  \"market\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"type\": \"<string>\",\n  \"product_ids\": [],\n  \"limit\": 64,\n  \"session_id\": \"<string>\"\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/v3/recommend/products?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"merchant\": \"<string>\",\n  \"market\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"type\": \"<string>\",\n  \"product_ids\": [],\n  \"limit\": 64,\n  \"session_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v3/recommend/products?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  \"merchant\": \"<string>\",\n  \"market\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"type\": \"<string>\",\n  \"product_ids\": [],\n  \"limit\": 64,\n  \"session_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "displays": [
    {
      "variant_index": 123,
      "variant_displays": [
        {}
      ],
      "variant_skus": [
        "<string>"
      ],
      "variant_product_ids": [
        "<string>"
      ]
    }
  ],
  "error": "<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
merchant
string
required

Identifier associated with the API integration

market
string
required

Market identifier

locale
string
required

Locale identifier

type
string
required

Type of the recommendation, e.g. cross_sell

product_ids
string[]

Zero, one, or multiple product identifiers (depending on the id)

limit
integer | null

Maximum number of recommendations returned.

Required range: 1 <= x <= 128
session_id
string | null

Session identifier

Response

Successful Response

displays
APIDisplay · object[]
required
error
string | null