API Overview
Every endpoint, parameter, request body, and response schema is documented in the interactive API Reference, which is generated from openapi.json. This page covers the conventions that apply across the whole API.
Two modules, one credential
Section titled “Two modules, one credential”The RestroLab Third-Party Integration API is provider-agnostic. Any external platform (food delivery, booking/OTA, POS, marketplace, and so on) can connect to a tenant’s Restaurant and/or Hotel operations. One credential works for both modules. Which endpoints respond depends only on which features the tenant has enabled. See Feature gating.
| Module | Endpoints |
|---|---|
| Restro | GET /v1/restro/dishes/, GET /v1/restro/dishes/{id}/, GET/POST /v1/restro/orders/, GET /v1/restro/orders/{external_order_id}/, POST /v1/restro/orders/{external_order_id}/cancel/, PATCH /v1/restro/orders/{external_order_id}/payment/ |
| Hotel | GET /v1/hotels/roomtypes/, GET /v1/hotels/roomtypes/{room_type_id}/availability/, GET/POST /v1/hotels/bookings/, GET/PATCH /v1/hotels/bookings/{external_reservation_id}/, POST /v1/hotels/bookings/{external_reservation_id}/cancel/ |
| Shared | GET /v1/restrolab/ping/, POST /v1/restrolab/webhook/ |
Base URL
Section titled “Base URL”openapi.json doesn’t declare a servers entry, but the backend confirms there is one shared API host for every tenant. The tenant is resolved from your Restro-API-Key credential, never from the request’s domain or a header:
https://api.restrolab.com/v1/TODO: api.restrolab.com is a placeholder. The real production hostname isn’t in the codebase (it’s an infrastructure/DNS detail), so confirm it with RestroLab during onboarding. What is confirmed is that it’s a single shared host, not a per-tenant domain or subdomain.
Authentication
Section titled “Authentication”Every endpoint is authenticated with Restro-API-Key / Restro-API-Secret headers. See Authentication for the full explanation.
API version
Section titled “API version”1.0.0Source: info.version in openapi.json.
Content type
Section titled “Content type”Request bodies are accepted as application/json, and the generated spec also allows application/x-www-form-urlencoded and multipart/form-data. We recommend application/json. All responses are application/json.
Idempotency
Section titled “Idempotency”POST /v1/restro/orders/ and POST /v1/hotels/bookings/ are idempotent on external_order_id / external_reservation_id. The first call returns 201 Created. A retry with the same id returns the existing resource with 200 OK instead of creating a duplicate.
Updating a reservation
Section titled “Updating a reservation”PATCH /v1/hotels/bookings/{external_reservation_id}/ changes a reservation’s dates, for example when a guest extends or shortens their stay on your platform. Only check_in and check_out can be changed right now. Send just the fields that changed.
{ "check_in": "2026-10-01", "check_out": "2026-10-06", "event_id": "your-change-id-123", "occurred_at": "2026-09-25T10:15:00Z"}event_id and occurred_at are optional, but we strongly recommend sending them:
event_idmakes the update safe to retry. If RestroLab has already applied an update with thisevent_id, it returns the reservation unchanged instead of applying it twice.occurred_atprotects against updates arriving out of order. If a newer update has already been applied, an older one is rejected with409 stale_update. Withoutoccurred_at, updates are applied in the order they arrive.
Only pending or confirmed reservations can be changed. The response has the same shape as GET on the reservation. See Error Handling for the errors this can return.
Payments
Section titled “Payments”If your platform collects payment from the customer, you can tell RestroLab when you create the order or reservation:
- Orders: set
payment_modeonPOST /v1/restro/orders/. Usepartner_collectedif your platform already took payment. Leave it out if the customer pays on delivery or at the property. - Reservations: set
amount_paidonPOST /v1/hotels/bookings/to the amount the guest already paid (full or partial).payment_methodis optional and defaults topartner_collectedwhenamount_paidis set. Leave both out if the guest pays at the property.
The allowed values are listed under PaymentModeEnum and PaymentMethodEnum in the API Reference.
If an order wasn’t paid upfront, report how it was later settled with PATCH /v1/restro/orders/{external_order_id}/payment/:
{ "payment_mode": "cash" }payment_mode here accepts cash, card, bank_transfer, esewa, or khalti — not partner_collected, which is only valid at order creation. Returns 409 invalid_status_transition if the order is already cancelled.
Pagination
Section titled “Pagination”Most list endpoints return every matching record in a single JSON array — GET /v1/hotels/roomtypes/ is the one exception, returning a {count, results} envelope. See Pagination.
Error format
Section titled “Error format”Errors aren’t formally modeled in openapi.json yet. See Error Handling for what’s confirmed and what’s still open.
Explore the full reference
Section titled “Explore the full reference”The interactive API Reference lets you:
- Browse every endpoint grouped by tag (Third-Party Integration, Third-Party Ping)
- Inspect parameters, request bodies, and response schemas
- View the full nested schemas (dishes, room types, orders, reservations)
- Try requests directly from the browser where supported
openapi.json is the single source of truth for endpoint details, so this site doesn’t repeat the endpoint list in Markdown.
