/joshin/products/search

POST /api/joshin/products/search

Price: 20 credits

Search Joshin (上新電機) products by keyword and narrow the result by genre, manufacturer, model code, price range, release date range, colour, sale state and the Japanese OTC medicine attributes. Returns product cards with JAN code, URL, name, manufacturer, model code, image, tax-included price, Joshin point reward, stock and shipping state, release date and short description.

How to use it

Search joshin (joshinweb.jp) products. keyword is required and is matched against the Japanese product text, so Japanese terms work best; a JAN code is not a searchable keyword. Narrow with genre, maker (exact manufacturer name from the makers endpoint), model_code, price_min/price_max in JPY, release_date_from/release_date_to, color, the sale-state flags (in_stock, on_sale, is_new, is_reserve, is_limited, has_coupon, has_guarantee, ships_24h), the medicine attributes (medicine_audience, medicine_class, dosage_form, is_quasi_drug) and sort. in_stock and ships_24h select almost the same products, agreeing exactly on seven of eight keywords measured, so setting both narrows very little. Each result carries id (13-digit JAN), url, genre, category_id, name, maker, model_code, image, price, point/point_rate, stock_message, is_in_stock, delivery_message, release_date, description, review_group and is_sponsored, which marks a paid placement inside the result. Feed id together with review_group into the reviews endpoints.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Free-text search query (examples: "ガンプラ", "冷蔵庫"; minLength: 1)
• count integer required — Max number of products to return (min: 1)
• genre string nullable — Keep only products of this top-level genre (one of: "kaden", "season", "house", "kitchen", "health", "interior", "av", "sound", "audio", "pc", "peripheral", "supply", "mobile", "camera", "car", "diy", "outdoor", "apparel", "watch", "game", "toy", "hobby", "train", "cg", "liquor", "drug")
• maker string nullable — Keep only products of this manufacturer (examples: "バンダイスピリッツ"; minLength: 1)
• model_code string nullable — Keep only products whose model code contains this text (examples: "RG"; minLength: 1)
• price_min integer nullable — Lowest tax-included price in JPY (min: 0)
• price_max integer nullable — Highest tax-included price in JPY (min: 0)
• release_date_from string nullable — Earliest release date, YYYY-MM-DD (examples: "2024-01-01"; pattern: ^\d{4}-\d{2}-\d{2}$)
• release_date_to string nullable — Latest release date, YYYY-MM-DD (examples: "2025-12-31"; pattern: ^\d{4}-\d{2}-\d{2}$)
• color string nullable — Keep only products of this colour family (one of: "black", "white", "grey", "red", "pink", "purple", "blue", "green", "yellow_orange", "brown", "beige", "silver", "gold", "clear", "other")
• in_stock boolean — Keep only products held in stock, a set that almost coincides with ships_24h (default: false)
• on_sale boolean — Keep only products currently on sale (default: false)
• is_new boolean — Keep only products marked as new releases (default: false)
• is_reserve boolean — Keep only products open for pre-order (default: false)
• is_limited boolean — Keep only products at a time-limited price (default: false)
• has_coupon boolean — Keep only products a web coupon applies to (default: false)
• has_guarantee boolean — Keep only products eligible for the extended warranty (default: false)
• ships_24h boolean — Keep only products shipped within 24 hours, a set that almost coincides with in_stock (default: false)
• medicine_audience string nullable — Keep only medicines intended for this audience (one of: "both", "adult", "child")
• medicine_class string nullable — Keep only medicines of this Japanese OTC risk class (one of: "designated_class_2", "class_2", "class_3")
• dosage_form string nullable — Keep only medicines supplied in this dosage form (one of: "powder", "granules", "fine_granules", "tablet", "pill", "capsule", "troche", "lozenge", "jelly_drop", "oral_liquid", "topical_liquid", "ointment", "plaster", "poultice", "adhesive_plaster", "suppository", "infusion", "decoction", "chewing_gum", "other_oral", "other_topical", "other")
• is_quasi_drug boolean — Keep only items registered as quasi-drugs (default: false)
• sort string — Result ordering (default: "relevance"; one of: "relevance", "release_date_desc", "release_date_asc", "price_asc", "price_desc", "model_code", "most_reviewed", "best_rated")

Response

• @type string (default: "JoshinProductCard")
• id string required
• url string required
• genre string required
• category_id string required
• name string nullable
• maker string nullable
• model_code string nullable
• image string nullable
• price number nullable
• currency string (default: "JPY")
• point integer nullable
• point_rate number nullable
• stock_message string nullable
• is_in_stock boolean nullable
• delivery_message string nullable
• release_date string nullable
• description string nullable
• review_group string nullable
• is_sponsored boolean (default: false)

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.