/1688/products/search

POST /api/1688/products/search

Price: 20 credits

Search 1688.com wholesale offers by keyword with price, tiered quantity pricing, order count, location and seller trade scores

How to use it

Finds Chinese domestic wholesale offers and the factories selling them. Query in Chinese: 1688 is a Chinese-language site. A keyword yields a few hundred offers at most, fewer on some keywords, so a large count can return less than asked. Prices are in CNY.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — Search keyword, in Chinese for best recall (examples: "手机壳"; minLength: 1)
• count integer required — Number of offers to return (examples: 60; min: 1; max: 300)
• sort string nullable — Order by sales volume or by price; omit for the site's relevance order (one of: "sales", "price_asc", "price_desc"; examples: "sales")
• price_min number nullable — Lowest offer price in CNY, applied to the source's filter price which can differ from the returned price so results below this value can still appear (examples: 20; min: 0)

Response

• @type string (default: "Ali1688Product")
• id string required
• url string required
• image string nullable
• images array (default: [])
• price number nullable
• price_label string nullable
• quantity_prices array (default: [])
  • @type string (default: "Ali1688ProductQuantityPrice")
  • quantity string required
  • price number nullable
• booked_count integer nullable
• sold_label string nullable
• repurchase_rate_percent number nullable
• province string nullable
• city string nullable
• service_tags array (default: [])
• promotion_tags array (default: [])
• service_labels array (default: [])
• tags array (default: [])
• is_ad boolean nullable
• seller object nullable
  • @type string (default: "Ali1688ProductSeller")
  • id string required
  • login_id string nullable
  • name string nullable
  • url string nullable
  • storefront_url string nullable
  • business_type string nullable
  • years_on_platform integer nullable
  • is_super_factory boolean nullable
  • has_factory_inspection boolean nullable
  • has_business_inspection boolean nullable
  • scores object nullable
    • @type string (default: "Ali1688ProductSellerScores")
    • composite number nullable
    • consultation number nullable
    • logistics number nullable
    • dispute number nullable
    • returns number nullable
    • goods number nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.