/pdp-recs - Frenzy AI Personalization

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.

PDP Recommendations

POST https://xyz.search.frenzy.ai/pdp-recs Get top N matching products for a given sku.

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.

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://)

200 Top N matching products for the given product-id are successfully retrieved.

Success
Success(full_description=true)
Failure

{  // list of matching products
  "matching_products": [
    "PSS-001-00001",
    "PSS-002-00002",
    ....
    ...
    ...
    "PSS-010-00015"
  ]
}

{
  "matching_products": [
  
    // description for product 1
    
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
    'sku' : "PSS-001-00001"
    },
    
    // description for product 2 
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
    'sku' : "PSS-002-00002"
    },
    ....
    ...
    ..
    
    // description for product N
    
    {
    'brand' :  " ",
    'category' : " ",
    ...
    ...
    ..
     'sku' : "PSS-010-00015"
    }
  ]
}

{'error': 'server_error'}

NOTE: For Shopify Customers

sku = product_id + ’_’ + variant_id

num_matching = is set in the portal

Response Object

Key	Type	Value
matching_products	array	Top N matching products
request_id	string	Id to track the request