Skip to content

nexscope-ai/nexscope-ecommerce-skills / ecommerce-shopify-product-query

ecommerce.shopify-product-query

Verified

Filter Shopify standalone store products by multiple dimensions (keyword/URL, price, weekly sales, listing date, Facebook ads, competitiveness, supplier availability, shipping country, etc.). Triggered when users mention Shopify products, Shopify product selection, standalone store product selection, Shopify bestsellers, Shopify dropshipping, standalone store sourcing, Facebook ad products, Shopify product query, or shopify items. Even if the user does not mention the tool name, this skill should be triggered whenever searching for products, viewing weekly sales/revenue/competitiveness, or filtering products on Shopify standalone stores.

FileKindSize
SKILL.mdskill md2.6 KB
manifest.jsonconfig289 B
references/api.mdmarkdown6.9 KB
scripts/shopify_product_query.pyscript6.6 KB

references/api.md

View on GitHub
# Shopify Product Query API Reference

## Usage Notes

- **Gateway route**: `POST ehunt/shopify/productQuery` (full: `${NEXSCOPE_PROXY_BASE}Query`).
- **MCP display name**: Shopify Product Query (the exact tool name is subject to the tool metadata deployed in the current environment).
- **Authentication**: Request header `Authorization: <api_key>`, api_key read from environment variable `NEXSCOPE_API_KEY` or `NEXSCOPE_API_KEY` (if not configured, follow the **## Resolving Authentication and Credits Issues** section in SKILL.md).
- **Note**: Business fields depend on the operation. Only the outer numeric platform `code: 0` indicates success; a nested business `code` does not replace it.

## Request Parameters (JSON)

| Parameter | Type | Required | Description |
|------|------|------|------|
| searchKey | string, maxLen=500 | No | Keyword or Shopify product/store URL |
| priceMin | number, >=0 | No | Price range start (USD), combined with priceMax to form upstream `price` |
| priceMax | number, >=0 | No | Price range end (USD) |
| salesWeeklyMin | integer, >=0 | No | Weekly sales range start |
| salesWeeklyMax | integer, >=0 | No | Weekly sales range end |
| publishedTimeBegin | string (YYYY-MM-DD) | No | Listing date range start |
| publishedTimeEnd | string (YYYY-MM-DD) | No | Listing date range end |
| facebookAd | integer | No | Has Facebook ad: 1=Yes |
| competitionMin | integer, >=0 | No | Competition (number of stores selling) range start |
| competitionMax | integer, >=0 | No | Competition (number of stores selling) range end |
| hasSupplier | integer | No | Has supplier: 1=Yes, 0=No |
| showDeleted | integer | No | Show delisted products: 1=Yes, 0=No |
| country | string | No | Shipping country (two-letter country code, e.g., US) |
| sortBy | integer | No | Sort field (default 14=Weekly sales descending; also includes price/ad count/competition/revenue etc. values, see enumeration below) |
| page | integer, >=1, default 1 | No | Page number (starting from 1) |
| pageSize | integer, 1~100, default 20 | No | Results per page, max 100, recommended not to exceed 50 |

### `sortBy` Values

Upstream sort enumeration, default `14` (weekly sales descending). Common values include ascending/descending combinations of price, listing time, ad count, competition, weekly sales, weekly revenue, revenue growth rate, etc.; specific codes are subject to the current gateway tool schema comments. Use the default when unknown.

## Nexscope response envelope

These research endpoints return a platform object with numeric `code`, nullable `msg`, and business `data`. Only outer `code: 0` means success; `200`, string codes, missing codes, and HTTP 200 alone do not. A nonzero code is a platform error: show `msg` and do not interpret the payload as a successful result.

`msg` preserves the upstream message when available; Chinese messages are translated to English by Nexscope. A successful response without a message has `msg: null`. Do not infer success or retry behavior from the message text. On both success and failure, the direct fields `code`, `errcode`, `errorCode`, `msg`, `errmsg`, `message`, and `errorMsg` are removed from public `data`. Read the message only from outer `msg`; deeper business fields are preserved, including nested `code` and `status`.

Business field tables and abbreviated business examples below describe `data`, unless explicitly labeled as a complete platform response. For example, a business `products` field is at HTTP `data.products`, and a business `data` array is at HTTP `data.data`. The research endpoints already had this outer envelope; no additional wrapper is added.

```json
{"code":0,"msg":null,"data":{}}
```

Metadata includes string `ts` (epoch milliseconds), string `cost` (elapsed milliseconds, not credits), `time`, and nullable `traceId`. Handle network/HTTP failures before the platform code; gateway failures may not be platform JSON. Keep the existing billing-header guidance separate from elapsed time.

## Main Response Fields

| Field | Type | Description |
|------|------|------|
| total | integer | Number of results returned on this page |
| productNum | integer | Total number of matching products (upstream `product_num`) |
| products | array | Shopify product list |
| columns | array | Columns for rendering |
| title | string | Title (`Shopify Product Query`) |
| sourceType | string | Source type: shopify |
| sourceTool | string | Tool type: ehunt |
| type | string | Render style: tableListWorkbenches |

### `products[]` Elements

| Field | Upstream Alias | Description |
|------|----------|------|
| productId | `product_id` | Product ID |
| title | - | Product title |
| productLink | `product_link` | Product link |
| previewImageUrl | `preview_image_url` | Main image URL |
| country | - | Shipping country |
| minPrice | `min_price` | Minimum price |
| maxPrice | `max_price` | Maximum price |
| storeId | `store_id` | Store ID |
| shopId | `shop_id` | Shopify shop ID |
| storeLink | `store_link` | Store link |
| storeRank | `store_rank` | Store rank |
| competitorCount | `competitor_count` | Competition (number of stores selling) |
| facebookAdCount | `facebook_ad_count` | Facebook ad count |
| weekOrderCount | `week_order_count` | Weekly order count (string) |
| weekRevenueCount | `week_revenue_count` | Weekly revenue |
| weekRevenueGrowth | `week_revenue_growth` | Weekly revenue growth rate (%) |
| shelfTime | `shelf_time` | Listing time |
| isDeleted | `is_deleted` | Whether delisted: 0=Listed, 1=Delisted |
| isFavourite | `is_favourite` | Whether favorited |

## Script Debugging (Optional)

The repository provides **`scripts/shopify_product_query.py`** (Python 3, standard library only), which POSTs JSON matching the MCP input parameters to the Nexscope tool gateway.

- **Gateway**: `${NEXSCOPE_PROXY_BASE}/api/v1/tools/research/ehunt/shopify/productQuery` (can override root URL with `NEXSCOPE_PROXY_BASE_BASE`)
- **Authentication**: Environment variable `NEXSCOPE_API_KEY` (same as other `nexscope-*` skills; if not configured, follow the **## Resolving Authentication and Credits Issues** section in SKILL.md)

```bash
export NEXSCOPE_API_KEY="<your-key>"
python scripts/shopify_product_query.py '{"searchKey": "phone case", "country": "US", "page": 1, "pageSize": 20}'
```

## API Key request rate and retries

All API Keys of one Nexscope user share the public API execution request-rate allowance, measured in any rolling 1-second window. The allowed RPS depends on that user's entitlements; it is not a universal 1 RPS. One Skill operation may issue multiple public API requests, each of which uses the allowance.

HTTP 429 with Nexscope outer code `13012` means request-rate exhaustion: honor the response's `Retry-After`. Outer code `13013` means concurrent-request exhaustion, not rate exhaustion; honor `Retry-After` when supplied. Check the HTTP status and outer JSON code separately. Do not automatically replay writes or requests with uncertain outcomes; first reconcile the operation's state.
reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis.Stars: 472kUpdated Claude CodeCodexVerifiedInstall
diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.Stars: 322kUpdated Claude CodeCodexVerifiedInstall
dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependenciesStars: 322kUpdated Claude CodeCodexVerifiedInstall
executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is availableStars: 322kUpdated Claude CodeCodexVerifiedInstall