/dhgate/stores/products

POST /api/dhgate/stores/products

Price: 20 credits

List the products of a DHgate store (seller) by store id or store URL. Returns the same product cards as product search (id, title, image, price, minimum order, units sold, rating, seller feedback and store), and supports an in-store keyword search and sorting.

How to use it

List a DHgate store's products. Each item has the same shape as dhgate/products/search cards (id, product_title, image, price, min_order, units_sold, rating, seller_feedback_percent, store_id/alias/url). Pass keyword to search within the store.

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")
• store string required — Store id or store URL (examples: "22224092"; minLength: 1)
• count integer required — Max number of products to return (min: 1)
• keyword string nullable — Search only within this store's products
• sort string — Result ordering (default: "best_match"; one of: "best_match", "orders", "newest", "price_low_to_high", "price_high_to_low")

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 — 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.