Service
Connect a Recruit account to search Hot Pepper Gourmet restaurants, inspect date/time/course/seat availability, list current reservations, and manage reservation lifecycle actions.
82.57%30-day uptimeAvg response261ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/hotpepper-gourmet/availability | Return valid party sizes and reservable dates for a restaurant. Use when you need to know which dates and party sizes can be booked before choosing a time. Do NOT use for time, course, or seat choices — use hotpepper-gourmet:time-slots instead. This operation does not accept visit_date or visit_time; pass a returned date to time-slots. Returns restaurant_ref, party_size, valid_party_sizes, valid_party_size_min, valid_party_size_max, available_dates, and summary. | |
| POST | /v1/hotpepper-gourmet/cancel-reservation | Cancel an authenticated Hot Pepper Gourmet reservation after explicit confirmation. Use only when the user has explicitly confirmed cancelling a specific reservation_ref obtained from reservations-list; this changes real booking state. Do NOT use to find the reservation to cancel — use hotpepper-gourmet:reservations-list instead. Returns reservation_ref, status, and summary. | |
| POST | /v1/hotpepper-gourmet/create-reservation | Create an authenticated Hot Pepper Gourmet reservation using choices returned by time-slots. Use only after the user has explicitly confirmed the restaurant, date, time, party size, course, and seat; this changes real booking state. Do NOT use to check availability or look up choices — use hotpepper-gourmet:time-slots instead. Do NOT use to list or cancel existing reservations — use hotpepper-gourmet:reservations-list or hotpepper-gourmet:cancel-reservation instead. Contact inputs are optional per-field overrides of the connected account's pre-filled values. Returns reservation_ref, restaurant_ref, restaurant_name, visit_date, visit_time, party_size, course_ref, verified_via, and summary. | |
| POST | /v1/hotpepper-gourmet/master-data | Browse local Hot Pepper Gourmet master data such as areas, genres, features, seat types, smoking filters, and budgets. Use when you need valid filter codes (area_id, genre_ids, feature_ids, seat_type, smoking) before calling search-restaurants. Do NOT use to find restaurants — use hotpepper-gourmet:search-restaurants instead. data_type accepts areas, genres, features, seat_types, smoking, or budgets. Returns data_type, items, and summary. |
Scopes define which services and APIs a key may call.
Retry rules and backoff behaviour for idempotent calls.
Receive events such as reservation confirmations and delivery updates.
Observed on this service over the last 30 days.
| POST | /v1/hotpepper-gourmet/reservations-list | List current authenticated Hot Pepper Gourmet reservations. Use when the user asks which reservations they have, or to verify the outcome after a create-reservation or cancel-reservation call that did not return a confirmed result. Do NOT use to search restaurants or check availability — use hotpepper-gourmet:search-restaurants or hotpepper-gourmet:availability instead. Returns reservations and summary. |
| POST | /v1/hotpepper-gourmet/restaurant-detail | Fetch normalized restaurant detail and course summaries for a Hot Pepper Gourmet restaurant. Use when you have a restaurant_ref and need its address, hours, reservation_mode, or course list. Do NOT use to find restaurants — use hotpepper-gourmet:search-restaurants instead. Do NOT use to check bookable dates or times — use hotpepper-gourmet:availability or hotpepper-gourmet:time-slots instead. Returns restaurant_ref, name, reservation_mode, address, access, phone, lat, lng, cuisine, business_hours, average_budget, seats_summary, courses, and summary. |
| POST | /v1/hotpepper-gourmet/search-restaurants | Search Hot Pepper Gourmet restaurants with normalized area, keyword, genre, budget, date/time, party-size, amenity, seat, and smoking filters. Use when the user is looking for restaurants and you need restaurant_ref values. Do NOT use to look up filter codes such as area or genre ids — use hotpepper-gourmet:master-data instead. Do NOT use for a restaurant you already have a restaurant_ref for — use hotpepper-gourmet:restaurant-detail instead. Returns area_id, page, total_count, items, and summary. |
| POST | /v1/hotpepper-gourmet/time-slots | Return time slots, course options, and seat options for a restaurant/date/party-size combination. Use when you have a reservable date and need the course_ref and seat_ref values required by create-reservation. Do NOT use to discover which dates can be booked — use hotpepper-gourmet:availability instead. visit_date is required; visit_time is optional and scopes the choices. Returns restaurant_ref, visit_date, selected_visit_time, selected_course_ref, requested_visit_time, time_slots, course_options, seat_options, instant_reservable, seat_request_available, and summary. |
