https://api.nexscope.ai/dl/productBillboardRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/dl/productBillboard |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
keyWord | string | optional | Product search keyword, must be in Chinese, maximum length 50 |
date | string | optional | Query time; the weekly list passes the Sunday date of the week (the longest is nearly 90 days), the monthly list passes the first day of the month (the longest is the last year) |
pageType | integer | optional | List type: `2` weekly list, `3` monthly list Example: 3 |
pageIndex | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | Return quantity per page, range 10-100 Example: 20 |
sortField | string | optional | `orderCount` sales number, `saleCount` sales number, `saleVolume` estimated sales, `offerCreateTime` shelf time, `price` wholesale price, `consignPrice` consignment price Example: orderCount |
sortType | string | optional | Sorting type: `desc` descending order, `asc` ascending order Example: desc |
searchType | integer | optional | Product keyword search: `1` fuzzy matching, `3` precise matching Example: 1 |
offerType | integer | optional | Product identification: `0` is not limited, `2` is new, `3` is carefully selected by 1688, `4` is cross-border, `5` supports customization, `6` is the treasure of the store Example: 0 |
companyType | integer | optional | Company type: `0` unlimited, `1` shop, `2` factory |
shiLiType | string | optional | Seller membership type, separate multiple choices with commas: `superFactory` super factory, `Power` powerful merchant, `TrustPass` integrity member |
beginTpYear | integer | optional | Start the Integrity Pass period |
endTpYear | integer | optional | End of integrity pass period |
beginPrice | number | optional | Wholesale price starting value |
endPrice | number | optional | wholesale price ending value |
beginConsignPrice | number | optional | Starting value of agency price |
endConsignPrice | number | optional | The end value of the agency price |
beginOrderCount | integer | optional | Starting value of number of sales |
endOrderCount | integer | optional | Sales end value |
beginSaleCount | integer | optional | Starting value of sales units |
endSaleCount | integer | optional | Sales end value |
beginSaleVolume | number | optional | sales starting value |
endSaleVolume | number | optional | sales end value |
beginStartQuantity | integer | optional | Starting batch size |
endStartQuantity | integer | optional | end batch |
beginOfferCreateTime | string | optional | Starting value of shelf time, format `YYYY-MM-DD` |
endOfferCreateTime | string | optional | Shelf time end value, format `YYYY-MM-DD` |
sendTime | string | optional | Shipping time, multiple selections separated by commas: `24`, `48`, `72` hours |
proxyRights | string | optional | For drop-shipping rights, multiple options must be separated by commas: `4360897`, free shipping for one piece, `449154`, purchase first, pay later |
shopService | string | optional | Seller services, multiple selections separated by commas: `4057409` Safe Purchase, `888777` In-depth Certification Report |
buyerProtections | string | optional | Rights protection, separate multiple choices with commas: `Free shipping for goods`, `7-day return guarantee`, `Support freight insurance` |
faceToFaceSupport | string | optional | Farewell support, multiple selections separated by commas: `441218` Taobao, `386434` Douyin, `422914` Pinduoduo, `422978` Xiaohongshu, `386370` Kuaishou |
productIds | string | optional | Product ID, multiple separated by commas, up to 20 |
goodsUrl | string | optional | Product link address |
Code example
{
"date": "2026-03-01",
"keyWord": "phone case",
"pageIndex": 1,
"pageSize": 20,
"pageType": 3,
"sortField": "orderCount",
"sortType": "desc"
}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.asin | any | optional | Asin value used by this API operation. |
data.asinUrl | any | optional | Asin url value used by this API operation. |
data.availableDate | any | optional | Available date value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.company | any | optional | Company value used by this API operation. |
data.consignPrice | any | optional | Consign price 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.currency | any | optional | Currency value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.dataType | any | optional | Data type value used by this API operation. |
data.deliveryTime | any | optional | Delivery time value used by this API operation. |
data.estimatedSalesAmount | any | optional | Estimated sales amount value used by this API operation. |
data.imageUrl | any | optional | Image url value used by this API operation. |
data.levelName | any | optional | Level name value used by this API operation. |
data.offerId | any | optional | Offer id 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.price | any | optional | Price value used by this API operation. |
data.products | any | optional | Products value used by this API operation. |
data.quantityBegin | any | optional | Quantity begin value used by this API operation. |
data.quantityPrices | any | optional | Quantity prices value used by this API operation. |
data.salesOrderCount | any | optional | Sales order count value used by this API operation. |
data.salesQuantity | any | optional | Sales quantity value used by this API operation. |
data.shopId | any | optional | Shop id value used by this API operation. |
data.shopUrl | any | optional | Shop url 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.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.type | any | optional | Type value used by this API operation. |
data.unit | any | optional | Unit value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | string | optional | Item number Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asin | null | optional | Asin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.asinUrl | string | optional | Product link address Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.asinUrl | null | optional | Asin url value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.availableDate | string | optional | Product shelf time, in the format of `yyyy-MM-dd HH:mm:ss` Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.availableDate | null | optional | Available date value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Render column definition 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.company | string | optional | Store name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.company | null | optional | Company value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.consignPrice | number | optional | Price on behalf of others Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.consignPrice | null | optional | Consign price 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 | Token cost reported by the upstream provider. 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.currency | string | optional | Currency Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.currency | null | optional | Currency 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.dataType | string | optional | Data type: `weeklyData` weekly data, `monthlyData` monthly data Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.dataType | null | optional | Data type value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.deliveryTime | string | optional | Shipping time Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.deliveryTime | null | optional | Delivery time value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedSalesAmount | integer | optional | Estimated sales, returning corresponding values according to statistical period Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.estimatedSalesAmount | null | optional | Estimated sales amount value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.imageUrl | string | optional | Image address 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.levelName | string | optional | Category level name Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.levelName | null | optional | Level name value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.offerId | string | optional | Product ID Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.offerId | null | optional | Offer id 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.price | number | optional | wholesale price 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.products | array | optional | Product list 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.quantityBegin | integer | optional | Minimum batch size Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.quantityBegin | null | optional | Quantity begin value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.quantityPrices | string | optional | price range Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.quantityPrices | null | optional | Quantity prices value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesOrderCount | integer | optional | The number of sales, returns the corresponding value according to the statistical period Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesOrderCount | null | optional | Sales order count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.salesQuantity | integer | optional | The number of pieces sold, returns the corresponding value according to the statistical period Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.salesQuantity | null | optional | Sales quantity 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.shopUrl | string | optional | Store link address 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.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 platform (1688) 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.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 | Number of records 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.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.unit | string | optional | unit Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.unit | null | optional | Unit 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.