Get Recommendation Types

Get the list of recommendation algorithm and the relevant page the recommendation widget can be placed.

End Point

GET https://api.cartup.ai/v1/algorithm

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

200: OK

{
  "errMsg": null,
  "widgets": [
    {
      "displayName": "Category Based Recommendation",
      "name": "categoryreco",
      "type": "custom",
      "description": "Recommend products in the same category as the product currently being viewed.",
      "pages": [
        "collection_page",
        "product_page"
      ],
      "recommendedPages": [
        "collection_page"
      ]
    },
    {
      "displayName": "Content Based Widget",
      "name": "contentbasedreco",
      "type": "custom",
      "description": "Recommendations of the same category or other categories based on the 'content type' of the product being viewed.",
      "pages": [
        "product_page"
      ],
      "recommendedPages": [
        "product_page"
      ]
    },
    {
      "displayName": "Recent Views",
      "name": "recentviews",
      "type": "custom",
      "description": "Displays the recently viewed products by the site visitor.",
      "pages": [
        "home_page",
        "product_page",
        "collection_page",
        "blogs_articles_page",
        "order_page",
        "404_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "product_page",
        "cart_page"
      ]
    },
    {
      "displayName": "Trending in category",
      "name": "trendingincategory",
      "type": "custom",
      "description": "Recommend trending products in the same category as the product currently being viewed.",
      "pages": [
        "collection_page"
      ],
      "recommendedPages": [
        "collection_page"
      ]
    },
    {
      "displayName": "Trending Items",
      "name": "trending",
      "type": "custom",
      "description": "Recommend products that are trending in different categories based on purchases by other users.",
      "pages": [
        "home_page",
        "product_page",
        "collection_page",
        "blogs_articles_page",
        "order_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "cart_page",
        "order_page",
        "collection_page"
      ]
    },
    {
      "displayName": "Based On Wishlist",
      "name": "wishlistreco",
      "type": "custom",
      "description": "Recommend products from the wishlist which are alternatives or associated with the product currently being viewed.",
      "pages": [
        "home_page",
        "product_page",
        "order_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "product_page",
        "cart_page"
      ]
    },
    {
      "displayName": "Cross Sell",
      "name": "crosssell",
      "type": "custom",
      "description": "Two or three products are recommended together (bundled) as addons to the product currently being viewed.",
      "pages": [
        "product_page",
        "cart_page",
        "home_page"
      ],
      "recommendedPages": [
        "product_page"
      ]
    },
    {
      "displayName": "Bought Category Items",
      "name": "boughtcatitemsreco",
      "type": "custom",
      "description": "Recommend products from of the category of products previously bought by the visitor.",
      "pages": [
        "home_page",
        "product_page",
        "blogs_articles_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "product_page",
        "cart_page"
      ]
    },
    {
      "displayName": "Viewed Category Items",
      "name": "viewedcatitemsreco",
      "type": "custom",
      "description": "Recommend products from of the category of products previously viewed by the visitor.",
      "pages": [
        "home_page",
        "product_page",
        "blogs_articles_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "product_page",
        "cart_page"
      ]
    },
    {
      "displayName": "Bought Also Bought",
      "name": "boughtalsobought",
      "type": "custom",
      "description": "Recommend products based on what other site visitors have bought.",
      "pages": [
        "home_page",
        "product_page",
        "blogs_articles_page",
        "cart_page"
      ],
      "recommendedPages": [
        "home_page",
        "product_page",
        "cart_page"
      ]
    },
    {
      "displayName": "Inspired By Your Browser History",
      "name": "inspbybrowsehist",
      "type": "custom",
      "description": "Recommendations are based on previously viewed or bought by the visitor.",
      "pages": [
        "home_page",
        "blogs_articles_page",
        "cart_page",
        "order_page"
      ],
      "recommendedPages": [
        "home_page",
        "cart_page",
        "order_page"
      ]
    },
    {
      "displayName": "Viewed Also Viewed",
      "name": "viewedalsoviewed",
      "type": "custom",
      "description": "Recommend products based on what other site visitors viewed after viewing the current product.",
      "pages": [
        "home_page",
        "blogs_articles_page",
        "cart_page",
        "order_page"
      ],
      "recommendedPages": [
        "home_page",
        "cart_page",
        "order_page"
      ]
    }
  ],
  "pages": [
    {
      "displayName": "Product Page",
      "name": "product_page",
      "pageType": "PDP",
      "description": "Add product page to increase discoverability of your entire catalogue."
    },
    {
      "displayName": "Home Page",
      "name": "home_page",
      "pageType": "Index",
      "description": "Add recommendations on homepage to showcase personalized and top products. Prevent dropoffs and give a personalized experience."
    },
    {
      "displayName": "Order Confirmation Page",
      "name": "order_page",
      "pageType": "order",
      "description": "Add recommendations on homepage to showcase personalized and top products. Prevent dropoffs and give a personalized experience."
    },
    {
      "displayName": "Collection Page",
      "name": "collection_page",
      "pageType": "Collection",
      "description": "Add on product page to increase discoverability of your entire catalogue."
    },
    {
      "displayName": "Cart Page",
      "name": "cart_page",
      "pageType": "Cart",
      "description": "Products on Cart page. Show recommendations based on a user's cart."
    },
    {
      "displayName": "AJAX Cart Page",
      "name": "ajax_cart_page",
      "pageType": "AJAX Cart",
      "description": "On themes supporting AJAX Cart, this is a great way to cross sell your products. Users can directly add products to their cart from this widget."
    },
    {
      "displayName": "Blogs and Articles",
      "name": "blogs_articles_page",
      "pageType": "Blog",
      "description": "Add relevant recommendations and Blog & Articles to attract customers to your store."
    },
    {
      "displayName": "404 NOT FOUND",
      "name": "404_page",
      "pageType": "404",
      "description": "Add recommendations on 404 Not Found page to keep users on the store website."
    }
  ]
}
    }]
}

403: Forbidden

‌

Curl Example

curl --request GET 'https://api.cartup.ai/v1/algorithm
--header 'Accept : application/json' \  
--header 'Content-Type : application/json' \  
--header 'X-Cartup-Access-Token : $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'

‌