search

/pdp-recs

This page outlines the request and response formats for Frenzy Search’s PDP Recommendations endpoint. It also includes examples for easier understanding.

The endpoint returns similar and cross-sell products based on the product provided in the request.

Note: The /pdp-recs endpoint consolidates the functionality of both /recommendation and /pair-with. We recommend using /pdp-recs moving forward to access the latest features.

hashtag
PDP Recommendations

POST https://xyz.search.frenzy.ai/pdp-recs

Get top N matching products for a given sku.

hashtag
Query Parameters

Name
Type
Description

sku*

string

Unique id for the product. For Shopify users - sku = product_id + "" + variant_id.

full_description

boolean

To get all products with their attributes set it to true. (Default false)

num_matching

integer

Required number of matching products

user_id

string

User id associated with the request (only required for personalization).

session_id

string

Session id associated with the request.

config_id

string

Configuration id for widget..

shop

string

Shopify's myshopify url. (without https://)

ab_test_id

string

A/B test id when test is running.

currency

string

Currency code.

country

string

Country code.

state

string

State code.

company_id

string

Shopify B2B company id.

location_id

string

Shopify B2B location id.

publication_app_id

string

Shopify publication app id.

hashtag
Headers

Name
Type
Description

X-Frenzy-Authorization*

string

API key provided at the time of account creation.

X-Shop

string

Shopify's myshopify url. (without https://)

NOTE: For Shopify Customers

  1. sku = product_id + '_' + variant_id

  2. num_matching = is set in the portal

hashtag
Response Object

Key

Type

Value

matching_products

array

Top N matching products

request_id

string

Id to track the request

PreviousCarouselsNext/landing-page-recs

Last updated