https://api.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchKey | string | optional | Store name or domain keyword |
country | string | optional | Country code (e.g., US, CN) |
year | integer | optional | Store creation year: 1=Last 1 year, 2=1~2 years, 3=2~3 years, 4=3+ years Example: 1 |
productNumMin | integer | optional | Product count range start Example: 1 |
productNumMax | integer | optional | Product count range end Example: 1 |
advertiseCountMin | integer | optional | Ad count range start Example: 1 |
advertiseCountMax | integer | optional | Ad count range end Example: 1 |
monthlyVisitMin | integer | optional | Monthly visits range start Example: 1 |
monthlyVisitMax | integer | optional | Monthly visits range end Example: 1 |
monthOrderMin | integer | optional | Monthly orders range start Example: 1 |
monthOrderMax | integer | optional | Monthly orders range end Example: 1 |
sortBy | integer | optional | Sort field: 0=Product count, 1=Category count, 2=Monthly visits, 3=FB followers, 4=Ins followers, 5=Ad count, 6=Relevance, 7=Monthly orders (default) Example: 7 |
orderBy | string | optional | Sort direction: desc (default) / asc Example: desc |
page | integer | optional | Page number (starting from 1) Example: 1 |
pageSize | integer | optional | Results per page, default 20, max 100 Example: 20 |
Code example
{
"page": 1,
"pageSize": 20,
"searchKey": "phone case"
}Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"storeNum": 1,
"stores": [
{
"facebookUrl": "https://example.com/image.jpg",
"instagramUrl": "https://example.com/image.jpg",
"shopId": "example-id",
"storeId": "example-id"
}
],
"total": 1
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.storeNum | any | optional | Store num value used by this API operation. |
data.stores | any | optional | Stores value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Columns for rendering Example: [] |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Token cost reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Tool type: ehunt Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Source type: shopify Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.storeNum | integer | optional | Total number of matching stores (upstream store_num) Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.storeNum | null | optional | Store num value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.stores | array | optional | Shopify store list Example: [] |
data.stores[] | object | required | Item in data stores. |
data.stores[].adLink | string | optional | Ad library link Example: null |
data.stores[].advertiseCount | string | optional | Ad count Example: null |
data.stores[].availableStatus | string | optional | Whether active: 1=Active Example: null |
data.stores[].categories | array | optional | Category list (elements contain id and name) Example: null |
data.stores[].categoryNum | string | optional | Category count Example: null |
data.stores[].country | string | optional | Country Example: null |
data.stores[].createdTime | string | optional | Creation time Example: null |
data.stores[].email | string | optional | Contact email Example: null |
data.stores[].facebookUrl | string | optional | Facebook page Example: https://example.com/image.jpg |
data.stores[].fbFollowers | string | optional | Facebook followers Example: null |
data.stores[].globalRank | string | optional | Global rank Example: null |
data.stores[].insFollowers | string | optional | Instagram followers Example: null |
data.stores[].instagramUrl | string | optional | Instagram page Example: https://example.com/image.jpg |
data.stores[].logo | string | optional | Store logo URL Example: null |
data.stores[].monthOrderNum | string | optional | Monthly orders (formatted) Example: null |
data.stores[].monthlyVisit | string | optional | Monthly visits (formatted) Example: null |
data.stores[].productNum | string | optional | Product count Example: null |
data.stores[].shopId | string | optional | Shopify shop ID Example: example-id |
data.stores[].socialLinks | object | optional | Social media links (Map) Example: null |
data.stores[].storeDomain | string | optional | Store domain Example: null |
data.stores[].storeId | string | optional | Store ID Example: example-id |
data.stores[].storeLink | string | optional | Store link Example: null |
data.stores[].storeName | string | optional | Store name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.stores | null | optional | Stores value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Title (Shopify Store Query) Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Number of results returned on this page Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Render style: tableListWorkbenches Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.