# /pckoubou/products/search

`POST /api/pckoubou/products/search`

Price: 20 credits

Search PC Koubou (パソコン工房) products by keyword and/or category across new and second-hand stock, narrowed by maker, holding branch, merchandising labels, campaign tags, the category-specific specification filters, a price range and the sale-start period, with six orderings. Returns product cards with the product id, name, maker with the maker's own product page, model number, JAN code, tax-included and tax-excluded price, reward-point rate, category trail, photos, the specification table, stock flag, holding branch, labels and the average customer rating.

## How to use it

Search pc-koubou.jp, the Japanese PC shop that sells built-to-order machines, DIY parts, peripherals and second-hand gear. Give a keyword (Japanese works), a category such as '自作PCパーツ:グラフィックカード' from the categories endpoint, or both; with neither you get the whole catalogue. Narrow with item_type (all/new/used), maker, store, labels, campaign_tags and specs tokens taken from the facets endpoint, price_min/price_max in JPY and release_period; order with sort. maker, store, labels and campaign_tags each take one value, spelled exactly as the facets endpoint publishes it, because the shop matches the whole value as one string: a product carries one maker, one branch and one label combination, so '値下げ商品' matches only products labelled with nothing else, while the combined 'NEW:値下げ商品' is a separate facet value. Several specs tokens combine, but only when they name different specifications. Every result carries id (usable with the products and products/reviews endpoints), url, name, summary, description, maker, maker_id and maker_url (the manufacturer's own page for the product, which about two thirds of the products have), model_number, jan, price with price_without_tax, and original_price with is_discounted while a campaign runs, point_rate, keywords, promotion_notes, department, category, category_path and category_paths, image and images (the catalogue photo), specs, is_used, in_stock, store (the branch holding a second-hand item), labels, campaign_tags, shipping_labels, rating, purchase_limit (how many one customer may buy), listed_at (when the shop listed the product, the order 'newest' sorts by) and updated_at, both unix seconds. Prices are in JPY; price is tax-included.

## 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 query matched on product name, model number and specification text (minLength: 1)
- `category` (string, nullable) — Category to search inside, colon-joined as the categories endpoint returns it (examples: "自作PCパーツ", "自作PCパーツ:グラフィックカード")
- `count` (integer, required) — Max number of results to return (min: 1)
- `item_type` (string) — Keep only brand-new or only second-hand stock (default: "all"; one of: "all", "new", "used")
- `maker` (string, nullable) — Maker name exactly as the facets endpoint returns it (examples: "ASUS")
- `store` (string, nullable) — Branch holding the item, exactly as the facets endpoint returns it (examples: "パソコン工房 秋葉原本店")
- `labels` (string, nullable) — Merchandising label combination exactly as the facets endpoint returns it (examples: "値下げ商品")
- `campaign_tags` (string, nullable) — Campaign tag combination exactly as the facets endpoint returns it (examples: "超還元 対象")
- `release_period` (string, nullable) — Keep only products whose sale-start date falls in this period (one of: "today", "this_week", "this_month", "this_year", "upcoming", "since_2000", "before_2000")
- `specs` (array, nullable) — Specification filters, each one the ready-made token the facets endpoint publishes as the filter field of a facet value (examples: ["s28:グラフィックス##GeForce RTX 5070"])
- `price_min` (integer, nullable) — Minimum tax-included price in JPY (min: 0)
- `price_max` (integer, nullable) — Maximum tax-included price in JPY (min: 0)
- `sort` (string) — Result ordering (default: "recommended"; one of: "recommended", "bestseller", "most_viewed", "newest", "price_asc", "price_desc")

## Response

### 200 — Successful Response

- `@type` (string) (default: "PckoubouProductCard")
- `id` (string, required)
- `url` (string, required)
- `name` (string, nullable)
- `summary` (string, nullable)
- `description` (string, nullable)
- `maker` (string, nullable)
- `maker_id` (string, nullable)
- `maker_url` (string, nullable)
- `model_number` (string, nullable)
- `jan` (string, nullable)
- `price` (number, nullable)
- `price_without_tax` (number, nullable)
- `original_price` (number, nullable)
- `currency` (string) (default: "JPY")
- `is_discounted` (boolean) (default: false)
- `point_rate` (number, nullable)
- `keywords` (array) (default: [])
- `promotion_notes` (array) (default: [])
- `department` (string, nullable)
- `category` (string, nullable)
- `category_path` (string, nullable)
- `category_paths` (array) (default: [])
- `image` (string, nullable)
- `images` (array) (default: [])
- `specs` (object) (default: {})
  - `*` (string)
- `is_used` (boolean) (default: false)
- `in_stock` (boolean) (default: false)
- `store` (string, nullable)
- `labels` (array) (default: [])
- `campaign_tags` (array) (default: [])
- `shipping_labels` (array) (default: [])
- `rating` (number, nullable)
- `purchase_limit` (integer, nullable)
- `listed_at` (integer, nullable)
- `updated_at` (integer, nullable)

## Errors

### 422 — Validation Error

A specs entry was not a facet filter token

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.