guest

Get the full menu of a meni.ge location: categories, items with prices, variant groups and addons, currency and ordering capabilities. domain = uppercase location code from the QR/menu URL.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Location domain code, e.g. MYCAFE"
    },
    "language": {
      "type": "string",
      "description": "ISO 639-1 menu language, default en"
    }
  },
  "required": [
    "domain"
  ]
}

Get one menu item with its variant groups and addons, or several at once: pass itemIds (up to 10) instead of itemId to look items up in bulk — the bulk answer is {items, notFound}.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "itemId": {
      "type": "string",
      "description": "One item; mutually exclusive with itemIds"
    },
    "itemIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "maxItems": 10,
      "description": "Bulk lookup, up to 10 ids; mutually exclusive with itemId"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "domain"
  ]
}

Semantic search over the location's catalog: product/dish names, descriptions, specifications, brand, SKU/barcodes and attached docs. Use for "do you have…" / "recommend…" / "how much is…" questions instead of paging through get_menu. Returns matching items with prices and a relevance score; falls back with a note when the search index is unavailable for the location.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "query": {
      "type": "string",
      "description": "What the guest is looking for, in any language"
    },
    "language": {
      "type": "string",
      "description": "ISO 639-1 menu language, default en"
    },
    "limit": {
      "type": "integer",
      "description": "How many items to return (1–10, default 6)"
    }
  },
  "required": [
    "domain",
    "query"
  ]
}

Build the guest order step by step in a server-side cart, the way a human uses the web cart. Without cartId a new cart is created (keep the returned cartId — it is the access token). Each entry of updates: {itemId, quantity, variants?, addons?, comment?} adds a line; {lineId, quantity} changes one; {lineId, quantity: 0} removes it. Prices are recomputed from the live menu on every read, never stored. The answer includes a checkoutUrl the human can open to finish in the normal web checkout, and the cart can be placed as an order with create_order(cartId).

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "cartId": {
      "type": "string",
      "description": "Omit to create a new cart"
    },
    "updates": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "lineId": {
            "type": "string",
            "description": "Existing line to change; omit to add a new one"
          },
          "itemId": {
            "type": "string",
            "description": "Required when adding a line"
          },
          "quantity": {
            "type": "integer",
            "minimum": 0,
            "maximum": 99,
            "description": "0 removes the line (needs lineId)"
          },
          "variants": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "comment": {
            "type": "string",
            "description": "Guest note for this line (e.g. \"no onions\")"
          }
        }
      }
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "updates"
  ]
}

Read a cart created with update_cart: lines with live unit prices, subtotal, item count, the checkoutUrl for a human hand-off and the expiry date (carts live 7 days). Lines whose item left the menu are flagged unavailable and excluded from the subtotal.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "cartId": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "cartId"
  ]
}

Facts about the location that are not on the menu: address, contacts, coordinates, working hours with openNow computed in the venue timezone, delivery and pickup terms (fees, minimum order, zones, ETA), accepted payment methods and currency, shipping/return terms and links to the published legal documents. Use this before answering "are you open?", "do you deliver?", "how much is delivery?".

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "language": {
      "type": "string",
      "description": "ISO 639-1; falls back to the location default"
    }
  },
  "required": [
    "domain"
  ]
}

Search the location's own published policies, FAQ entries and info pages (privacy, terms, returns, delivery, cookies, help articles) plus, when the owner allows it, their internal knowledge base. Returns short snippets with a link to the source. Use it for policy/help questions instead of guessing; use get_store_info when you need structured numbers.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "query": {
      "type": "string",
      "description": "The guest question, in any language"
    },
    "language": {
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "description": "How many snippets to return (1–10, default 5)"
    }
  },
  "required": [
    "domain",
    "query"
  ]
}

