https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| 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: 1 |
orderBy | string | optional | Sort direction: desc (default) / asc |
page | integer | optional | Page number (starting from 1) Example: 1 |
pageSize | integer | optional | Results per page, max 100 Example: 1 |
Request example
{
"keyword": "phone case",
"pageSize": 10,
"page": 1
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of results returned on this page Example: 1 |
storeNum | integer | optional | Total number of matching stores (upstream store_num) Example: 1 |
stores | array | optional | Shopify store list Example: [] |
columns | array | optional | Columns for rendering Example: [] |
title | string | optional | Title (Shopify Store Query) |
sourceType | string | optional | Source type: shopify |
sourceTool | string | optional | Tool type: ehunt |
type | string | optional | Render style: tableListWorkbenches |
stores[].storeId | string | optional | Store ID Example: example-id |
stores[].shopId | string | optional | Shopify shop ID Example: example-id |
stores[].storeName | string | optional | Store name |
stores[].storeDomain | string | optional | Store domain |
stores[].storeLink | string | optional | Store link |
stores[].country | string | optional | Country |
stores[].createdTime | string | optional | Creation time |
stores[].productNum | string | optional | Product count |
stores[].categoryNum | string | optional | Category count |
stores[].categories | string | optional | Category list (elements contain id, name) |
stores[].monthlyVisit | string | optional | Monthly visits (formatted) |
stores[].monthOrderNum | string | optional | Monthly orders (formatted) |
stores[].fbFollowers | string | optional | Facebook followers |
stores[].insFollowers | string | optional | Instagram followers |
stores[].advertiseCount | string | optional | Ad count |
stores[].adLink | string | optional | Ad library link |
stores[].email | string | optional | Contact email |
stores[].facebookUrl | string | optional | Facebook page Example: https://example.com/image.jpg |
stores[].instagramUrl | string | optional | Instagram page Example: https://example.com/image.jpg |
stores[].socialLinks | string | optional | Social media links (Map) |
stores[].globalRank | string | optional | Global rank |
stores[].logo | string | optional | Store logo URL |
stores[].availableStatus | string | optional | Whether active: 1=Active |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
costToken | integer | optional | Token cost reported by the upstream provider. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"total": 1,
"storeNum": 1,
"stores": [
{
"storeId": "example-id",
"shopId": "example-id",
"facebookUrl": "https://example.com/image.jpg",
"instagramUrl": "https://example.com/image.jpg"
}
],
"columns": []
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.