/jalan/hotels/plans

POST /api/jalan/hotels/plans

Price: 10 credits

List Jalan (じゃらん) accommodation plans and their bookable room offers for a hotel/ryokan by id (or hotel URL): plan name, meal type, check-in/out times, reservation period and per-room offers (room type, room category, price per adult, total price, sale/discount, loyalty points and remaining rooms). Optionally scoped to a stay date and party size.

How to use it

List the accommodation plans of a single Jalan (じゃらん) hotel or ryokan by its numeric id (e.g. '340595' or 'yad340595') or a full hotel URL. Pass checkin (and optionally checkout) plus adults to price plans for a specific stay; omit dates for date-undecided lowest 'from' prices. Each plan returns name, description, meal, checkin_time/checkout_time, reservation_period, image, labels and a rooms list — each room with room_type, room_category, price (per adult), original_price, total_price, discount, points and remaining_count.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• hotel string required — Jalan hotel/ryokan id (numeric, e.g. 340595) or a full hotel URL (examples: "340595", "yad340595", "https://www.jalan.net/yad340595/"; minLength: 1)
• checkin string nullable — Check-in date (YYYY-MM-DD); omit for date-undecided lowest prices (format: date)
• checkout string nullable — Check-out date (YYYY-MM-DD); defaults to one night after check-in (format: date)
• adults integer — Number of adults (default: 2; min: 1; max: 20)
• count integer required — Max number of plans to return (min: 1)

Response

• @type string (default: "JalanPlan")
• plan_code string required
• name string nullable
• description string nullable
• meal string nullable
• checkin_time string nullable
• checkout_time string nullable
• reservation_period string nullable
• image string nullable
• labels array (default: [])
• rooms array (default: [])
  • @type string (default: "JalanPlanRoom")
  • room_type string nullable
  • room_type_cd string nullable
  • room_category string nullable
  • labels array (default: [])
  • image string nullable
  • price integer nullable
  • original_price integer nullable
  • total_price integer nullable
  • discount string nullable
  • points integer nullable
  • remaining_count integer 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 — Hotel not found (well-formed id but the hotel does not exist on Jalan) 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.