Shopee Product Search 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

Shopee Marketplace

API overview

YouYing Shopee product selection tool supporting product query and filtering across all Shopee marketplaces, covering Malaysia, Taiwan (China), Indonesia, Thailand, Philippines, Singapore, Vietnam, Brazil, Mexico, Chile, and Colombia.

Try this API

Endpoint

https://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopee-product-search/run

MCP method

nexscope_shopee_product_search

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/shopee-product-search/run

Run an API

Request parameters documented by ecommerce.shopee-product-search.

Slug	`shopee-product-search`
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/shopee-product-search/run \
  -H "Authorization: Bearer nk_xxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{   "keywordType": 1,   "keyword": "phone case",   "page": 1,   "station": "SG",   "pageSize": 10 }'

All categories/ Shopee Marketplace

POSThttps://claw-callback.nexscope.ai/api/skill-api/v1/skills/shopee-product-search/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/shopee-product-search/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request body

Name	Type	Required	Description
`station`	`string`	required	Required. Shopee site, accepts name or code. See site mapping table below Example: SG
`keyword`	`string`	optional	Product title keyword Example: phone case
`keywordType`	`integer`	optional	Match mode: 1=Exact phrase (default), 2=Multi-word AND, 3=Multi-word OR Example: 1
`notExistKeyword`	`string`	optional	Exclude products containing this keyword Example: phone case
`notExistKeywordType`	`integer`	optional	Exclusion match mode: 1=Exact phrase (default), 2=Multi-word AND, 3=Multi-word OR Example: 1
`priceMin`	`number`	optional	Minimum total product price (local currency) Example: 1
`priceMax`	`number`	optional	Maximum total product price Example: 1
`soldMin`	`integer`	optional	Minimum units sold in last 30 days Example: 1
`soldMax`	`integer`	optional	Maximum units sold in last 30 days Example: 1
`estimateSoldStart`	`integer`	optional	Minimum estimated units sold in last 30 days Example: 1
`estimateSoldEnd`	`integer`	optional	Maximum estimated units sold in last 30 days Example: 1
`historicalSoldStart`	`integer`	optional	Minimum total historical units sold Example: 1
`historicalSoldEnd`	`integer`	optional	Maximum total historical units sold Example: 1
`paymentStart`	`number`	optional	Minimum sales revenue in last 30 days Example: 1
`paymentEnd`	`number`	optional	Maximum sales revenue in last 30 days Example: 1
`ratingMin`	`number`	optional	Minimum product rating (0-5) Example: 1
`ratingMax`	`number`	optional	Maximum product rating Example: 1
`ratingsMin`	`integer`	optional	Minimum number of ratings Example: 1
`ratingsMax`	`integer`	optional	Maximum number of ratings Example: 1
`favoriteMin`	`integer`	optional	Minimum number of favorites Example: 1
`favoriteMax`	`integer`	optional	Maximum number of favorites Example: 1
`skuNumberStart`	`integer`	optional	Minimum total SKU count Example: 1
`skuNumberEnd`	`integer`	optional	Maximum total SKU count Example: 1
`listingDateFrom`	`string`	optional	Product listing date range start (format: yyyy-MM-dd) Example: 2026-01-01
`listingDateTo`	`string`	optional	Product listing date range end (format: yyyy-MM-dd) Example: 2026-01-01
`statTimeStart`	`string`	optional	Statistics time range start (format: yyyy-MM-dd HH:mm:ss)
`statTimeEnd`	`string`	optional	Statistics time range end (format: yyyy-MM-dd HH:mm:ss)
`lastModiTimeStart`	`string`	optional	Latest crawl time range start (format: yyyy-MM-dd)
`lastModiTimeEnd`	`string`	optional	Latest crawl time range end (format: yyyy-MM-dd)
`approvedDateStart`	`string`	optional	Store opening time range start (format: yyyy-MM-dd) Example: 2026-01-01
`approvedDateEnd`	`string`	optional	Store opening time range end (format: yyyy-MM-dd) Example: 2026-01-01
`pL1Id`	`string`	optional	Level 1 category ID Example: example-id
`pL2Id`	`string`	optional	Level 2 category ID Example: example-id
`pL3Id`	`string`	optional	Level 3 category ID Example: example-id
`cidList`	`string`	optional	Category ID list, full path, multiple groups separated by
`shopIdList`	`string`	optional	Specific store ID list, comma-separated
`notExistShopIdList`	`string`	optional	Excluded store ID list, comma-separated
`merchant`	`string`	optional	Store name or username
`shopLocation`	`string`	optional	Store location
`shippingIconType`	`integer`	optional	Store location type: 0=Local, 1=Overseas Example: 1
`cbOption`	`integer`	optional	Shipping origin: 0=Local, 1=Cross-border Example: 1
`isShopeeVerified`	`integer`	optional	Shopee Preferred: 0=Not preferred, 1=Preferred Example: 1
`isOfficialShop`	`integer`	optional	Official store: 0=No, 1=Yes Example: 1
`isHotSales`	`integer`	optional	Hot selling: 0=Not hot, 1=Hot Example: 1
`pids`	`string`	optional	Product ID list (max 500), comma-separated
`orderBy`	`string`	optional	Sort field: rating, price, historical_sold (total sales), sold (30-day sales), payment (30-day revenue), favorite, ratings, gen_time (listing time), estimate_sold (estimated sales)
`orderByType`	`string`	optional	Sort direction: ASC (ascending), DESC (descending)
`page`	`integer`	optional	Page number (starting from 1) Example: 1
`pageSize`	`integer`	optional	Products per page (range 1-1000) Example: 10

