Get Recommended Items

5min
The Get Recommended Items endpoint is a powerful recommendation engine that utilizes machine learning, matrix factorization, and user feedback to provide accurate and relevant item suggestions. By integrating these techniques, the API enhances customer engagement and boosts sales conversions.
Key Features
Personalized Engagement – Tailors recommendations based on user behavior.
Diverse Suggestions – Expands product discovery with varied options.
Scalability & Real-Time Adaptation – Ensures seamless performance for large-scale operations.
Increased Conversions – Drives higher sales through accurate recommendations.
Accessing Recommended Items
Retailers can retrieve recommended product suggestions via the Get Recommended Items API.
API Details
Endpoint: GET https://api.upstartcommerce.com/v1/catalog/live/recommendation/item/{catalogItemId}
Headers
Curl
{
  "x-upstart-tenant": "yourtenant",
  "x-upstart-site": "your-site-id",
  "Authorization": "Bearer your-auth-token"
}
{
  "x-upstart-tenant": "yourtenant",
  "x-upstart-site": "your-site-id",
  "Authorization": "Bearer your-auth-token"
}
﻿
Path Parameters:
catalogItemId (string, required) – Unique identifier for a catalog item.
Query Parameters:
recommendationType (string, optional) – Type of recommendation to retrieve.
Allowed values: frequently_bought, visually_similar, similar
Example Request
Curl
curl --request GET \
  --url https://api.upstartcommerce.com/v1/catalog/live/recommendation/item/{catalogItemId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'x-upstart-site: your-site-id' \
  --header 'x-upstart-tenant: yourtenant'
curl --request GET \
  --url https://api.upstartcommerce.com/v1/catalog/live/recommendation/item/{catalogItemId} \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'x-upstart-site: your-site-id' \
  --header 'x-upstart-tenant: yourtenant'
﻿
Example Response
Curl
[
  {
    "id": "123456",
    "name": "Example Reclining Loveseat",
    "brandName": "FurnitureCo",
    "avgRating": 4.62,
    "numReviews": 17,
    "manufacturerName": "BestMakers",
    "price": {
      "currency": "USD",
      "value": 499.99
    },
    "media": {
      "uri": "https://example.com/images/item123456.jpg",
      "altText": "Example Reclining Loveseat"
    }
  },
  {
    "id": "789101",
    "name": "Premium Loveseat",
    "brandName": "HomeComfort",
    "avgRating": 4.8,
    "numReviews": 25,
    "manufacturerName": "TopFurniture",
    "price": {
      "currency": "USD",
      "value": 599.99
    },
    "media": {
      "uri": "https://example.com/images/item789101.jpg",
      "altText": "Premium Loveseat"
    }
  }
]
[
  {
    "id": "123456",
    "name": "Example Reclining Loveseat",
    "brandName": "FurnitureCo",
    "avgRating": 4.62,
    "numReviews": 17,
    "manufacturerName": "BestMakers",
    "price": {
      "currency": "USD",
      "value": 499.99
    },
    "media": {
      "uri": "https://example.com/images/item123456.jpg",
      "altText": "Example Reclining Loveseat"
    }
  },
  {
    "id": "789101",
    "name": "Premium Loveseat",
    "brandName": "HomeComfort",
    "avgRating": 4.8,
    "numReviews": 25,
    "manufacturerName": "TopFurniture",
    "price": {
      "currency": "USD",
      "value": 599.99
    },
    "media": {
      "uri": "https://example.com/images/item789101.jpg",
      "altText": "Premium Loveseat"
    }
  }
]
﻿
﻿
Did this page help you?
Alternate Product Recommendation
Welcome