/yogiyo/restaurants/menu

POST /api/yogiyo/restaurants/menu

Price: 20 credits

Get the full Yogiyo (요기요) menu of a restaurant: one row per dish with its menu section, price, photo, badges, review count and every option group with its choices and their prices

How to use it

Restaurant ids come from yogiyo/restaurants/search. Pass the delivery point to get the menu as offered at that address; without one the restaurant's own location is used. Money is in KRW.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• restaurant string required — Yogiyo restaurant id or restaurant URL (examples: "1274060", "https://www.yogiyo.co.kr/mobile/#/1274060/"; minLength: 1)
• latitude number nullable — Latitude of the delivery address (min: 33; max: 39)
• longitude number nullable — Longitude of the delivery address (min: 124; max: 132)

Response

• @type string (default: "YogiyoMenuItem")
• id string required
• restaurant_id string required
• section_id string nullable
• section_title string nullable
• section_description string nullable
• name string nullable
• description string nullable
• price number nullable
• original_price number nullable
• price_with_required_options number nullable
• original_price_with_required_options number nullable
• image string nullable
• badges array (default: [])
• review_count integer nullable
• reward_points integer nullable
• is_sold_out boolean nullable
• is_adult_only boolean nullable
• is_liquor boolean nullable
• option_groups array (default: [])
  • @type string (default: "YogiyoOptionGroup")
  • id string nullable
  • is_required boolean nullable
  • allows_multiple boolean nullable
  • max_choices integer nullable
  • allows_quantity boolean nullable
  • options array (default: [])
    • @type string (default: "YogiyoMenuOption")
    • id string nullable
    • name string nullable
    • description string nullable
    • price number nullable
    • original_price number nullable
    • deposit number nullable
    • deposit_description string nullable
    • is_sold_out boolean nullable
    • uses_reusable_packaging boolean 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 — Yogiyo has no 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.