Alternate Product Recommendation
4 min
The Alternate Product Recommendation endpoint enhances the product discovery experience for consumers while increasing catalog exposure for retailers. This feature is integrated into the UpStart Commerce Search application, enabling personalized recommendations based on product attributes rather than visual similarity.
Accessing Product Recommendations
To retrieve alternate product recommendations for a specific product, businesses can use the Alternate Recommendation API. This API allows users to fetch relevant alternatives based on predefined attributes.
How to Retrieve Recommendations
- Make a GET Request: Send a request to the API endpoint with the product ID.
- Provide Required Headers:
- x-upstart-tenant: Identifies the retailer making the request.
- x-upstart-site: Specifies the particular site where recommendations are needed.
- Receive a Response: The system will return a list of recommended products with relevance scores.
API Endpoint
- Catalog Endpoint → recommendation
- Endpoint: /catalog/live/recommendation/item/{product_id}?recommendationType=similar
Headers
{
"x-upstart-tenant": "tenant",
"x-upstart-site": "site"
"Authorization": "Bearer your-auth-token"
}Example Request
A retailer wants recommendations for a particular product.
curl --location 'https://api.yourdomain.com/catalog/live/recommendation/item/{product_id}?recommendationType=similar' \
--header 'accept: application/json' \
--header 'x-upstart-tenant: tenant' \
--header 'x-upstart-site: site'
[
{
"id": "123456",
"name": "Example Reclining Loveseat",
"brand": "FurnitureCo",
"manufacturer": "BestMakers",
"color": "Gray",
"dimensions":
{
"length": 75,
"width": 40,
"height": 42,
"unit": "in"
},
"features":
[
"Reclining", "USB Port"
]
},
{
"id": "789101",
"name": "Premium Loveseat",
"brand": "HomeComfort",
"manufacturer": "TopFurniture",
"color": "Beige",
"dimensions":
{
"length": 80,
"width": 38,
"height": 40,
"unit": "in"
},
"features":
[
"Power Recline",
"Cup Holder"
]
}
]