https://api.nexscope.ai/eh/shopify/productQueryRun 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/productQuery |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
searchKey | string | optional | Keyword or Shopify product/store URL |
priceMin | number | optional | Price range (starting, USD), formed with `priceMax` upstream `price` |
priceMax | number | optional | Price range (end, USD) |
salesWeeklyMin | integer | optional | Weekly sales range (starting) |
salesWeeklyMax | integer | optional | Weekly sales range (end) |
publishedTimeBegin | string | optional | The start of the shelf date range |
publishedTimeEnd | string | optional | End of shelf date range |
facebookAd | integer | optional | Whether there are Facebook ads: 1=Yes |
competitionMin | integer | optional | Competition degree (number of stores on sale) range starts |
competitionMax | integer | optional | Competition degree (number of stores on sale) range ends |
hasSupplier | integer | optional | Whether there is supply: 1=Yes, 0=No |
showDeleted | integer | optional | Whether to display removed products: 1=yes, 0=no |
country | string | optional | Shipping country (two-digit country code, such as `US`) |
sortBy | integer | optional | Sorting field; default `14`=weekly sales in descending order, see the current gateway tool schema comments for other encodings Example: 14 |
page | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | Number of entries per page, maximum 100, recommended not to exceed 50 Example: 20 |
Code example
{
"country": "US",
"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": {},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
Response field reference (26 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of items returned on this page |
productNum | integer | optional | Total number of eligible items (upstream `product_num`) |
products | array | optional | Shopify product list |
columns | array | optional | Rendered columns |
title | string | optional | Title (`Shopify Product Query`) |
sourceType | string | optional | Source type: shopify |
type | string | optional | Rendered style: tableListWorkbenches |
productId | `product_id` | optional | Product ID |
title | - | optional | Product title |
productLink | `product_link` | optional | Product link |
previewImageUrl | `preview_image_url` | optional | Main image URL |
country | - | optional | Shipping country |
minPrice | `min_price` | optional | lowest price |
maxPrice | `max_price` | optional | highest price |
storeId | `store_id` | optional | Store ID |
shopId | `shop_id` | optional | Shopify shop ID |
storeLink | `store_link` | optional | Store link |
storeRank | `store_rank` | optional | store level |
competitorCount | `competitor_count` | optional | Competition (number of stores on sale) |
facebookAdCount | `facebook_ad_count` | optional | Number of Facebook ads |
weekOrderCount | `week_order_count` | optional | Weekly sales (string) |
weekRevenueCount | `week_revenue_count` | optional | weekly sales |
weekRevenueGrowth | `week_revenue_growth` | optional | Weekly sales growth rate (%) |
shelfTime | `shelf_time` | optional | Shelf time |
isDeleted | `is_deleted` | optional | Whether to take it off the shelf: 0=on the shelf, 1=off the shelf |
isFavourite | `is_favourite` | optional | Has it been collected? |
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.