/ikyu/restaurants/courses

POST /api/ikyu/restaurants/courses

Price: 20 credits

Get the bookable courses and seat-only plans of a restaurant on Ikyu (一休.com レストラン): course name and menu, meal period, price and discount, points, party size, included drinks, restrictions, payment type, cancellation policy, child and option menus

How to use it

Restaurant ids come from ikyu/restaurants/search. ikyu/restaurants/availability shows which days can be booked.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Ikyu restaurant id or restaurant URL (examples: "103903", "https://restaurant.ikyu.com/103903"; minLength: 1)
• count integer required — Max number of results (min: 1; max: 500)

Response

• @type string (default: "IkyuCoursePlan")
• id string required
• restaurant_id string required
• restaurant_url string required
• course_id string nullable
• course_name string nullable
• course_menu string nullable
• course_images array (default: [])
  • @type string (default: "IkyuImage")
  • url string required
  • caption string nullable
  • category string nullable
• is_seat_only boolean nullable
• meal_period string nullable
• description string nullable
• included string nullable
• restrictions string nullable
• notes string nullable
• price integer nullable
• price_before_discount integer nullable
• list_price integer nullable
• list_price_is_reference boolean nullable
• discount_percent integer nullable
• has_varied_price boolean nullable
• point_rate_percent integer nullable
• points integer nullable
• has_point_up boolean nullable
• has_last_minute_deal boolean nullable
• timesale_label boolean nullable
• timesale_from string nullable
• timesale_to string nullable
• min_party integer nullable
• max_party integer nullable
• payment_type string nullable
• member_limit string nullable
• is_request_only boolean nullable
• has_cancel_guard boolean nullable
• cancel_policy string nullable
• attributes array (default: [])
• child_menus array (default: [])
  • @type string (default: "IkyuMenuExtra")
  • id string required
  • name string nullable
  • price integer nullable
  • description string nullable
• option_menus array (default: [])
  • @type string (default: "IkyuMenuExtra")
  • id string required
  • name string nullable
  • price integer nullable
  • description string nullable

Errors

• 422 — restaurant is not an Ikyu restaurant 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 restaurant 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.