/yodobashi/products/search

POST /api/yodobashi/products/search

Price: 20 credits

Search Yodobashi Camera (ヨドバシカメラ) products by keyword, category, maker, price range, release date range and spec facets. Returns product cards with SKU, name, brand, image, price, Gold Point reward, stock and delivery status, rating, review count and the number of stores holding the item.

How to use it

Search yodobashi.com products. Provide at least one of keyword, category (path like '19531/19533' from the categories endpoint) or maker (10-digit id from the makers endpoint); narrow further with price_min/price_max (JPY), release date range, spec_codes, include_discontinued and sort. Each result has id (18-digit SKU usable with the products endpoint), url, name, brand, image, price, point/point_rate (Gold Point reward), stock_message, delivery_message, maker+maker_id, category+category_id, release_date, rating, review_count and store_stock_count. Sponsored placements are excluded. The source caps a single query at 4320 items.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free-text search query (examples: "iPhone", "冷蔵庫")
• category string nullable — Category path to search inside, e.g. '19531/19533' (from the categories endpoint) (examples: "19531/19533")
• maker string nullable — Maker id (10 digits) from the makers endpoint (examples: "0000001826")
• count integer required — Max number of results to return (min: 1; max: 4320)
• price_min integer nullable — Minimum price in JPY (min: 0)
• price_max integer nullable — Maximum price in JPY (min: 0)
• release_year_from integer nullable — Earliest release year (min: 1900; max: 2100)
• release_month_from integer nullable — Earliest release month (min: 1; max: 12)
• release_year_to integer nullable — Latest release year (min: 1900; max: 2100)
• release_month_to integer nullable — Latest release month (min: 1; max: 12)
• spec_codes array nullable — Spec facet codes of the selected category, as returned in category listing facets (examples: ["Specvaluecode_500000000314001001_0001_0000000044_0000001349"])
• include_discontinued boolean — Include products that are no longer sold (default: false)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "newest_listed", "price_asc", "price_desc", "release_date_desc")

Response

• @type string (default: "YodobashiProductCard")
• id string required
• url string required
• name string nullable
• brand string nullable
• image string nullable
• price number nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• stock_message string nullable
• delivery_message string nullable
• maker string nullable
• maker_id string nullable
• category string nullable
• category_id string nullable
• release_date string nullable
• rating number nullable
• review_count integer nullable
• store_stock_count integer nullable

Errors

• 422 — No search scope given (keyword, category or maker), or a malformed category/maker id 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.