Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-shop
string
required

Shopify store URL

Example:

"shop.myshopify.com"

Body

application/json

Request body

product_ids
integer[]
required

List of product IDs to get recommendations for

recommendation_type
enum<string>
required

Type of recommendations to retrieve

Available options:
similar_products
view
enum<string>
required

Context where recommendations will be displayed

Available options:
product_details,
product_ids
filter
object
pagination
object

Response

Recommendations

status
enum<string>

Status of the response

Available options:
ok
serve_id
string

Unique identifier for this recommendation serve

pagination
object
products
object[]