/ikyu/hotels/plans

POST /api/ikyu/hotels/plans

Price: 10 credits

Get the bookable stay plans of a hotel on Ikyu (一休.com) for a check-in day, nights, adults and rooms: plan name, meals, check-in and check-out times, and every room offered with its size, beds, features, photos, price, discount, points and rooms left

How to use it

Hotel ids come from ikyu/hotels/search. An empty list means nothing is bookable for that stay; ikyu/hotels/calendar shows which check-in days have availability.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• nights integer — Number of nights (default: 1; min: 1; max: 9)
• adults integer — Adults per room (default: 2; min: 1; max: 10)
• rooms integer — Number of rooms (default: 1; min: 1; max: 10)
• hotel string required — Ikyu hotel id or hotel URL (examples: "00001278", "https://www.ikyu.com/00001278/"; minLength: 1)
• check_in integer required — Check-in day as unix seconds (examples: 1794700800)
• count integer required — Max number of results (min: 1; max: 500)

Response

• @type string (default: "IkyuHotelPlan")
• id string required
• hotel_id string required
• hotel_url string required
• name string nullable
• meal object nullable
  • @type string (default: "IkyuNamedCode")
  • code string required
  • name string nullable
• check_in_from string nullable
• check_in_until string nullable
• check_out string nullable
• sale_type string nullable
• member_rank string nullable
• is_ikyu_exclusive boolean nullable
• is_within_two_weeks_only boolean nullable
• is_bookable_soon boolean nullable
• is_ending_soon boolean nullable
• features array (default: [])
  • @type string (default: "IkyuNamedCode")
  • code string required
  • name string nullable
• image_urls array (default: [])
• lowest_price integer nullable
• room_offer_count integer nullable
• room_offers array (default: [])
  • @type string (default: "IkyuRoomOffer")
  • room_id string required
  • room_name string nullable
  • room_type object nullable
    • @type string (default: "IkyuNamedCode")
    • code string required
    • name string nullable
  • size_sqm_min number nullable
  • size_sqm_max number nullable
  • capacity_min integer nullable
  • capacity_max integer nullable
  • floor_plan string nullable
  • floor_min integer nullable
  • floor_max integer nullable
  • renovated string nullable
  • beds array (default: [])
    • @type string (default: "IkyuBed")
    • count integer nullable
    • sleeps integer nullable
    • width_cm integer nullable
    • length_cm integer nullable
    • height_cm integer nullable
  • features array (default: [])
    • @type string (default: "IkyuNamedCode")
    • code string required
    • name string nullable
  • images array (default: [])
    • @type string (default: "IkyuImage")
    • url string required
    • caption string nullable
    • category string nullable
  • price integer nullable
  • price_before_discount integer nullable
  • discount_rate integer nullable
  • points integer nullable
  • point_rate number nullable
  • rooms_left integer nullable

Errors

• 422 — hotel is not an Ikyu hotel id or URL 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 — No Ikyu hotel under that id 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.