Cartup docs
  • Introduction
  • Browse Topics
  • Getting Started
  • Recommendation Configuration
    • Get Recommendation Types
    • Create Recommendation
      • Rules
    • Get Recommendation
    • Update Recommendation
    • Delete Recommendation
    • Create Themes
    • Get Theme List
    • Get Theme
    • Update Theme
    • Delete Theme
  • Recommendations
  • About Recommendations
  • Crosssell Products
  • Content Based Recommendation
  • Trending Product
  • Trending in category
  • Viewed also viewed
  • Recentviews
  • Category Based Recommendations
  • Bought Category Items
  • Bought also bought
  • Viewed Category Items
  • Inspired By Browser History
  • Based on Wishlist
  • Search
  • Search Configurations
  • Create Search Config
  • Get Search Config
  • Update Search Config
  • Delete Search Config
  • Upload Synonym
  • Upload Stop Word
  • Upload OneWay Synonym
  • Get synonym csv file
  • Get OneWay Synonym csv file
  • Get Stopwords csv file
  • Delete Synonym CSV file
  • Delete OneWaySynonym CSV file
  • Delete Stopwords CSV file
  • Search Suggestions
    • Get Search suggestions
  • Search Result
    • Get Search result
  • Shopify app configuration
  • Events Configuration
  • Shopify Widget Configuration
    • Create Widget
    • Verify the Widget
    • To create widget theme
  • Shopify badging configuration
    • To verify default badges
    • To create new badges
      • Create badge
      • Verify the badge
  • Shopify search configuration
    • To verify default search
    • To reconfigure your search
      • AI personalization & Ranking
      • Synomyns & Rules
      • Auto Facets
      • Advanced
    • To create search bar theme
    • To create search results theme
  • Shopify plp configuration
    • To configure plp
    • Verify plp
    • To create plp result theme
  • Events
  • Mobile Integration
  • iOS Integration
  • Android Integration
Powered by GitBook
On this page

Was this helpful?

Content Based Recommendation

Recommendation of the same category or other categories base on the 'content type' of the product being viewed.

End Point

GET https://api.cartup.ai/v1/widgetserver/contentbasedreco

Query Parameters

Name
Type
Description

divisionId*

String

HTLM tag id (need to be unique)

orgId*

String

Your org ID

domain*

String

Your Domain

pname*

String

Your Product Name

Headers

Name
Type
Description

Accept*

String

application/json

Content_type*

String

application/json

X-Cartup-Access-Token*

String

$CARTUP_API_KEY

X-Cartup-orgId *

String

$CARTUP_ORD_ID

{
    "errMsg": null,
    "numberofdocs": 10,
    "success": "0",
    "widgetType": "contentbasedreco",
    "widgetName": "More Items to Consider",
    "products": [
        {
            "name": "Jupiter All-Weather Trainer",
            "sku": "MJ06",
            "price": "56.99",
            "smallImage": "http://mdev.ecomtics.nl//pub/media/catalog/product/m/j/mj06-blue_main_1.jpg",
            "currentPageUrl": "http://mdev.ecomtics.nl/jupiter-all-weather-trainer.html"
        }
    ],
    "customValues": {}
}

}
{
    "errMsg": "org id is empty",
    "numberofdocs": 0,
    "success": null,
    "widgetType": null,
    "widgetName": null,
    "products": null,
    "customValues": null
}

‌

Curl Example

curl --request GET 'http://api.cartup.ai/v1/widgetserver/contentbasedreco?divisionId=demo_content_based&pname=Fiona Fitness Short&orgId=850a8b8f-a6fe-49e4-88fc-874843279d66&domain=magento'
--header 'Accept: application/json' \  
--header 'Content-Type: application/json' \  
--header 'X-Cartup-Access-Token: $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'

​

‌

‌

‌

‌

‌

PreviousCrosssell ProductsNextTrending Product

Last updated 3 years ago

Was this helpful?