https://api.nexscope.ai/yy/shopee/getProductInfosRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/yy/shopee/getProductInfos |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
station | string | optional | **Required**. Shopee site, you can pass the name or code. See site mapping table below. |
keyword | string | optional | Product title keywords. |
keywordType | integer | optional | Matching mode: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR. |
notExistKeyword | string | optional | Exclude products containing this keyword. |
notExistKeywordType | integer | optional | Exclude match patterns: 1=whole sentence (default), 2=multi-word AND, 3=multi-word OR. |
priceMin | number | optional | Total product price starting value (local currency). |
priceMax | number | optional | The end value of the total price of the product. |
soldMin | integer | optional | The starting value of the number of units sold in the previous 30 days. |
soldMax | integer | optional | The end value of the number of units sold in the previous 30 days. |
estimateSoldStart | integer | optional | Estimate the starting value of the number of units sold in the first 30 days. |
estimateSoldEnd | integer | optional | Estimate the end value of the number of units sold in the first 30 days. |
historicalSoldStart | integer | optional | The starting value of the total number of units sold of the product. |
historicalSoldEnd | integer | optional | The end value of the total number of units sold of the product. |
paymentStart | number | optional | The starting value of sales amount in the previous 30 days. |
paymentEnd | number | optional | Ending value of sales amount in the previous 30 days. |
ratingMin | number | optional | Minimum product rating (0-5). |
ratingMax | number | optional | Maximum product rating. |
ratingsMin | integer | optional | The starting value of the score. |
ratingsMax | integer | optional | The end value of the score. |
favoriteMin | integer | optional | The starting value of the number of collections. |
favoriteMax | integer | optional | End value of collection count. |
skuNumberStart | integer | optional | Starting value of the total number of SKUs. |
skuNumberEnd | integer | optional | The end value of the total number of SKUs. |
listingDateFrom | string | optional | The starting value of product shelf time (format: yyyy-MM-dd). |
listingDateTo | string | optional | Product shelf end value (format: yyyy-MM-dd). |
statTimeStart | string | optional | Starting value of statistical time (format: yyyy-MM-dd HH:mm:ss). |
statTimeEnd | string | optional | End value of statistical time (format: yyyy-MM-dd HH:mm:ss). |
lastModiTimeStart | string | optional | The latest crawl time starting value (format: yyyy-MM-dd). |
lastModiTimeEnd | string | optional | The latest crawl time end value (format: yyyy-MM-dd). |
approvedDateStart | string | optional | The starting value of the store opening time (format: yyyy-MM-dd). |
approvedDateEnd | string | optional | The end value of the store opening time (format: yyyy-MM-dd). |
pL1Id | string | optional | Level 1 category ID. |
pL2Id | string | optional | Level 2 category ID. |
pL3Id | string | optional | Level 3 category ID. |
cidList | string | optional | Category id list, complete path, multiple groups separated by `|`, such as: `AAA,BBB,CCC|DDD,EEE`. |
shopIdList | string | optional | Specify a list of store IDs, separated by multiple commas. |
notExistShopIdList | string | optional | Exclude a list of store IDs, separated by multiple commas. |
merchant | string | optional | Store name or user name. |
shopLocation | string | optional | Store location. |
shippingIconType | integer | optional | Store location: 0=local, 1=overseas. |
cbOption | integer | optional | Shipping location: 0=domestic, 1=cross-border. |
isShopeeVerified | integer | optional | Shopee Preferred: 0=not preferred, 1=preferred. |
isOfficialShop | integer | optional | Official store: 0=no, 1=yes. |
isHotSales | integer | optional | Whether it is a hot seller: 0 = not a hot seller, 1 = a hot seller. |
pids | string | optional | List of product IDs (up to 500), separated by commas. |
orderBy | string | optional | Sorting fields: `rating` (rating), `price` (price), `historical_sold` (total sales), `sold` (30-day sales), `payment` (30-day sales), `favorite` (number of collections), `ratings` (number of ratings), `gen_time` (time on shelves), `estimate_sold` (estimated sales). |
orderByType | string | optional | Sorting direction: `ASC` (ascending order), `DESC` (descending order). Example: DESC |
page | integer | optional | Page number (starting from 1). Example: 1 |
pageSize | integer | optional | Number of items per page (range 1-1000). Example: 1000 |
Code example
{
"keyword": "Storage Box",
"keywordType": 2,
"orderBy": "sold",
"orderByType": "DESC",
"pageSize": 50,
"soldMin": 100,
"station": "malaysia"
}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 (46 fields)
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | The current number of records returned. |
totalSize | integer | optional | Total number of results. |
sourceType | string | optional | Source type: `shopee`. |
columns | array | optional | Render column definitions. |
costToken | integer | optional | Consume token. |
type | string | optional | Rendering style. |
products | array | optional | List of products (see fields below). |
pid | string | optional | Product unique ID. |
title | string | optional | Product title. |
description | string | optional | Product description. |
imageUrl | string | optional | Product main image URL. |
productUrl | string | optional | Shopee product link. |
shopeeUrl | string | optional | Product links under the Shopee domain name. |
price | number | optional | Product default price (local currency). |
minPrice | number | optional | SKU lowest price. |
maxPrice | number | optional | The highest price of the SKU. |
sold | integer | optional | Number of units sold in the previous 30 days. |
estimateSold | integer | optional | Estimate the number of units sold in the previous 30 days. |
historicalSold | integer | optional | The total number of items sold. |
payment | number | optional | Sales in the previous 30 days (local currency). |
rating | number | optional | Product rating (0-5). |
ratings | integer | optional | Rating number. |
favorite | integer | optional | Number of collections. |
viewCount | integer | optional | Number of views. |
stock | integer | optional | Stock count. |
skuNumber | integer | optional | SKU quantity. |
genTime | string | optional | Shelf time. |
statTime | string | optional | Statistics time. |
lastModiTime | string | optional | Latest crawl time. |
categoryStructure | string | optional | Category structure path. |
cid | string | optional | Category IDs (comma separated). |
shopId | string | optional | Store ID. |
shopName | string | optional | Store name. |
shopUrl | string | optional | Store link. |
userName | string | optional | Store owner name. |
shopLocation | string | optional | Store location. |
shopProductsCount | integer | optional | The total number of items in the store. |
approvedDate | string | optional | Store opening hours. |
isOfficialShop | integer | optional | Is it an official store (1=yes, 0=no). |
isShopeeVerified | integer | optional | Shopee is preferred (1=yes, 0=no). |
isHotSales | integer | optional | Is it a hot seller (1=yes, 0=no). |
shippingIconType | integer | optional | Store location type (0=local, 1=overseas, 3 or null=unknown). |
cbOption | integer | optional | Shipping location (0=domestic, 1=cross-border). |
estimatedDays | integer | optional | Estimated days of arrival. |
status | integer | optional | Product status (1=normal, 0=removed, 8=excluded from list). |
notExist | integer | optional | Whether it exists (0=exists, 1=does not exist). |
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.