/yodobashi/products/stock

POST /api/yodobashi/products/stock

Price: 5 credits

Physical store availability of a Yodobashi Camera (ヨドバシカメラ) product: per-store stock flag and message, in-store price and Gold Point reward, pickup readiness, address, postal code, coordinates, prefecture, shopping area, phone number and the next seven days of opening hours.

How to use it

Where a yodobashi.com product is physically available. Pass the 18-digit SKU (or product URL); narrow with prefecture, sub_area (shopping areas of Tokyo and Kanagawa), chain, in_stock_only or on_display_only. Each store has id, name, url, price (JPY), point, is_in_stock, stock_message, is_on_display, pickup_message, is_pickup_all_day, address, postal_code, prefecture+prefecture_id, sub_area+sub_area_id, lat, lng and brands (retail chains at that address, each with phone, its own address and coordinates when it sits apart from the host store, after-hours pickup note and a seven-day business_hours schedule). Online-only products return 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 — Yodobashi product SKU (18 digits) or a full product URL (examples: "100000001002968430"; minLength: 1)
• count integer required — Max number of stores to return (min: 1)
• prefecture string nullable — Keep only stores in this prefecture (one of: "hokkaido", "aomori", "iwate", "miyagi", "akita", "yamagata", "fukushima", "ibaraki", "tochigi", "gunma", "saitama", "chiba", "tokyo", "kanagawa", "niigata", "toyama", "ishikawa", "fukui", "yamanashi", "nagano", "gifu", "shizuoka", "aichi", "mie", "shiga", "kyoto", "osaka", "hyogo", "nara", "wakayama", "tottori", "shimane", "okayama", "hiroshima", "yamaguchi", "tokushima", "kagawa", "ehime", "kochi", "fukuoka", "saga", "nagasaki", "kumamoto", "oita", "miyazaki", "kagoshima", "okinawa")
• sub_area string nullable — Keep only stores in this shopping area of Tokyo or Kanagawa (one of: "shinjuku", "tokyo_ginza_kanda", "akihabara_ueno_kinshicho", "kichijoji", "tachikawa_machida_hachioji", "ikebukuro", "kawasaki", "yokohama", "kamiooka")
• chain string nullable — Keep only stores of this retail chain (one of: "yodobashi_camera", "ishii_sports", "art_sports", "yodobloom")
• in_stock_only boolean — Keep only stores that hold the item in stock (default: false)
• on_display_only boolean — Keep only stores where the item is on display (default: false)

Response

• @type string (default: "YodobashiStoreStock")
• id string required
• name string nullable
• url string nullable
• price number nullable
• currency string (default: "JPY")
• point integer nullable
• is_in_stock boolean (default: false)
• stock_message string nullable
• is_on_display boolean (default: false)
• pickup_message string nullable
• is_pickup_all_day boolean (default: false)
• address string nullable
• postal_code string nullable
• prefecture string nullable
• prefecture_id string nullable
• sub_area string nullable
• sub_area_id string nullable
• lat number nullable
• lng number nullable
• brands array (default: [])
  • @type string (default: "YodobashiStoreBrand")
  • id string required
  • name string nullable
  • chain string nullable
  • phone string nullable
  • store_type string nullable
  • address string nullable
  • postal_code string nullable
  • lat number nullable
  • lng number nullable
  • after_hours_pickup_message string nullable
  • business_hours_note string nullable
  • business_hours array (default: [])
    • @type string (default: "YodobashiStoreBusinessHours")
    • date string required
    • is_open boolean (default: false)
    • open_time string nullable
    • close_time string nullable

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.