# /bookoff/products

`POST /api/bookoff/products`

Price: 5 credits

Get one BookOff Online (ブックオフ) catalogue entry by its product code or product URL: title, author or artist, publisher, JAN or ISBN barcode, format and language, the second-hand or the brand-new price with the saving against the retail price, reward points, stock and delivery note, star rating and review count, the publisher's blurb, release date, the full genre breadcrumb chain, the related-word tags, cover images, which of the two conditions the shop carries, and how many branches have a copy on the shelf.

## How to use it

Fetch one BookOff Online catalogue entry by its 10-digit product code (e.g. '0020384450') or a full shopping.bookoff.co.jp/used/... or /new/... URL. The same code addresses both sides of a title: pass condition 'used' or 'new' to choose which, or give a URL and the side is taken from it; used is the default. Returns id, url, condition, name, image and images, author and authors, publisher, barcode, media_format, language, price, list_price with discount_amount and discount_percent, reward_points, availability and is_in_stock, which both come from the shop's structured stock statement and therefore agree, so a title the shop marks as down to its last copies still reports as in stock, shipping_note, rating and review_count with reviews_url, description, release_date, category and subcategory, genre_code, categories (the whole breadcrumb chain, each id usable as category_id on the search endpoint), tags (twenty related words the shop draws at random from a much larger pool on every request, so the list differs call to call; each one is usable as the tag filter on search), condition_variants listing the sides the shop publishes for this title, bundle_url when the title is also sold as a set, and store_count, the number of branches that have a copy on the shelf. Barcodes do not address a product directly: feed a JAN or ISBN to the search endpoint as keyword instead, which returns exactly the matching entry. The catalogue keeps entries that are out of stock, so a record exists long after the last copy is sold. Prices are tax-included JPY.

## 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")
- `condition` (string, nullable) — Which side of the listing to read; taken from the URL when one is given (one of: "used", "new")

## Response

### 200 — Successful Response

- `@type` (string) (default: "BookoffProduct")
- `id` (string, required)
- `url` (string, required)
- `condition` (string, required)
- `name` (string, nullable)
- `image` (string, nullable)
- `images` (array) (default: [])
- `author` (string, nullable)
- `authors` (array) (default: [])
- `publisher` (string, nullable)
- `barcode` (string, nullable)
- `media_format` (string, nullable)
- `language` (string, nullable)
- `price` (number, nullable)
- `currency` (string) (default: "JPY")
- `list_price` (number, nullable)
- `discount_amount` (number, nullable)
- `discount_percent` (integer, nullable)
- `reward_points` (integer, nullable)
- `availability` (string, nullable)
- `is_in_stock` (boolean) (default: false)
- `shipping_note` (string, nullable)
- `rating` (number, nullable)
- `review_count` (integer, nullable)
- `reviews_url` (string, nullable)
- `description` (string, nullable)
- `details` (object) (default: {})
  - `*` (string)
- `release_date` (string, nullable)
- `category` (string, nullable)
- `subcategory` (string, nullable)
- `genre_code` (string, nullable)
- `categories` (array) (default: [])
  - `@type` (string) (default: "BookoffCategoryRef")
  - `id` (string, required)
  - `name` (string, required)
- `tags` (array) (default: [])
- `condition_variants` (array) (default: [])
- `bundle_url` (string, nullable)
- `store_count` (integer, nullable)
- `stores_available` (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.