Validate and place an order at a meni.ge location. Returns orderId (keep it — it is the access token for status checks) and the computed total. customer.name/phone are required for pickup and delivery; delivery.address is required for delivery. Pass either items (inline) or cartId (the cart built with update_cart) — not both. Always pass idempotencyKey when you might retry: the same key within 48h returns the original order instead of placing a second one.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "cartId": {
      "type": "string",
      "description": "Order this cart; mutually exclusive with items"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64,
      "description": "Retry guard, e.g. a UUID you keep for this order attempt"
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "itemId"
        ],
        "properties": {
          "itemId": {
            "type": "string"
          },
          "quantity": {
            "type": "integer",
            "minimum": 1,
            "default": 1
          },
          "variants": {
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          },
          "addons": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "orderType": {
      "type": "string",
      "enum": [
        "dine-in",
        "delivery",
        "pickup"
      ]
    },
    "customer": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "phone": {
          "type": "string"
        },
        "email": {
          "type": "string"
        }
      }
    },
    "delivery": {
      "type": "object",
      "properties": {
        "address": {
          "type": "string"
        },
        "notes": {
          "type": "string"
        }
      }
    },
    "pickup": {
      "type": "object",
      "properties": {
        "scheduledFor": {
          "type": "string"
        }
      }
    },
    "paymentMethod": {
      "type": "string",
      "enum": [
        "cash",
        "card-on-delivery",
        "online"
      ]
    },
    "notes": {
      "type": "string"
    },
    "qrCode": {
      "type": "string"
    },
    "language": {
      "type": "string"
    }
  },
  "required": [
    "domain"
  ]
}

Check the status of an order previously created with create_order.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "orderId": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "orderId"
  ]
}

Which tables of the location are free or busy in a given time window (uses the floor plan published by the restaurant). Pass the chosen table id to create_reservation as tableId.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "description": "ISO 8601 datetime"
    },
    "durationMinutes": {
      "type": "integer",
      "default": 120
    }
  },
  "required": [
    "domain",
    "start"
  ]
}

Request a table reservation. Starts as "pending" until the restaurant confirms — check with get_reservation_status. Returns reservationId (keep it: it is the token for status and cancellation). Optionally bind a specific table via tableId (from check_table_availability).

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "start": {
      "type": "string",
      "description": "ISO 8601 datetime"
    },
    "durationMinutes": {
      "type": "integer",
      "minimum": 30,
      "maximum": 600,
      "default": 120
    },
    "partySize": {
      "type": "integer",
      "minimum": 1,
      "maximum": 50,
      "default": 2
    },
    "name": {
      "type": "string",
      "description": "Guest name"
    },
    "phone": {
      "type": "string"
    },
    "comment": {
      "type": "string"
    },
    "tableId": {
      "type": "string"
    },
    "codeId": {
      "type": "string"
    },
    "idempotencyKey": {
      "type": "string",
      "minLength": 8,
      "maxLength": 64,
      "description": "Retry guard: repeating the same key returns the original reservation instead of booking twice."
    }
  },
  "required": [
    "domain",
    "start",
    "name"
  ]
}

Status of a reservation created with create_reservation (pending/confirmed/seated).

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "reservationId": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "reservationId"
  ]
}

Cancel a reservation previously created with create_reservation.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string"
    },
    "reservationId": {
      "type": "string"
    }
  },
  "required": [
    "domain",
    "reservationId"
  ]
}

Hotels only. Факты об отеле из его базы знаний для гостей: заезд/выезд, завтрак, парковка, правила, услуги, как добраться. Вызывай для любого вопроса об отеле, кроме свободных номеров и цены проживания, — и для ПРОСЬБЫ об услуге («организуйте трансфер», «закажите такси», «нужна кроватка»): узнай, как она заказывается, и ответь фактами. Возвращает выдержки; ok:false — в базе ответа нет, тогда честно скажи, что не знаешь, и предложи человека.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Hotel location code (uppercase, from the site URL or QR)."
    },
    "query": {
      "type": "string",
      "description": "Вопрос гостя своими словами (на любом языке)."
    },
    "lang": {
      "type": "string",
      "description": "Язык гостя (en, ru, ka, tr…), необязательно."
    }
  },
  "required": [
    "domain",
    "query"
  ]
}

