/pchome/products/search

POST /api/pchome/products/search

Price: 5 credits

Search PChome 24h products by keyword, with sort, price range, brand, category and delivery filters: product cards with price, list price, rating, review count, images and category ids

How to use it

Prices are in TWD. Brand ids come from brand_id on pchome/products; category ids from pchome/categories.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of products to return (min: 1; max: 10000)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "best_selling", "newest", "price_asc", "price_desc")
• price_min integer nullable — Minimum price in TWD (min: 0)
• price_max integer nullable — Maximum price in TWD (min: 0)
• brand_ids array nullable — Brand ids to keep, as returned in brand_id by pchome/products (examples: ["1_7164"])
• delivery array nullable — Delivery options every product must offer (one of: "fast_delivery", "convenience_store_pickup", "super_fast_pickup", "i_post_pickup", "quick_install")
• keyword string required — Search keyword (examples: "耳機"; minLength: 1)
• category_id string nullable — PChome category id or category URL (examples: "DYAQ")

Response

• @type string (default: "PchomeListedProduct")
• id string required
• name string nullable
• url string nullable
• summary string nullable
• price number nullable
• list_price number nullable
• image string nullable
• thumbnail string nullable
• rating number nullable
• review_count integer nullable
• category_ids array (default: [])
• coupon_ids array (default: [])
• author string nullable
• publisher string nullable
• published_date integer nullable
• is_book boolean nullable
• is_adult boolean 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 — PChome rejected the filter combination 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.