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

1
curl --request POST 'https://api.cartup.ai/v1/widget/custom/update'
2
--header 'Accept: application/json' \
3
--header 'Content-Type: application/json' \
4
--header 'X-Cartup-Access-Token: $CARTUP_API_KEY'
5
--header 'X-Cartup-orgId : $CARTUP_ORD_ID'
6
-d '{
7
"id": "3b856051-c508-4778-b775-5ec208965e84",
8
"name": "test123",
9
"divisionId": "test123",
10
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
11
"orgName": "WorldMarts",
12
"description": null,
13
"algoName": "Trending Items",
14
"widgetShowType": "carousel",
15
"displayMode": "carousel",
16
"displayTitle": "test123",
17
"maxProducts": 10,
18
"themeId": "fa23ac55-493b-4699-bcbf-3eebcd8ebd0d",
19
"pageMappings": {
20
"pageMappingList": [
21
{
22
"pageId": "Home Page"
23
}
24
]
25
},
26
"includeRules": {
27
"productPlacements": [],
28
"rules": [],
29
"categoryPlacements": [],
30
"bundledProductPlacements": [
31
{
32
"customValues": {},
33
"name": "Sahara Leggings",
34
"anchorProname": "Sahara20Leggings",
35
"id": "WP05",
36
"bundledProducts": [
37
{
38
"index": 0,
39
"date": "2021-10-06T10:45",
40
"endDate": "2021-10-20T05:15",
41
"id": "WorldMarts_10.0",
42
"name": "Savvy Shoulder Tote",
43
"proName": "Savvy20Shoulder20Tote",
44
"duration": {
45
"startDate": "2021-10-06T05:15:00.000Z",
46
"endDate": "2021-10-19T23:45:00.000Z"
47
},
48
"date1": "2021-10-06T10:45",
49
"date2": "2021-10-20T05:15",
50
"showLabel": true,
51
"proId": 1,
52
"$hashKey": "0KC"
53
}
54
],
55
"show": false
56
}
57
]
58
},
59
"excludeRules": {
60
"rules": [],
61
"categoryPlacements": []
62
},
63
"timeZone": "Asia/Calcutta",
64
"widgetTypes": [
65
"trending"
66
],
67
"id": "cd65e939-a48a-430b-b392-cf835efe2a04"
68
}'
Copied!

Request Body

Please refer to field descriptions in the POST Body above.

‌Example

1
{
2
"name": "test123",
3
"divisionId": "test123",
4
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
5
"orgName": "WorldMarts",
6
"description": null,
7
"algoName": "Trending Items",
8
"widgetShowType": "carousel",
9
"displayMode": "carousel",
10
"displayTitle": "test123",
11
"maxProducts": 10,
12
"themeId": "fa23ac55-493b-4699-bcbf-3eebcd8ebd0d",
13
"pageMappings": {
14
"pageMappingList": [
15
{
16
"pageId": "Home Page"
17
}
18
]
19
},
20
"includeRules": {
21
"productPlacements": [],
22
"rules": [],
23
"categoryPlacements": [],
24
"bundledProductPlacements": [
25
{
26
"customValues": {},
27
"name": "Sahara Leggings",
28
"anchorProname": "Sahara20Leggings",
29
"id": "WP05",
30
"bundledProducts": [
31
{
32
"index": 0,
33
"date": "2021-10-06T10:45",
34
"endDate": "2021-10-20T05:15",
35
"id": "WorldMarts_10.0",
36
"name": "Savvy Shoulder Tote",
37
"proName": "Savvy20Shoulder20Tote",
38
"duration": {
39
"startDate": "2021-10-06T05:15:00.000Z",
40
"endDate": "2021-10-19T23:45:00.000Z"
41
},
42
"date1": "2021-10-06T10:45",
43
"date2": "2021-10-20T05:15",
44
"showLabel": true,
45
"proId": 1,
46
"$hashKey": "0KC"
47
}
48
],
49
"show": false
50
}
51
]
52
},
53
"excludeRules": {
54
"rules": [],
55
"categoryPlacements": []
56
},
57
"timeZone": "Asia/Calcutta",
58
"widgetTypes": [
59
"trending"
60
],
61
"id": "cd65e939-a48a-430b-b392-cf835efe2a04"
62
}
Copied!
Last modified 1mo ago
Copy link
Contents
post