API Docs
Search…
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

1
curl --request POST 'https://api.cartup.ai/v1/widget/custom'
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
"name": "cartup-demo",
8
"divisionId": "cartup-demo",
9
"orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
10
"orgName": "freshcouture",
11
"algoName": "Based On Wishlist",
12
"widgetShowType": "carousel",
13
"displayMode": "carousel",
14
"displayTitle": "Demo for Cartup",
15
"maxProducts": 20,
16
"themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
17
"pageMappings": {
18
"pageMappingList": [
19
{
20
"pageId": "Home Page"
21
},
22
{
23
"pageId": "Product Page"
24
},
25
{
26
"pageId": "Cart Page"
27
}
28
]
29
},
30
"includeRules": {
31
"productPlacements": [],
32
"rules": [],
33
"categoryPlacements": []
34
},
35
"excludeRules": {
36
"rules": [],
37
"categoryPlacements": []
38
},
39
"timeZone": "America/Los_Angeles",
40
"widgetTypes": [
41
"wishlistreco"
42
]
43
}'
Copied!

‌Request Body

Please refer to field descriptions in the POST Body above.

‌Example

1
{
2
"name": "cartup-demo",
3
"divisionId": "cartup-demo",
4
"orgId": "8dbc90c4-ad66-48c4-9711-ce3065cfd189",
5
"orgName": "freshcouture",
6
"algoName": "Based On Wishlist",
7
"widgetShowType": "carousel",
8
"displayMode": "carousel",
9
"displayTitle": "Demo for Cartup",
10
"maxProducts": 20,
11
"themeId": "7dd46eda-0d9f-4b9c-bafc-a3e154be8092",
12
"pageMappings": {
13
"pageMappingList": [
14
{
15
"pageId": "Home Page"
16
},
17
{
18
"pageId": "Product Page"
19
},
20
{
21
"pageId": "Cart Page"
22
}
23
]
24
},
25
"includeRules": {
26
"productPlacements": [],
27
"rules": [],
28
"categoryPlacements": []
29
},
30
"excludeRules": {
31
"rules": [],
32
"categoryPlacements": []
33
},
34
"timeZone": "America/Los_Angeles",
35
"widgetTypes": [
36
"wishlistreco"
37
]
38
}
Copied!
Last modified 1mo ago
Copy link
Contents
post