# /tsukumo/products/facets

`POST /api/tsukumo/products/facets`

Price: 10 credits

Get the full filter catalogue TSUKUMO (ツクモ) offers for a category or a free-text query: every maker, availability label, price band, merchandising label and category-specific specification value, each with the number of products behind it and the exact code to pass back to the search endpoint.

## How to use it

Given a category (e.g. '20:2005' from the categories endpoint), a keyword, both or neither, return every filter shop.tsukumo.co.jp supports for that scope. Each facet carries the key it occupies, a Japanese name, the payload_field of the search endpoint it feeds, and its values with value (the code to send), name and product_count. Maker codes go into the maker field of the search endpoint, availability labels into stock, specification values into specs, merchandising labels into tags, and the price bands are a shortcut for price_min/price_max. The specification facets differ from one category to another, so read them per category rather than assuming a fixed set.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `category` (string, nullable) — Category whose filter catalogue to return (examples: "20:2005")
- `keyword` (string, nullable) — Return the filters available for this free-text query instead (minLength: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "TsukumoProductFacets")
- `category` (string, nullable)
- `keyword` (string, nullable)
- `product_count` (integer, nullable)
- `facets` (array) (default: [])
  - `@type` (string) (default: "TsukumoFacet")
  - `key` (string, required)
  - `name` (string, nullable)
  - `payload_field` (string, nullable)
  - `values` (array) (default: [])
    - `@type` (string) (default: "TsukumoFacetValue")
    - `value` (string, required)
    - `name` (string, nullable)
    - `product_count` (integer, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

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 requested category or keyword matches no products on shop.tsukumo.co.jp

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.