# /bookoff/products/reviews

`POST /api/bookoff/products/reviews`

Price: 5 credits

List the customer reviews BookOff Online (ブックオフ) publishes under one catalogue entry: the star rating, the review text, the date it was posted, where it came from, and whether the writer flagged it as containing spoilers.

## How to use it

Read the reviews under one BookOff Online entry, newest first. Pass product as the 10-digit product code or a full product URL, and count for how many to read. Reviews belong to the title, not to one side of it, so the used and the new page of the same code share them. Each review carries product_id, rating out of five, text, published_at, source (most are syndicated from the reading-diary service ブクログ) and has_spoiler; a review flagged as a spoiler still carries its full text. The star breakdown and the average rating live on the products endpoint. A title with no reviews returns an empty list.

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `product` (string, required) — BookOff product code (10 digits) or a full product URL (examples: "0020384450", "https://shopping.bookoff.co.jp/used/0020384450")
- `count` (integer, required) — Max number of reviews to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "BookoffReview")
- `product_id` (string, required)
- `rating` (integer, nullable)
- `text` (string, nullable)
- `published_at` (string, nullable)
- `source` (string, nullable)
- `has_spoiler` (boolean) (default: false)

## Errors

### 422 — Validation Error

Malformed product (a BookOff product code is 10 digits, e.g. '0020384450')

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

Product not found (well-formed code but nothing under that address on shopping.bookoff.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.