/yogiyo/restaurants

POST /api/yogiyo/restaurants

Price: 5 credits

Get a Yogiyo (요기요) restaurant by id or URL: business details, address and coordinates, hygiene grade, opening hours, rating and review counts, representative menus, and per serving option (delivery, pickup) delivery fee tiers, estimated delivery time, payment methods and discounts

How to use it

Restaurant ids come from yogiyo/restaurants/search. Pass a delivery point to get fees and delivery times for 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: "YogiyoRestaurant")
• id string required
• url string required
• name string nullable
• franchise_id string nullable
• franchise_name string nullable
• categories array (default: [])
• tags array (default: [])
• phone string nullable
• company_name string nullable
• business_registration_number string nullable
• owner_name string nullable
• city string nullable
• district string nullable
• neighborhood string nullable
• address_detail string nullable
• address_extra string nullable
• latitude number nullable
• longitude number nullable
• distance_m number nullable
• thumbnail string nullable
• logo_image string nullable
• images array (default: [])
• introduction_title string nullable
• introduction string nullable
• introduction_images array (default: [])
• has_review_event boolean nullable
• allergy_url string nullable
• nutrition_url string nullable
• delivery_fee_surcharges array (default: [])
  • @type string (default: "YogiyoSurchargeSchedule")
  • serving_type string nullable
  • active_amount number nullable
  • windows array (default: [])
    • @type string (default: "YogiyoSurchargeWindow")
    • days array (default: [])
    • start_time string nullable
    • end_time string nullable
    • amount number nullable
• country_of_origin string nullable
• hygiene_grade string nullable
• hygiene_grade_from integer nullable
• hygiene_grade_until integer nullable
• open_status string nullable
• next_open_status string nullable
• next_open_status_at integer nullable
• is_delivery_available boolean nullable
• opening_hours array (default: [])
  • @type string (default: "YogiyoOpeningHours")
  • weekday string nullable
  • opens_at string nullable
  • closes_at string nullable
  • delivery_opens_at string nullable
  • delivery_closes_at string nullable
  • break_times array (default: [])
• holidays array (default: [])
• rating number nullable
• review_count integer nullable
• review_image_count integer nullable
• review_reply_count integer nullable
• accepts_livelihood_voucher boolean nullable
• allows_below_minimum_order boolean nullable
• allows_single_dish_order boolean nullable
• uses_virtual_phone_number boolean nullable
• uses_reusable_packaging boolean nullable
• vertical_type string nullable
• serving_priority array (default: [])
• serving_options array (default: [])
  • @type string (default: "YogiyoServing")
  • serving_type string required
  • available boolean nullable
  • status string nullable
  • delivery_fee number nullable
  • delivery_fee_tiers array (default: [])
    • @type string (default: "YogiyoFeeTier")
    • order_amount number nullable
    • delivery_fee number nullable
  • delivery_fee_surcharge number nullable
  • delivery_fee_funding number nullable
  • delivery_minutes_min integer nullable
  • delivery_minutes_max integer nullable
  • pickup_minutes_min integer nullable
  • payment_methods array (default: [])
  • coupon object nullable
    • @type string (default: "YogiyoCoupon")
    • mode string nullable
    • amount number nullable
    • rate_percent number nullable
    • maximum_amount number nullable
    • minimum_order_amount number nullable
    • payment_restriction string nullable
  • additional_discount_amount number nullable
  • additional_discount_minimum_order number nullable
  • additional_discount_members_only boolean nullable
  • additional_discount_specific_menu_only boolean nullable
  • shop_discount_percent number nullable
  • membership_point_percent number 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.