/dhgate/products/search

POST /api/dhgate/products/search

Price: 20 credits

Search DHgate products by keyword. Returns product cards with id, title, image, price (with the original price and per-piece measure), minimum order, free-shipping flag, units sold, rating, seller feedback percentage, ad flag and the seller store (id, alias, url). Supports sorting, category, price range, minimum order, sample/wholesale order type, seller rating, brand, the keyword's own attribute facets, free-shipping, US-warehouse, customizable and fast-delivery switches, plus ship-to country and currency.

How to use it

Search the DHgate wholesale catalog by keyword. Each item has id, product_id, product_url, product_title, image, price and price_text, original_price_text, measure, min_order and min_order_quantity, is_free_shipping, units_sold, rating, review_count, seller_feedback_percent, discount, is_ad and the store (store_id, store_alias, store_url). Use filters like ['Material:Leather','Color:Black'] to narrow by the facets the keyword offers, and brand to filter by brand name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• currency string — Currency the prices are returned in (default: "USD"; one of: "USD", "EUR", "GBP", "CAD", "AUD", "JPY", "RUB", "BRL", "INR", "MXN", "KRW", "TRY", "SEK", "NOK", "DKK", "PLN", "CHF", "NZD", "SGD", "HKD", "THB", "ILS", "AED", "SAR", "ZAR", "CZK")
• ship_to_country string — Ship-to country — drives shipping cost and delivery estimates (default: "US"; one of: "US", "GB", "CA", "AU", "DE", "FR", "IT", "ES", "NL", "BE", "SE", "NO", "DK", "FI", "IE", "PT", "PL", "CH", "AT", "CZ", "GR", "RU", "BR", "MX", "CL", "AR", "JP", "KR", "CN", "HK", "TW", "SG", "MY", "TH", "ID", "PH", "VN", "IN", "AE", "SA", "IL", "TR", "ZA", "NZ")
• keyword string required — Search keyword (examples: "phone case", "led light"; minLength: 1)
• count integer required — Max number of products to return (min: 1)
• sort string — Result ordering (default: "best_match"; one of: "best_match", "orders", "newest", "price_low_to_high", "price_high_to_low")
• category string nullable — Category id to narrow the search
• min_price number nullable — Minimum price in the requested currency (min: 0)
• max_price number nullable — Maximum price in the requested currency (min: 0)
• min_order integer nullable — Only items whose minimum order is at most this (min: 1)
• order_type string — Sample keeps items buyable from 1 piece; wholesale keeps bulk-only items (default: "all"; one of: "all", "sample", "wholesale")
• seller_rating number nullable — Only items from sellers rated at least this (1-5) (min: 1; max: 5)
• free_shipping boolean — Keep only items with free shipping (default: false)
• us_local_warehouse boolean — Keep only items shipped from a US local warehouse (default: false)
• customizable boolean — Keep only customizable items (default: false)
• fast_delivery boolean — Keep only fast-delivery items (default: false)
• brand string nullable — Brand name to filter by, matched case-insensitively
• filters array — Refine the result set with the attribute facets the keyword itself offers, as `Group:Value` pairs (`Compatible:for iPhone 17`, `Material:Leather`, `Type:Wallet Case`). Facet names and values differ per keyword and are matched case-insensitively; a pair that is not offered is rejected with the list of accepted ones (default: []; examples: ["Material:Leather"], ["Compatible:for iPhone 17","Color:Black"])

Response

• @type string (default: "DhgateSearchProduct")
• id string required
• product_id string nullable
• product_url string nullable
• product_title string nullable
• image string nullable
• price number nullable
• price_text string nullable
• original_price_text string nullable
• measure string nullable
• min_order string nullable
• min_order_quantity integer nullable
• is_free_shipping boolean (default: false)
• units_sold integer nullable
• rating number nullable
• review_count integer nullable
• seller_feedback_percent number nullable
• discount number nullable
• is_ad boolean (default: false)
• store_id string nullable
• store_alias string nullable
• store_url string nullable

Errors

• 422 — Unknown brand or attribute filter for this keyword 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.