Service
Search public TableCheck restaurants, inspect availability, and connect an account for private profile and reservation reads.
99.84%30-day uptimeAvg response440ms
Selecting a row opens the reference for that API.
| Method | API | Path | Summary |
|---|---|---|---|
| POST | /v1/tablecheck/cancel-reservation | Cancels a real reservation owned by the connected account using its confirmation code. Before the destructive PUT, one reservation-detail GET confirms ownership and identity; a reservation-scoped 401 adds an account GET to distinguish invalid credentials without revealing whether the reservation exists. The single PUT sends no request body and its result must match the requested code. If TableCheck reports the reservation as already cancelled, the call fails with the non-retryable RESERVATION_ALREADY_CANCELLED error; the operation is not idempotent and always requires approval. | |
| POST | /v1/tablecheck/check-availability | Checks TableCheck's anonymous booking widget for one shop, venue-local date and time, and age-bucket party composition. Use when a specific restaurant and desired time are already known. Do NOT use to create, hold, or modify a reservation — use tablecheck:create-reservation-cart instead. Do NOT use to browse nearby dates and times — use tablecheck:get-availability-timetable instead. Returns a top-level status of success, same_day, closed, disabled, preorder_required, service_category_required, unavailable, invalid_request, or unknown, together with slots. The statuses preorder_required, service_category_required, unavailable, invalid_request, and unknown always return an empty slots array; invalid_request may include a structured invalid_reason and unknown may include a diagnostic. | |
| POST | /v1/tablecheck/confirm-reservation | Creates a real, binding restaurant reservation from a valid TableCheck cart and caller-supplied customer identity. Pass the cart_handle from create-reservation-cart through exactly as returned. Missing customer fields, purpose, venue questions, service category, menu orders, unsupported payment collection, and any other precondition this provider cannot satisfy are rejected before submission. Upstream customer-format failures return normalized field names only. Confirmation proceeds only while current cart state matches the approved handle. | |
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.
| POST |
| /v1/tablecheck/create-reservation-cart |
| Creates a short-lived TableCheck reservation cart. A venue may return cart:null with normalized availability and next_action guidance; only an available cart receives a handle. The cart exposes missing customer fields, customer-field modes, purpose and question preconditions, payment collection support, and nullable menu prices. Caller-supplied customer and purpose values are forwarded exactly as given and never filled in by the provider, while answer definitions and cart echoes are validated without logging personal content. |
| POST | /v1/tablecheck/get-availability-timetable | Retrieves the anonymous TableCheck timetable for one shop, starting date, and age-bucket party composition. Use when the caller can vary the requested time and wants nearby available dates and times. Do NOT use to check one exact time — use tablecheck:check-availability instead. Do NOT use to create or hold a reservation — use tablecheck:create-reservation-cart instead. Returns top-level date-grouped venue-local slots, an HH:MM time domain, and the venue time zone. Unsupported timetable responses use empty arrays plus an optional normalized diagnostic. |
| POST | /v1/tablecheck/get-my-profile | Reads the connected TableCheck customer's safe profile fields. Use to identify the connection owner or read their name, phone, and text-message provider preference (preferred_text_provider). Do NOT use to retrieve credentials or tokens. Returns only account fields verified from the upstream profile, with personal free text marked as untrusted upstream content. |
| POST | /v1/tablecheck/get-reservation-cart | Re-reads a short-lived TableCheck reservation cart using the cart_handle returned by create-reservation-cart; pass it through exactly as returned. The response includes normalized questionnaire answer echoes as metadata only (never free text), and the server-held approved cart state detects if submitted answers, orders, seating, totals, or other approved cart state changed. A cart whose checkout already ran answers CART_ALREADY_SUBMITTED. |
| POST | /v1/tablecheck/get-shop | Retrieves the full public detail record for one TableCheck shop slug. Use after search-shops or when a known live slug is available. Do NOT use to discover restaurants by location, cuisine, or other filters — use tablecheck:search-shops instead; neither operation supports free-text name search. Returns normalized multilingual identity and content, addresses, venue coordinates, nearby stations, currency-aware budgets, cuisine and tag IDs, images, booking and loyalty flags, and the venue's IANA time zone. |
| POST | /v1/tablecheck/list-cuisines | Lists TableCheck's public cuisine taxonomy with stable IDs and all supplied translations. Use before tablecheck:search-shops when a cuisine ID is unknown or when building a cuisine selector. Do NOT use for restaurant discovery by itself — use tablecheck:search-shops instead. Returns the complete normalized vocabulary; translation text is untrusted upstream content and cuisine IDs are validated by the provider. |
| POST | /v1/tablecheck/list-my-reservations | Lists a public one-based page of the connected customer's upcoming or past TableCheck reservations. The provider translates it to TableCheck's zero-based page, returns reservation summaries and record_count as total_count, omits the unreliable upstream total_pages, and derives a boolean has_more from the upstream page metadata; when that metadata is inconsistent the call fails with UPSTREAM_SCHEMA_ERROR instead of guessing. |
| POST | /v1/tablecheck/list-shop-menus | Lists courses and plans published for one TableCheck venue. Use before tablecheck:create-reservation-cart to choose a menu_id. Text fields are returned in Japanese as published by the venue; when a venue publishes no Japanese text for a field, its English text is returned, then any other language it does publish. The response language is not an input of this operation. Each item can include a name, tagline, description, fine print, and redemption instructions, current and previous prices with currency, tax treatment, and service-fee basis, offering date ranges and venue-clock offering times that may read past 24:00 for after-midnight service, a last-order time, cancellation policy terms, category names, meal periods, weekday and holiday availability, quantity bounds, duration, a coupon flag, and one image URL. limit defaults to 50 and accepts 1 through 100. total_count equals the number of returned items; TableCheck yields at most 100 menus per call and this operation is not pageable. An empty collection is valid for venues without menus. |
| POST | /v1/tablecheck/search-shops | Searches TableCheck's public restaurant directory with cuisine, tag, geographic, budget, service, booking, loyalty, and availability-projection filters. Use when exploring restaurants or obtaining a slug for another operation. Do NOT use for free-text name search because shop_search ignores query text. Do NOT use to read one already-known shop — use tablecheck:get-shop instead. Returns normalized multilingual summaries, the upstream total count, and a next_cursor handle for the following page; availability fields affect ranking and projected slots rather than the count. |
