POSThttps://api.nexscope.ai/api/skill-api/v1/skills/1688-product-search/run

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/api/skill-api/v1/skills/1688-product-search/run`
Auth	`Bearer API key`
Content-Type	`application/json`

Request parameters

Name	Type	Required	Description
`keyWord`	`string`	optional	Search keyword (must be written in Simplified Chinese; maximum 50 characters) Example: 瑜伽垫
`goodsUrl`	`string`	optional	Product link URL (mutually exclusive with keyWord) Example: https://example.com/image.jpg
`productIds`	`string`	optional	Product IDs, separated by the Chinese enumeration comma (、), max 20
`cycle`	`string`	optional	Statistical period: 7 (last 7 days) or 30 (last 30 days)
`searchType`	`integer`

Code example

{
  "pageIndex": 1,
  "searchType": 1,
  "keyWord": "瑜伽垫",
  "pageSize": 20
}

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "data": {
    "total": 1,
    "columns": [],
    "products": [
      {
        "offerId": "example-id",
        "asin": "B072MQ5BRX",
        "asinUrl": "https://detail.1688.com/offer/1040473674152.html",
        "imageUrl": "https://example.com/image.jpg",
        "price": 1,
        "consignPrice": 1,
        "quantityBegin": 1,
        "salesOrderCount": 1,
        "salesQuantity": 1,
        "estimatedSalesAmount": 1,
        "availableDate": "2026-01-01",
        "shopId": "example-id",
        "shopUrl": "https://example.com/image.jpg"
      }
    ]
  },
  "code": 0,
  "msg": null,
  "ts": "0",
  "time": "2026-01-01 00:00:00",
  "cost": "-1",
  "traceId": null
}

Response fields

Name	Type	Required	Description
`data`	`any`	required	Data value used by this API operation.
`code`	`integer`	required	0 means accepted or successful; nonzero is a platform error.
`msg`	`string \| null`	required	Msg value used by this API operation.
`ts`	`string`	required	Epoch milliseconds.
`time`	`string`	required	Server local time: yyyy-MM-dd HH:mm:ss.
`cost`

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.

Name

Type

Required

Description

data

object

required

Data value used by this API operation.

data.total

integer

optional

Total record count

Example: 1

data.type

string

optional

Render style

Example: null

data.columns

array

optional

Render column definitions

Example: []

data.products

array

optional

Product list (see fields below)

Example: []

data.products[]

object

required

Item in data products.

data.products[].offerId

string

optional

Product ID

Example: example-id

data.products[].asin

string

optional

Product number

Example: B072MQ5BRX

data.products[].title

string

optional

Product title

Example: null

data.products[].asinUrl

string

optional

Product link URL

Example: https://detail.1688.com/offer/1040473674152.html

data.products[].imageUrl

string

optional

Product image URL

Example: https://example.com/image.jpg

data.products[].price

number

optional

Wholesale price

Example: 1

data.products[].consignPrice

number

optional

Dropship price

Example: 1

data.products[].quantityPrices

string

optional

Price range

Example: null

data.products[].quantityBegin

integer

optional

Minimum order quantity

Example: 1

data.products[].unit

string

optional

Unit

Example: null

data.products[].currency

string

optional

Currency

Example: null

data.products[].salesOrderCount

integer

optional

Order count (by statistical period)

Example: 1

data.products[].salesQuantity

integer

optional

Units sold (by statistical period)

Example: 1

data.products[].estimatedSalesAmount

integer

optional

Estimated sales amount (by statistical period)

Example: 1

data.products[].deliveryTime

string

optional

Delivery time

Example: null

data.products[].availableDate

string

optional

Product listing time

Example: 2026-01-01

data.products[].levelName

string

optional

Category hierarchy name

Example: null

data.products[].company

string

optional

Store name

Example: null

data.products[].shopId

string

optional

Store ID

Example: example-id

data.products[].shopUrl

string

optional

Store link URL

Example: https://example.com/image.jpg

data.products[].dataType

string

optional

Data type: weeklyData (weekly data), monthlyData (monthly data)

Example: null

data.products[].sourceType

string

optional

Source platform (1688)

Example: null

data.products[].sourceTool

string

optional

Source tool

Example: null

data.title

string

optional

Provider-specific response title.

Example: null

data.sourceType

string

optional

Provider-specific source platform type.

Example: null

data.sourceTool

string

optional

Provider-specific source tool name.

Example: null

data.costToken

integer

optional

Token cost reported by the upstream provider.

Example: null

data.costTime

integer

optional

Execution time reported by the upstream provider.

Example: null

data.page

integer

optional

Current page returned by the upstream provider.

Example: null

data.pageSize

integer

optional

Page size returned by the upstream provider.

Example: null

data.pageItemCount

integer

optional

Item count on the current page returned by the upstream provider.

Example: null

data.totalPage

integer

optional

Total page count returned by the upstream provider.

Example: null

data.dataSnapshotMonth

string

optional

Data snapshot month returned by the upstream provider.

Example: null

Name

Type

Required

Description

data

null

required

Data value used by this API operation.

1688 Product Search

What this API does

1688 Product Search

What this API does

Authentication

Run an API

Example request

Check the response

HTTP status codes

Run this API

Endpoint

Request parameters

Code example

Response example

Response fields

Responses

Data source, freshness, and limitations

MCP

Call a tool

Legacy MCP v1

Online test

Try it

Related APIs

Any of option 1

Any of option 2