Request example

{
  "keywordType": 1,
  "keyword": "phone case",
  "page": 1,
  "station": "SG",
  "pageSize": 10
}

Response body

Returns the documented upstream API response directly without an additional wrapper.

Name	Type	Required	Description
`total`	`integer`	optional	Number of records returned in current response Example: 1
`totalSize`	`integer`	optional	Total number of results Example: 1
`sourceTool`	`string`	optional	Source tool identifier
`sourceType`	`string`	optional	Source type: shopee
`columns`	`array`	optional	Column definitions for rendering Example: []
`costToken`	`integer`	optional	Tokens consumed Example: 1
`type`	`string`	optional	Render style
`products`	`array`	optional	Product list (see fields below) Example: []
`products[].pid`	`string`	optional	Unique product ID Example: example-id
`products[].title`	`string`	optional	Product title
`products[].description`	`string`	optional	Product description
`products[].imageUrl`	`string`	optional	Product main image URL Example: https://example.com/image.jpg
`products[].productUrl`	`string`	optional	Shopee product link Example: https://example.com/image.jpg
`products[].price`	`number`	optional	Default product price (local currency) Example: 1
`products[].minPrice`	`number`	optional	Lowest SKU price Example: 1
`products[].maxPrice`	`number`	optional	Highest SKU price Example: 1
`products[].sold`	`integer`	optional	Units sold in last 30 days Example: 1
`products[].estimateSold`	`integer`	optional	Estimated units sold in last 30 days Example: 1
`products[].historicalSold`	`integer`	optional	Total historical units sold Example: 1
`products[].payment`	`number`	optional	Sales revenue in last 30 days (local currency) Example: 1
`products[].rating`	`number`	optional	Product rating (0-5) Example: 1
`products[].ratings`	`integer`	optional	Number of ratings Example: 1
`products[].favorite`	`integer`	optional	Number of favorites Example: 1
`products[].viewCount`	`integer`	optional	View count Example: 1
`products[].stock`	`integer`	optional	Stock quantity Example: 1
`products[].skuNumber`	`integer`	optional	Number of SKUs Example: 1
`products[].genTime`	`string`	optional	Listing time
`products[].statTime`	`string`	optional	Statistics time
`products[].lastModiTime`	`string`	optional	Latest crawl time
`products[].categoryStructure`	`string`	optional	Category structure path
`products[].cid`	`string`	optional	Category ID (comma-separated) Example: example-id
`products[].shopId`	`string`	optional	Store ID Example: example-id
`products[].shopName`	`string`	optional	Store name
`products[].shopUrl`	`string`	optional	Store link Example: https://example.com/image.jpg
`products[].userName`	`string`	optional	Store owner name
`products[].shopLocation`	`string`	optional	Store location
`products[].shopProductsCount`	`integer`	optional	Total products in store Example: 1
`products[].approvedDate`	`string`	optional	Store opening time Example: 2026-01-01
`products[].isOfficialShop`	`integer`	optional	Whether official store (1=Yes, 0=No) Example: 1
`products[].isShopeeVerified`	`integer`	optional	Shopee Preferred (1=Yes, 0=No) Example: 1
`products[].isHotSales`	`integer`	optional	Whether hot selling (1=Yes, 0=No) Example: 1
`products[].shippingIconType`	`integer`	optional	Store location type (0=Local, 1=Overseas, 3 or null=Unknown) Example: 1
`products[].cbOption`	`integer`	optional	Shipping origin (0=Local, 1=Cross-border) Example: 1
`products[].estimatedDays`	`integer`	optional	Estimated delivery days Example: 1
`products[].status`	`integer`	optional	Product status (1=Active, 0=Delisted, 8=Excluded from listing) Example: 1
`products[].notExist`	`integer`	optional	Whether exists (0=Exists, 1=Does not exist) Example: 1
`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.
`title`	`string`	optional	Provider-specific response title.
`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,
  "totalSize": 1,
  "columns": [],
  "costToken": 1,
  "products": [
    {
      "pid": "example-id",
      "imageUrl": "https://example.com/image.jpg",
      "productUrl": "https://example.com/image.jpg",
      "price": 1,
      "minPrice": 1,
      "maxPrice": 1,
      "sold": 1,
      "estimateSold": 1,
      "historicalSold": 1,
      "payment": 1,
      "rating": 1,
      "ratings": 1,
      "favorite": 1,
      "viewCount": 1,
      "stock": 1,
      "skuNumber": 1,
      "cid": "example-id",
      "shopId": "example-id",
      "shopUrl": "https://example.com/image.jpg",
      "shopProductsCount": 1,
      "approvedDate": "2026-01-01",
      "isOfficialShop": 1,
      "isShopeeVerified": 1,
      "isHotSales": 1,
      "shippingIconType": 1,
      "cbOption": 1,
      "estimatedDays": 1,
      "status": 1,
      "notExist": 1
    }
  ]
}

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.

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_shopee_product_search",
    "arguments": {
      "keywordType": 1,
      "keyword": "phone case",
      "page": 1,
      "station": "SG",
      "pageSize": 10
    }
  }
}

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/shopee-product-search/run

MCP method

nexscope_shopee_product_search

API key*JSON payload*

cURL

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

Response

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