/bookoff/products/stores

POST /api/bookoff/products/stores

Price: 5 credits

List the physical BookOff branches that have taken in a copy of one catalogue entry: the branch name, its page on the BookOff corporate site, its address, prefecture and municipality.

How to use it

List the BookOff branches holding a copy of one entry on the shelf. Pass product as the 10-digit product code or a full product URL, and count for how many branches to return; narrow with prefecture and city, both spelled in Japanese exactly as a branch reports them. The reported total counts every branch holding the entry, before any prefecture and city narrowing. Each branch carries id, name, url on the corporate site, address, prefecture and city. Coverage is uneven by product kind: games, discs and other packaged media are tracked branch by branch and commonly sit in hundreds of them, while books normally report none at all, and the brand-new side of a title carries no branch stock at all, so ask for the second-hand side. The shop states the reading is not live, so a listed branch may already have sold its copy, and branch prices differ from the online ones.

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: "0018958301", "https://shopping.bookoff.co.jp/used/0018958301")
• count integer required — Max number of branches to return (min: 1)
• condition string nullable — Which side of the listing to read; taken from the URL when one is given (one of: "used", "new")
• prefecture string nullable — Keep only branches in this prefecture (examples: "東京都"; minLength: 1)
• city string nullable — Keep only branches in this municipality (examples: "八戸市"; minLength: 1)

Response

• @type string (default: "BookoffStore")
• id string required
• name string required
• url string nullable
• address string nullable
• prefecture string nullable
• city string nullable

Errors

• 422 — Malformed product (a BookOff product code is 10 digits, e.g. '0018958301') Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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) 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 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 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 Wait at least 30 seconds, then retry.

Response 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.