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
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.approvedDate | any | optional | Approved date value used by this API operation. |
data.categoryStructure | any | optional | Category structure value used by this API operation. |
data.cbOption | any | optional | Cb option value used by this API operation. |
data.cid | any | optional | Cid value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.description | any | optional | Description value used by this API operation. |
data.estimateSold | any | optional | Estimate sold value used by this API operation. |
data.estimatedDays | any | optional | Estimated days value used by this API operation. |
data.favorite | any | optional | Favorite value used by this API operation. |
data.genTime | any | optional | Gen time value used by this API operation. |
data.historicalSold | any | optional | Historical sold value used by this API operation. |
data.imageUrl | any | optional | Image url value used by this API operation. |
data.isHotSales | any | optional | Is hot sales value used by this API operation. |
data.isOfficialShop | any | optional | Is official shop value used by this API operation. |
data.isShopeeVerified | any | optional | Is shopee verified value used by this API operation. |
data.lastModiTime | any | optional | Last modi time value used by this API operation. |
data.maxPrice | any | optional | Max price value used by this API operation. |
data.minPrice | any | optional | Min price value used by this API operation. |
data.notExist | any | optional | Not exist value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.payment | any | optional | Payment value used by this API operation. |
data.pid | any | optional | Pid value used by this API operation. |
data.price | any | optional | Price value used by this API operation. |
data.productUrl | any | optional | Product url value used by this API operation. |
data.products | any | optional | Products value used by this API operation. |
data.rating | any | optional | Rating value used by this API operation. |
data.ratings | any | optional | Ratings value used by this API operation. |
data.shippingIconType | any | optional | Shipping icon type value used by this API operation. |
data.shopId | any | optional | Shop id value used by this API operation. |
data.shopLocation | any | optional | Shop location value used by this API operation. |
data.shopName | any | optional | Shop name value used by this API operation. |
data.shopProductsCount | any | optional | Shop products count value used by this API operation. |
data.shopUrl | any | optional | Shop url value used by this API operation. |
data.shopeeUrl | any | optional | Shopee url value used by this API operation. |
data.skuNumber | any | optional | Sku number value used by this API operation. |
data.sold | any | optional | Sold value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.statTime | any | optional | Stat time value used by this API operation. |
data.status | any | optional | Status value used by this API operation. |
data.stock | any | optional | Stock value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.totalSize | any | optional | Total size value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.userName | any | optional | User name value used by this API operation. |
data.viewCount | any | optional | View count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.approvedDate | string | optional | Store opening hours. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.approvedDate | null | optional | Approved date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryStructure | string | optional | Category structure path. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categoryStructure | null | optional | Category structure value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.cbOption | integer | optional | Shipping location (0=domestic, 1=cross-border). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.cbOption | null | optional | Cb option value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.cid | string | optional | Category IDs (comma separated). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.cid | null | optional | Cid value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Render column definitions. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Consume token. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.description | string | optional | Product description. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.description | null | optional | Description value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.estimateSold | integer | optional | Estimate the number of units sold in the previous 30 days. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.estimateSold | null | optional | Estimate sold value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedDays | integer | optional | Estimated days of arrival. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedDays | null | optional | Estimated days value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.favorite | integer | optional | Number of collections. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.favorite | null | optional | Favorite value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.genTime | string | optional | Shelf time. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.genTime | null | optional | Gen time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.historicalSold | integer | optional | The total number of items sold. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.historicalSold | null | optional | Historical sold value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | string | optional | Product main image URL. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | null | optional | Image url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isHotSales | integer | optional | Is it a hot seller (1=yes, 0=no). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isHotSales | null | optional | Is hot sales value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isOfficialShop | integer | optional | Is it an official store (1=yes, 0=no). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isOfficialShop | null | optional | Is official shop value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.isShopeeVerified | integer | optional | Shopee is preferred (1=yes, 0=no). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.isShopeeVerified | null | optional | Is shopee verified value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.lastModiTime | string | optional | Latest crawl time. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.lastModiTime | null | optional | Last modi time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.maxPrice | number | optional | The highest price of the SKU. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.maxPrice | null | optional | Max price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.minPrice | number | optional | SKU lowest price. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.minPrice | null | optional | Min price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.notExist | integer | optional | Whether it exists (0=exists, 1=does not exist). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.notExist | null | optional | Not exist value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.payment | number | optional | Sales in the previous 30 days (local currency). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.payment | null | optional | Payment value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.pid | string | optional | Product unique ID. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.pid | null | optional | Pid value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.price | number | optional | Product default price (local currency). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.price | null | optional | Price value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.productUrl | string | optional | Shopee product link. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.productUrl | null | optional | Product url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.products | array | optional | List of products (see fields below). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.products | null | optional | Products value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | number | optional | Product rating (0-5). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.rating | null | optional | Rating value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.ratings | integer | optional | Rating number. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.ratings | null | optional | Ratings value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shippingIconType | integer | optional | Store location type (0=local, 1=overseas, 3 or null=unknown). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shippingIconType | null | optional | Shipping icon type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopId | string | optional | Store ID. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopId | null | optional | Shop id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopLocation | string | optional | Store location. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopLocation | null | optional | Shop location value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopName | string | optional | Store name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopName | null | optional | Shop name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopProductsCount | integer | optional | The total number of items in the store. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopProductsCount | null | optional | Shop products count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopUrl | string | optional | Store link. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopUrl | null | optional | Shop url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.shopeeUrl | string | optional | Product links under the Shopee domain name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.shopeeUrl | null | optional | Shopee url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.skuNumber | integer | optional | SKU quantity. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.skuNumber | null | optional | Sku number value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sold | integer | optional | Number of units sold in the previous 30 days. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sold | null | optional | Sold value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Source type: `shopee`. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.statTime | string | optional | Statistics time. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.statTime | null | optional | Stat time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.status | integer | optional | Product status (1=normal, 0=removed, 8=excluded from list). Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.status | null | optional | Status value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.stock | integer | optional | Stock count. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.stock | null | optional | Stock value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Product title. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | The current number of records returned. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalSize | integer | optional | Total number of results. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalSize | null | optional | Total size value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Rendering style. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.userName | string | optional | Store owner name. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.userName | null | optional | User name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.viewCount | integer | optional | Number of views. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.viewCount | null | optional | View count value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.