/lohaco/products/search

POST /api/lohaco/products/search

Price: 5 credits

Search the LOHACO (ロハコ) catalog by keyword, category, brand, price range, promotion tags and category-specific specification filters. Returns product cards with price, unit price, stock, brand, rating, review count, shipment type and PayPay point rate.

How to use it

Search LOHACO (ロハコ, Japanese consumer e-commerce run by ASKUL: groceries, drinks, cosmetics, household goods, stationery). Every filter is optional except `count`, but at least one of `keyword`, `category`, `brand_id`, `specs` or `tags` must narrow the catalog. Prices are JPY including tax. `specs`, `tags` and `brand_id` values are category-dependent — read them from lohaco/categories for the same category. `is_promoted` marks sponsored placements mixed into the listing. Drop-shipped items sit under a different `store_id`; pass `store_id/id` to lohaco/products to fetch them in one round trip.

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 keyword (examples: "ミネラルウォーター", "洗剤")
• count integer required — Max number of results to return (min: 1; max: 2970)
• category string nullable — Category id to search within, as returned by lohaco/categories (examples: "51007")
• brand_id string nullable — Brand id, as listed in the `brands` of lohaco/categories (examples: "14829")
• specs array nullable — Category-specific specification filters, given as option ids from the `specs` of lohaco/categories. Several ids are combined with AND (examples: ["E360348"])
• tags array nullable — Programme tags: the ids listed in the `tags` of lohaco/categories plus `outOfStock` (include sold-out items), `subsc` (subscription items) and `edlp` (permanently low price). Several tags are combined with AND (examples: ["pb"], ["outlet"], ["fromsup"])
• price_min integer nullable — Minimum price in JPY, including tax (min: 0)
• price_max integer nullable — Maximum price in JPY, including tax (min: 0)
• sort string — Result ordering (default: "recommended"; one of: "recommended", "price_asc", "price_desc", "newest", "review_count_desc", "rating_desc", "discount_desc")

Response

• @type string (default: "LohacoSearchItem")
• id string required
• url string required
• name string required
• image string nullable
• price number nullable
• unit_price number nullable
• currency string (default: "JPY")
• in_stock boolean nullable
• brand string nullable
• brand_id string nullable
• rating number nullable
• review_count integer nullable
• is_promoted boolean nullable
• is_on_sale boolean nullable
• is_best_price boolean nullable
• is_set_discount boolean nullable
• is_subscription_available boolean nullable
• shipment string nullable
• store_id string nullable
• free_shipping_threshold number nullable
• point_percent number nullable
• options object (default: {})
  • * string

Errors

• 422 — The supplied filter ids are not accepted by LOHACO for this query 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.