https://api.nexscope.ai/eh/shopify/storeQueryRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/eh/shopify/storeQuery |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchKey | string | optional | Store name or domain name keywords |
country | string | optional | Country code (e.g. `US`, `CN`) |
year | integer | optional | Store creation year: 1=last year, 2=1~2 years, 3=2~3 years, 4=more than 3 years |
productNumMin | integer | optional | Product number range (start) |
productNumMax | integer | optional | Product number interval (end) |
advertiseCountMin | integer | optional | Advertisement count interval (start) |
advertiseCountMax | integer | optional | Advertisement count interval (end) |
monthlyVisitMin | integer | optional | Monthly visit range (start) |
monthlyVisitMax | integer | optional | Monthly visit range (end) |
monthOrderMin | integer | optional | Monthly order volume range (starting) |
monthOrderMax | integer | optional | Monthly order volume range (end) |
sortBy | integer | optional | Sorting fields: 0=number of products, 1=number of categories, 2=monthly visits, 3=FB fans, 4=Ins fans, 5=number of ads, 6=relevance, 7=number of monthly orders Example: 7 |
orderBy | string | optional | Sorting direction: `desc` (descending order)/`asc` (ascending order) Example: desc |
page | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | Number of items per page, maximum 100 Example: 20 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (30 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of items returned on this page |
storeNum | integer | optional | Total number of eligible stores (upstream `store_num`) |
stores | array | optional | Shopify store list |
columns | array | optional | Rendered columns |
title | string | optional | Title (`Shopify store query`) |
sourceType | string | optional | Source type: shopify |
type | string | optional | Rendered style: tableListWorkbenches |
storeId | `store_id` | optional | Store ID |
shopId | `shop_id` | optional | Shopify shop ID |
storeName | `store_name` | optional | Store name |
storeDomain | `store_domain` | optional | Store domain name |
storeLink | `store_link` | optional | Store link |
country | - | optional | country |
createdTime | `created_time` | optional | creation time |
productNum | `product_num` | optional | Number of products |
categoryNum | `category_num` | optional | Number of categories |
categories | - | optional | Category list (elements include `id`, `name`) |
monthlyVisit | `monthly_visit` | optional | Monthly visits (formatted) |
monthOrderNum | `month_order_num` | optional | Monthly order volume (formatted) |
fbFollowers | `fb_followers` | optional | Number of Facebook fans |
insFollowers | `ins_followers` | optional | Instagram followers |
advertiseCount | `advertise_count` | optional | Number of ads |
adLink | `ad_link` | optional | Ad library link |
email | - | optional | Contact email |
facebookUrl | `facebook_url` | optional | Facebook home page |
instagramUrl | `instagram_url` | optional | Instagram Home Page |
socialLinks | `social_links` | optional | Social Media Links (Map) |
globalRank | `global_rank` | optional | global ranking |
logo | - | optional | Store Logo URL |
availableStatus | `available_status` | optional | Is it active: 1=active |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.