API Docs
Search…
Create Search Config
Create a search algorithm.

End Point

post
https://api.cartup.ai/v1/conf/search

Curl example

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

Request Body

Please refer to field descriptions in the POST Body above.

Example

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