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>"
}
'
{
  "displays": [
    {
      "variant_index": 123,
      "variant_displays": [
        {}
      ],
      "variant_skus": [
        "<string>"
      ],
      "variant_product_ids": [
        "<string>"
      ]
    }
  ],
  "error": "<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
​
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