跳至內容

The guest's reservation ​

Public booking API · https://api.conciar.com/public/v1

What the guest can do with the confirmation token. Here the token works until a day after the reservation; an unknown restaurant, an unknown token and an expired one all answer 404 NOT_FOUND.

INFO

API 參考文件以英文撰寫。

Get the reservation ​

GET/public/v1/restaurants/{organization_guid}/reservations/{token}/manage
不需金鑰

速率限制: 120/min per restaurant and IP

路徑參數

  • organization_guidstring必填

    The restaurant's guid or its handle (any case, a leading @ is ignored; former handles still resolve).

  • tokenstring必填

    The confirmation token from manage_url (40 letters and digits; the route accepts 32–64).

查詢參數

  • langstring

    en, nl, de, fr or es. Otherwise the language the guest booked in.

狀態碼

  • 404NOT_FOUND.

注意事項

  • state is confirmed, pending, cancelled or past. deposit is a formatted amount or null; guarantee is {amount, deadline, status, deadline_passed} or null; tickets is {reference, quantity, event, total, status} or null. sms.available is true only for an upcoming reservation, at a restaurant that sends texts, for a guest with a mobile number.
curl "https://api.conciar.com/public/v1/restaurants/bistro-example/reservations/0000000000000000000000000000000000000000/manage" \
  -H "Accept: application/json"
回應範例 · 200
{
  "status": true,
  "locale": "en",
  "handle": "bistro-example",
  "reservation": {
    "reference": "EXAMPLE-R-0001",
    "date": "2026-10-24",
    "time": "19:00",
    "party_size": 2,
    "name": "Alex Example",
    "email": "alex@example.com",
    "note": null
  },
  "state": "confirmed",
  "expired": false,
  "deposit": null,
  "deposit_paid": false,
  "payment_url": null,
  "awaits_card": false,
  "guarantee": null,
  "tickets": null,
  "can_cancel": true,
  "address": "Example Street 1, 1000 AA Example City",
  "sms": {
    "available": true,
    "opted_out": false
  }
}

Cancel the reservation ​

The guest is emailed and the restaurant notified. Returns the same fields as the manage call plus outcome: cancelled or already (200), or not_cancellable.

POST/public/v1/restaurants/{organization_guid}/reservations/{token}/cancel
不需金鑰

速率限制: 10/min per restaurant and IP

路徑參數

  • organization_guidstring必填

    The restaurant's guid or its handle (any case, a leading @ is ignored; former handles still resolve).

  • tokenstring必填

    The confirmation token from manage_url (40 letters and digits; the route accepts 32–64).

狀態碼

  • 404NOT_FOUND.
  • 422{status: false, outcome: not_cancellable, …} — not confirmed or pending, in the past, or has paid tickets.
curl -X POST "https://api.conciar.com/public/v1/restaurants/bistro-example/reservations/0000000000000000000000000000000000000000/cancel" \
  -H "Accept: application/json"
回應範例 · 200
{
  "status": true,
  "outcome": "cancelled",
  "state": "cancelled",
  "can_cancel": false,
  "…": "…"
}

Stop text messages ​

POST/public/v1/restaurants/{organization_guid}/reservations/{token}/sms-stop
不需金鑰

速率限制: 10/min per restaurant and IP

路徑參數

  • organization_guidstring必填

    The restaurant's guid or its handle (any case, a leading @ is ignored; former handles still resolve).

  • tokenstring必填

    The confirmation token from manage_url (40 letters and digits; the route accepts 32–64).

狀態碼

  • 404NOT_FOUND.
  • 422{status: false, sms} (no code) — the guest has no valid mobile number.
curl -X POST "https://api.conciar.com/public/v1/restaurants/bistro-example/reservations/0000000000000000000000000000000000000000/sms-stop" \
  -H "Accept: application/json"
回應範例 · 200
{
  "status": true,
  "sms": {
    "available": true,
    "opted_out": true
  }
}

Resume text messages ​

POST/public/v1/restaurants/{organization_guid}/reservations/{token}/sms-start
不需金鑰

速率限制: 10/min per restaurant and IP

路徑參數

  • organization_guidstring必填

    The restaurant's guid or its handle (any case, a leading @ is ignored; former handles still resolve).

  • tokenstring必填

    The confirmation token from manage_url (40 letters and digits; the route accepts 32–64).

狀態碼

  • 404NOT_FOUND.
  • 422{status: false, sms} (no code) — the guest has no valid mobile number.
curl -X POST "https://api.conciar.com/public/v1/restaurants/bistro-example/reservations/0000000000000000000000000000000000000000/sms-start" \
  -H "Accept: application/json"
回應範例 · 200
{
  "status": true,
  "sms": {
    "available": true,
    "opted_out": false
  }
}

The 8-character code in a reservation text message to the reservation page.

GET/public/v1/short/{code}
不需金鑰

速率限制: 30/min per IP

路徑參數

  • codestring必填

    8 characters: uppercase letters and the digits 2–9 (no I, L, O, 0 or 1).

狀態碼

  • 404NOT_FOUND — unknown or expired.
curl "https://api.conciar.com/public/v1/short/ABCDEF23" \
  -H "Accept: application/json"
回應範例 · 200
{
  "status": true,
  "handle": "bistro-example",
  "token": "0000000000000000000000000000000000000000",
  "url": "https://r.conciar.com/bistro-example/reservation/0000000000000000000000000000000000000000"
}