API Docs
Search…
Recommendation Configuration
Recommendations
Search
Search Configurations
Search Suggestions
Search Result
Events Configuration
Events
Mobile Integration
Update Search Config
Update the existing search configuration
End Point
post
https://api.cartup.ai/v1/conf/search/update
Request samples
1
curl --request POST 'https://api.cartup.ai/v1/conf/search/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
--data-raw '{
7
{
8
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
9
"docType": "searchconf",
10
"spellcheck": true,
11
"paginationCount": 51,
12
"searchableFields": [
13
{
14
"repoFieldName": "gender_ss",
15
"displayName": "Gender",
16
"order": 1
17
},
18
{
19
"repoFieldName": "avg_rating_d",
20
"displayName": "Rating",
21
"order": 1
22
},
23
{
24
"repoFieldName": "price_d",
25
"displayName": "Price",
26
"order": 1
27
},
28
{
29
"repoFieldName": "sku_s",
30
"displayName": "Sku",
31
"order": 1
32
},
33
{
34
"repoFieldName": "description_t",
35
"displayName": "Description",
36
"order": 1
37
},
38
{
39
"repoFieldName": "namel_t",
40
"displayName": "Name",
41
"order": 1
42
}
43
],
44
"sortEntity": {
45
"sortEntities": [
46
{
47
"key": "Price High to Low",
48
"value": "price_d desc"
49
},
50
{
51
"key": "Rating High to Low",
52
"value": "avg_rating_d desc"
53
},
54
{
55
"key": "Most Popular",
56
"value": "popularity_score_d desc"
57
},
58
{
59
"key": "Price Low to High",
60
"value": "price_d asc"
61
}
62
]
63
},
64
"includeWidgets": [
65
"spotdyCategoryBasedRecommendation",
66
"spotdyMoreItemsToConsider",
67
"spotdyUpSell",
68
"spotdyRecentView"
69
],
70
"indexLang": "ab",
71
"queryLang": "aa",
72
"personalization": true,
73
"reranking": true,
74
"synonym": true,
75
"stopWords": true,
76
"facetList": [
77
{
78
"facetIndex": 0,
79
"category": "default",
80
"categoryReplaced": "default",
81
"facets": [
82
{
83
"value": [],
84
"facetIndex": 0,
85
"type": "rating",
86
"displayName": "Ratings",
87
"displayType": "multiselect",
88
"operator": null,
89
"repoFieldName": "avg_rating_d"
90
},
91
{
92
"value": [
93
{
94
"index": 4,
95
"name": "Price [70 - 100]",
96
"value": "[70 TO 100]"
97
},
98
{
99
"index": 3,
100
"name": "Price [30 - 70]",
101
"value": "[31 TO 70]"
102
},
103
{
104
"index": 2,
105
"name": "Price [1 - 30]",
106
"value": "[1 TO 30]"
107
},
108
{
109
"index": 1,
110
"name": "Price [1-40]",
111
"value": "[1 TO 40]"
112
}
113
],
114
"facetIndex": 0,
115
"type": "numeric",
116
"displayName": "Price",
117
"displayType": "multiselect",
118
"operator": "[*TO*]",
119
"repoFieldName": "price_d"
120
},
121
{
122
"value": [
123
{
124
"index": 2,
125
"name": "male",
126
"value": "male"
127
},
128
{
129
"index": 1,
130
"name": "female",
131
"value": "female"
132
}
133
],
134
"facetIndex": 0,
135
"type": "categorical",
136
"displayName": "Gender",
137
"displayType": "radio",
138
"operator": "=",
139
"repoFieldName": "gender_ss"
140
}
141
]
142
},
143
{
144
"facetIndex": 1,
145
"category": "Bags",
146
"categoryReplaced": "Bags",
147
"facets": [
148
{
149
"value": [],
150
"facetIndex": 1,
151
"type": "rating",
152
"displayName": "Rating and Review",
153
"displayType": "multiselect",
154
"operator": null,
155
"repoFieldName": "avg_rating_d"
156
}
157
]
158
},
159
{
160
"facetIndex": 2,
161
"category": "Tops",
162
"categoryReplaced": "Tops",
163
"facets": [
164
{
165
"value": [
166
{
167
"index": 2,
168
"name": "male",
169
"value": "male"
170
},
171
{
172
"index": 1,
173
"name": "female",
174
"value": "female"
175
}
176
],
177
"facetIndex": 2,
178
"type": "categorical",
179
"displayName": "categories",
180
"displayType": "radio",
181
"operator": "=",
182
"repoFieldName": "gender_ss"
183
}
184
]
185
},
186
{
187
"facetIndex": 3,
188
"category": "Jackets",
189
"categoryReplaced": "Jackets",
190
"facets": [
191
{
192
"value": [
193
{
194
"index": 3,
195
"name": "Stock [1 - 100]]",
196
"value": "[1 TO 100]"
197
},
198
{
199
"index": 2,
200
"name": "Stock [100 - 500]]",
201
"value": "[100 TO 500]"
202
},
203
{
204
"index": 1,
205
"name": "Stock [500 - 100]]",
206
"value": "[500 TO 1000]"
207
}
208
],
209
"facetIndex": 3,
210
"type": "numeric",
211
"displayName": "Stock",
212
"displayType": "radio",
213
"operator": "[*TO*]",
214
"repoFieldName": "inventory_i",
215
"repoFieldDisplayName": "No of stock in inventory"
216
}
217
]
218
}
219
]
220
}
Copied!
‌
Request payload
1
{
2
"orgId": "850a8b8f-a6fe-49e4-88fc-874843279d66",
3
"docType": "searchconf",
4
"spellcheck": true,
5
"paginationCount": 51,
6
"searchableFields": [
7
{
8
"repoFieldName": "gender_ss",
9
"displayName": "Gender",
10
"order": 1
11
},
12
{
13
"repoFieldName": "avg_rating_d",
14
"displayName": "Rating",
15
"order": 1
16
},
17
{
18
"repoFieldName": "price_d",
19
"displayName": "Price",
20
"order": 1
21
},
22
{
23
"repoFieldName": "sku_s",
24
"displayName": "Sku",
25
"order": 1
26
},
27
{
28
"repoFieldName": "description_t",
29
"displayName": "Description",
30
"order": 1
31
},
32
{
33
"repoFieldName": "namel_t",
34
"displayName": "Name",
35
"order": 1
36
}
37
],
38
"sortEntity": {
39
"sortEntities": [
40
{
41
"key": "Price High to Low",
42
"value": "price_d desc"
43
},
44
{
45
"key": "Rating High to Low",
46
"value": "avg_rating_d desc"
47
},
48
{
49
"key": "Most Popular",
50
"value": "popularity_score_d desc"
51
},
52
{
53
"key": "Price Low to High",
54
"value": "price_d asc"
55
}
56
]
57
},
58
"includeWidgets": [
59
"spotdyCategoryBasedRecommendation",
60
"spotdyMoreItemsToConsider",
61
"spotdyUpSell",
62
"spotdyRecentView"
63
],
64
"indexLang": "ab",
65
"queryLang": "aa",
66
"personalization": true,
67
"reranking": true,
68
"synonym": true,
69
"stopWords": true,
70
"facetList": [
71
{
72
"facetIndex": 0,
73
"category": "default",
74
"categoryReplaced": "default",
75
"facets": [
76
{
77
"value": [],
78
"facetIndex": 0,
79
"type": "rating",
80
"displayName": "Ratings",
81
"displayType": "multiselect",
82
"operator": null,
83
"repoFieldName": "avg_rating_d"
84
},
85
{
86
"value": [
87
{
88
"index": 4,
89
"name": "Price [70 - 100]",
90
"value": "[70 TO 100]"
91
},
92
{
93
"index": 3,
94
"name": "Price [30 - 70]",
95
"value": "[31 TO 70]"
96
},
97
{
98
"index": 2,
99
"name": "Price [1 - 30]",
100
"value": "[1 TO 30]"
101
},
102
{
103
"index": 1,
104
"name": "Price [1-40]",
105
"value": "[1 TO 40]"
106
}
107
],
108
"facetIndex": 0,
109
"type": "numeric",
110
"displayName": "Price",
111
"displayType": "multiselect",
112
"operator": "[*TO*]",
113
"repoFieldName": "price_d"
114
},
115
{
116
"value": [
117
{
118
"index": 2,
119
"name": "male",
120
"value": "male"
121
},
122
{
123
"index": 1,
124
"name": "female",
125
"value": "female"
126
}
127
],
128
"facetIndex": 0,
129
"type": "categorical",
130
"displayName": "Gender",
131
"displayType": "radio",
132
"operator": "=",
133
"repoFieldName": "gender_ss"
134
}
135
]
136
},
137
{
138
"facetIndex": 1,
139
"category": "Bags",
140
"categoryReplaced": "Bags",
141
"facets": [
142
{
143
"value": [],
144
"facetIndex": 1,
145
"type": "rating",
146
"displayName": "Rating and Review",
147
"displayType": "multiselect",
148
"operator": null,
149
"repoFieldName": "avg_rating_d"
150
}
151
]
152
},
153
{
154
"facetIndex": 2,
155
"category": "Tops",
156
"categoryReplaced": "Tops",
157
"facets": [
158
{
159
"value": [
160
{
161
"index": 2,
162
"name": "male",
163
"value": "male"
164
},
165
{
166
"index": 1,
167
"name": "female",
168
"value": "female"
169
}
170
],
171
"facetIndex": 2,
172
"type": "categorical",
173
"displayName": "categories",
174
"displayType": "radio",
175
"operator": "=",
176
"repoFieldName": "gender_ss"
177
}
178
]
179
},
180
{
181
"facetIndex": 3,
182
"category": "Jackets",
183
"categoryReplaced": "Jackets",
184
"facets": [
185
{
186
"value": [
187
{
188
"index": 3,
189
"name": "Stock [1 - 100]]",
190
"value": "[1 TO 100]"
191
},
192
{
193
"index": 2,
194
"name": "Stock [100 - 500]]",
195
"value": "[100 TO 500]"
196
},
197
{
198
"index": 1,
199
"name": "Stock [500 - 100]]",
200
"value": "[500 TO 1000]"
201
}
202
],
203
"facetIndex": 3,
204
"type": "numeric",
205
"displayName": "Stock",
206
"displayType": "radio",
207
"operator": "[*TO*]",
208
"repoFieldName": "inventory_i",
209
"repoFieldDisplayName": "No of stock in inventory"
210
}
211
]
212
}
213
]
214
}
Copied!
‌
‌
Last modified 1mo ago
Copy link
Contents
post