API Docs
Search…
Update Recommendation
Update the exiting recommendation algorithm and the relevant page with the recommendation widget can be placed.

End Point

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

Curl Example

curl --request POST 'https://api.cartup.ai/v1/widget/custom/update'
--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 '{
"id": "3b856051-c508-4778-b775-5ec208965e84",
"name": "test123",
"divisionId": "test123",
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
"orgName": "WorldMarts",
"description": null,
"algoName": "Trending Items",
"widgetShowType": "carousel",
"displayMode": "carousel",
"displayTitle": "test123",
"maxProducts": 10,
"themeId": "fa23ac55-493b-4699-bcbf-3eebcd8ebd0d",
"pageMappings": {
"pageMappingList": [
{
"pageId": "Home Page"
}
]
},
"includeRules": {
"productPlacements": [],
"rules": [],
"categoryPlacements": [],
"bundledProductPlacements": [
{
"customValues": {},
"name": "Sahara Leggings",
"anchorProname": "Sahara20Leggings",
"id": "WP05",
"bundledProducts": [
{
"index": 0,
"date": "2021-10-06T10:45",
"endDate": "2021-10-20T05:15",
"id": "WorldMarts_10.0",
"name": "Savvy Shoulder Tote",
"proName": "Savvy20Shoulder20Tote",
"duration": {
"startDate": "2021-10-06T05:15:00.000Z",
"endDate": "2021-10-19T23:45:00.000Z"
},
"date1": "2021-10-06T10:45",
"date2": "2021-10-20T05:15",
"showLabel": true,
"proId": 1,
"$hashKey": "0KC"
}
],
"show": false
}
]
},
"excludeRules": {
"rules": [],
"categoryPlacements": []
},
"timeZone": "Asia/Calcutta",
"widgetTypes": [
"trending"
],
"id": "cd65e939-a48a-430b-b392-cf835efe2a04"
}'

Request Body

Please refer to field descriptions in the POST Body above.

‌Example

{
"name": "test123",
"divisionId": "test123",
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
"orgName": "WorldMarts",
"description": null,
"algoName": "Trending Items",
"widgetShowType": "carousel",
"displayMode": "carousel",
"displayTitle": "test123",
"maxProducts": 10,
"themeId": "fa23ac55-493b-4699-bcbf-3eebcd8ebd0d",
"pageMappings": {
"pageMappingList": [
{
"pageId": "Home Page"
}
]
},
"includeRules": {
"productPlacements": [],
"rules": [],
"categoryPlacements": [],
"bundledProductPlacements": [
{
"customValues": {},
"name": "Sahara Leggings",
"anchorProname": "Sahara20Leggings",
"id": "WP05",
"bundledProducts": [
{
"index": 0,
"date": "2021-10-06T10:45",
"endDate": "2021-10-20T05:15",
"id": "WorldMarts_10.0",
"name": "Savvy Shoulder Tote",
"proName": "Savvy20Shoulder20Tote",
"duration": {
"startDate": "2021-10-06T05:15:00.000Z",
"endDate": "2021-10-19T23:45:00.000Z"
},
"date1": "2021-10-06T10:45",
"date2": "2021-10-20T05:15",
"showLabel": true,
"proId": 1,
"$hashKey": "0KC"
}
],
"show": false
}
]
},
"excludeRules": {
"rules": [],
"categoryPlacements": []
},
"timeZone": "Asia/Calcutta",
"widgetTypes": [
"trending"
],
"id": "cd65e939-a48a-430b-b392-cf835efe2a04"
}
Copy link
On this page
post