Shopify Product Query API

REST API and MCP service documentation generated from server-side API definitions. Responses shown here are the direct payload returned by each API execution.

API selector

Shopify Commerce

API overview

Filter Shopify standalone store products by multiple dimensions (keyword/URL, price, weekly sales, listing date, Facebook ads, competitiveness, supplier availability, shipping country, etc.).

Try this API

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run

MCP method

nexscope_shopify_product_query

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk_xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run

Run an API

Request parameters documented by ecommerce.shopify-product-query.

Slug	`shopify-product-query`
Headers	`Authorization: Bearer nk_...` `Content-Type: application/json`
Request body	API-specific JSON object.
Response body	Direct API response payload. No data/result wrapper is added.

Status codes

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.

Example request

curl -X POST https://api.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "keyword": "phone case",   "pageSize": 10,   "page": 1 }'

All categories/ Shopify Commerce

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run

Run this API

Send a JSON request to execute this API and receive the direct response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`searchKey`	`string`	optional	Keyword or Shopify product/store URL
`priceMin`	`number`	optional	Price range start (USD), combined with priceMax to form upstream price Example: 1
`priceMax`	`number`	optional	Price range end (USD) Example: 1
`salesWeeklyMin`	`integer`	optional	Weekly sales range start Example: 1
`salesWeeklyMax`	`integer`	optional	Weekly sales range end Example: 1
`publishedTimeBegin`	`string`	optional	Listing date range start
`publishedTimeEnd`	`string`	optional	Listing date range end
`facebookAd`	`integer`	optional	Has Facebook ad: 1=Yes Example: 1
`competitionMin`	`integer`	optional	Competition (number of stores selling) range start Example: 1
`competitionMax`	`integer`	optional	Competition (number of stores selling) range end Example: 1
`hasSupplier`	`integer`	optional	Has supplier: 1=Yes, 0=No Example: 1
`showDeleted`	`integer`	optional	Show delisted products: 1=Yes, 0=No Example: 1
`country`	`string`	optional	Shipping country (two-letter country code, e.g., US)
`sortBy`	`integer`	optional	Sort field (default 14=Weekly sales descending; also includes price/ad count/competition/revenue etc. values, see enumeration below) Example: 1
`page`	`integer`	optional	Page number (starting from 1) Example: 1
`pageSize`	`integer`	optional	Results per page, max 100, recommended not to exceed 50 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
`productNum`	`integer`	optional	Total number of matching products (upstream product_num) Example: 1
`products`	`array`	optional	Shopify product list Example: []
`columns`	`array`	optional	Columns for rendering Example: []
`title`	`string`	optional	Title (Shopify Product Query)
`sourceType`	`string`	optional	Source type: shopify
`sourceTool`	`string`	optional	Tool type: ehunt
`type`	`string`	optional	Render style: tableListWorkbenches
`products[].productId`	`string`	optional	Product ID Example: example-id
`products[].title`	`string`	optional	Product title
`products[].productLink`	`string`	optional	Product link
`products[].previewImageUrl`	`string`	optional	Main image URL Example: https://example.com/image.jpg
`products[].country`	`string`	optional	Shipping country
`products[].minPrice`	`string`	optional	Minimum price
`products[].maxPrice`	`string`	optional	Maximum price
`products[].storeId`	`string`	optional	Store ID Example: example-id
`products[].shopId`	`string`	optional	Shopify shop ID Example: example-id
`products[].storeLink`	`string`	optional	Store link
`products[].storeRank`	`string`	optional	Store rank
`products[].competitorCount`	`string`	optional	Competition (number of stores selling)
`products[].facebookAdCount`	`string`	optional	Facebook ad count
`products[].weekOrderCount`	`string`	optional	Weekly order count (string)
`products[].weekRevenueCount`	`string`	optional	Weekly revenue
`products[].weekRevenueGrowth`	`string`	optional	Weekly revenue growth rate (%)
`products[].shelfTime`	`string`	optional	Listing time
`products[].isDeleted`	`string`	optional	Whether delisted: 0=Listed, 1=Delisted
`products[].isFavourite`	`string`	optional	Whether favorited
`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,
  "productNum": 1,
  "products": [
    {
      "productId": "example-id",
      "previewImageUrl": "https://example.com/image.jpg",
      "storeId": "example-id",
      "shopId": "example-id"
    }
  ],
  "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.

Related APIs

Shopify Store Query

Filter Shopify standalone stores by multiple dimensions (store name/domain, country, years since creation, product count, ad count, monthly visits, monthly orders, social media followers, etc.).

MCP

Use the MCP endpoint when an agent needs to discover and call API tools with JSON-RPC.

GET /api/skill-api/v1/mcp

POST /api/skill-api/v1/mcp
Authorization: Bearer nk_xxxxxxxxxxxxxxxxx
Content-Type: application/json

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_shopify_product_query",
    "arguments": {
      "keyword": "phone case",
      "pageSize": 10,
      "page": 1
    }
  }
}

Online test

Execute the current API with your API key and JSON payload.

Try it

Send a real request with the same contract shown in the reference.

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run

MCP method

nexscope_shopify_product_query

API key*JSON payload*

cURL

curl -X POST \
  https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopify-product-query/run \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "keyword": "phone case", "pageSize": 10, "page": 1 }'

Response

No response yet. Run the request to see the response here.