POSThttps://api.nexscope.ai/api/skill-api/v1/skills/shopify-store-query/run

Run 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

Code example

{
  "pageSize": 20,
  "searchKey": "phone case",
  "page": 1
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "total": 1,
    "storeNum": 1,
    "stores": [
      {
        "storeId": "example-id",
        "shopId": "example-id",
        "facebookUrl": "https://example.com/image.jpg",
        "instagramUrl": "https://example.com/image.jpg"
      }
    ],
    "columns": []
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

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.

Name

Type

Required

Description

data

object

required

Data value used by this API operation.

data.total

integer

optional

Number of results returned on this page

Example: 1

data.storeNum

integer

optional

Total number of matching stores (upstream store_num)

Example: 1

data.stores

array

optional

Shopify store list

Example: []

data.stores[]

object

required

Item in data stores.

data.stores[].storeId

string

optional

Store ID

Example: example-id

data.stores[].shopId

string

optional

Shopify shop ID

Example: example-id

data.stores[].storeName

string

optional

Store name

Example: null

data.stores[].storeDomain

string

optional

Store domain

Example: null

data.stores[].storeLink

string

optional

Store link

Example: null

data.stores[].country

string

optional

Country

Example: null

data.stores[].createdTime

string

optional

Creation time

Example: null

data.stores[].productNum

string

optional

Product count

Example: null

data.stores[].categoryNum

string

optional

Category count

Example: null

data.stores[].categories

array

optional

Category list (elements contain id and name)

Example: null

data.stores[].monthlyVisit

string

optional

Monthly visits (formatted)

Example: null

data.stores[].monthOrderNum

string

optional

Monthly orders (formatted)

Example: null

data.stores[].fbFollowers

string

optional

Facebook followers

Example: null

data.stores[].insFollowers

string

optional

Instagram followers

Example: null

data.stores[].advertiseCount

string

optional

Ad count

Example: null

data.stores[].adLink

string

optional

Ad library link

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[].instagramUrl

string

optional

Instagram page

Example: https://example.com/image.jpg

data.stores[].socialLinks

object

optional

Social media links (Map)

Example: null

data.stores[].globalRank

string

optional

Global rank

Example: null

data.stores[].logo

string

optional

Store logo URL

Example: null

data.stores[].availableStatus

string

optional

Whether active: 1=Active

Example: null

data.columns

array

optional

Columns for rendering

Example: []

data.title

string

optional

Title (Shopify Store Query)

Example: null

data.sourceType

string

optional

Source type: shopify

Example: null

data.sourceTool

string

optional

Tool type: ehunt

Example: null

data.type

string

optional

Render style: tableListWorkbenches

Example: null

data.costToken

integer

optional

Token cost reported by the upstream provider.

Example: null

data.costTime

integer

optional

Execution time reported by the upstream provider.

Example: null

data.page

integer

optional

Current page returned by the upstream provider.

Example: null

data.pageSize

integer

optional

Page size returned by the upstream provider.

Example: null

data.pageItemCount

integer

optional

Item count on the current page returned by the upstream provider.

Example: null

data.totalPage

integer

optional

Total page count returned by the upstream provider.

Example: null

data.dataSnapshotMonth

string

optional

Data snapshot month returned by the upstream provider.

Example: null

Name

Type

Required

Description

data

null

required

Data value used by this API operation.

Shopify Store Query

What this API does

Shopify Store Query

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Any of option 1

Any of option 2