# /biccamera/products/search

`POST /api/biccamera/products/search`

Price: 20 credits

Search Bic Camera (ビックカメラ) products by keyword and/or category, narrowed by maker, price range, colour, release month, stock, discount, pre-order, second-hand availability, trade-in payout, free warranty, subscription, made-in-Japan and new-arrival flags, shelf-specific specification filters, with seven orderings. Returns product cards with id, name, maker, image, price, BicPoint reward, delivery and stock messages, rating, review count, second-hand offers and colour variations.

## How to use it

Search biccamera.com. Give a keyword, a category_id (path like '001/150/010' from the categories endpoint) or both; a category_id alone only lists products from the third level down, and a shallower path is a navigation hub that returns an empty list unless a keyword is given as well. Narrow with brand (maker labels exactly as the brand field of a product, e.g. 'Apple｜アップル'), price_min/price_max in JPY, colour families, release_month ('202608' or '202701_after'), trade_in_min/trade_in_max, the boolean flags and spec_filters (specification filters a shelf offers for its own kind of product, such as fridge capacity); order with sort. Each result carries id (usable with the products endpoint), url, name, brand, image, price, point, shipping_message, delivery_message, stock_message, rating, review_count, used_count and used_price_from, spec_labels, badges, coupon and color_variations (sibling items in other colours). Discontinued products are excluded unless include_discontinued is set. Promoted placements are not returned. All prices are in JPY and tax-included. The source serves at most 10000 items per query.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 1500; min: 20; max: 1500)
- `keyword` (string, nullable) — Free-text search query (examples: "iPhone", "冷蔵庫"; minLength: 1)
- `category_id` (string, nullable) — Category path to search inside, e.g. '001/150/010' (from the categories endpoint) (examples: "001/150/010")
- `count` (integer, required) — Max number of results to return (min: 1; max: 10000)
- `brand` (array, nullable) — Maker labels exactly as returned in the brand field of a product, e.g. 'Apple｜アップル' (examples: ["Apple｜アップル"])
- `price_min` (integer, nullable) — Minimum price in JPY (min: 0)
- `price_max` (integer, nullable) — Maximum price in JPY (min: 0)
- `color` (array, nullable) — Colour families to keep (one of: "black", "white", "gray", "silver", "blue", "green", "beige", "yellow", "gold", "orange", "brown", "red", "pink", "purple", "clear", "other")
- `release_month` (array, nullable) — Manufacturer release months as 'YYYYMM', or 'YYYYMM_after' for that month onwards (examples: ["202608","202701_after"])
- `trade_in_min` (integer, nullable) — Minimum trade-in payout in JPY (min: 0)
- `trade_in_max` (integer, nullable) — Maximum trade-in payout in JPY (min: 0)
- `in_stock_only` (boolean) — Keep only products currently in stock (default: false)
- `include_discontinued` (boolean) — Also return products that are no longer sold (default: false)
- `discounted_only` (boolean) — Keep only products whose price was lowered (default: false)
- `preorder_only` (boolean) — Keep only products open for pre-order (default: false)
- `has_used` (boolean) — Keep only products with second-hand offers (default: false)
- `has_trade_in` (boolean) — Keep only products accepted for trade-in (default: false)
- `free_warranty` (boolean) — Keep only products with a free extended warranty (default: false)
- `subscription` (boolean) — Keep only products available on subscription (default: false)
- `made_in_japan` (boolean) — Keep only products made in Japan (default: false)
- `new_arrivals` (boolean) — Keep only newly released products (default: false)
- `split_variations` (boolean) — List every colour and size variation separately instead of one entry per model (default: false)
- `sort` (string) — Result ordering (default: "popular"; one of: "popular", "newest", "price_asc", "price_desc", "release_date", "delivery_speed", "review_count", "rating")
- `spec_filters` (object, nullable) — Shelf-specific specification filters, keyed by the filter name the category publishes (e.g. 'spec_251011_151') with the values exactly as that shelf spells them ('060‘300L～399L（2～3人）'). Only a shelf that offers a filter accepts it (examples: {"spec_251011_151":["060‘300L～399L（2～3人）","070‘200L～299L（1～2人）"]})
  - `*` (array)

## Response

### 200 — Successful Response

- `@type` (string) (default: "BiccameraProductCard")
- `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)
- `delivery_message` (string, nullable)
- `stock_message` (string, nullable)
- `shipping_message` (string, nullable)
- `rating` (number, nullable)
- `review_count` (integer, nullable)
- `used_count` (integer, nullable)
- `used_price_from` (number, nullable)
- `spec_labels` (array) (default: [])
- `badges` (array) (default: [])
- `coupon` (string, nullable)
- `color_variations` (array) (default: [])
  - `@type` (string) (default: "BiccameraColorVariation")
  - `id` (string, required)
  - `url` (string, required)
  - `name` (string, nullable)
  - `color` (string, nullable)
  - `is_current` (boolean) (default: false)

## Errors

### 422 — Validation Error

Neither keyword nor category_id was given, or a malformed category_id, release_month or spec_filters key

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: 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

What to do: 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

What to do: 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

What to do: 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

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these 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.