Skip to main content
POST
/
v3
/
search
/
related
Get Related Recommendations
curl --request POST \
  --url 'https://api.example.com/v3/search/related?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "market": "<string>",
  "merchant": "<string>",
  "locale": "<string>",
  "filters": [
    {
      "field": "<string>",
      "op": "eq",
      "data": "true",
      "meta": {
        "type": "<unknown>",
        "min": 123,
        "max": 123,
        "group_title": "<string>",
        "group_expanded": true,
        "unit": "<string>",
        "currency": "<string>"
      },
      "id": "<string>"
    }
  ],
  "sort": {
    "field": "<string>",
    "order": "asc",
    "meta": {
      "title": "<string>",
      "values": [
        "asc"
      ],
      "names": [
        "<string>"
      ]
    }
  },
  "session_id": "<string>",
  "metadata": {},
  "query": "<string>"
}
'
{
  "displays": [
    {}
  ],
  "error": "<string>",
  "variant": 123,
  "experiment_id": "<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

​
x-use-db-display-store
boolean
default:false

Body

application/json
​
market
string
required
​
merchant
string
required
​
locale
string
required
​
filters
SearchFilter · object[] | null

List of filters to apply to the results.

​
sort
SortModel · object

Specifies the sorting method. By default, the results are ordered by relevance. To find the possible values for this field, query the endpoint and look at the sorts field.

​
session_id
string | null

Session identifier

Minimum string length: 1
​
metadata
Metadata · object

Metadata that can be used to modify the behaviour of the search.

​
query
string | null

The search query.

Response

Successful Response

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