Hotels only. Есть ли свободные номера на ВСЕ ночи [checkIn, checkOut): по типам номеров — сколько свободно и помещается ли компания. Данные — из опубликованного календаря отеля. Дат нет — не вызывай, а спроси их. ok:false с reason unknown/stale/unavailable — данных нет: не утверждай ни «свободно», ни «занято», веди к форме бронирования или к человеку. ok:false с reason bad_request — ошибка в датах вызова, а не «данных нет»: dates-required — спроси у гостя даты заезда и выезда; checkin-in-the-past, checkout-not-after-checkin, checkin-too-far-ahead — уточни даты.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Hotel location code (uppercase, from the site URL or QR)."
    },
    "checkIn": {
      "type": "string",
      "description": "Заезд. Дата YYYY-MM-DD по календарю отеля."
    },
    "checkOut": {
      "type": "string",
      "description": "Выезд (позже заезда). Дата YYYY-MM-DD по календарю отеля."
    },
    "party": {
      "type": "object",
      "description": "Сколько гостей: взрослые (≥1) и дети. Передавай, только если гость назвал; не назвал — не передавай (посчитается 1 взрослый) и НЕ спрашивай ради цены или наличия: цена от числа гостей не зависит.",
      "properties": {
        "adults": {
          "type": "integer",
          "minimum": 1
        },
        "children": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  },
  "required": [
    "domain",
    "checkIn",
    "checkOut"
  ]
}

Hotels only. ПРЕДВАРИТЕЛЬНАЯ цена проживания на конкретные даты (не бронь и не резерв). roomTypeId — из get_hotel_availability, если гость выбрал тип номера; тип не назван — НЕ спрашивай его, а вызывай без roomTypeId: посчитается каждый тип (roomTypes[] — у каждого quote или reason отказа). Называй гостю ровно total и currency из ответа вместе с датами; окончательная цена — в форме бронирования. ok:false — цены нет, не угадывай; detail — причина (min-stay — минимальный срок проживания и т.п.), её и назови. Цена относится к тарифу ratePlan из ответа: называй его по ratePlan.name (на языке гостя) и с его условиями отмены, а не тарифом, о котором спросил гость. Тариф не назван — подбирается самый дешёвый продаваемый; notOffered — тарифы, которые на эти даты не продаются, и причина (min-stay и т.п.). Число гостей для цены не нужно. ok:false с reason bad_request — ошибка в датах вызова, а не «данных нет»: dates-required — спроси у гостя даты заезда и выезда; checkin-in-the-past, checkout-not-after-checkin, checkin-too-far-ahead — уточни даты.

{
  "type": "object",
  "properties": {
    "domain": {
      "type": "string",
      "description": "Hotel location code (uppercase, from the site URL or QR)."
    },
    "roomTypeId": {
      "type": "string",
      "description": "roomTypeId из ответа get_hotel_availability; гость тип не назвал — не передавай (посчитаются все типы)."
    },
    "ratePlanId": {
      "type": "string",
      "description": "id тарифа (ratePlan.ratePlanId или id из notOffered прежнего ответа), если гость выбрал конкретный тариф; иначе не передавай. Тариф с ограничением на эти даты вернёт ok:false с причиной."
    },
    "checkIn": {
      "type": "string",
      "description": "Заезд. Дата YYYY-MM-DD по календарю отеля."
    },
    "checkOut": {
      "type": "string",
      "description": "Выезд (позже заезда). Дата YYYY-MM-DD по календарю отеля."
    },
    "party": {
      "type": "object",
      "description": "Сколько гостей: взрослые (≥1) и дети. Передавай, только если гость назвал; не назвал — не передавай (посчитается 1 взрослый) и НЕ спрашивай ради цены или наличия: цена от числа гостей не зависит.",
      "properties": {
        "adults": {
          "type": "integer",
          "minimum": 1
        },
        "children": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  },
  "required": [
    "domain",
    "checkIn",
    "checkOut"
  ]
}