/joshin/stores/search

POST /api/joshin/stores/search

Price: 20 credits

List Joshin (上新電機) shops, optionally narrowed to a prefecture, a city or a name and address match. Each shop carries its store code, name, address, phone, coordinates, opening state and its weekly opening hours.

How to use it

List joshin shops. Narrow with prefecture (the Japanese prefecture name, e.g. '大阪府'), city (the Japanese city, ward or town name), keyword (matched against the shop name and address) and open_only. Shops come back ordered by store code, each with id (the store code the stores endpoint takes), url, name, name_kana, prefecture, city, address, postal_code, phone, latitude, longitude, business_status, opening_date, notes, business_hours and special_hours.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of shops to return (min: 1)
• prefecture string nullable — Keep only shops in this prefecture (examples: "大阪府", "岐阜県"; minLength: 1)
• city string nullable — Keep only shops in this city, ward or town (examples: "本巣市"; minLength: 1)
• keyword string nullable — Keep only shops whose name or address contains this text (minLength: 1)
• open_only boolean — Keep only shops that are currently trading (default: false)

Response

• @type string (default: "JoshinStore")
• id string required
• url string required
• name string required
• name_kana string nullable
• prefecture string nullable
• city string nullable
• address string nullable
• postal_code string nullable
• phone string nullable
• latitude number nullable
• longitude number nullable
• business_status string nullable
• opening_date string nullable
• notes array (default: [])
• business_hours array (default: [])
  • @type string (default: "JoshinStoreHours")
  • day string required
  • open_time string nullable
  • close_time string nullable
• special_hours array (default: [])
  • @type string (default: "JoshinStoreSpecialHours")
  • start_date string required
  • end_date string nullable
  • open_time string nullable
  • close_time string nullable
  • is_closed boolean (default: false)

Errors

• 422 — The request body did not validate 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 — The entity was not found, or a precondition failed 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.