POST
/
v3
/
recommend
/
products
{
  "displays": [
    {
      "variant_index": 123,
      "variant_displays": [
        {}
      ],
      "variant_skus": [
        "<string>"
      ],
      "variant_product_ids": [
        "<string>"
      ]
    }
  ],
  "error": "<string>"
}

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

200
application/json
Successful Response
​
displays
object[]
required
​
error
string | null

Was this page helpful?

Get Related RecommendationsGet Displays