API Docs
Search
⌃K
Comment on page

Create Recommendation

Create a recommendation algorithm and the relevant page the recommendation widget can be placed.

End Point

post
https://api.cartup.ai/v1/widget/custom

Curl Example

curl --request POST 'https://api.cartup.ai/v1/widget/custom'
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'X-Cartup-Access-Token : $CARTUP_API_KEY'
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'
-d '{
"name": "cartup-demo",
"divisionId": "cartup-demo",
"orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
"orgName": "freshcouture",
"algoName": "Based On Wishlist",
"widgetShowType": "carousel",
"displayMode": "carousel",
"displayTitle": "Demo for Cartup",
"maxProducts": 20,
"themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
"pageMappings": {
"pageMappingList": [
{
"pageId": "Home Page"
},
{
"pageId": "Product Page"
},
{
"pageId": "Cart Page"
}
]
},
"includeRules": {
"productPlacements": [],
"rules": [],
"categoryPlacements": []
},
"excludeRules": {
"rules": [],
"categoryPlacements": []
},
"timeZone": "America/Los_Angeles",
"widgetTypes": [
"wishlistreco"
]
}'

​

‌Request Body

Please refer to field descriptions in the POST Body above.

‌Example

{
"name": "cartup-demo",
"divisionId": "cartup-demo",
"orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
"orgName": "freshcouture",
"algoName": "Based On Wishlist",
"widgetShowType": "carousel",
"displayMode": "carousel",
"displayTitle": "Demo for Cartup",
"maxProducts": 20,
"themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
"pageMappings": {
"pageMappingList": [
{
"pageId": "Home Page"
},
{
"pageId": "Product Page"
},
{
"pageId": "Cart Page"
}
]
},
"includeRules": {
"productPlacements": [],
"rules": [],
"categoryPlacements": []
},
"excludeRules": {
"rules": [],
"categoryPlacements": []
},
"timeZone": "America/Los_Angeles",
"widgetTypes": [
"wishlistreco"
]
}
Recommendation Configuration - Previous
Get Recommendation Types
Next
Rules
Last modified 2yr ago