https://api.nexscope.ai/alibaba1688/imageSearchRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/alibaba1688/imageSearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | optional | Image URL, maximum length 1000; only supports png/jpg/jpeg; choose one of `imageBase64`, `imageId` |
imageBase64 | string | optional | Pure Base64 encoding, does not contain `data:image/jpeg;base64,` prefix; only supports png/jpg/jpeg; choose one of `imageUrl` and `imageId` |
imageId | string | optional | 1688 picture ID; it is recommended to carry `page>1` when paging, which can speed up the response; choose one of three `imageUrl` and `imageBase64` |
page | integer | optional | Page number, starting from 1 Example: 1 |
pageSize | integer | optional | The number of products per page cannot exceed 50 Example: 20 |
priceStart | string | optional | Price filter starting value (RMB), such as `10` |
priceEnd | string | optional | Price filter end value (RMB), such as `100` |
filter | string | optional | Filter conditions, multiple conditions separated by commas; see the table below for valid values |
sort | string | optional | JSON format `{sort field: sorting method}`; valid fields are `price`, `monthSold`, `rePurchaseRate` Example: {
"monthSold": "desc"
} |
keyword | string | optional | Keywords to further search in the results |
productCollectionId | string | optional | Pallet ID, single choice; see the table below for valid values |
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 (34 fields)
| Name | Type | Required | Description |
|---|---|---|---|
imageId | string | optional | The image ID after uploading; returning it during paging query can speed up the process |
total | integer | optional | Quantity of products on this page |
totalPage | integer | optional | Total pages |
sourceType | string | optional | Source type, fixed to `1688` |
type | string | optional | Rendering style, fixed to `productWorkbenches` |
columns | array | optional | Render column definition |
costToken | integer | optional | Consume token |
products | array | optional | Product list, see table below |
offerId | string | optional | Product ID |
asin | string | optional | Item number, same as `offerId` |
imageUrl | string | optional | Product pictures |
title | string | optional | Product title |
price | number | optional | Wholesale price (yuan) |
consignPrice | number | optional | Price for one piece (yuan) |
salesQuantity | integer | optional | Number of pieces sold per month |
estimatedSalesAmount | number | optional | Estimated sales |
asinUrl | string | optional | Product link |
isOnePsale | string | optional | Whether to ship on behalf of one piece (yes/no) |
isJxhy | string | optional | Whether to select supply sources (yes/no) |
sellerIdentities | string | optional | Merchant identity (super factory/powerful merchant/integrity member) |
offerIdentities | string | optional | Product label (carefully selected) |
repurchaseRate | string | optional | Repurchase rate |
tradeScore | string | optional | Product Transaction Rating |
compositeServiceScore | string | optional | Comprehensive service experience points |
sendGoodsAddressText | string | optional | Place of shipment |
deliveryTime | string | optional | Shipping time (24/48 hours) |
quantityBegin | integer | optional | Minimum batch size |
hasPromotion | string | optional | Is there a marketing campaign (yes/no) |
promotionType | string | optional | marketing type |
isPatentProduct | string | optional | Is it a patented product (yes/no) |
isSelect | string | optional | Cross-Border Select Pallet Identification |
currency | string | optional | Currency, fixed to `¥` |
sourceType | string | optional | Source type, fixed to `1688` |
dataType | string | optional | Data type, fixed to `monthlyData` |
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.