https://api.nexscope.ai/et/listSellerRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/et/listSeller |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
region | string | required | area. Optional values: US (United States), ID (Indonesia), TH (Thailand), PH (Philippines), MY (Malaysia), VN (Vietnam), GB (UK), MX (Mexico), SG (Singapore), SA (Saudi Arabia), BR (Brazil), ES (Spain), JP (Japan), DE (Germany), IT (Italy), FR (France) |
categoryId | string | optional | Store-level category ID. Maximum length 1000 |
categoryL2Id | string | optional | Store secondary category ID. Maximum length 1000 |
categoryL3Id | string | optional | The third-level category ID of the store. Maximum length 1000 |
minTotalSaleGmv30dAmt | number | optional | GMV screening in the past 30 days (minimum value) |
maxTotalSaleGmv30dAmt | number | optional | GMV filtering in the past 30 days (maximum value) |
salesTrendFlag | integer | optional | Sales trend in the past 7 days: 0=stable, 1=increasing, 2=declining |
fromFlag | integer | optional | Store source: 1=local store, 2=cross-border store |
salesFlag | integer | optional | Main delivery methods: 1=video, 2=live broadcast |
minFirstCrawlDt | integer | optional | Estimated shelf time filter (minimum value), yyyyMMdd format (for example, 20240101 represents 2024-01-01) |
maxFirstCrawlDt | integer | optional | Estimated shelf time filter (maximum value), yyyyMMdd format |
sellerSortField | integer | optional | Sorting fields: 1=total sales (total_sale_cnt), 2=total sales (total_sale_gmv_amt), 3=average price of product SKU in the store (spu_avg_price) Example: 2 |
sortType | integer | optional | Sorting method: 0=ascending order (asc), 1=descending order (desc) Example: 1 |
pageNum | integer | optional | Pagination page number, starting from 1 Example: 1 |
pageSize | integer | optional | Number of items per page. **must be a multiple of 10, the maximum is 100**; the upper limit of a single page in the official interface is 10, internally it is 10 after multiple pulls per page and then merged Example: 50 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
No response example is published for this API. Refer to the response fields below.
Response fields
Response field reference (49 fields)
| Name | Type | Required | Description |
|---|---|---|---|
errcode | integer | optional | Business status code, 200 indicates success (see error code below for details) |
errmsg | string | optional | Business status description |
total | integer | optional | Number of records |
sellers | array | optional | Store list (see store fields below for details) |
columns | array | optional | Rendered columns |
type | string | optional | Rendering style |
costToken | integer | optional | Consume token |
sellerId | string | optional | Store ID |
sellerName | string | optional | Store name |
sellerLink | string | optional | Store link |
coverUrl | string | optional | Store cover address |
region | string | optional | area |
categoryId | string | optional | First level classification ID |
categoryL2Id | string | optional | Secondary classification ID |
categoryL3Id | string | optional | Third level classification ID |
totalSaleCnt | integer | optional | total sales |
totalSale1dCnt | integer | optional | Sales volume in the last day (incremental) |
totalSale7dCnt | integer | optional | Sales volume in the last 7 days (incremental) |
totalSale30dCnt | integer | optional | Sales volume in the last 30 days (incremental) |
totalSale90dCnt | integer | optional | Sales volume in the last 90 days (incremental) |
totalSaleGmvAmt | number | optional | total sales |
totalSaleGmv1dAmt | number | optional | Sales in the last day (incremental) |
totalSaleGmv7dAmt | number | optional | Sales in the last 7 days (incremental) |
totalSaleGmv30dAmt | number | optional | Sales in the last 30 days (incremental) |
totalSaleGmv90dAmt | number | optional | Sales in the last 90 days (incremental) |
followersCount | integer | optional | Number of fans |
rating | number | optional | Rating |
reviewCount | integer | optional | Number of reviews |
positiveFeedbackRate | number | optional | Positive rating |
responseRate | number | optional | response rate |
deliveryRate | integer | optional | Delivery rate |
totalProductCnt | integer | optional | Historical number of items in the store (including removal from shelves) |
totalCrawlProductCnt | integer | optional | Number of items in store |
spuAvgPrice | number | optional | Average price of product SKU in the store |
minPrice | integer | optional | lowest price |
maxPrice | integer | optional | highest price |
totalIflCnt | integer | optional | Total number of people carrying goods |
totalVideoCnt | integer | optional | Total number of videos delivered |
totalLiveCnt | integer | optional | Total live broadcasts |
salesFlagText | string | optional | Main delivery methods |
salesTrendFlagText | string | optional | sales trends |
shopIdentityLabel | string | optional | store logo |
shopTypeText | string | optional | Is it a brand store? |
fromFlagText | string | optional | Cross-border identification |
productCategoryList | string | optional | Product classification |
mostProductCategoryList | string | optional | TOP1 product classification |
firstCrawlDt | integer | optional | Estimated release time, yyyyMMdd format (for example, 20240101 represents 2024-01-01) |
userId | string | optional | Master UID |
sourceType | string | optional | Product source |
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.