@oomol-lab/open-connector 1.6.3 → 1.6.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/open-connector/catalog/apps/aisa.json +568 -0
- package/assets/open-connector/catalog/apps/bilibili.json +2586 -0
- package/assets/open-connector/catalog/apps/bitwarden.json +1423 -0
- package/assets/open-connector/catalog/apps/cronfree.json +303 -0
- package/assets/open-connector/catalog/apps/cufinder.json +368 -0
- package/assets/open-connector/catalog/apps/feishu_app_bot.json +2 -2
- package/assets/open-connector/catalog/apps/gmail.json +73 -0
- package/assets/open-connector/catalog/apps/investoday_mcp.json +22228 -197
- package/assets/open-connector/catalog/apps/ixspy.json +2274 -0
- package/assets/open-connector/catalog/apps/jin10.json +1 -1
- package/assets/open-connector/catalog/apps/osv.json +663 -0
- package/assets/open-connector/catalog/apps/pdf_vector.json +329 -0
- package/assets/open-connector/catalog/apps/pulsetic.json +406 -0
- package/assets/open-connector/catalog/apps/shopee.json +1785 -0
- package/assets/open-connector/catalog/apps/slack.json +81 -0
- package/assets/open-connector/catalog/apps/slackbot.json +81 -0
- package/assets/open-connector/catalog/apps/speak_ai.json +360 -0
- package/assets/open-connector/catalog/apps/tongdaxin.json +11 -440
- package/assets/open-connector/catalog/apps/zyhub.json +1585 -0
- package/assets/open-connector/catalog/apps-index.json +1 -1
- package/package.json +1 -1
- package/src/core/json-schema.d.ts +5 -1
- package/src/core/json-schema.js +14 -2
- package/src/core/types.d.ts +9 -0
- package/src/oauth/oauth-credential-refresh-service.js +3 -1
- package/src/oauth/oauth-flow-service.js +17 -2
- package/src/oauth/oauth-token.d.ts +13 -0
- package/src/providers/action-contracts.generated.d.ts +16 -4
- package/src/providers/aisa/executors.d.ts +4 -0
- package/src/providers/aisa/executors.js +176 -0
- package/src/providers/bilibili/articles.d.ts +3 -0
- package/src/providers/bilibili/articles.js +369 -0
- package/src/providers/bilibili/executors.d.ts +8 -0
- package/src/providers/bilibili/executors.js +262 -0
- package/src/providers/bilibili/runtime.d.ts +95 -0
- package/src/providers/bilibili/runtime.js +238 -0
- package/src/providers/bilibili/upload.d.ts +14 -0
- package/src/providers/bilibili/upload.js +105 -0
- package/src/providers/bitwarden/executors.d.ts +3 -0
- package/src/providers/bitwarden/executors.js +146 -0
- package/src/providers/cronfree/executors.d.ts +4 -0
- package/src/providers/cronfree/executors.js +89 -0
- package/src/providers/cufinder/executors.d.ts +4 -0
- package/src/providers/cufinder/executors.js +105 -0
- package/src/providers/dropbox/executors.js +21 -3
- package/src/providers/elevenreader/runtime.js +6 -5
- package/src/providers/feishu_app_bot/scopes.js +1 -1
- package/src/providers/gmail/attachment-stream.d.ts +2 -0
- package/src/providers/gmail/attachment-stream.js +162 -0
- package/src/providers/gmail/executors.d.ts +3 -1
- package/src/providers/gmail/executors.js +53 -25
- package/src/providers/investoday_mcp/official-actions.js +19 -372
- package/src/providers/investoday_mcp/official-tool-types.d.ts +10 -0
- package/src/providers/investoday_mcp/official-tool-types.js +4 -0
- package/src/providers/investoday_mcp/official-tools/charts.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/charts.js +32 -0
- package/src/providers/investoday_mcp/official-tools/fixed-income.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/fixed-income.js +326 -0
- package/src/providers/investoday_mcp/official-tools/funds.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/funds.js +1085 -0
- package/src/providers/investoday_mcp/official-tools/hong-kong.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/hong-kong.js +275 -0
- package/src/providers/investoday_mcp/official-tools/indices-industries.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/indices-industries.js +642 -0
- package/src/providers/investoday_mcp/official-tools/macro-calendar.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/macro-calendar.js +398 -0
- package/src/providers/investoday_mcp/official-tools/other.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/other.js +131 -0
- package/src/providers/investoday_mcp/official-tools/research-news.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/research-news.js +302 -0
- package/src/providers/investoday_mcp/official-tools/stocks.d.ts +2 -0
- package/src/providers/investoday_mcp/official-tools/stocks.js +2829 -0
- package/src/providers/ixspy/executors.d.ts +3 -0
- package/src/providers/ixspy/executors.js +220 -0
- package/src/providers/mcp-client.d.ts +1 -0
- package/src/providers/mcp-client.js +41 -27
- package/src/providers/osv/executors.d.ts +2 -0
- package/src/providers/osv/executors.js +11 -0
- package/src/providers/osv/runtime.d.ts +9 -0
- package/src/providers/osv/runtime.js +66 -0
- package/src/providers/pdf_vector/executors.d.ts +4 -0
- package/src/providers/pdf_vector/executors.js +108 -0
- package/src/providers/provider-runtime.d.ts +3 -0
- package/src/providers/provider-runtime.js +4 -1
- package/src/providers/pulsetic/executors.d.ts +4 -0
- package/src/providers/pulsetic/executors.js +126 -0
- package/src/providers/registry.generated.js +12 -0
- package/src/providers/sellersprite_mcp/executors.js +2 -1
- package/src/providers/shopee/actions.d.ts +2 -0
- package/src/providers/shopee/actions.js +474 -0
- package/src/providers/shopee/executors.d.ts +3 -0
- package/src/providers/shopee/executors.js +85 -0
- package/src/providers/shopee/runtime.d.ts +79 -0
- package/src/providers/shopee/runtime.js +693 -0
- package/src/providers/slack/actions.js +17 -0
- package/src/providers/slack/runtime.js +62 -4
- package/src/providers/speak_ai/executors.d.ts +3 -0
- package/src/providers/speak_ai/executors.js +187 -0
- package/src/providers/tongdaxin/executors.js +5 -4
- package/src/providers/tongdaxin/named-action-output.js +3 -9
- package/src/providers/tongdaxin/named-action-routing.js +1 -1
- package/src/providers/tongdaxin/named-actions.js +1 -6
- package/src/providers/tushare/runtime.js +22 -9
- package/src/providers/twenty_crm/runtime.js +4 -2
- package/src/providers/zyhub/executors.d.ts +3 -0
- package/src/providers/zyhub/executors.js +240 -0
- package/src/server/files/transit-files.d.ts +3 -2
- package/src/server/files/transit-files.js +31 -35
|
@@ -0,0 +1,2274 @@
|
|
|
1
|
+
{
|
|
2
|
+
"service": "ixspy",
|
|
3
|
+
"displayName": "IXSPY",
|
|
4
|
+
"description": "Research AliExpress products, categories, rankings, trends, and markets with IXSPY.",
|
|
5
|
+
"categories": [
|
|
6
|
+
"Data",
|
|
7
|
+
"Marketing",
|
|
8
|
+
"E-commerce"
|
|
9
|
+
],
|
|
10
|
+
"authTypes": [
|
|
11
|
+
"api_key"
|
|
12
|
+
],
|
|
13
|
+
"auth": [
|
|
14
|
+
{
|
|
15
|
+
"type": "api_key",
|
|
16
|
+
"label": "API Key",
|
|
17
|
+
"placeholder": "YOUR_IXSPY_API_KEY",
|
|
18
|
+
"description": "IXSPY Open API key sent as a Bearer token. Copy it from My Keys at https://open.ixspy.com/#/account/keys.",
|
|
19
|
+
"extraFields": []
|
|
20
|
+
}
|
|
21
|
+
],
|
|
22
|
+
"homepageUrl": "https://ixspy.com/",
|
|
23
|
+
"actions": [
|
|
24
|
+
{
|
|
25
|
+
"id": "ixspy.get_category_resource",
|
|
26
|
+
"service": "ixspy",
|
|
27
|
+
"name": "get_category_resource",
|
|
28
|
+
"description": "Get the current IXSPY CDN URL for the complete AliExpress category tree resource.",
|
|
29
|
+
"operationType": "read",
|
|
30
|
+
"requiredScopes": [],
|
|
31
|
+
"providerPermissions": [],
|
|
32
|
+
"inputSchema": {
|
|
33
|
+
"type": "object",
|
|
34
|
+
"properties": {},
|
|
35
|
+
"additionalProperties": false,
|
|
36
|
+
"description": "No input is required to get the category tree resource."
|
|
37
|
+
},
|
|
38
|
+
"outputSchema": {
|
|
39
|
+
"type": "object",
|
|
40
|
+
"properties": {
|
|
41
|
+
"url": {
|
|
42
|
+
"type": "string",
|
|
43
|
+
"description": "The CDN URL for downloading the complete category tree JSON resource.",
|
|
44
|
+
"format": "uri"
|
|
45
|
+
},
|
|
46
|
+
"credits": {
|
|
47
|
+
"anyOf": [
|
|
48
|
+
{
|
|
49
|
+
"type": "number",
|
|
50
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"type": "null"
|
|
54
|
+
}
|
|
55
|
+
]
|
|
56
|
+
}
|
|
57
|
+
},
|
|
58
|
+
"additionalProperties": false,
|
|
59
|
+
"description": "The current AliExpress category tree resource returned by IXSPY."
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
"id": "ixspy.get_keyword_rank",
|
|
64
|
+
"service": "ixspy",
|
|
65
|
+
"name": "get_keyword_rank",
|
|
66
|
+
"description": "Get an IXSPY AliExpress keyword ranking with search popularity, click, conversion, competition, supply, and growth metrics.",
|
|
67
|
+
"operationType": "read",
|
|
68
|
+
"requiredScopes": [],
|
|
69
|
+
"providerPermissions": [],
|
|
70
|
+
"inputSchema": {
|
|
71
|
+
"type": "object",
|
|
72
|
+
"properties": {
|
|
73
|
+
"rankDate": {
|
|
74
|
+
"type": "string",
|
|
75
|
+
"description": "The available IXSPY keyword ranking date.",
|
|
76
|
+
"format": "date"
|
|
77
|
+
},
|
|
78
|
+
"dateType": {
|
|
79
|
+
"type": "string",
|
|
80
|
+
"enum": [
|
|
81
|
+
"week",
|
|
82
|
+
"month"
|
|
83
|
+
],
|
|
84
|
+
"description": "The ranking period."
|
|
85
|
+
},
|
|
86
|
+
"categoryId": {
|
|
87
|
+
"type": "integer",
|
|
88
|
+
"minimum": 1,
|
|
89
|
+
"description": "The category ID represented by the keyword ranking."
|
|
90
|
+
},
|
|
91
|
+
"regionCode": {
|
|
92
|
+
"type": "string",
|
|
93
|
+
"enum": [
|
|
94
|
+
"ALL",
|
|
95
|
+
"US",
|
|
96
|
+
"RU"
|
|
97
|
+
],
|
|
98
|
+
"description": "The supported IXSPY keyword region."
|
|
99
|
+
},
|
|
100
|
+
"keyword": {
|
|
101
|
+
"type": "string",
|
|
102
|
+
"minLength": 1,
|
|
103
|
+
"description": "A fuzzy keyword filter.",
|
|
104
|
+
"pattern": "\\S"
|
|
105
|
+
},
|
|
106
|
+
"orderBy": {
|
|
107
|
+
"type": "string",
|
|
108
|
+
"enum": [
|
|
109
|
+
"searchPopularity",
|
|
110
|
+
"searchGrowth",
|
|
111
|
+
"clickRate",
|
|
112
|
+
"conversionRate"
|
|
113
|
+
],
|
|
114
|
+
"description": "The keyword metric used for sorting."
|
|
115
|
+
},
|
|
116
|
+
"orderKind": {
|
|
117
|
+
"type": "string",
|
|
118
|
+
"enum": [
|
|
119
|
+
"asc",
|
|
120
|
+
"desc"
|
|
121
|
+
],
|
|
122
|
+
"description": "The result sort direction."
|
|
123
|
+
},
|
|
124
|
+
"page": {
|
|
125
|
+
"type": "integer",
|
|
126
|
+
"minimum": 1,
|
|
127
|
+
"description": "The one-based result page number.",
|
|
128
|
+
"default": 1
|
|
129
|
+
},
|
|
130
|
+
"size": {
|
|
131
|
+
"type": "integer",
|
|
132
|
+
"minimum": 1,
|
|
133
|
+
"maximum": 50,
|
|
134
|
+
"description": "The number of results per page, up to 50.",
|
|
135
|
+
"default": 50
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
"additionalProperties": false,
|
|
139
|
+
"required": [
|
|
140
|
+
"rankDate",
|
|
141
|
+
"dateType",
|
|
142
|
+
"categoryId",
|
|
143
|
+
"regionCode"
|
|
144
|
+
],
|
|
145
|
+
"description": "The keyword ranking, period, date, category, region, optional filter, and pagination."
|
|
146
|
+
},
|
|
147
|
+
"outputSchema": {
|
|
148
|
+
"type": "object",
|
|
149
|
+
"properties": {
|
|
150
|
+
"items": {
|
|
151
|
+
"type": "array",
|
|
152
|
+
"items": {
|
|
153
|
+
"type": "object",
|
|
154
|
+
"properties": {},
|
|
155
|
+
"additionalProperties": true,
|
|
156
|
+
"description": "One ranked keyword with demand, conversion, supply, competition, and growth metrics."
|
|
157
|
+
},
|
|
158
|
+
"description": "The records returned by IXSPY."
|
|
159
|
+
},
|
|
160
|
+
"page": {
|
|
161
|
+
"anyOf": [
|
|
162
|
+
{
|
|
163
|
+
"type": "integer",
|
|
164
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
165
|
+
},
|
|
166
|
+
{
|
|
167
|
+
"type": "null"
|
|
168
|
+
}
|
|
169
|
+
]
|
|
170
|
+
},
|
|
171
|
+
"pages": {
|
|
172
|
+
"anyOf": [
|
|
173
|
+
{
|
|
174
|
+
"type": "integer",
|
|
175
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"type": "null"
|
|
179
|
+
}
|
|
180
|
+
]
|
|
181
|
+
},
|
|
182
|
+
"total": {
|
|
183
|
+
"anyOf": [
|
|
184
|
+
{
|
|
185
|
+
"type": "integer",
|
|
186
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"type": "null"
|
|
190
|
+
}
|
|
191
|
+
]
|
|
192
|
+
},
|
|
193
|
+
"credits": {
|
|
194
|
+
"anyOf": [
|
|
195
|
+
{
|
|
196
|
+
"type": "number",
|
|
197
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
"type": "null"
|
|
201
|
+
}
|
|
202
|
+
]
|
|
203
|
+
}
|
|
204
|
+
},
|
|
205
|
+
"additionalProperties": false,
|
|
206
|
+
"description": "The AliExpress keyword ranking returned by IXSPY."
|
|
207
|
+
}
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"id": "ixspy.get_market_insights",
|
|
211
|
+
"service": "ixspy",
|
|
212
|
+
"name": "get_market_insights",
|
|
213
|
+
"description": "Compare immediate child categories in IXSPY using product, sales, revenue, review, market-share, and Choice-product metrics.",
|
|
214
|
+
"operationType": "read",
|
|
215
|
+
"requiredScopes": [],
|
|
216
|
+
"providerPermissions": [],
|
|
217
|
+
"inputSchema": {
|
|
218
|
+
"type": "object",
|
|
219
|
+
"properties": {
|
|
220
|
+
"parentCategoryId": {
|
|
221
|
+
"type": "integer",
|
|
222
|
+
"minimum": 0,
|
|
223
|
+
"description": "The parent category ID. Use 0 for top-level categories."
|
|
224
|
+
},
|
|
225
|
+
"page": {
|
|
226
|
+
"type": "integer",
|
|
227
|
+
"minimum": 1,
|
|
228
|
+
"description": "The one-based result page number.",
|
|
229
|
+
"default": 1
|
|
230
|
+
},
|
|
231
|
+
"size": {
|
|
232
|
+
"type": "integer",
|
|
233
|
+
"minimum": 1,
|
|
234
|
+
"maximum": 50,
|
|
235
|
+
"description": "The number of results per page, up to 50.",
|
|
236
|
+
"default": 50
|
|
237
|
+
}
|
|
238
|
+
},
|
|
239
|
+
"additionalProperties": false,
|
|
240
|
+
"required": [
|
|
241
|
+
"parentCategoryId"
|
|
242
|
+
],
|
|
243
|
+
"description": "The parent category and pagination for market insights."
|
|
244
|
+
},
|
|
245
|
+
"outputSchema": {
|
|
246
|
+
"type": "object",
|
|
247
|
+
"properties": {
|
|
248
|
+
"items": {
|
|
249
|
+
"type": "array",
|
|
250
|
+
"items": {
|
|
251
|
+
"type": "object",
|
|
252
|
+
"properties": {},
|
|
253
|
+
"additionalProperties": true,
|
|
254
|
+
"description": "One child category with market size, revenue, share, and Choice-product metrics."
|
|
255
|
+
},
|
|
256
|
+
"description": "The records returned by IXSPY."
|
|
257
|
+
},
|
|
258
|
+
"page": {
|
|
259
|
+
"anyOf": [
|
|
260
|
+
{
|
|
261
|
+
"type": "integer",
|
|
262
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
263
|
+
},
|
|
264
|
+
{
|
|
265
|
+
"type": "null"
|
|
266
|
+
}
|
|
267
|
+
]
|
|
268
|
+
},
|
|
269
|
+
"pages": {
|
|
270
|
+
"anyOf": [
|
|
271
|
+
{
|
|
272
|
+
"type": "integer",
|
|
273
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
"type": "null"
|
|
277
|
+
}
|
|
278
|
+
]
|
|
279
|
+
},
|
|
280
|
+
"total": {
|
|
281
|
+
"anyOf": [
|
|
282
|
+
{
|
|
283
|
+
"type": "integer",
|
|
284
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
"type": "null"
|
|
288
|
+
}
|
|
289
|
+
]
|
|
290
|
+
},
|
|
291
|
+
"credits": {
|
|
292
|
+
"anyOf": [
|
|
293
|
+
{
|
|
294
|
+
"type": "number",
|
|
295
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
296
|
+
},
|
|
297
|
+
{
|
|
298
|
+
"type": "null"
|
|
299
|
+
}
|
|
300
|
+
]
|
|
301
|
+
}
|
|
302
|
+
},
|
|
303
|
+
"additionalProperties": false,
|
|
304
|
+
"description": "The AliExpress market insight results returned by IXSPY."
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
"id": "ixspy.get_product_details",
|
|
309
|
+
"service": "ixspy",
|
|
310
|
+
"name": "get_product_details",
|
|
311
|
+
"description": "Get IXSPY details for up to 10 AliExpress product IDs.",
|
|
312
|
+
"operationType": "read",
|
|
313
|
+
"requiredScopes": [],
|
|
314
|
+
"providerPermissions": [],
|
|
315
|
+
"inputSchema": {
|
|
316
|
+
"type": "object",
|
|
317
|
+
"properties": {
|
|
318
|
+
"productIds": {
|
|
319
|
+
"type": "array",
|
|
320
|
+
"items": {
|
|
321
|
+
"type": "integer",
|
|
322
|
+
"minimum": 1,
|
|
323
|
+
"description": "One AliExpress product ID."
|
|
324
|
+
},
|
|
325
|
+
"description": "The product IDs to retrieve.",
|
|
326
|
+
"minItems": 1,
|
|
327
|
+
"maxItems": 10,
|
|
328
|
+
"uniqueItems": true
|
|
329
|
+
}
|
|
330
|
+
},
|
|
331
|
+
"additionalProperties": false,
|
|
332
|
+
"description": "The AliExpress products to retrieve."
|
|
333
|
+
},
|
|
334
|
+
"outputSchema": {
|
|
335
|
+
"type": "object",
|
|
336
|
+
"properties": {
|
|
337
|
+
"items": {
|
|
338
|
+
"type": "array",
|
|
339
|
+
"items": {
|
|
340
|
+
"type": "object",
|
|
341
|
+
"properties": {},
|
|
342
|
+
"additionalProperties": true,
|
|
343
|
+
"description": "One AliExpress product detail record."
|
|
344
|
+
},
|
|
345
|
+
"description": "The records returned by IXSPY."
|
|
346
|
+
},
|
|
347
|
+
"page": {
|
|
348
|
+
"anyOf": [
|
|
349
|
+
{
|
|
350
|
+
"type": "integer",
|
|
351
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
"type": "null"
|
|
355
|
+
}
|
|
356
|
+
]
|
|
357
|
+
},
|
|
358
|
+
"pages": {
|
|
359
|
+
"anyOf": [
|
|
360
|
+
{
|
|
361
|
+
"type": "integer",
|
|
362
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"type": "null"
|
|
366
|
+
}
|
|
367
|
+
]
|
|
368
|
+
},
|
|
369
|
+
"total": {
|
|
370
|
+
"anyOf": [
|
|
371
|
+
{
|
|
372
|
+
"type": "integer",
|
|
373
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
"type": "null"
|
|
377
|
+
}
|
|
378
|
+
]
|
|
379
|
+
},
|
|
380
|
+
"credits": {
|
|
381
|
+
"anyOf": [
|
|
382
|
+
{
|
|
383
|
+
"type": "number",
|
|
384
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
385
|
+
},
|
|
386
|
+
{
|
|
387
|
+
"type": "null"
|
|
388
|
+
}
|
|
389
|
+
]
|
|
390
|
+
}
|
|
391
|
+
},
|
|
392
|
+
"additionalProperties": false,
|
|
393
|
+
"description": "The requested AliExpress product details returned by IXSPY."
|
|
394
|
+
}
|
|
395
|
+
},
|
|
396
|
+
{
|
|
397
|
+
"id": "ixspy.get_product_rank",
|
|
398
|
+
"service": "ixspy",
|
|
399
|
+
"name": "get_product_rank",
|
|
400
|
+
"description": "Get an IXSPY AliExpress total, hot, growth, new-product, or holiday product ranking.",
|
|
401
|
+
"operationType": "read",
|
|
402
|
+
"requiredScopes": [],
|
|
403
|
+
"providerPermissions": [],
|
|
404
|
+
"inputSchema": {
|
|
405
|
+
"type": "object",
|
|
406
|
+
"properties": {
|
|
407
|
+
"rankType": {
|
|
408
|
+
"type": "string",
|
|
409
|
+
"enum": [
|
|
410
|
+
"total",
|
|
411
|
+
"normalHot",
|
|
412
|
+
"normalGrowth",
|
|
413
|
+
"newHot",
|
|
414
|
+
"newGrowth",
|
|
415
|
+
"holidayNormal",
|
|
416
|
+
"holidayNew"
|
|
417
|
+
],
|
|
418
|
+
"description": "The product ranking type."
|
|
419
|
+
},
|
|
420
|
+
"dateType": {
|
|
421
|
+
"type": "string",
|
|
422
|
+
"enum": [
|
|
423
|
+
"day",
|
|
424
|
+
"week",
|
|
425
|
+
"month",
|
|
426
|
+
"holiday"
|
|
427
|
+
],
|
|
428
|
+
"description": "The ranking period."
|
|
429
|
+
},
|
|
430
|
+
"categoryId": {
|
|
431
|
+
"type": "integer",
|
|
432
|
+
"minimum": 1,
|
|
433
|
+
"description": "The category ID represented by the ranking."
|
|
434
|
+
},
|
|
435
|
+
"rankDate": {
|
|
436
|
+
"type": "string",
|
|
437
|
+
"description": "The available IXSPY ranking date.",
|
|
438
|
+
"format": "date"
|
|
439
|
+
},
|
|
440
|
+
"searchWords": {
|
|
441
|
+
"type": "string",
|
|
442
|
+
"minLength": 1,
|
|
443
|
+
"description": "Words that must occur in the product title.",
|
|
444
|
+
"pattern": "\\S"
|
|
445
|
+
},
|
|
446
|
+
"choiceType": {
|
|
447
|
+
"type": "integer",
|
|
448
|
+
"minimum": 0,
|
|
449
|
+
"maximum": 2,
|
|
450
|
+
"description": "The AliExpress fulfillment type: 0 for POP, 1 for semi-managed, or 2 for fully managed."
|
|
451
|
+
},
|
|
452
|
+
"priceMin": {
|
|
453
|
+
"type": "number",
|
|
454
|
+
"minimum": 0,
|
|
455
|
+
"description": "The minimum product price in USD."
|
|
456
|
+
},
|
|
457
|
+
"priceMax": {
|
|
458
|
+
"type": "number",
|
|
459
|
+
"minimum": 0,
|
|
460
|
+
"description": "The maximum product price in USD."
|
|
461
|
+
},
|
|
462
|
+
"page": {
|
|
463
|
+
"type": "integer",
|
|
464
|
+
"minimum": 1,
|
|
465
|
+
"description": "The one-based result page number.",
|
|
466
|
+
"default": 1
|
|
467
|
+
},
|
|
468
|
+
"size": {
|
|
469
|
+
"type": "integer",
|
|
470
|
+
"minimum": 1,
|
|
471
|
+
"maximum": 50,
|
|
472
|
+
"description": "The number of results per page, up to 50.",
|
|
473
|
+
"default": 50
|
|
474
|
+
}
|
|
475
|
+
},
|
|
476
|
+
"additionalProperties": false,
|
|
477
|
+
"required": [
|
|
478
|
+
"rankType",
|
|
479
|
+
"dateType",
|
|
480
|
+
"categoryId",
|
|
481
|
+
"rankDate"
|
|
482
|
+
],
|
|
483
|
+
"description": "The product ranking, date, category, optional filters, and pagination."
|
|
484
|
+
},
|
|
485
|
+
"outputSchema": {
|
|
486
|
+
"type": "object",
|
|
487
|
+
"properties": {
|
|
488
|
+
"items": {
|
|
489
|
+
"type": "array",
|
|
490
|
+
"items": {
|
|
491
|
+
"type": "object",
|
|
492
|
+
"properties": {},
|
|
493
|
+
"additionalProperties": true,
|
|
494
|
+
"description": "One ranked AliExpress product and its current and previous rank metrics."
|
|
495
|
+
},
|
|
496
|
+
"description": "The records returned by IXSPY."
|
|
497
|
+
},
|
|
498
|
+
"page": {
|
|
499
|
+
"anyOf": [
|
|
500
|
+
{
|
|
501
|
+
"type": "integer",
|
|
502
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
"type": "null"
|
|
506
|
+
}
|
|
507
|
+
]
|
|
508
|
+
},
|
|
509
|
+
"pages": {
|
|
510
|
+
"anyOf": [
|
|
511
|
+
{
|
|
512
|
+
"type": "integer",
|
|
513
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
514
|
+
},
|
|
515
|
+
{
|
|
516
|
+
"type": "null"
|
|
517
|
+
}
|
|
518
|
+
]
|
|
519
|
+
},
|
|
520
|
+
"total": {
|
|
521
|
+
"anyOf": [
|
|
522
|
+
{
|
|
523
|
+
"type": "integer",
|
|
524
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
525
|
+
},
|
|
526
|
+
{
|
|
527
|
+
"type": "null"
|
|
528
|
+
}
|
|
529
|
+
]
|
|
530
|
+
},
|
|
531
|
+
"credits": {
|
|
532
|
+
"anyOf": [
|
|
533
|
+
{
|
|
534
|
+
"type": "number",
|
|
535
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
536
|
+
},
|
|
537
|
+
{
|
|
538
|
+
"type": "null"
|
|
539
|
+
}
|
|
540
|
+
]
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
"additionalProperties": false,
|
|
544
|
+
"description": "The AliExpress product ranking returned by IXSPY."
|
|
545
|
+
}
|
|
546
|
+
},
|
|
547
|
+
{
|
|
548
|
+
"id": "ixspy.get_product_region_sales",
|
|
549
|
+
"service": "ixspy",
|
|
550
|
+
"name": "get_product_region_sales",
|
|
551
|
+
"description": "Get estimated AliExpress product order counts grouped by buyer country or region.",
|
|
552
|
+
"operationType": "read",
|
|
553
|
+
"requiredScopes": [],
|
|
554
|
+
"providerPermissions": [],
|
|
555
|
+
"inputSchema": {
|
|
556
|
+
"type": "object",
|
|
557
|
+
"properties": {
|
|
558
|
+
"productId": {
|
|
559
|
+
"type": "integer",
|
|
560
|
+
"minimum": 1,
|
|
561
|
+
"description": "The AliExpress product ID."
|
|
562
|
+
}
|
|
563
|
+
},
|
|
564
|
+
"additionalProperties": false,
|
|
565
|
+
"description": "The AliExpress product to analyze."
|
|
566
|
+
},
|
|
567
|
+
"outputSchema": {
|
|
568
|
+
"type": "object",
|
|
569
|
+
"properties": {
|
|
570
|
+
"entityId": {
|
|
571
|
+
"anyOf": [
|
|
572
|
+
{
|
|
573
|
+
"type": "integer",
|
|
574
|
+
"description": "An integer IXSPY identifier."
|
|
575
|
+
},
|
|
576
|
+
{
|
|
577
|
+
"type": "string",
|
|
578
|
+
"description": "A string IXSPY identifier."
|
|
579
|
+
}
|
|
580
|
+
],
|
|
581
|
+
"description": "The product identifier returned by IXSPY."
|
|
582
|
+
},
|
|
583
|
+
"statistics": {
|
|
584
|
+
"type": "array",
|
|
585
|
+
"items": {
|
|
586
|
+
"type": "object",
|
|
587
|
+
"properties": {},
|
|
588
|
+
"additionalProperties": true,
|
|
589
|
+
"description": "One buyer region and its estimated order count."
|
|
590
|
+
},
|
|
591
|
+
"description": "The product statistic rows returned by IXSPY."
|
|
592
|
+
},
|
|
593
|
+
"credits": {
|
|
594
|
+
"anyOf": [
|
|
595
|
+
{
|
|
596
|
+
"type": "number",
|
|
597
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"type": "null"
|
|
601
|
+
}
|
|
602
|
+
]
|
|
603
|
+
}
|
|
604
|
+
},
|
|
605
|
+
"additionalProperties": false,
|
|
606
|
+
"description": "The product statistics returned by IXSPY."
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"id": "ixspy.get_product_shipping_stats",
|
|
611
|
+
"service": "ixspy",
|
|
612
|
+
"name": "get_product_shipping_stats",
|
|
613
|
+
"description": "Get estimated AliExpress order counts grouped by shipping method for a product.",
|
|
614
|
+
"operationType": "read",
|
|
615
|
+
"requiredScopes": [],
|
|
616
|
+
"providerPermissions": [],
|
|
617
|
+
"inputSchema": {
|
|
618
|
+
"type": "object",
|
|
619
|
+
"properties": {
|
|
620
|
+
"productId": {
|
|
621
|
+
"type": "integer",
|
|
622
|
+
"minimum": 1,
|
|
623
|
+
"description": "The AliExpress product ID."
|
|
624
|
+
}
|
|
625
|
+
},
|
|
626
|
+
"additionalProperties": false,
|
|
627
|
+
"description": "The AliExpress product to analyze."
|
|
628
|
+
},
|
|
629
|
+
"outputSchema": {
|
|
630
|
+
"type": "object",
|
|
631
|
+
"properties": {
|
|
632
|
+
"entityId": {
|
|
633
|
+
"anyOf": [
|
|
634
|
+
{
|
|
635
|
+
"type": "integer",
|
|
636
|
+
"description": "An integer IXSPY identifier."
|
|
637
|
+
},
|
|
638
|
+
{
|
|
639
|
+
"type": "string",
|
|
640
|
+
"description": "A string IXSPY identifier."
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"description": "The product identifier returned by IXSPY."
|
|
644
|
+
},
|
|
645
|
+
"statistics": {
|
|
646
|
+
"type": "array",
|
|
647
|
+
"items": {
|
|
648
|
+
"type": "object",
|
|
649
|
+
"properties": {},
|
|
650
|
+
"additionalProperties": true,
|
|
651
|
+
"description": "One shipping method and its estimated order count."
|
|
652
|
+
},
|
|
653
|
+
"description": "The product statistic rows returned by IXSPY."
|
|
654
|
+
},
|
|
655
|
+
"credits": {
|
|
656
|
+
"anyOf": [
|
|
657
|
+
{
|
|
658
|
+
"type": "number",
|
|
659
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"type": "null"
|
|
663
|
+
}
|
|
664
|
+
]
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"additionalProperties": false,
|
|
668
|
+
"description": "The product statistics returned by IXSPY."
|
|
669
|
+
}
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"id": "ixspy.get_product_sku_sales",
|
|
673
|
+
"service": "ixspy",
|
|
674
|
+
"name": "get_product_sku_sales",
|
|
675
|
+
"description": "Get the estimated order distribution across SKU variants for an AliExpress product.",
|
|
676
|
+
"operationType": "read",
|
|
677
|
+
"requiredScopes": [],
|
|
678
|
+
"providerPermissions": [],
|
|
679
|
+
"inputSchema": {
|
|
680
|
+
"type": "object",
|
|
681
|
+
"properties": {
|
|
682
|
+
"productId": {
|
|
683
|
+
"type": "integer",
|
|
684
|
+
"minimum": 1,
|
|
685
|
+
"description": "The AliExpress product ID."
|
|
686
|
+
}
|
|
687
|
+
},
|
|
688
|
+
"additionalProperties": false,
|
|
689
|
+
"description": "The AliExpress product to analyze."
|
|
690
|
+
},
|
|
691
|
+
"outputSchema": {
|
|
692
|
+
"type": "object",
|
|
693
|
+
"properties": {
|
|
694
|
+
"entityId": {
|
|
695
|
+
"anyOf": [
|
|
696
|
+
{
|
|
697
|
+
"type": "integer",
|
|
698
|
+
"description": "An integer IXSPY identifier."
|
|
699
|
+
},
|
|
700
|
+
{
|
|
701
|
+
"type": "string",
|
|
702
|
+
"description": "A string IXSPY identifier."
|
|
703
|
+
}
|
|
704
|
+
],
|
|
705
|
+
"description": "The product identifier returned by IXSPY."
|
|
706
|
+
},
|
|
707
|
+
"statistics": {
|
|
708
|
+
"type": "array",
|
|
709
|
+
"items": {
|
|
710
|
+
"type": "object",
|
|
711
|
+
"properties": {},
|
|
712
|
+
"additionalProperties": true,
|
|
713
|
+
"description": "One SKU combination and its estimated order count."
|
|
714
|
+
},
|
|
715
|
+
"description": "The product statistic rows returned by IXSPY."
|
|
716
|
+
},
|
|
717
|
+
"credits": {
|
|
718
|
+
"anyOf": [
|
|
719
|
+
{
|
|
720
|
+
"type": "number",
|
|
721
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
722
|
+
},
|
|
723
|
+
{
|
|
724
|
+
"type": "null"
|
|
725
|
+
}
|
|
726
|
+
]
|
|
727
|
+
}
|
|
728
|
+
},
|
|
729
|
+
"additionalProperties": false,
|
|
730
|
+
"description": "The product statistics returned by IXSPY."
|
|
731
|
+
}
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"id": "ixspy.get_product_trends",
|
|
735
|
+
"service": "ixspy",
|
|
736
|
+
"name": "get_product_trends",
|
|
737
|
+
"description": "Get up to 90 days of IXSPY price, sales, and review trend data for a product.",
|
|
738
|
+
"operationType": "read",
|
|
739
|
+
"requiredScopes": [],
|
|
740
|
+
"providerPermissions": [],
|
|
741
|
+
"inputSchema": {
|
|
742
|
+
"type": "object",
|
|
743
|
+
"properties": {
|
|
744
|
+
"productId": {
|
|
745
|
+
"type": "integer",
|
|
746
|
+
"minimum": 1,
|
|
747
|
+
"description": "The AliExpress product ID."
|
|
748
|
+
},
|
|
749
|
+
"startDate": {
|
|
750
|
+
"type": "string",
|
|
751
|
+
"description": "The first trend date. IXSPY defaults to 30 days before today.",
|
|
752
|
+
"format": "date"
|
|
753
|
+
},
|
|
754
|
+
"endDate": {
|
|
755
|
+
"type": "string",
|
|
756
|
+
"description": "The last trend date, no more than 90 days after the start date.",
|
|
757
|
+
"format": "date"
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
"additionalProperties": false,
|
|
761
|
+
"required": [
|
|
762
|
+
"productId"
|
|
763
|
+
],
|
|
764
|
+
"description": "The AliExpress product and optional date range to analyze."
|
|
765
|
+
},
|
|
766
|
+
"outputSchema": {
|
|
767
|
+
"type": "object",
|
|
768
|
+
"properties": {
|
|
769
|
+
"entityId": {
|
|
770
|
+
"anyOf": [
|
|
771
|
+
{
|
|
772
|
+
"type": "integer",
|
|
773
|
+
"description": "An integer IXSPY identifier."
|
|
774
|
+
},
|
|
775
|
+
{
|
|
776
|
+
"type": "string",
|
|
777
|
+
"description": "A string IXSPY identifier."
|
|
778
|
+
}
|
|
779
|
+
],
|
|
780
|
+
"description": "The product identifier returned by IXSPY."
|
|
781
|
+
},
|
|
782
|
+
"startDate": {
|
|
783
|
+
"anyOf": [
|
|
784
|
+
{
|
|
785
|
+
"type": "string",
|
|
786
|
+
"description": "The first date represented in the trend series.",
|
|
787
|
+
"format": "date"
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"type": "null"
|
|
791
|
+
}
|
|
792
|
+
]
|
|
793
|
+
},
|
|
794
|
+
"endDate": {
|
|
795
|
+
"anyOf": [
|
|
796
|
+
{
|
|
797
|
+
"type": "string",
|
|
798
|
+
"description": "The last date represented in the trend series.",
|
|
799
|
+
"format": "date"
|
|
800
|
+
},
|
|
801
|
+
{
|
|
802
|
+
"type": "null"
|
|
803
|
+
}
|
|
804
|
+
]
|
|
805
|
+
},
|
|
806
|
+
"points": {
|
|
807
|
+
"type": "array",
|
|
808
|
+
"items": {
|
|
809
|
+
"type": "object",
|
|
810
|
+
"properties": {},
|
|
811
|
+
"additionalProperties": true,
|
|
812
|
+
"description": "One product trend point with provider-defined metrics."
|
|
813
|
+
},
|
|
814
|
+
"description": "The daily product trend points returned by IXSPY."
|
|
815
|
+
},
|
|
816
|
+
"credits": {
|
|
817
|
+
"anyOf": [
|
|
818
|
+
{
|
|
819
|
+
"type": "number",
|
|
820
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
821
|
+
},
|
|
822
|
+
{
|
|
823
|
+
"type": "null"
|
|
824
|
+
}
|
|
825
|
+
]
|
|
826
|
+
}
|
|
827
|
+
},
|
|
828
|
+
"additionalProperties": false,
|
|
829
|
+
"description": "The product trend series returned by IXSPY."
|
|
830
|
+
}
|
|
831
|
+
},
|
|
832
|
+
{
|
|
833
|
+
"id": "ixspy.get_region_product_rank",
|
|
834
|
+
"service": "ixspy",
|
|
835
|
+
"name": "get_region_product_rank",
|
|
836
|
+
"description": "Get an IXSPY weekly or monthly AliExpress product ranking for one buyer region.",
|
|
837
|
+
"operationType": "read",
|
|
838
|
+
"requiredScopes": [],
|
|
839
|
+
"providerPermissions": [],
|
|
840
|
+
"inputSchema": {
|
|
841
|
+
"type": "object",
|
|
842
|
+
"properties": {
|
|
843
|
+
"dateType": {
|
|
844
|
+
"type": "string",
|
|
845
|
+
"enum": [
|
|
846
|
+
"week",
|
|
847
|
+
"month"
|
|
848
|
+
],
|
|
849
|
+
"description": "The ranking period."
|
|
850
|
+
},
|
|
851
|
+
"categoryId": {
|
|
852
|
+
"type": "integer",
|
|
853
|
+
"minimum": 1,
|
|
854
|
+
"description": "The category ID represented by the ranking."
|
|
855
|
+
},
|
|
856
|
+
"rankDate": {
|
|
857
|
+
"type": "string",
|
|
858
|
+
"description": "The available IXSPY ranking date.",
|
|
859
|
+
"format": "date"
|
|
860
|
+
},
|
|
861
|
+
"regionCode": {
|
|
862
|
+
"type": "string",
|
|
863
|
+
"enum": [
|
|
864
|
+
"RU",
|
|
865
|
+
"ES",
|
|
866
|
+
"FR",
|
|
867
|
+
"US",
|
|
868
|
+
"CL",
|
|
869
|
+
"UA",
|
|
870
|
+
"NL",
|
|
871
|
+
"PL",
|
|
872
|
+
"BR",
|
|
873
|
+
"IT",
|
|
874
|
+
"DE",
|
|
875
|
+
"KR",
|
|
876
|
+
"SA",
|
|
877
|
+
"IL",
|
|
878
|
+
"RO",
|
|
879
|
+
"KH",
|
|
880
|
+
"PE",
|
|
881
|
+
"JP",
|
|
882
|
+
"TR",
|
|
883
|
+
"UK",
|
|
884
|
+
"CA",
|
|
885
|
+
"BY",
|
|
886
|
+
"MX",
|
|
887
|
+
"AE",
|
|
888
|
+
"FI",
|
|
889
|
+
"LT",
|
|
890
|
+
"NO",
|
|
891
|
+
"SE",
|
|
892
|
+
"PT",
|
|
893
|
+
"BG",
|
|
894
|
+
"HU",
|
|
895
|
+
"ZA",
|
|
896
|
+
"AU"
|
|
897
|
+
],
|
|
898
|
+
"description": "The documented IXSPY buyer-region code."
|
|
899
|
+
},
|
|
900
|
+
"searchWords": {
|
|
901
|
+
"type": "string",
|
|
902
|
+
"minLength": 1,
|
|
903
|
+
"description": "Words that must occur in the product title.",
|
|
904
|
+
"pattern": "\\S"
|
|
905
|
+
},
|
|
906
|
+
"choiceType": {
|
|
907
|
+
"type": "integer",
|
|
908
|
+
"minimum": 0,
|
|
909
|
+
"maximum": 2,
|
|
910
|
+
"description": "The AliExpress fulfillment type: 0 for POP, 1 for semi-managed, or 2 for fully managed."
|
|
911
|
+
},
|
|
912
|
+
"priceMin": {
|
|
913
|
+
"type": "number",
|
|
914
|
+
"minimum": 0,
|
|
915
|
+
"description": "The minimum product price in USD."
|
|
916
|
+
},
|
|
917
|
+
"priceMax": {
|
|
918
|
+
"type": "number",
|
|
919
|
+
"minimum": 0,
|
|
920
|
+
"description": "The maximum product price in USD."
|
|
921
|
+
},
|
|
922
|
+
"page": {
|
|
923
|
+
"type": "integer",
|
|
924
|
+
"minimum": 1,
|
|
925
|
+
"description": "The one-based result page number.",
|
|
926
|
+
"default": 1
|
|
927
|
+
},
|
|
928
|
+
"size": {
|
|
929
|
+
"type": "integer",
|
|
930
|
+
"minimum": 1,
|
|
931
|
+
"maximum": 50,
|
|
932
|
+
"description": "The number of results per page, up to 50.",
|
|
933
|
+
"default": 50
|
|
934
|
+
}
|
|
935
|
+
},
|
|
936
|
+
"additionalProperties": false,
|
|
937
|
+
"required": [
|
|
938
|
+
"dateType",
|
|
939
|
+
"categoryId",
|
|
940
|
+
"rankDate",
|
|
941
|
+
"regionCode"
|
|
942
|
+
],
|
|
943
|
+
"description": "The regional product ranking, date, category, optional filters, and pagination."
|
|
944
|
+
},
|
|
945
|
+
"outputSchema": {
|
|
946
|
+
"type": "object",
|
|
947
|
+
"properties": {
|
|
948
|
+
"items": {
|
|
949
|
+
"type": "array",
|
|
950
|
+
"items": {
|
|
951
|
+
"type": "object",
|
|
952
|
+
"properties": {},
|
|
953
|
+
"additionalProperties": true,
|
|
954
|
+
"description": "One ranked AliExpress product and its regional sales metrics."
|
|
955
|
+
},
|
|
956
|
+
"description": "The records returned by IXSPY."
|
|
957
|
+
},
|
|
958
|
+
"page": {
|
|
959
|
+
"anyOf": [
|
|
960
|
+
{
|
|
961
|
+
"type": "integer",
|
|
962
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
963
|
+
},
|
|
964
|
+
{
|
|
965
|
+
"type": "null"
|
|
966
|
+
}
|
|
967
|
+
]
|
|
968
|
+
},
|
|
969
|
+
"pages": {
|
|
970
|
+
"anyOf": [
|
|
971
|
+
{
|
|
972
|
+
"type": "integer",
|
|
973
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
974
|
+
},
|
|
975
|
+
{
|
|
976
|
+
"type": "null"
|
|
977
|
+
}
|
|
978
|
+
]
|
|
979
|
+
},
|
|
980
|
+
"total": {
|
|
981
|
+
"anyOf": [
|
|
982
|
+
{
|
|
983
|
+
"type": "integer",
|
|
984
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
985
|
+
},
|
|
986
|
+
{
|
|
987
|
+
"type": "null"
|
|
988
|
+
}
|
|
989
|
+
]
|
|
990
|
+
},
|
|
991
|
+
"credits": {
|
|
992
|
+
"anyOf": [
|
|
993
|
+
{
|
|
994
|
+
"type": "number",
|
|
995
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
996
|
+
},
|
|
997
|
+
{
|
|
998
|
+
"type": "null"
|
|
999
|
+
}
|
|
1000
|
+
]
|
|
1001
|
+
}
|
|
1002
|
+
},
|
|
1003
|
+
"additionalProperties": false,
|
|
1004
|
+
"description": "The regional AliExpress product ranking returned by IXSPY."
|
|
1005
|
+
}
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"id": "ixspy.get_store_category_distribution",
|
|
1009
|
+
"service": "ixspy",
|
|
1010
|
+
"name": "get_store_category_distribution",
|
|
1011
|
+
"description": "Get IXSPY product and sales distribution by category for an AliExpress store.",
|
|
1012
|
+
"operationType": "read",
|
|
1013
|
+
"requiredScopes": [],
|
|
1014
|
+
"providerPermissions": [],
|
|
1015
|
+
"inputSchema": {
|
|
1016
|
+
"type": "object",
|
|
1017
|
+
"properties": {
|
|
1018
|
+
"storeMerchantId": {
|
|
1019
|
+
"type": "integer",
|
|
1020
|
+
"minimum": 1,
|
|
1021
|
+
"description": "The AliExpress merchant ID."
|
|
1022
|
+
}
|
|
1023
|
+
},
|
|
1024
|
+
"additionalProperties": false,
|
|
1025
|
+
"description": "The AliExpress store to analyze."
|
|
1026
|
+
},
|
|
1027
|
+
"outputSchema": {
|
|
1028
|
+
"type": "object",
|
|
1029
|
+
"properties": {
|
|
1030
|
+
"entityId": {
|
|
1031
|
+
"anyOf": [
|
|
1032
|
+
{
|
|
1033
|
+
"type": "integer",
|
|
1034
|
+
"description": "An integer IXSPY identifier."
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
"type": "string",
|
|
1038
|
+
"description": "A string IXSPY identifier."
|
|
1039
|
+
}
|
|
1040
|
+
],
|
|
1041
|
+
"description": "The store identifier returned by IXSPY."
|
|
1042
|
+
},
|
|
1043
|
+
"statistics": {
|
|
1044
|
+
"type": "array",
|
|
1045
|
+
"items": {
|
|
1046
|
+
"type": "object",
|
|
1047
|
+
"properties": {},
|
|
1048
|
+
"additionalProperties": true,
|
|
1049
|
+
"description": "One category path with product and sales distribution metrics."
|
|
1050
|
+
},
|
|
1051
|
+
"description": "The store statistic rows returned by IXSPY."
|
|
1052
|
+
},
|
|
1053
|
+
"credits": {
|
|
1054
|
+
"anyOf": [
|
|
1055
|
+
{
|
|
1056
|
+
"type": "number",
|
|
1057
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1058
|
+
},
|
|
1059
|
+
{
|
|
1060
|
+
"type": "null"
|
|
1061
|
+
}
|
|
1062
|
+
]
|
|
1063
|
+
}
|
|
1064
|
+
},
|
|
1065
|
+
"additionalProperties": false,
|
|
1066
|
+
"description": "The store statistics returned by IXSPY."
|
|
1067
|
+
}
|
|
1068
|
+
},
|
|
1069
|
+
{
|
|
1070
|
+
"id": "ixspy.get_store_details",
|
|
1071
|
+
"service": "ixspy",
|
|
1072
|
+
"name": "get_store_details",
|
|
1073
|
+
"description": "Get IXSPY details for up to 10 AliExpress stores by merchant IDs or link IDs.",
|
|
1074
|
+
"operationType": "read",
|
|
1075
|
+
"requiredScopes": [],
|
|
1076
|
+
"providerPermissions": [],
|
|
1077
|
+
"inputSchema": {
|
|
1078
|
+
"type": "object",
|
|
1079
|
+
"properties": {
|
|
1080
|
+
"merchantIds": {
|
|
1081
|
+
"type": "array",
|
|
1082
|
+
"items": {
|
|
1083
|
+
"type": "integer",
|
|
1084
|
+
"minimum": 1,
|
|
1085
|
+
"description": "One AliExpress merchant ID."
|
|
1086
|
+
},
|
|
1087
|
+
"description": "The merchant IDs to retrieve.",
|
|
1088
|
+
"minItems": 1,
|
|
1089
|
+
"maxItems": 10,
|
|
1090
|
+
"uniqueItems": true
|
|
1091
|
+
},
|
|
1092
|
+
"linkIds": {
|
|
1093
|
+
"type": "array",
|
|
1094
|
+
"items": {
|
|
1095
|
+
"type": "integer",
|
|
1096
|
+
"minimum": 1,
|
|
1097
|
+
"description": "One AliExpress store link ID."
|
|
1098
|
+
},
|
|
1099
|
+
"description": "The store link IDs to retrieve.",
|
|
1100
|
+
"minItems": 1,
|
|
1101
|
+
"maxItems": 10,
|
|
1102
|
+
"uniqueItems": true
|
|
1103
|
+
}
|
|
1104
|
+
},
|
|
1105
|
+
"additionalProperties": false,
|
|
1106
|
+
"description": "Exactly one type of AliExpress store identifier to retrieve, with up to 10 IDs.",
|
|
1107
|
+
"oneOf": [
|
|
1108
|
+
{
|
|
1109
|
+
"required": [
|
|
1110
|
+
"merchantIds"
|
|
1111
|
+
]
|
|
1112
|
+
},
|
|
1113
|
+
{
|
|
1114
|
+
"required": [
|
|
1115
|
+
"linkIds"
|
|
1116
|
+
]
|
|
1117
|
+
}
|
|
1118
|
+
]
|
|
1119
|
+
},
|
|
1120
|
+
"outputSchema": {
|
|
1121
|
+
"type": "object",
|
|
1122
|
+
"properties": {
|
|
1123
|
+
"items": {
|
|
1124
|
+
"type": "array",
|
|
1125
|
+
"items": {
|
|
1126
|
+
"type": "object",
|
|
1127
|
+
"properties": {},
|
|
1128
|
+
"additionalProperties": true,
|
|
1129
|
+
"description": "One AliExpress store detail record."
|
|
1130
|
+
},
|
|
1131
|
+
"description": "The records returned by IXSPY."
|
|
1132
|
+
},
|
|
1133
|
+
"page": {
|
|
1134
|
+
"anyOf": [
|
|
1135
|
+
{
|
|
1136
|
+
"type": "integer",
|
|
1137
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
1138
|
+
},
|
|
1139
|
+
{
|
|
1140
|
+
"type": "null"
|
|
1141
|
+
}
|
|
1142
|
+
]
|
|
1143
|
+
},
|
|
1144
|
+
"pages": {
|
|
1145
|
+
"anyOf": [
|
|
1146
|
+
{
|
|
1147
|
+
"type": "integer",
|
|
1148
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
"type": "null"
|
|
1152
|
+
}
|
|
1153
|
+
]
|
|
1154
|
+
},
|
|
1155
|
+
"total": {
|
|
1156
|
+
"anyOf": [
|
|
1157
|
+
{
|
|
1158
|
+
"type": "integer",
|
|
1159
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
1160
|
+
},
|
|
1161
|
+
{
|
|
1162
|
+
"type": "null"
|
|
1163
|
+
}
|
|
1164
|
+
]
|
|
1165
|
+
},
|
|
1166
|
+
"credits": {
|
|
1167
|
+
"anyOf": [
|
|
1168
|
+
{
|
|
1169
|
+
"type": "number",
|
|
1170
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
"type": "null"
|
|
1174
|
+
}
|
|
1175
|
+
]
|
|
1176
|
+
}
|
|
1177
|
+
},
|
|
1178
|
+
"additionalProperties": false,
|
|
1179
|
+
"description": "The requested AliExpress store details returned by IXSPY."
|
|
1180
|
+
}
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
"id": "ixspy.get_store_rank",
|
|
1184
|
+
"service": "ixspy",
|
|
1185
|
+
"name": "get_store_rank",
|
|
1186
|
+
"description": "Get an IXSPY AliExpress total, hot, growth, new-store, or rising-store ranking.",
|
|
1187
|
+
"operationType": "read",
|
|
1188
|
+
"requiredScopes": [],
|
|
1189
|
+
"providerPermissions": [],
|
|
1190
|
+
"inputSchema": {
|
|
1191
|
+
"type": "object",
|
|
1192
|
+
"properties": {
|
|
1193
|
+
"rankType": {
|
|
1194
|
+
"type": "string",
|
|
1195
|
+
"enum": [
|
|
1196
|
+
"total",
|
|
1197
|
+
"normalHot",
|
|
1198
|
+
"normalGrowth",
|
|
1199
|
+
"newHot",
|
|
1200
|
+
"newGrowth"
|
|
1201
|
+
],
|
|
1202
|
+
"description": "The store ranking type."
|
|
1203
|
+
},
|
|
1204
|
+
"dateType": {
|
|
1205
|
+
"type": "string",
|
|
1206
|
+
"enum": [
|
|
1207
|
+
"day",
|
|
1208
|
+
"week",
|
|
1209
|
+
"month"
|
|
1210
|
+
],
|
|
1211
|
+
"description": "The ranking period."
|
|
1212
|
+
},
|
|
1213
|
+
"rankDate": {
|
|
1214
|
+
"type": "string",
|
|
1215
|
+
"description": "The available IXSPY ranking date.",
|
|
1216
|
+
"format": "date"
|
|
1217
|
+
},
|
|
1218
|
+
"categoryId": {
|
|
1219
|
+
"type": "integer",
|
|
1220
|
+
"minimum": 1,
|
|
1221
|
+
"description": "The top-level category ID represented by the ranking."
|
|
1222
|
+
},
|
|
1223
|
+
"searchWords": {
|
|
1224
|
+
"type": "string",
|
|
1225
|
+
"minLength": 1,
|
|
1226
|
+
"description": "Words that must occur in the store name.",
|
|
1227
|
+
"pattern": "\\S"
|
|
1228
|
+
},
|
|
1229
|
+
"choiceType": {
|
|
1230
|
+
"type": "integer",
|
|
1231
|
+
"minimum": 0,
|
|
1232
|
+
"maximum": 2,
|
|
1233
|
+
"description": "The AliExpress fulfillment type: 0 for POP, 1 for semi-managed, or 2 for fully managed."
|
|
1234
|
+
},
|
|
1235
|
+
"page": {
|
|
1236
|
+
"type": "integer",
|
|
1237
|
+
"minimum": 1,
|
|
1238
|
+
"description": "The one-based result page number.",
|
|
1239
|
+
"default": 1
|
|
1240
|
+
},
|
|
1241
|
+
"size": {
|
|
1242
|
+
"type": "integer",
|
|
1243
|
+
"minimum": 1,
|
|
1244
|
+
"maximum": 50,
|
|
1245
|
+
"description": "The number of results per page, up to 50.",
|
|
1246
|
+
"default": 50
|
|
1247
|
+
}
|
|
1248
|
+
},
|
|
1249
|
+
"additionalProperties": false,
|
|
1250
|
+
"required": [
|
|
1251
|
+
"rankType",
|
|
1252
|
+
"dateType",
|
|
1253
|
+
"rankDate",
|
|
1254
|
+
"categoryId"
|
|
1255
|
+
],
|
|
1256
|
+
"description": "The store ranking, date, top-level category, optional filters, and pagination."
|
|
1257
|
+
},
|
|
1258
|
+
"outputSchema": {
|
|
1259
|
+
"type": "object",
|
|
1260
|
+
"properties": {
|
|
1261
|
+
"items": {
|
|
1262
|
+
"type": "array",
|
|
1263
|
+
"items": {
|
|
1264
|
+
"type": "object",
|
|
1265
|
+
"properties": {},
|
|
1266
|
+
"additionalProperties": true,
|
|
1267
|
+
"description": "One ranked AliExpress store and its current and previous rank metrics."
|
|
1268
|
+
},
|
|
1269
|
+
"description": "The records returned by IXSPY."
|
|
1270
|
+
},
|
|
1271
|
+
"page": {
|
|
1272
|
+
"anyOf": [
|
|
1273
|
+
{
|
|
1274
|
+
"type": "integer",
|
|
1275
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
1276
|
+
},
|
|
1277
|
+
{
|
|
1278
|
+
"type": "null"
|
|
1279
|
+
}
|
|
1280
|
+
]
|
|
1281
|
+
},
|
|
1282
|
+
"pages": {
|
|
1283
|
+
"anyOf": [
|
|
1284
|
+
{
|
|
1285
|
+
"type": "integer",
|
|
1286
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
1287
|
+
},
|
|
1288
|
+
{
|
|
1289
|
+
"type": "null"
|
|
1290
|
+
}
|
|
1291
|
+
]
|
|
1292
|
+
},
|
|
1293
|
+
"total": {
|
|
1294
|
+
"anyOf": [
|
|
1295
|
+
{
|
|
1296
|
+
"type": "integer",
|
|
1297
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
1298
|
+
},
|
|
1299
|
+
{
|
|
1300
|
+
"type": "null"
|
|
1301
|
+
}
|
|
1302
|
+
]
|
|
1303
|
+
},
|
|
1304
|
+
"credits": {
|
|
1305
|
+
"anyOf": [
|
|
1306
|
+
{
|
|
1307
|
+
"type": "number",
|
|
1308
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1309
|
+
},
|
|
1310
|
+
{
|
|
1311
|
+
"type": "null"
|
|
1312
|
+
}
|
|
1313
|
+
]
|
|
1314
|
+
}
|
|
1315
|
+
},
|
|
1316
|
+
"additionalProperties": false,
|
|
1317
|
+
"description": "The AliExpress store ranking returned by IXSPY."
|
|
1318
|
+
}
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
"id": "ixspy.get_store_region_sales",
|
|
1322
|
+
"service": "ixspy",
|
|
1323
|
+
"name": "get_store_region_sales",
|
|
1324
|
+
"description": "Get estimated AliExpress store order counts grouped by buyer country or region.",
|
|
1325
|
+
"operationType": "read",
|
|
1326
|
+
"requiredScopes": [],
|
|
1327
|
+
"providerPermissions": [],
|
|
1328
|
+
"inputSchema": {
|
|
1329
|
+
"type": "object",
|
|
1330
|
+
"properties": {
|
|
1331
|
+
"storeMerchantId": {
|
|
1332
|
+
"type": "integer",
|
|
1333
|
+
"minimum": 1,
|
|
1334
|
+
"description": "The AliExpress merchant ID."
|
|
1335
|
+
}
|
|
1336
|
+
},
|
|
1337
|
+
"additionalProperties": false,
|
|
1338
|
+
"description": "The AliExpress store to analyze."
|
|
1339
|
+
},
|
|
1340
|
+
"outputSchema": {
|
|
1341
|
+
"type": "object",
|
|
1342
|
+
"properties": {
|
|
1343
|
+
"entityId": {
|
|
1344
|
+
"anyOf": [
|
|
1345
|
+
{
|
|
1346
|
+
"type": "integer",
|
|
1347
|
+
"description": "An integer IXSPY identifier."
|
|
1348
|
+
},
|
|
1349
|
+
{
|
|
1350
|
+
"type": "string",
|
|
1351
|
+
"description": "A string IXSPY identifier."
|
|
1352
|
+
}
|
|
1353
|
+
],
|
|
1354
|
+
"description": "The store identifier returned by IXSPY."
|
|
1355
|
+
},
|
|
1356
|
+
"statistics": {
|
|
1357
|
+
"type": "array",
|
|
1358
|
+
"items": {
|
|
1359
|
+
"type": "object",
|
|
1360
|
+
"properties": {},
|
|
1361
|
+
"additionalProperties": true,
|
|
1362
|
+
"description": "One buyer region and its estimated order count."
|
|
1363
|
+
},
|
|
1364
|
+
"description": "The store statistic rows returned by IXSPY."
|
|
1365
|
+
},
|
|
1366
|
+
"credits": {
|
|
1367
|
+
"anyOf": [
|
|
1368
|
+
{
|
|
1369
|
+
"type": "number",
|
|
1370
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1371
|
+
},
|
|
1372
|
+
{
|
|
1373
|
+
"type": "null"
|
|
1374
|
+
}
|
|
1375
|
+
]
|
|
1376
|
+
}
|
|
1377
|
+
},
|
|
1378
|
+
"additionalProperties": false,
|
|
1379
|
+
"description": "The store statistics returned by IXSPY."
|
|
1380
|
+
}
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"id": "ixspy.get_store_trends",
|
|
1384
|
+
"service": "ixspy",
|
|
1385
|
+
"name": "get_store_trends",
|
|
1386
|
+
"description": "Get up to 90 days of IXSPY follower, sales, and review trend data for a store.",
|
|
1387
|
+
"operationType": "read",
|
|
1388
|
+
"requiredScopes": [],
|
|
1389
|
+
"providerPermissions": [],
|
|
1390
|
+
"inputSchema": {
|
|
1391
|
+
"type": "object",
|
|
1392
|
+
"properties": {
|
|
1393
|
+
"storeMerchantId": {
|
|
1394
|
+
"type": "integer",
|
|
1395
|
+
"minimum": 1,
|
|
1396
|
+
"description": "The AliExpress merchant ID."
|
|
1397
|
+
},
|
|
1398
|
+
"startDate": {
|
|
1399
|
+
"type": "string",
|
|
1400
|
+
"description": "The first trend date.",
|
|
1401
|
+
"format": "date"
|
|
1402
|
+
},
|
|
1403
|
+
"endDate": {
|
|
1404
|
+
"type": "string",
|
|
1405
|
+
"description": "The last trend date, no more than 90 days after the start date.",
|
|
1406
|
+
"format": "date"
|
|
1407
|
+
}
|
|
1408
|
+
},
|
|
1409
|
+
"additionalProperties": false,
|
|
1410
|
+
"description": "The AliExpress store and date range to analyze."
|
|
1411
|
+
},
|
|
1412
|
+
"outputSchema": {
|
|
1413
|
+
"type": "object",
|
|
1414
|
+
"properties": {
|
|
1415
|
+
"entityId": {
|
|
1416
|
+
"anyOf": [
|
|
1417
|
+
{
|
|
1418
|
+
"type": "integer",
|
|
1419
|
+
"description": "An integer IXSPY identifier."
|
|
1420
|
+
},
|
|
1421
|
+
{
|
|
1422
|
+
"type": "string",
|
|
1423
|
+
"description": "A string IXSPY identifier."
|
|
1424
|
+
}
|
|
1425
|
+
],
|
|
1426
|
+
"description": "The store identifier returned by IXSPY."
|
|
1427
|
+
},
|
|
1428
|
+
"startDate": {
|
|
1429
|
+
"anyOf": [
|
|
1430
|
+
{
|
|
1431
|
+
"type": "string",
|
|
1432
|
+
"description": "The first date represented in the trend series.",
|
|
1433
|
+
"format": "date"
|
|
1434
|
+
},
|
|
1435
|
+
{
|
|
1436
|
+
"type": "null"
|
|
1437
|
+
}
|
|
1438
|
+
]
|
|
1439
|
+
},
|
|
1440
|
+
"endDate": {
|
|
1441
|
+
"anyOf": [
|
|
1442
|
+
{
|
|
1443
|
+
"type": "string",
|
|
1444
|
+
"description": "The last date represented in the trend series.",
|
|
1445
|
+
"format": "date"
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
"type": "null"
|
|
1449
|
+
}
|
|
1450
|
+
]
|
|
1451
|
+
},
|
|
1452
|
+
"points": {
|
|
1453
|
+
"type": "array",
|
|
1454
|
+
"items": {
|
|
1455
|
+
"type": "object",
|
|
1456
|
+
"properties": {},
|
|
1457
|
+
"additionalProperties": true,
|
|
1458
|
+
"description": "One store trend point with provider-defined metrics."
|
|
1459
|
+
},
|
|
1460
|
+
"description": "The daily store trend points returned by IXSPY."
|
|
1461
|
+
},
|
|
1462
|
+
"credits": {
|
|
1463
|
+
"anyOf": [
|
|
1464
|
+
{
|
|
1465
|
+
"type": "number",
|
|
1466
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1467
|
+
},
|
|
1468
|
+
{
|
|
1469
|
+
"type": "null"
|
|
1470
|
+
}
|
|
1471
|
+
]
|
|
1472
|
+
}
|
|
1473
|
+
},
|
|
1474
|
+
"additionalProperties": false,
|
|
1475
|
+
"description": "The store trend series returned by IXSPY."
|
|
1476
|
+
}
|
|
1477
|
+
},
|
|
1478
|
+
{
|
|
1479
|
+
"id": "ixspy.list_category_children",
|
|
1480
|
+
"service": "ixspy",
|
|
1481
|
+
"name": "list_category_children",
|
|
1482
|
+
"description": "List the immediate AliExpress child categories under an IXSPY category, including root categories.",
|
|
1483
|
+
"operationType": "read",
|
|
1484
|
+
"requiredScopes": [],
|
|
1485
|
+
"providerPermissions": [],
|
|
1486
|
+
"inputSchema": {
|
|
1487
|
+
"type": "object",
|
|
1488
|
+
"properties": {
|
|
1489
|
+
"parentId": {
|
|
1490
|
+
"type": "integer",
|
|
1491
|
+
"minimum": 0,
|
|
1492
|
+
"description": "The parent category ID. Use 0 for root categories."
|
|
1493
|
+
}
|
|
1494
|
+
},
|
|
1495
|
+
"additionalProperties": false,
|
|
1496
|
+
"description": "The parent category whose immediate children should be listed."
|
|
1497
|
+
},
|
|
1498
|
+
"outputSchema": {
|
|
1499
|
+
"type": "object",
|
|
1500
|
+
"properties": {
|
|
1501
|
+
"parentId": {
|
|
1502
|
+
"anyOf": [
|
|
1503
|
+
{
|
|
1504
|
+
"type": "integer",
|
|
1505
|
+
"description": "An integer category identifier."
|
|
1506
|
+
},
|
|
1507
|
+
{
|
|
1508
|
+
"type": "string",
|
|
1509
|
+
"description": "A string category identifier."
|
|
1510
|
+
}
|
|
1511
|
+
],
|
|
1512
|
+
"description": "The parent category identifier returned by IXSPY."
|
|
1513
|
+
},
|
|
1514
|
+
"count": {
|
|
1515
|
+
"type": "integer",
|
|
1516
|
+
"description": "The number of immediate child categories returned."
|
|
1517
|
+
},
|
|
1518
|
+
"categories": {
|
|
1519
|
+
"type": "array",
|
|
1520
|
+
"items": {
|
|
1521
|
+
"type": "object",
|
|
1522
|
+
"properties": {},
|
|
1523
|
+
"additionalProperties": true,
|
|
1524
|
+
"description": "One AliExpress category with names, hierarchy, and leaf metadata."
|
|
1525
|
+
},
|
|
1526
|
+
"description": "The immediate child categories."
|
|
1527
|
+
},
|
|
1528
|
+
"credits": {
|
|
1529
|
+
"anyOf": [
|
|
1530
|
+
{
|
|
1531
|
+
"type": "number",
|
|
1532
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1533
|
+
},
|
|
1534
|
+
{
|
|
1535
|
+
"type": "null"
|
|
1536
|
+
}
|
|
1537
|
+
]
|
|
1538
|
+
}
|
|
1539
|
+
},
|
|
1540
|
+
"additionalProperties": false,
|
|
1541
|
+
"description": "The AliExpress child categories returned by IXSPY."
|
|
1542
|
+
}
|
|
1543
|
+
},
|
|
1544
|
+
{
|
|
1545
|
+
"id": "ixspy.list_rank_dates",
|
|
1546
|
+
"service": "ixspy",
|
|
1547
|
+
"name": "list_rank_dates",
|
|
1548
|
+
"description": "List the IXSPY dates currently available for normal, holiday, or keyword AliExpress rankings.",
|
|
1549
|
+
"operationType": "read",
|
|
1550
|
+
"requiredScopes": [],
|
|
1551
|
+
"providerPermissions": [],
|
|
1552
|
+
"inputSchema": {
|
|
1553
|
+
"type": "object",
|
|
1554
|
+
"properties": {
|
|
1555
|
+
"rankType": {
|
|
1556
|
+
"type": "string",
|
|
1557
|
+
"enum": [
|
|
1558
|
+
"normalRank",
|
|
1559
|
+
"holidayRank",
|
|
1560
|
+
"keywordRank"
|
|
1561
|
+
],
|
|
1562
|
+
"description": "The ranking date family."
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
"additionalProperties": false,
|
|
1566
|
+
"description": "The ranking family whose available dates should be listed."
|
|
1567
|
+
},
|
|
1568
|
+
"outputSchema": {
|
|
1569
|
+
"type": "object",
|
|
1570
|
+
"properties": {
|
|
1571
|
+
"rankType": {
|
|
1572
|
+
"type": "string",
|
|
1573
|
+
"description": "The ranking family returned by IXSPY."
|
|
1574
|
+
},
|
|
1575
|
+
"dateTypes": {
|
|
1576
|
+
"type": "array",
|
|
1577
|
+
"items": {
|
|
1578
|
+
"type": "object",
|
|
1579
|
+
"properties": {},
|
|
1580
|
+
"additionalProperties": true,
|
|
1581
|
+
"description": "One ranking period with dates and optional holiday metadata."
|
|
1582
|
+
},
|
|
1583
|
+
"description": "The available date groups."
|
|
1584
|
+
},
|
|
1585
|
+
"credits": {
|
|
1586
|
+
"anyOf": [
|
|
1587
|
+
{
|
|
1588
|
+
"type": "number",
|
|
1589
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1590
|
+
},
|
|
1591
|
+
{
|
|
1592
|
+
"type": "null"
|
|
1593
|
+
}
|
|
1594
|
+
]
|
|
1595
|
+
}
|
|
1596
|
+
},
|
|
1597
|
+
"additionalProperties": false,
|
|
1598
|
+
"description": "The available IXSPY ranking dates."
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
{
|
|
1602
|
+
"id": "ixspy.research_categories",
|
|
1603
|
+
"service": "ixspy",
|
|
1604
|
+
"name": "research_categories",
|
|
1605
|
+
"description": "Compare immediate child categories in IXSPY using products, stores, sales, reviews, supply-demand, regional, and top-100 opportunity metrics.",
|
|
1606
|
+
"operationType": "read",
|
|
1607
|
+
"requiredScopes": [],
|
|
1608
|
+
"providerPermissions": [],
|
|
1609
|
+
"inputSchema": {
|
|
1610
|
+
"type": "object",
|
|
1611
|
+
"properties": {
|
|
1612
|
+
"parentCategoryId": {
|
|
1613
|
+
"type": "integer",
|
|
1614
|
+
"minimum": 0,
|
|
1615
|
+
"description": "The parent category ID. Use 0 for top-level categories."
|
|
1616
|
+
},
|
|
1617
|
+
"page": {
|
|
1618
|
+
"type": "integer",
|
|
1619
|
+
"minimum": 1,
|
|
1620
|
+
"description": "The one-based result page number.",
|
|
1621
|
+
"default": 1
|
|
1622
|
+
},
|
|
1623
|
+
"size": {
|
|
1624
|
+
"type": "integer",
|
|
1625
|
+
"minimum": 1,
|
|
1626
|
+
"maximum": 50,
|
|
1627
|
+
"description": "The number of results per page, up to 50.",
|
|
1628
|
+
"default": 50
|
|
1629
|
+
}
|
|
1630
|
+
},
|
|
1631
|
+
"additionalProperties": false,
|
|
1632
|
+
"required": [
|
|
1633
|
+
"parentCategoryId"
|
|
1634
|
+
],
|
|
1635
|
+
"description": "The parent category and pagination for category research."
|
|
1636
|
+
},
|
|
1637
|
+
"outputSchema": {
|
|
1638
|
+
"type": "object",
|
|
1639
|
+
"properties": {
|
|
1640
|
+
"items": {
|
|
1641
|
+
"type": "array",
|
|
1642
|
+
"items": {
|
|
1643
|
+
"type": "object",
|
|
1644
|
+
"properties": {},
|
|
1645
|
+
"additionalProperties": true,
|
|
1646
|
+
"description": "One child category with market-size, demand, competition, regional, and opportunity metrics."
|
|
1647
|
+
},
|
|
1648
|
+
"description": "The records returned by IXSPY."
|
|
1649
|
+
},
|
|
1650
|
+
"page": {
|
|
1651
|
+
"anyOf": [
|
|
1652
|
+
{
|
|
1653
|
+
"type": "integer",
|
|
1654
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
1655
|
+
},
|
|
1656
|
+
{
|
|
1657
|
+
"type": "null"
|
|
1658
|
+
}
|
|
1659
|
+
]
|
|
1660
|
+
},
|
|
1661
|
+
"pages": {
|
|
1662
|
+
"anyOf": [
|
|
1663
|
+
{
|
|
1664
|
+
"type": "integer",
|
|
1665
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
1666
|
+
},
|
|
1667
|
+
{
|
|
1668
|
+
"type": "null"
|
|
1669
|
+
}
|
|
1670
|
+
]
|
|
1671
|
+
},
|
|
1672
|
+
"total": {
|
|
1673
|
+
"anyOf": [
|
|
1674
|
+
{
|
|
1675
|
+
"type": "integer",
|
|
1676
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
1677
|
+
},
|
|
1678
|
+
{
|
|
1679
|
+
"type": "null"
|
|
1680
|
+
}
|
|
1681
|
+
]
|
|
1682
|
+
},
|
|
1683
|
+
"credits": {
|
|
1684
|
+
"anyOf": [
|
|
1685
|
+
{
|
|
1686
|
+
"type": "number",
|
|
1687
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1688
|
+
},
|
|
1689
|
+
{
|
|
1690
|
+
"type": "null"
|
|
1691
|
+
}
|
|
1692
|
+
]
|
|
1693
|
+
}
|
|
1694
|
+
},
|
|
1695
|
+
"additionalProperties": false,
|
|
1696
|
+
"description": "The AliExpress category research results returned by IXSPY."
|
|
1697
|
+
}
|
|
1698
|
+
},
|
|
1699
|
+
{
|
|
1700
|
+
"id": "ixspy.search_categories",
|
|
1701
|
+
"service": "ixspy",
|
|
1702
|
+
"name": "search_categories",
|
|
1703
|
+
"description": "Search AliExpress categories in IXSPY by Chinese or English name, path, or fuzzy keyword.",
|
|
1704
|
+
"operationType": "read",
|
|
1705
|
+
"requiredScopes": [],
|
|
1706
|
+
"providerPermissions": [],
|
|
1707
|
+
"inputSchema": {
|
|
1708
|
+
"type": "object",
|
|
1709
|
+
"properties": {
|
|
1710
|
+
"keyword": {
|
|
1711
|
+
"type": "string",
|
|
1712
|
+
"minLength": 1,
|
|
1713
|
+
"description": "The Chinese or English category keyword or path to search.",
|
|
1714
|
+
"pattern": "\\S"
|
|
1715
|
+
},
|
|
1716
|
+
"level": {
|
|
1717
|
+
"type": "integer",
|
|
1718
|
+
"minimum": 1,
|
|
1719
|
+
"description": "The exact category depth to return when supplied."
|
|
1720
|
+
},
|
|
1721
|
+
"isLeaf": {
|
|
1722
|
+
"type": "boolean",
|
|
1723
|
+
"description": "Whether to return only leaf categories."
|
|
1724
|
+
},
|
|
1725
|
+
"limit": {
|
|
1726
|
+
"type": "integer",
|
|
1727
|
+
"minimum": 1,
|
|
1728
|
+
"maximum": 100,
|
|
1729
|
+
"description": "The maximum number of matching categories to return."
|
|
1730
|
+
}
|
|
1731
|
+
},
|
|
1732
|
+
"additionalProperties": false,
|
|
1733
|
+
"required": [
|
|
1734
|
+
"keyword"
|
|
1735
|
+
],
|
|
1736
|
+
"description": "Filters for searching AliExpress categories."
|
|
1737
|
+
},
|
|
1738
|
+
"outputSchema": {
|
|
1739
|
+
"type": "object",
|
|
1740
|
+
"properties": {
|
|
1741
|
+
"items": {
|
|
1742
|
+
"type": "array",
|
|
1743
|
+
"items": {
|
|
1744
|
+
"type": "object",
|
|
1745
|
+
"properties": {},
|
|
1746
|
+
"additionalProperties": true,
|
|
1747
|
+
"description": "One matching AliExpress category with names and hierarchy metadata."
|
|
1748
|
+
},
|
|
1749
|
+
"description": "The records returned by IXSPY."
|
|
1750
|
+
},
|
|
1751
|
+
"page": {
|
|
1752
|
+
"anyOf": [
|
|
1753
|
+
{
|
|
1754
|
+
"type": "integer",
|
|
1755
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
1756
|
+
},
|
|
1757
|
+
{
|
|
1758
|
+
"type": "null"
|
|
1759
|
+
}
|
|
1760
|
+
]
|
|
1761
|
+
},
|
|
1762
|
+
"pages": {
|
|
1763
|
+
"anyOf": [
|
|
1764
|
+
{
|
|
1765
|
+
"type": "integer",
|
|
1766
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
1767
|
+
},
|
|
1768
|
+
{
|
|
1769
|
+
"type": "null"
|
|
1770
|
+
}
|
|
1771
|
+
]
|
|
1772
|
+
},
|
|
1773
|
+
"total": {
|
|
1774
|
+
"anyOf": [
|
|
1775
|
+
{
|
|
1776
|
+
"type": "integer",
|
|
1777
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
1778
|
+
},
|
|
1779
|
+
{
|
|
1780
|
+
"type": "null"
|
|
1781
|
+
}
|
|
1782
|
+
]
|
|
1783
|
+
},
|
|
1784
|
+
"credits": {
|
|
1785
|
+
"anyOf": [
|
|
1786
|
+
{
|
|
1787
|
+
"type": "number",
|
|
1788
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
1789
|
+
},
|
|
1790
|
+
{
|
|
1791
|
+
"type": "null"
|
|
1792
|
+
}
|
|
1793
|
+
]
|
|
1794
|
+
}
|
|
1795
|
+
},
|
|
1796
|
+
"additionalProperties": false,
|
|
1797
|
+
"description": "The matching AliExpress categories returned by IXSPY."
|
|
1798
|
+
}
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
"id": "ixspy.search_products",
|
|
1802
|
+
"service": "ixspy",
|
|
1803
|
+
"name": "search_products",
|
|
1804
|
+
"description": "Search IXSPY AliExpress products with keyword, category, price, sales, review, rating, fulfillment, discovery, and update filters.",
|
|
1805
|
+
"operationType": "read",
|
|
1806
|
+
"requiredScopes": [],
|
|
1807
|
+
"providerPermissions": [],
|
|
1808
|
+
"inputSchema": {
|
|
1809
|
+
"type": "object",
|
|
1810
|
+
"properties": {
|
|
1811
|
+
"categoryId": {
|
|
1812
|
+
"type": "integer",
|
|
1813
|
+
"minimum": 1,
|
|
1814
|
+
"description": "The category ID whose descendants should also be searched."
|
|
1815
|
+
},
|
|
1816
|
+
"nameKeyword": {
|
|
1817
|
+
"type": "string",
|
|
1818
|
+
"minLength": 1,
|
|
1819
|
+
"description": "An English product-title keyword.",
|
|
1820
|
+
"pattern": "\\S"
|
|
1821
|
+
},
|
|
1822
|
+
"choiceTypes": {
|
|
1823
|
+
"type": "array",
|
|
1824
|
+
"items": {
|
|
1825
|
+
"type": "integer",
|
|
1826
|
+
"minimum": 0,
|
|
1827
|
+
"maximum": 2,
|
|
1828
|
+
"description": "The AliExpress fulfillment type: 0 for POP, 1 for semi-managed, or 2 for fully managed."
|
|
1829
|
+
},
|
|
1830
|
+
"description": "The AliExpress fulfillment types to include.",
|
|
1831
|
+
"minItems": 1,
|
|
1832
|
+
"maxItems": 3,
|
|
1833
|
+
"uniqueItems": true
|
|
1834
|
+
},
|
|
1835
|
+
"shipsFrom": {
|
|
1836
|
+
"type": "string",
|
|
1837
|
+
"enum": [
|
|
1838
|
+
"US",
|
|
1839
|
+
"FR",
|
|
1840
|
+
"RU",
|
|
1841
|
+
"ES",
|
|
1842
|
+
"AU",
|
|
1843
|
+
"PL",
|
|
1844
|
+
"IT",
|
|
1845
|
+
"CZ",
|
|
1846
|
+
"GB",
|
|
1847
|
+
"BE",
|
|
1848
|
+
"DE",
|
|
1849
|
+
"IL",
|
|
1850
|
+
"TR",
|
|
1851
|
+
"UA",
|
|
1852
|
+
"BR",
|
|
1853
|
+
"KR",
|
|
1854
|
+
"HU",
|
|
1855
|
+
"SA",
|
|
1856
|
+
"ID",
|
|
1857
|
+
"AE",
|
|
1858
|
+
"CL",
|
|
1859
|
+
"ZA",
|
|
1860
|
+
"MX",
|
|
1861
|
+
"China"
|
|
1862
|
+
],
|
|
1863
|
+
"description": "The documented IXSPY product origin code."
|
|
1864
|
+
},
|
|
1865
|
+
"discoveredAfter": {
|
|
1866
|
+
"type": "integer",
|
|
1867
|
+
"minimum": 0,
|
|
1868
|
+
"description": "The earliest IXSPY discovery time as a Unix timestamp in seconds."
|
|
1869
|
+
},
|
|
1870
|
+
"discoveredBefore": {
|
|
1871
|
+
"type": "integer",
|
|
1872
|
+
"minimum": 0,
|
|
1873
|
+
"description": "The latest IXSPY discovery time as a Unix timestamp in seconds."
|
|
1874
|
+
},
|
|
1875
|
+
"priceMin": {
|
|
1876
|
+
"type": "number",
|
|
1877
|
+
"minimum": 0,
|
|
1878
|
+
"description": "The minimum product price in USD."
|
|
1879
|
+
},
|
|
1880
|
+
"priceMax": {
|
|
1881
|
+
"type": "number",
|
|
1882
|
+
"minimum": 0,
|
|
1883
|
+
"description": "The maximum product price in USD."
|
|
1884
|
+
},
|
|
1885
|
+
"totalSalesMin": {
|
|
1886
|
+
"type": "integer",
|
|
1887
|
+
"minimum": 0,
|
|
1888
|
+
"description": "The minimum one-year total sales count."
|
|
1889
|
+
},
|
|
1890
|
+
"totalSalesMax": {
|
|
1891
|
+
"type": "integer",
|
|
1892
|
+
"minimum": 0,
|
|
1893
|
+
"description": "The maximum one-year total sales count."
|
|
1894
|
+
},
|
|
1895
|
+
"sales7dMin": {
|
|
1896
|
+
"type": "integer",
|
|
1897
|
+
"minimum": 0,
|
|
1898
|
+
"description": "The minimum seven-day sales count."
|
|
1899
|
+
},
|
|
1900
|
+
"sales7dMax": {
|
|
1901
|
+
"type": "integer",
|
|
1902
|
+
"minimum": 0,
|
|
1903
|
+
"description": "The maximum seven-day sales count."
|
|
1904
|
+
},
|
|
1905
|
+
"totalReviewsMin": {
|
|
1906
|
+
"type": "integer",
|
|
1907
|
+
"minimum": 0,
|
|
1908
|
+
"description": "The minimum one-year review count."
|
|
1909
|
+
},
|
|
1910
|
+
"totalReviewsMax": {
|
|
1911
|
+
"type": "integer",
|
|
1912
|
+
"minimum": 0,
|
|
1913
|
+
"description": "The maximum one-year review count."
|
|
1914
|
+
},
|
|
1915
|
+
"salesReviewRatioMin": {
|
|
1916
|
+
"type": "number",
|
|
1917
|
+
"minimum": 0,
|
|
1918
|
+
"description": "The minimum sales-to-review ratio."
|
|
1919
|
+
},
|
|
1920
|
+
"salesReviewRatioMax": {
|
|
1921
|
+
"type": "number",
|
|
1922
|
+
"minimum": 0,
|
|
1923
|
+
"description": "The maximum sales-to-review ratio."
|
|
1924
|
+
},
|
|
1925
|
+
"ratingMin": {
|
|
1926
|
+
"type": "number",
|
|
1927
|
+
"minimum": 0,
|
|
1928
|
+
"maximum": 5,
|
|
1929
|
+
"description": "The minimum product rating."
|
|
1930
|
+
},
|
|
1931
|
+
"ratingMax": {
|
|
1932
|
+
"type": "number",
|
|
1933
|
+
"minimum": 0,
|
|
1934
|
+
"maximum": 5,
|
|
1935
|
+
"description": "The maximum product rating."
|
|
1936
|
+
},
|
|
1937
|
+
"hasVideo": {
|
|
1938
|
+
"type": "boolean",
|
|
1939
|
+
"description": "Whether products must contain a video."
|
|
1940
|
+
},
|
|
1941
|
+
"storeMerchantId": {
|
|
1942
|
+
"type": "integer",
|
|
1943
|
+
"minimum": 1,
|
|
1944
|
+
"description": "The merchant ID used to restrict results to one store."
|
|
1945
|
+
},
|
|
1946
|
+
"updatedAfter": {
|
|
1947
|
+
"type": "integer",
|
|
1948
|
+
"minimum": 0,
|
|
1949
|
+
"description": "The earliest data update time as a Unix timestamp in seconds."
|
|
1950
|
+
},
|
|
1951
|
+
"updatedBefore": {
|
|
1952
|
+
"type": "integer",
|
|
1953
|
+
"minimum": 0,
|
|
1954
|
+
"description": "The latest data update time as a Unix timestamp in seconds."
|
|
1955
|
+
},
|
|
1956
|
+
"orderBy": {
|
|
1957
|
+
"type": "string",
|
|
1958
|
+
"enum": [
|
|
1959
|
+
"totalSales",
|
|
1960
|
+
"totalReviews",
|
|
1961
|
+
"sales7d",
|
|
1962
|
+
"discoveredTime"
|
|
1963
|
+
],
|
|
1964
|
+
"description": "The product field used for sorting."
|
|
1965
|
+
},
|
|
1966
|
+
"orderKind": {
|
|
1967
|
+
"type": "string",
|
|
1968
|
+
"enum": [
|
|
1969
|
+
"asc",
|
|
1970
|
+
"desc"
|
|
1971
|
+
],
|
|
1972
|
+
"description": "The result sort direction."
|
|
1973
|
+
},
|
|
1974
|
+
"page": {
|
|
1975
|
+
"type": "integer",
|
|
1976
|
+
"minimum": 1,
|
|
1977
|
+
"description": "The one-based result page number.",
|
|
1978
|
+
"default": 1
|
|
1979
|
+
},
|
|
1980
|
+
"size": {
|
|
1981
|
+
"type": "integer",
|
|
1982
|
+
"minimum": 1,
|
|
1983
|
+
"maximum": 50,
|
|
1984
|
+
"description": "The number of results per page, up to 50.",
|
|
1985
|
+
"default": 50
|
|
1986
|
+
}
|
|
1987
|
+
},
|
|
1988
|
+
"additionalProperties": false,
|
|
1989
|
+
"description": "Filters and pagination for searching AliExpress products."
|
|
1990
|
+
},
|
|
1991
|
+
"outputSchema": {
|
|
1992
|
+
"type": "object",
|
|
1993
|
+
"properties": {
|
|
1994
|
+
"items": {
|
|
1995
|
+
"type": "array",
|
|
1996
|
+
"items": {
|
|
1997
|
+
"type": "object",
|
|
1998
|
+
"properties": {},
|
|
1999
|
+
"additionalProperties": true,
|
|
2000
|
+
"description": "One AliExpress product with pricing, sales, reviews, store, media, and category metadata."
|
|
2001
|
+
},
|
|
2002
|
+
"description": "The records returned by IXSPY."
|
|
2003
|
+
},
|
|
2004
|
+
"page": {
|
|
2005
|
+
"anyOf": [
|
|
2006
|
+
{
|
|
2007
|
+
"type": "integer",
|
|
2008
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
2009
|
+
},
|
|
2010
|
+
{
|
|
2011
|
+
"type": "null"
|
|
2012
|
+
}
|
|
2013
|
+
]
|
|
2014
|
+
},
|
|
2015
|
+
"pages": {
|
|
2016
|
+
"anyOf": [
|
|
2017
|
+
{
|
|
2018
|
+
"type": "integer",
|
|
2019
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
2020
|
+
},
|
|
2021
|
+
{
|
|
2022
|
+
"type": "null"
|
|
2023
|
+
}
|
|
2024
|
+
]
|
|
2025
|
+
},
|
|
2026
|
+
"total": {
|
|
2027
|
+
"anyOf": [
|
|
2028
|
+
{
|
|
2029
|
+
"type": "integer",
|
|
2030
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
2031
|
+
},
|
|
2032
|
+
{
|
|
2033
|
+
"type": "null"
|
|
2034
|
+
}
|
|
2035
|
+
]
|
|
2036
|
+
},
|
|
2037
|
+
"credits": {
|
|
2038
|
+
"anyOf": [
|
|
2039
|
+
{
|
|
2040
|
+
"type": "number",
|
|
2041
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
2042
|
+
},
|
|
2043
|
+
{
|
|
2044
|
+
"type": "null"
|
|
2045
|
+
}
|
|
2046
|
+
]
|
|
2047
|
+
}
|
|
2048
|
+
},
|
|
2049
|
+
"additionalProperties": false,
|
|
2050
|
+
"description": "The AliExpress product search results returned by IXSPY."
|
|
2051
|
+
}
|
|
2052
|
+
},
|
|
2053
|
+
{
|
|
2054
|
+
"id": "ixspy.search_stores",
|
|
2055
|
+
"service": "ixspy",
|
|
2056
|
+
"name": "search_stores",
|
|
2057
|
+
"description": "Search IXSPY AliExpress stores with name, category, sales, followers, reviews, rating, price, product count, origin, age, tags, and fulfillment filters.",
|
|
2058
|
+
"operationType": "read",
|
|
2059
|
+
"requiredScopes": [],
|
|
2060
|
+
"providerPermissions": [],
|
|
2061
|
+
"inputSchema": {
|
|
2062
|
+
"type": "object",
|
|
2063
|
+
"properties": {
|
|
2064
|
+
"nameKeyword": {
|
|
2065
|
+
"type": "string",
|
|
2066
|
+
"minLength": 1,
|
|
2067
|
+
"description": "A store-name keyword for fuzzy matching.",
|
|
2068
|
+
"pattern": "\\S"
|
|
2069
|
+
},
|
|
2070
|
+
"categoryId": {
|
|
2071
|
+
"type": "integer",
|
|
2072
|
+
"minimum": 1,
|
|
2073
|
+
"description": "A top-level category ID."
|
|
2074
|
+
},
|
|
2075
|
+
"totalSalesMin": {
|
|
2076
|
+
"type": "integer",
|
|
2077
|
+
"minimum": 0,
|
|
2078
|
+
"description": "The minimum total store sales count."
|
|
2079
|
+
},
|
|
2080
|
+
"totalSalesMax": {
|
|
2081
|
+
"type": "integer",
|
|
2082
|
+
"minimum": 0,
|
|
2083
|
+
"description": "The maximum total store sales count."
|
|
2084
|
+
},
|
|
2085
|
+
"totalFollowersMin": {
|
|
2086
|
+
"type": "integer",
|
|
2087
|
+
"minimum": 0,
|
|
2088
|
+
"description": "The minimum store follower count."
|
|
2089
|
+
},
|
|
2090
|
+
"totalFollowersMax": {
|
|
2091
|
+
"type": "integer",
|
|
2092
|
+
"minimum": 0,
|
|
2093
|
+
"description": "The maximum store follower count."
|
|
2094
|
+
},
|
|
2095
|
+
"totalReviewsMin": {
|
|
2096
|
+
"type": "integer",
|
|
2097
|
+
"minimum": 0,
|
|
2098
|
+
"description": "The minimum store review count."
|
|
2099
|
+
},
|
|
2100
|
+
"totalReviewsMax": {
|
|
2101
|
+
"type": "integer",
|
|
2102
|
+
"minimum": 0,
|
|
2103
|
+
"description": "The maximum store review count."
|
|
2104
|
+
},
|
|
2105
|
+
"ratingMin": {
|
|
2106
|
+
"type": "number",
|
|
2107
|
+
"minimum": 0,
|
|
2108
|
+
"maximum": 5,
|
|
2109
|
+
"description": "The minimum store rating."
|
|
2110
|
+
},
|
|
2111
|
+
"ratingMax": {
|
|
2112
|
+
"type": "number",
|
|
2113
|
+
"minimum": 0,
|
|
2114
|
+
"maximum": 5,
|
|
2115
|
+
"description": "The maximum store rating."
|
|
2116
|
+
},
|
|
2117
|
+
"averagePriceMin": {
|
|
2118
|
+
"type": "number",
|
|
2119
|
+
"minimum": 0,
|
|
2120
|
+
"description": "The minimum average product price in USD."
|
|
2121
|
+
},
|
|
2122
|
+
"averagePriceMax": {
|
|
2123
|
+
"type": "number",
|
|
2124
|
+
"minimum": 0,
|
|
2125
|
+
"description": "The maximum average product price in USD."
|
|
2126
|
+
},
|
|
2127
|
+
"totalProductsMin": {
|
|
2128
|
+
"type": "integer",
|
|
2129
|
+
"minimum": 0,
|
|
2130
|
+
"description": "The minimum store product count."
|
|
2131
|
+
},
|
|
2132
|
+
"totalProductsMax": {
|
|
2133
|
+
"type": "integer",
|
|
2134
|
+
"minimum": 0,
|
|
2135
|
+
"description": "The maximum store product count."
|
|
2136
|
+
},
|
|
2137
|
+
"createdAfter": {
|
|
2138
|
+
"type": "integer",
|
|
2139
|
+
"minimum": 0,
|
|
2140
|
+
"description": "The earliest store creation time as a Unix timestamp in seconds."
|
|
2141
|
+
},
|
|
2142
|
+
"createdBefore": {
|
|
2143
|
+
"type": "integer",
|
|
2144
|
+
"minimum": 0,
|
|
2145
|
+
"description": "The latest store creation time as a Unix timestamp in seconds."
|
|
2146
|
+
},
|
|
2147
|
+
"topBrandTag": {
|
|
2148
|
+
"type": "integer",
|
|
2149
|
+
"minimum": 0,
|
|
2150
|
+
"maximum": 4,
|
|
2151
|
+
"description": "The store tier: 0 for none, 1 for Brand, 2 for Silver, 3 for Gold, or 4 for Plus."
|
|
2152
|
+
},
|
|
2153
|
+
"shipsFrom": {
|
|
2154
|
+
"type": "string",
|
|
2155
|
+
"minLength": 1,
|
|
2156
|
+
"description": "The origin country name used by IXSPY.",
|
|
2157
|
+
"pattern": "\\S"
|
|
2158
|
+
},
|
|
2159
|
+
"styleZone": {
|
|
2160
|
+
"type": "boolean",
|
|
2161
|
+
"description": "Whether the store must be in the AliExpress Style Zone."
|
|
2162
|
+
},
|
|
2163
|
+
"choiceTypes": {
|
|
2164
|
+
"type": "array",
|
|
2165
|
+
"items": {
|
|
2166
|
+
"type": "integer",
|
|
2167
|
+
"minimum": 0,
|
|
2168
|
+
"maximum": 2,
|
|
2169
|
+
"description": "The AliExpress fulfillment type: 0 for POP, 1 for semi-managed, or 2 for fully managed."
|
|
2170
|
+
},
|
|
2171
|
+
"description": "The AliExpress fulfillment types to include.",
|
|
2172
|
+
"minItems": 1,
|
|
2173
|
+
"maxItems": 3,
|
|
2174
|
+
"uniqueItems": true
|
|
2175
|
+
},
|
|
2176
|
+
"orderBy": {
|
|
2177
|
+
"type": "string",
|
|
2178
|
+
"enum": [
|
|
2179
|
+
"totalSales",
|
|
2180
|
+
"totalReviews",
|
|
2181
|
+
"totalFollowers",
|
|
2182
|
+
"createdTime"
|
|
2183
|
+
],
|
|
2184
|
+
"description": "The store field used for sorting."
|
|
2185
|
+
},
|
|
2186
|
+
"orderKind": {
|
|
2187
|
+
"type": "string",
|
|
2188
|
+
"enum": [
|
|
2189
|
+
"asc",
|
|
2190
|
+
"desc"
|
|
2191
|
+
],
|
|
2192
|
+
"description": "The result sort direction."
|
|
2193
|
+
},
|
|
2194
|
+
"page": {
|
|
2195
|
+
"type": "integer",
|
|
2196
|
+
"minimum": 1,
|
|
2197
|
+
"description": "The one-based result page number.",
|
|
2198
|
+
"default": 1
|
|
2199
|
+
},
|
|
2200
|
+
"size": {
|
|
2201
|
+
"type": "integer",
|
|
2202
|
+
"minimum": 1,
|
|
2203
|
+
"maximum": 50,
|
|
2204
|
+
"description": "The number of results per page, up to 50.",
|
|
2205
|
+
"default": 50
|
|
2206
|
+
}
|
|
2207
|
+
},
|
|
2208
|
+
"additionalProperties": false,
|
|
2209
|
+
"description": "Filters and pagination for searching AliExpress stores."
|
|
2210
|
+
},
|
|
2211
|
+
"outputSchema": {
|
|
2212
|
+
"type": "object",
|
|
2213
|
+
"properties": {
|
|
2214
|
+
"items": {
|
|
2215
|
+
"type": "array",
|
|
2216
|
+
"items": {
|
|
2217
|
+
"type": "object",
|
|
2218
|
+
"properties": {},
|
|
2219
|
+
"additionalProperties": true,
|
|
2220
|
+
"description": "One AliExpress store with sales, followers, reviews, rating, category, and fulfillment metadata."
|
|
2221
|
+
},
|
|
2222
|
+
"description": "The records returned by IXSPY."
|
|
2223
|
+
},
|
|
2224
|
+
"page": {
|
|
2225
|
+
"anyOf": [
|
|
2226
|
+
{
|
|
2227
|
+
"type": "integer",
|
|
2228
|
+
"description": "The current one-based page number when IXSPY supplies pagination."
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
"type": "null"
|
|
2232
|
+
}
|
|
2233
|
+
]
|
|
2234
|
+
},
|
|
2235
|
+
"pages": {
|
|
2236
|
+
"anyOf": [
|
|
2237
|
+
{
|
|
2238
|
+
"type": "integer",
|
|
2239
|
+
"description": "The total number of pages when IXSPY supplies pagination."
|
|
2240
|
+
},
|
|
2241
|
+
{
|
|
2242
|
+
"type": "null"
|
|
2243
|
+
}
|
|
2244
|
+
]
|
|
2245
|
+
},
|
|
2246
|
+
"total": {
|
|
2247
|
+
"anyOf": [
|
|
2248
|
+
{
|
|
2249
|
+
"type": "integer",
|
|
2250
|
+
"description": "The total matching record count when IXSPY supplies it."
|
|
2251
|
+
},
|
|
2252
|
+
{
|
|
2253
|
+
"type": "null"
|
|
2254
|
+
}
|
|
2255
|
+
]
|
|
2256
|
+
},
|
|
2257
|
+
"credits": {
|
|
2258
|
+
"anyOf": [
|
|
2259
|
+
{
|
|
2260
|
+
"type": "number",
|
|
2261
|
+
"description": "The IXSPY credit delta reported for the request. A negative value means credits were deducted."
|
|
2262
|
+
},
|
|
2263
|
+
{
|
|
2264
|
+
"type": "null"
|
|
2265
|
+
}
|
|
2266
|
+
]
|
|
2267
|
+
}
|
|
2268
|
+
},
|
|
2269
|
+
"additionalProperties": false,
|
|
2270
|
+
"description": "The AliExpress store search results returned by IXSPY."
|
|
2271
|
+
}
|
|
2272
|
+
}
|
|
2273
|
+
]
|
|
2274
|
+
}
|