/recommendation

This page explains the request and response formats of 'recommendation' endpoint of Frenzy Search. It also provide examples to help you understand better.

Returns similar products for the given product in the request.

recommendation

GET https://xyz.search.frenzy.ai/recommendation

Get top N matching products for a given product-id.

Query Parameters

Name	Type	Description
sku*	string	product-id of the product
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)
config_id	string	Config ID for A/B text
shop	string	name of the Shopify Store. (required for shopify stores)

Headers

Name	Type	Description
X-Frenzy-Authorization*	string	API key provided at the time of account creation.

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

Success

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

Success(full_description=true)

{
  "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"
    }
  ]
}

Failure

{'error': 'server_error'}

NOTE: For Shopify Customers

1. sku = product_id + '_' + variant_id

2. 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

Example Request

By default, the request will return only the list of matching product-ids.

curl --location --request GET 'https://xyz.search.frenzy.ai/recommendation?sku=7104647135405_41289316270253&num_matching=15' \
--header 'X-Frenzy-Authorization: API_KEY'

Example Request (full_description = true)

To get all product attributes along with product-ids, set the full_description parameter to true

curl --location --request GET 'https://xyz.search.frenzy.ai/recommendation?sku=7104647135405_41289316270253&num_matching=15&full_description=true' \
--header 'X-Frenzy-Authorization: API_KEY'